Skip to content

Update a Authentication

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

This operation allows to manually update the status of an authentication. This should only be used with custom code authentications.

Set the authentication status to "passed" after you validated the authentication code. Similarly, set the authentication status to "canceled" if you want to restart start a new authentication with a different code.

When not using custom codes, there is no need to used this method as the REACH Authentix API can manage the whole life cycle of an authentication.

Parameters

  • configurationIdstringrequiredpath

    The identifier of the configuration being used.

  • authenticationIdstringrequiredpath

    The identifier of the authentication to be updated.

  • statusstringrequired

    The new status of the authentication. One of passed, or canceled.

Example 1: Manually validate a Authentication

The example below demonstrates how to manually validate a authentication using the Reach Authentix API.

curl -X POST https://api.reach.talkylabs.com/rest/authentix/v1/configurations/CIDXXXXXXXXXXXX/authentications/VIDXXXXXXXXXXXX --data-urlencode "status=passed" -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"
}

Example 2: Manually cancel a Authentication

The example below demonstrates how to manually cancel a authentication using the Reach Authentix API.

curl -X POST https://api.reach.talkylabs.com/rest/authentix/v1/configurations/CIDXXXXXXXXXXXX/authentications/VIDXXXXXXXXXXXX --data-urlencode "status=canceled" -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"
}