Request image categories for GridPlus

This command allows you to request a list of Secure GridPlus image categories.

The server will respond with an array. These categories are used to set up client GridPlus passwords.

GET https://api.clickatell.com/rest/categories

Note that the REST API may respond with various HTTP status codes.

HTTP GET

Description

It fetches the list of Secure GridPlus image categories and returns an array in the API call response. These categories are used in conjunction with requesting a Secure GridPlus challenge by specifying the challenge solution as the GridPlus challenge password.

API Endpoint

https://api.clickatell.com/rest/auth/categories

Supported parameters

  • None

Returns

  • Array of Secure GridPlus image categories with sample image URL

Notes

  • Use the image categories exactly as provided in the Secure GridPlus request.

JSON

Request

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

Response

HTTP/1.1 202 Accepted
Content-Type: application/json
{
  "data": [
    {
      "category": [
        {
          "name": "dog",
          "sampleImage": "https://secure.clickatell.com/mfa/api/image/1"
        },
        {
          "name": "house",
          "sampleImage": "https://secure.clickatell.com/mfa/api/image/2"
        },
        {
          "name": "tree",
          "sampleImage": "https://secure.clickatell.com/mfa/api/image/3"
        }
      ]
    }
  ]
}