Passer au contenu principal
POST
curl

Nommer votre marque dans le SMS

Les codes SMS portent le nom d’expéditeur des SMS de votre application, défini dans la Business Console, sans frais supplémentaires :
123456 est votre code de vérification pour Acme Bank
Pour envoyer un code avec un autre nom, transmettez options.sms_sender_name (de 1 à 30 caractères : lettres, chiffres, espaces et ’ & - ! uniquement, et non uniquement des chiffres) :
Un nom ne respectant pas ces règles renvoie 400 et aucun code n’est envoyé. Les codes WhatsApp utilisent un message fixe et ne sont pas personnalisés ; connectez votre propre numéro WhatsApp Business dans la Business Console pour les envoyer sous le nom de votre entreprise. Voir Envoyer des codes WhatsApp depuis votre propre numéro. Consultez Messages de vérification personnalisés pour savoir quel nom figure sur un code et connaître la limite quotidienne de nouveaux noms.

Gérer les pannes du fournisseur

Si le fournisseur de téléphonie est temporairement indisponible, cet endpoint renvoie 502 avec un code stable lisible par machine :
Considérez cette réponse comme indiquant qu’une nouvelle tentative est possible. Appliquez un court délai avant de réessayer, et affichez à l’utilisateur un message indiquant un service temporairement indisponible, au lieu de lui demander de modifier un numéro de téléphone ou un code valides.

Autorisations

x-api-key
string
header
requis

La clé API de votre application, issue de Développeurs -> Clés API dans la Business Console. La clé principale dispose d'un accès complet. Une clé nommée peut être restreinte : aucun, lecture ou écriture par ressource, limitée à certains workflows ou aux sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou action, ou que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur une route de session signifie que la session est hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL d'images, de vidéos et de PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys.

Corps

application/json
phone_number
string
requis

Numéro de téléphone du destinataire au format E.164 — avec un + initial et l'indicatif du pays (par ex., +14155552671). Les numéros sont validés et normalisés au format E.164 ; les numéros invalides ou impossibles à analyser renvoient une erreur 400 avec une erreur sur le champ phone_number.

Maximum string length: 20
Exemple:

"+14155552671"

options
object

Options de livraison de l'OTP. Tous les champs sont facultatifs.

signals
object

Signaux d'appareil et de réseau optionnels concernant l'utilisateur final, transmis à la couche antifraude pour améliorer la détection de trafic abusif ou automatisé. Tous les champs sont optionnels.

vendor_data
string

Identifiant optionnel contrôlé par l'appelant (votre identifiant utilisateur interne, un e-mail, un UUID, etc.) persisté sur la session et renvoyé dans la réponse d'envoi, la réponse de vérification de correspondance, les webhooks et la Business Console. Utilisez-le pour corréler le request_id de Didit avec votre dossier utilisateur.

metadata
object | null

Objet JSON libre optionnel conservé sur la session et renvoyé dans la réponse d'envoi, la réponse de vérification de correspondance, les webhooks et la Business Console.

Réponse

Envoi pris en compte. Examinez status : Success et Retry indiquent qu'un code est en cours d'envoi ; Blocked signifie que la couche antifraude a refusé et que la vérification est déjà finalisée en tant que Declined. request_id est l'identifiant de session persistant (même identifiant lors d'un Retry).

request_id
string<uuid>

ID de session de la vérification. Un envoi Retry renvoie le même request_id que l'envoi initial. Cet identifiant apparaît dans la Business Console, est renvoyé à nouveau par un POST /v3/phone/check/ finalisé, et peut être transmis à GET /v3/session/{sessionId}/decision/.

status
enum<string>

Success — OTP envoyé pour une nouvelle vérification. Retry — OTP renvoyé pour la vérification en attente créée par un envoi précédent. Blocked — la couche antifraude a refusé l'envoi ; la vérification est immédiatement finalisée comme Declined et rien n'est facturé.

Options disponibles:
Success,
Retry,
Blocked
reason
string | null

Raison pour laquelle un envoi a été Blocked (par exemple repeated_attempts, suspicious, spam). null pour Success et Retry.

vendor_data
string | null

Écho des vendor_data stockées sur la session (depuis le premier envoi).

metadata
object | null

Écho des metadata stockées sur la session (depuis le premier envoi).

Dernière modification le 7 novembre 2026