Skip to content

Contrôler une authentification

post
https://api.reach.talkylabs.com/rest/authentix/v1/configurations/{configurationId}/authentication-controls

Cette opération permet de vérifier l'exactitude d'un code fourni par l'utilisateur final. Cette opération ne concerne que les authentifications dans l'état awaiting.

Dans le cas où une vérification est effectuée sur une authentification dont le statut est différent de awaiting, une réponse HTTP 404 est renvoyée.

Paramètres

  • configurationIdstringrequiredpath

    L'identifiant de la configuration utilisée.

  • deststringoptional

    Le numéro de téléphone ou l'adresse électronique à vérifier. Les numéros de téléphone doivent être au format E.164.

  • codestringoptional

    Le code de 4 à 10 caractères à vérifier. Ceci est obligatoire pour les canaux sms et email.

  • authenticationIdstringoptional

    L'identifiant de l'authentification en cours de validation. Ce paramètre ou le paramètre dest doit être spécifié.

  • paymentInfostringoptional

    Informations relatives au paiement numérique à authentifier. Elle est requise lorsque usedForDigitalPayment est vrai. Elle est ignorée dans le cas contraire. Il s'agit d'un objet JSON à plat où les clés sont payee, amount, et currency et les valeurs associées sont respectivement le bénéficiaire, le montant, et la devise d'une transaction financière. Par exemple "{'payee' : 'ACME', 'amount' : '1000', 'currency' : 'xaf'}".

Exemple 1: Vérifier l'exactitude d'un code en utilisant l'ID

L'exemple ci-dessous montre comment vérifier une authentification via son identifiant en utilisant l'API Reach Authentix.

curl -X POST https://api.reach.talkylabs.com/rest/authentix/v1/configurations/CIDXXXXXXXXXXXX/authentication-controls --data-urlencode "authenticationId=VIDXXXXXXXXXXXX" --data-urlencode "code=10234" -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": "passed",
  "dest": "+237671234567",
  "channel": "sms",
  "paymentInfo": {
    "payee": "ACME",
    "amount": 1000,
    "currency": "xaf"
  },
  "dateCreated": "2016-08-29T09:12:33.001Z",
  "dateUpdated": "2016-08-29T09:12:35.001Z"
}

Exemple 2: Vérifier l'exactitude d'un code en utilisant le numéro de téléphone

L'exemple ci-dessous montre comment vérifier une authentification via un numéro de téléphone en utilisant l'API Reach Authentix.

curl -X POST https://api.reach.talkylabs.com/rest/authentix/v1/configurations/CIDXXXXXXXXXXXX/authentication-controls --data-urlencode "dest=+237671234567" --data-urlencode "code=10234" -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": "passed",
  "dest": "+237671234567",
  "channel": "sms",
  "paymentInfo": {
    "payee": "ACME",
    "amount": 1000,
    "currency": "xaf"
  },
  "dateCreated": "2016-08-29T09:12:33.001Z",
  "dateUpdated": "2016-08-29T09:12:35.001Z"
}

Exemple 3: Vérifier l'exactitude d'un code en utilisant le courrier électronique

L'exemple ci-dessous montre comment vérifier une authentification via le courrier électronique en utilisant l'API Reach Authentix.

curl -X POST https://api.reach.talkylabs.com/rest/authentix/v1/configurations/CIDXXXXXXXXXXXX/authentication-controls --data-urlencode "dest=user@customsite.com" --data-urlencode "code=10234" -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": "passed",
  "dest": "+237671234567",
  "channel": "sms",
  "paymentInfo": {
    "payee": "ACME",
    "amount": 1000,
    "currency": "xaf"
  },
  "dateCreated": "2016-08-29T09:12:33.001Z",
  "dateUpdated": "2016-08-29T09:12:35.001Z"
}

Exemple 4: Vérifier l'exactitude d'un code lors d'une transaction de paiement numérique

L'exemple ci-dessous montre comment vérifier l'authentification d'une transaction de paiement numérique à l'aide de l'API Reach Authentix.

curl -X POST https://api.reach.talkylabs.com/rest/authentix/v1/configurations/CIDXXXXXXXXXXXX/authentication-controls --data-urlencode "dest=+237671234567" --data-urlencode "code=10234" --data-urlencode "paymentInfo={'payee': 'ACME', 'amount': '1000', 'currency': 'xaf'}" -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": "passed",
  "dest": "+237671234567",
  "channel": "sms",
  "paymentInfo": {
    "payee": "ACME",
    "amount": 1000,
    "currency": "xaf"
  },
  "dateCreated": "2016-08-29T09:12:33.001Z",
  "dateUpdated": "2016-08-29T09:12:35.001Z"
}