Skip to main content

​
Référence

reference est votre propre identifiant stable du client, de 1 à 64 caractères parmi A-Z a-z 0-9 _ . : -. Avec une référence, l’appel crée un dossier que vos équipes peuvent consulter. Sans référence, rien n’est enregistré dans votre espace de travail et aucun webhook n’est envoyé. Choisissez une référence qui ne change pas et qui n’est pas une donnée personnelle. Un identifiant de base de données (client-0001, acct:8812) convient. Une adresse e-mail ne convient pas (le @ n’est pas autorisé, et elle placerait des données personnelles dans vos journaux et dans les webhooks).

​
Dossier

Un dossier est unique par espace de travail, environnement et référence. Le premier appel avec une référence le crée. Les appels suivants le mettent à jour :
  • /extract ajoute un document, ses champs lus et ses contrôles.
  • /verify et /assess enregistrent le verdict, et l’évaluation pour /assess. Les documents dont vous renvoyez le document_id sont rattachés au dossier.
  • /eid enregistre la demande eID comme en attente, et une interrogation enregistre le résultat.
Un nom envoyé dans subject remplace le nom enregistré. Un appel sans nom conserve celui qui est enregistré. Si aucun subject n’est envoyé, le nom est construit à partir des champs lus. Un statut défini par une personne dans la console (approved, refused) n’est jamais modifié par un nouveau verdict.

​
Environnement

environment vaut sandbox (par défaut) ou production. La même référence dans les deux environnements donne deux dossiers. Voir Sandbox et production pour ce que ce champ change d’autre.

​
Document et champs

Un document est lu en champs à partir d’un vocabulaire fixe de clés (noms, dates, adresse, coordonnées bancaires, numéros d’entité et plus). Chaque valeur est une chaîne. Le lecteur omet ce qu’il ne peut pas lire. Voir Types de documents et champs.

​
Verdict et gravité

Chaque contrôle a une gravité. critical bloque, warning signale pour une personne, info sert de trace. passed vaut true lorsqu’aucun contrôle critique n’a échoué. Voir Vérifier un profil.

​
Politique

Chaque appel s’exécute selon la politique de votre espace de travail pour le type de client (kyc ou kyb) et l’environnement. Une option de requête peut ajouter des contrôles, mais ne peut pas désactiver un contrôle verrouillé par la politique. Une option refusée est listée dans policy.overrides_refused et n’est pas une erreur. La politique fixe les seuils (en jours), les verrous, les documents requis et la sévérité des tranches de risque. Elle se modifie dans Settings, KYC policy dans la console.

​
Types de client

​
Ce que l’API ne fait pas

  • Elle ne décide pas. Elle renvoie des contrôles et un verdict. Votre politique décide de la suite.
  • Elle ne renvoie pas de niveau de confiance par champ.
  • Elle n’a pas d’endpoint de connexion bancaire ni de score sur 1000 points. Ce sont des produits de la console.
  • Elle n’a pas d’endpoint par lots ni de clé d’idempotence.