Verify Secure Pin 2FA request

After requesting a Secure Pin authentication, you can verify entered PIN codes from your users for successful authentication.

PUT https://api.clickatell.com/rest/auth/[ApiRequestID]

HTTP PUT

Description

Check if the passed PIN code matches the specified API request ID.

API endpoint

https://api.clickatell.com/rest/auth/[ApiRequestID]

Supported parameters

  • pinCode                             [ Required – The actual PIN code ]
  • The API request ID is specified as part of the URL

Returns

  • challengeStatus: contains status code (see the section called ‘Secure REST API response status codes’)
  • challengeSolved: true/false (0 or 1 for XML)
  • description: description of the status code

Notes

  • Users only have a limited number of attempts before the maximum attempts are reached (default number of attempts is three, but this can be overridden using the maximumRetries parameter).
  • Users have limited time to complete the challenge before it expires (default is 10 minutes, but this can be overridden using the overrideExpireTime parameter).

JSON

Request

PUT /rest/auth/[ApiRequestID] HTTP/1.1
HOST: api.clickatell.com
X-Version: 1
Content-Type: application/JSON
Authorization: Bearer [Your Authorization Token]
Accept: application/JSON
{"pinCode":"9999"}

Response

HTTP/1.1 200 OK
Content-Type: application/JSON

{
   "data":{
            "challengeStatus":"020"
            "challengeSolved": true
            "description":"The challenge has been solved"
   }
}