Références API

/phone/auth

POST

Crée une demande d’identification pendant un appel téléphonique.

Lance une identification de l’utilisateur pendant un appel avec votre organisation (centre d’appels, conseiller). La personne reçoit la demande dans son application, sans code QR ni démarrage automatique. Utilisez /collect pour connaître l’état.

Corps de la requête

application/json
personalNumber chaîne Obligatoire

Le numéro d’identité de la personne à identifier (6 à 20 lettres ou chiffres).

callInitiator chaîne Obligatoire

Qui a lancé l’appel. user : la personne vous a appelé. RP : c’est vous qui l’avez appelée.

Pour un appel entrant (user), l’application demande à la personne de confirmer qu’elle est bien en communication avec votre organisation (userCallConfirm) : cela protège contre l’usurpation d’un appel. Pour un appel sortant (RP), l’application affiche directement la demande.

userVisibleData chaîne

Texte affiché à l’utilisateur, en Base64. 1 500 caractères au plus. Pour un appel, il doit rappeler le contexte : « Vous êtes en appel avec le service client de… ».

userVisibleDataFormat, userNonVisibleData, requirement

Identiques à ceux de /auth. requirement.personalNumber n’est pas utilisé ici : le numéro est le paramètre personalNumber.

Exemple

{
  "personalNumber": "B1234567",
  "callInitiator": "RP",
  "userVisibleData": "Vm91cyDDqnRlcyBlbiBhcHBlbCBhdmVjIGxlIHNlcnZpY2UgY2xpZW50IGRlIE1vbiBTZXJ2aWNl"
}

Réponses

200 · Requête réussie

orderRef chaîne Obligatoire

Référence de la demande, pour /collect et /cancel. Il n’y a ni autoStartToken ni données de code QR : la demande part directement vers l’application de la personne.

{ "orderRef": "131daac9-16c6-4618-beb0-365768f37288" }

Pour un appel entrant, un hintCode userCallConfirm apparaît pendant la demande ; si la personne répond qu’elle n’est pas en appel avec vous, la demande échoue avec userDeclinedCall.