Skip to content

List multiple Authentications

get
https://api.reach.talkylabs.com/rest/authentix/v1/configurations/{configurationId}/authentications

This operation allows to retrieve all authentications generated from a given configuration that are not expired and for which the number of maximum trials/controls is not exceeded.

When getting the authentication list, results will be sorted based on the dateCreated field with the most recent record appearing first.

Parameters

  • configurationIdstringrequiredpath

    The identifier of the configuration being used.

  • pageSizeintegeroptional

    Maximum number of records to return per call. The default value is 20.

  • pageintegeroptional

    This is the page of record to be returned. This is to avoid returning duplicate data. The default value is 0.

Example 1: Retrieve pending authentications

The example below demonstrates how to retrieve from the Reach platform previously initiated authentications that are still pending.

curl -X GET https://api.reach.talkylabs.com/rest/authentix/v1/configurations/CIDXXXXXXXXXXXX/authentications?pageSize=20 -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"
Output example
{
  "page": 0,
  "pageSize": 1,
  "totalAuthentications": 1,
  "totalPages": 1,
  "outOfPageRange": false,
  "authentications": [
    {
      "appletId": "AIDXXXXXXXXXXXX",
      "apiVersion": "1.0.0",
      "configurationId": "CIDXXXXXXXXXXXX",
      "authenticationId": "VIDXXXXXXXXXXXX",
      "status": "awaiting",
      "dest": "+237671234567",
      "channel": "sms",
      "expiryTime": 5,
      "maxTrials": 5,
      "maxControls": 3,
      "paymentInfo": {
        "payee": "ACME",
        "amount": 1000,
        "currency": "xaf"
      },
      "trials": [
        {
          "dateCreated": "2016-08-29T09:12:33.001Z",
          "trialId": "TRDXXXXXXXXXX",
          "channel": "sms"
        }
      ],
      "dateCreated": "2016-08-29T09:12:33.001Z",
      "dateUpdated": "2016-08-29T09:12:35.001Z"
    }
  ]
}