Skip to content

List multiple Authentication Trials

get
https://api.reach.talkylabs.com/rest/authentix/v1/authenticationTrials

This operation allows to retrieve from the Reach platform authentication trial records that satisfied specified criteria.

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

Parameters

  • deststringoptional

    Retrieve authentication trials sent only to this phone number or email. The phone number must be in the E.164 format.

  • trialStatusstringoptional

    Retrieve authentication trials with the specified status. One of successful, or unsuccessful.

  • channelstringoptional

    Retrieve authentication trials sent via the specified channel. One of sms, or email.

  • configurationIdstringoptional

    Retrieve authentication trials from the configuration whose ID matches the specified one.

  • authenticationIdstringoptional

    Retrieve authentication trials from the authentication whose ID matches the specified one.

  • countrystringoptional

    Retrieve authentication trials sent to the specified destination country (in ISO 3166-1 alpha-2 format). Only possible when dest is a phone number.

  • sentAtdate-timeoptional

    Retrieve only authentication trials generated at the specified date. Must be in ISO 8601 format.

  • sentAfterdate-timeoptional

    Retrieve only authentication trials generated after the specified datetime. Must be in ISO 8601 format.

  • sentBeforedate-timeoptional

    Retrieve only authentication trials generated before the specified datetime. Must be in ISO 8601 format.

  • 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 all Authentication Trials

curl -X GET https://api.reach.talkylabs.com/rest/authentix/v1/authenticationTrials?pageSize=20 -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"
Output example
{
  "page": 0,
  "pageSize": 1,
  "totalAuthenticationTrials": 1,
  "totalPages": 1,
  "outOfPageRange": false,
  "authenticationTrials": [
    {
      "appletId": "AIDXXXXXXXXXXXX",
      "apiVersion": "1.0.0",
      "configurationId": "CIDXXXXXXXXXXXX",
      "authenticationId": "VIDXXXXXXXXXXXX",
      "trialId": "TRDXXXXXXXXXX",
      "trialStatus": "successful",
      "channel": "sms",
      "paymentInfo": {
        "payee": "ACME",
        "amount": 1000,
        "currency": "xaf"
      },
      "dateCreated": "2016-08-29T09:12:33.001Z",
      "dateUpdated": "2016-08-29T09:12:35.001Z",
      "price": 25.0,
      "priceUnit": "xaf",
      "channelInfo": {}
    }
  ]
}

Example 2: Retrieve Successful Authentication Trials Sent to Cameroon

curl -X GET https://api.reach.talkylabs.com/rest/authentix/v1/authenticationTrials?country=CM&trialStatus=successful&pageSize=20 -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"
Output example
{
  "page": 0,
  "pageSize": 1,
  "totalAuthenticationTrials": 1,
  "totalPages": 1,
  "outOfPageRange": false,
  "authenticationTrials": [
    {
      "appletId": "AIDXXXXXXXXXXXX",
      "apiVersion": "1.0.0",
      "configurationId": "CIDXXXXXXXXXXXX",
      "authenticationId": "VIDXXXXXXXXXXXX",
      "trialId": "TRDXXXXXXXXXX",
      "trialStatus": "successful",
      "channel": "sms",
      "paymentInfo": {
        "payee": "ACME",
        "amount": 1000,
        "currency": "xaf"
      },
      "dateCreated": "2016-08-29T09:12:33.001Z",
      "dateUpdated": "2016-08-29T09:12:35.001Z",
      "price": 25.0,
      "priceUnit": "xaf",
      "channelInfo": {}
    }
  ]
}