Sign In with OTP

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.

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 pass the public authentication key you receive from the Get Public Auth Key API response. It must be passed in the API header as Authorization = <Your Auth Key>

 

API URL

POST
https://{host}/api/Authentication/Signin?
Copy URL

Request

JSON Body/Payload

Content-Type: application/json

{
    "OTPSigninRequest": true,
    "OTPSigninData": {
        "Otp": "430897",
        "FieldContent": "+14-157415569",
        "Code": "cDlEd0k4dy9qTTZHYThMNFg4ZEt3MmV0TFowRWFXN1E3K29sdENMTU5CbEdPNDNFNi9tUFVDOXMrc2JyVHQwdWxJakdhblJtMnQ4YkY0d0Jwd0l2emFGNU1PcndmUGtLSStzMVdZZ0hydnZjc3NaVFZsK21oYWJ0YytPSWx0dmhtQ0p3cm1Sc2ltTjJ2T05xWmpjNTBkNjVTRDZ4ZzVtMlNlOXJtNFBnMjN6cFA0Z3NQQ2QyZ0ExcFR2cE90emF6dXZrR25zQWxJZXlzNXh5Q3JZTjlKRTdxYlo0RmFxbG9ZUE5yREI1UFdoc3U1SFc5TldIOVRkSnNhSWpTU3AzQnZ4bmhMNjhtSHlpaWlmT1FvWGNQQ1E9PQ=="
    }
}

JSON Properties

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.

 

Response

200 OK

Content-Type: application/json



			

HTTP Response Code

Code Description
200 OK

This is the status code for successful API call.

401 Unauthorized

The API call was made with invalid access credentials. Check your AccessKey and SecretKey.

400 Bad Request

The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure.

404 Not Found

The API could not be found. Please check the API signature.

429 Too Many Requests

API calls exceeded the limit of 25 in 5 second(s)

500 Internal Server Error

The API called failed. There could be many reasons for it. Check the exception message to get more details.