User
The User APIs help manage everything related to logging in and securing your account. They allow you to sign in, verify your password or MPIN, reset your password if you forget it, and update your login details whenever needed.
📄️ Send OTP (Password-TOTP)
This call can be used in case if the client has forgotten the password or he wants to register TOTP and OTP is to be sent on the registered mobile number.
📄️ Login
This API needs to be used for signing-in to the application using login
📄️ Logout
This call would logout the user from the system and end the active session.
📄️ Validate Session
This call will help validate if the session token passed is active in the system or not.
📄️ Forgot User ID
This API can be used to retrieve the User ID in case the user forgets it. The user will have to provide his PAN to retrive the ID.
📄️ Register MPIN
This call allows User to set MPIN which shall be used to login during the day instead of entering User ID and Password again. This will allow user to quickly login to the system.
📄️ Change MPIN
This call would allow the user to change the MPIN, this API will be used to change the MPIN in case of expiry or if the user chooses to change the MPIN. This call will not allow user to change the MPIN if he has forgotten the existing MPIN.
📄️ Change Password
This call would allow the user to change the Password, this API will be used to change the Password in case of expiry or if the user chooses to change the Password. This call will not allow user to change the Password if he has forgotten the existing Password.
📄️ GetUserDetails
This call would return back the mobile and eMail details of the client, which will be used to send an OTP.
📄️ Verify OTP
This call would be used to validate the OTP entered by the user in the front end against the one sent to the user in Send OTP call.
📄️ Set Password
On successful validation of OTP, this call would allow the user to set a new password for login.
📄️ Forgot MPIN Send OTP
This call allows the user to send an OTP on his registered mobile number in case he forgets the MPIN.
📄️ Set MPIN
This call allows the user to set a new MPIN, the pre-requisite in this case would be to call the 'Verify OTP' call to ensure that the OTP is validated correctly.
📄️ Set Fingerprint
This call allows User to set Fingerprint to login where the prerequisite shall be to verify OTP to ensure that the OTP has been validated correctly.
📄️ User Profile
This call will fetch the basic details like user_name, email, mobile_no, pan, address including bank and DP details of the client.
📄️ User Profile v2
Use this API to retrieve User details such as Name, unmasked email, unmasked telephone no. The data will be in encrypted format. The methodology to decrypt the data is as shown below, for the key please get in touch with the support team. <div style='background-color: black; color: white;'> <p>Decryption Logic</p> <code style='background-color: black; color: white;'> decryptWithAEScbc(sKey, str) { </br> const combined = CryptoJS.enc.Base64.parse(str); <span style='color: green;'>// Parse the Base64-encoded input.</span> </br> <span style='color: green;'>// Extract the IV from the first 16 bytes</span> </br> const extractedIv = CryptoJS.lib.WordArray.create(combined.words.slice(0, 4)); </br> extractedIv.sigBytes = 16; </br> <span style='color: green;'>// Extract the ciphertext from the remaining bytes</span> </br> const ciphertext = CryptoJS.lib.WordArray.create(combined.words.slice(4)); </br> ciphertext.sigBytes = combined.sigBytes - 16; </br> const key = CryptoJS.enc.Utf8.parse(sKey); <span style='color: green;'>// Parse the key to a WordArray object</span> </br> const decrypted = CryptoJS.AES.decrypt({ ciphertext }, key, { <span style='color: green;'>// Decrypt the ciphertext using the extracted IV </span> </br> iv: extractedIv, </br> mode: CryptoJS.mode.CBC, </br> padding: CryptoJS.pad.Pkcs7 </br> }); </br> return decrypted.toString(CryptoJS.enc.Utf8); <span style='color: green;'>// Return the decrypted result as a UTF-8 string.</span> </br> } </br> </code> </div>
📄️ Register TOTP
This call would allow the user to fetch the details required to register for TOTP as second factor authentication.
📄️ Delete TOTP
This call would allow the user to disable TOTP as second factor authentication.
📄️ Verify TOTP
This call would be used to enable TOTP after login by verifying the TOTP entered by the user as second factor authentication.