API SMS Phone Confirmation — Vérifier un code OTP

Support DQE
Support DQE
  • Mise à jour

L'endpoint GDPR_VERIF vérifie le code PIN saisi par l'utilisateur par rapport au token retourné par une requête GDPR_MSG préalable.

Documentation SMS Phone Confirmation associée :

Requête GET

Endpoint

https://{SERVER_ADDRESS}/GDPR_VERIF/?Phone={PHONE}&Token={SMS_TOKEN}&Pin={CODE_PIN}

Remplacez les valeurs entre accolades par vos propres informations :

Paramètre Valeur Description Obligatoire/Optionnel
SERVER_ADDRESS {SERVER_ADDRESS} Adresse du serveur DQE qui traitera les données. Obligatoire
Phone {PHONE} Numéro de téléphone au format international. Obligatoire
Token {SMS_TOKEN} Identifiant retourné par la requête GDPR_MSG (champ smsToken). Obligatoire
Pin {CODE_PIN} Code de vérification à 6 chiffres reçu par l'utilisateur par SMS. Obligatoire

Requête POST

Endpoint

https://{SERVER_ADDRESS}/GDPR_VERIF/

Ajoutez les paramètres suivants dans le corps de la requête en utilisant x-www-form-urlencoded.

Paramètre Valeur Description Obligatoire/Optionnel
Phone {PHONE} Numéro de téléphone au format international. Obligatoire
Token {SMS_TOKEN} Identifiant retourné par la requête GDPR_MSG (champ smsToken). Obligatoire
Pin {CODE_PIN} Code de vérification à 6 chiffres reçu par l'utilisateur par SMS. Obligatoire

Réponse

Réponse de succès

Clé Description Format
status OK si le PIN est valide, KO sinon. STRING
phone Numéro de téléphone au format international. STRING
dateTime Date et heure de la vérification. STRING
channels Canaux de communication sélectionnés. JSON OBJECT
errors Détails de l'erreur. JSON OBJECT

Codes d'erreur :

Code Description
00 Aucune erreur.
01 Paramètres manquants.
02 Le PIN doit contenir 6 chiffres.
03 PIN expiré.
04 PIN invalide pour ce token ou ce numéro de téléphone.
05 Token invalide.

Exemple :

{
  "status": "OK",
  "phone": "33631525429",
  "errors": {
    "00": "00 - No errors"
  },
  "channels": {
    "phone": 0,
    "post": 0,
    "sms": 1,
    "email": 1
  },
  "dateTime": "2019-07-29 11:34:48.998397"
}

Voir aussi

Associé à

Cet article vous a-t-il été utile ?

Utilisateurs qui ont trouvé cela utile : 0 sur 0