Skip to content

Fetch an Authentication

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

This operation allows to fetch the API record associated to an authentication.

Parameters

  • configurationIdstringrequiredpath

    The identifier of the configuration being used.

  • authenticationIdstringrequiredpath

    The identifier of the authentication to be fetched.

Example 1: Fetch a Authentication

The example below demonstrates how to fetch a given authentication using the authenticationId from the Reach platform using the Reach Authentix API.

curl -X GET https://api.reach.talkylabs.com/rest/authentix/v1/configurations/CIDXXXXXXXXXXXX/authentications/VIDXXXXXXXXXXXX -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"
Output example
{
  "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"
}