Sign In with OTP
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
This API signs-in a registered user. Once signed in, the user will have access to the custom functionality developed within your portal (for example, loan/education application forms, progress tracking, contact information, etc.).
Before calling this API you must get the OTP data using the Get Sign In OTP API.
In the JSON body –
- Pass “OTPSigninRequest” as true.
- In the “OTPSigninData” property, pass the “Code” and “FieldContent” together with the “Otp” (received on the user’s phone) from the response of the Get Sign In OTP API.
API Headers
Pass the following mandatory headers:
- The public authentication key you receive from the Get Public Auth Key API response.
- For example, Authorization = <Your Auth Key>
- The registration token you received Get Portal Registration Token API response.
- For example, x-lsq-registertoken = <registration token>
- The portal Id. This specifies which portal to register the user on.
- For example, x-lsq-portalid = <portal id>
The response will return the “LeadId” and an “AuthKey”. The “AuthKey” is a Private Authentication Key used to authenticate the session after a user has signed in to the portal. It is valid for 4 hours.
Note: You must use the correct API host to make successful calls.
API URL
URL
POST
https://{host}/api/Authentication/v2/Signin?
Request
Content-Type: application/jsonJSON Body/Payload
{
"OTPSigninRequest": true,
"OTPSigninData": {
"Otp": "430897",
"FieldContent": "+14-157415569",
"Code": "cDlEd0k4dy9qTTZHYThMNFg4ZEt3MmV0TFowRWFXN1E3K29sdENMTU5CbEdPNDNFNi9tUFVDOXMrc2JyVHQwdWxJakdhblJtMnQ4YkY0d0Jwd0l2emFGNU1PcndmUGtLSStzMVdZZ0hydnZjc3NaVFZsK21oYWJ0YytPSWx0dmhtQ0p3cm1Sc2ltTjJ2T05xWmpjNTBkNjVTRDZ4ZzVtMlNlOXJtNFBnMjN6cFA0Z3NQQ2QyZ0ExcFR2cE90emF6dXZrR25zQWxJZXlzNXh5Q3JZTjlKRTdxYlo0RmFxbG9ZUE5yREI1UFdoc3U1SFc5TldIOVRkSnNhSWpTU3AzQnZ4bmhMNjhtSHlpaWlmT1FvWGNQQ1E9PQ=="
}
}
Request Parameters
| Parameter | Description |
|---|---|
| OTPSigninRequest | This must be passed as true to sign the user in using OTP data. |
| OTPSigninData | Pass the “Code” and “FieldContent” together with the “Otp” (received on the user’s phone) from the response of the Get Sign In OTP API.
|
