Get Sign In OTP

Returns a One-Time Password (OTP) that can be used to sign-in a user. The “Code” and “FieldContent” returned from the response (together with the OTP received on the user’s phone) must be passed in the Sign-In with OTP API.

  • In the “FieldSchemaName” parameter, you can pass the schema name of any unique lead field where you’re storing the phone number where the OTP must be sent.
  • The OTP will be sent to the phone number specified in the “FieldContent” parameter.

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/SigninOTP/Get?
Copy URL

Request

JSON Body/Payload

Content-Type: application/json

{
   "FieldSchemaName": "Phone",
   "FieldContent": "+14-157415569"
}

JSON Properties

Parameter Description
FieldSchemaName

Pass the schema name of any unique lead field where the phone numbers are being stored. For example, “Phone” or “mx_Agent_Number”.

FieldContent

Pass the value of the field specified in “FieldSchemaName”. This is the phone number you want to send the OTP to.

Response

200 OK

Content-Type: application/json

{
 "Code":"NnBCRlhGQUpXR3NldzVGck0ycXlYMnhQSG8zM2ZOWHNjUGFGS0xNNGdweGNRcUFhRXljTHJXVnhock5xQ3dzY3d6TkVwT1RDVDRyKy9nZllzL2NVT2tpSnc1OUdhM0R2YnpoU3JKbTJyY3BVNXNVa3owbVdrbEJEQ0RCNWw5NlVRN0I2bE1aYk96NXFSOTlIbGJ2eDllV09mMFI4d3o3R3cvdWo0YXZsZEJqdjVDTXdrSGJrbDFzdW5mS3BCZWtGdEhKbkFmbnVhZ2F4cWUwWFZsUVBaSkIwVjJqakNrb3dJRFdOdDRySVZwVnlaVDJFTkFKY3cyNTlvZ2RCSkNYL1gzZENSV1pUMGJRb1YybXg5NG9kWHc9PQ==",
   "FieldContent":"+14-157415569",
   "Message":null,
   "Status":"Success"
}

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.