Verify Secure Grid 2FA request

After requesting a Secure Grid 2FA, you can verify that the challenge has been successfully solved by your users.

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

HTTP GET

Description

This is used to query/poll the Secure platform to find out if an MFA challenge has been solved. 

API endpoint

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

Supported parameters

  • None – only the API request ID in the URL is used.
  • It is recommended to verify the Grid challenge every 5 seconds until the MFA is resolved, failed or timed-out.

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

JSON

Request

GET /rest/auth/[ApiRequestID] HTTP/1.1
HOST: api.clickatell.com
X-Version: 1
Authorization: Bearer [Your Authorization Token]
Accept: application/JSON

Response

HTTP/1.1 200 OK
Content-Type: application/JSON
{
   "data":{
            "challengeStatus":"020"
            "challengeSolved": true
            "description":"Challenge solved"
   }
}