Aller au contenu principal
Vue d'ensemble de la API Reference

Tout ce dont vous avez besoin pour passer de zéro à votre premier humanToken.

Markdown

Human Token dispose de trois endpoints. Cette page montre comment ils s'articulent pour que vous puissiez commencer l'intégration immédiatement.

URL de base​

EnvironnementURL de base
Productionhttps://humantoken.unico.app

Toutes les requêtes nécessitent l'en-tête x-unico-accesskey. Consultez Authentification pour générer votre clé.


Flux de démarrage rapide​


Étape 1 — Authentification​

Générez votre x-unico-accesskey dans le Human Dashboard ou via l'Authentication API. Chaque requête ci-dessous utilise cette clé.

x-unico-accesskey: uip_ak.prod.a1b2c3d4.e5f6g7h8.i9j0k1l2

Étape 2 — Créer un processus​

Appelez Create Process pour démarrer la vérification. Choisissez l'un des deux modèles :

ModèleFlowsFonctionnement
API Onlyapi+humantoken, api+liveness+humantoken, api+liveness+humantoken+revalidationVotre backend envoie le selfie en tant que imageBase64. Le humanToken est retourné dans la même réponse.
Human Token Journeyhumantoken, humantoken+revalidationL'utilisateur effectue la capture sur la plateforme Unico. Vous obtenez un token et un link pour présenter le journey, puis récupérez le résultat avec Get Process.

Exemple API Only :

curl -X POST https://humantoken.unico.app/client/v1/process \
-H "x-unico-accesskey: $UNICO_ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{
"flow": "api+humantoken",
"imageBase64": "<base64-encoded-selfie>",
"companyBranchId": "<your-branch-id>"
}'

Exemple Human Token Journey :

curl -X POST https://humantoken.unico.app/client/v1/process \
-H "x-unico-accesskey: $UNICO_ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{
"flow": "humantoken",
"callbackUri": "https://yourapp.com/callback",
"companyBranchId": "<your-branch-id>"
}'

Consultez Create Process pour tous les flows, paramètres et détails de réponse.


Étape 3 — Présenter le journey à l'utilisateur (flows Journey uniquement)​

Pour les flows humantoken et humantoken+revalidation, la réponse de Create Process inclut :

  • token — initialise le Web SDK ou l'intégration native
  • link — URL vers laquelle rediriger l'utilisateur

Choisissez l'intégration adaptée à votre plateforme :

PlateformeApproche
Web — SDKIntégrez le journey en ligne avec idpay-b2b-sdk → Web Integration
Web — RedirectRedirigez l'utilisateur vers link → Web Integration
AndroidCustom Tabs → Android
iOSASWebAuthenticationSession → iOS
IonicCapacitor plugin → Ionic
React NativeNative module → React Native
FlutterPlatform Channels → Flutter

Lorsque le journey se termine, l'utilisateur revient à votre callbackUri. Passez à l'étape 4.

Flows API Only

Ignorez cette étape — le résultat se trouve déjà dans la réponse de Create Process.


Étape 4 — Récupérer le résultat (flows Journey uniquement)​

Appelez Get Process avec l'id du processus pour récupérer le résultat :

curl https://humantoken.unico.app/client/v1/process/$PROCESS_ID \
-H "x-unico-accesskey: $UNICO_ACCESS_KEY"

La réponse inclut data.humanToken.value (flows standard) ou data.humanTokenMatch (flows de revalidation). Consultez Get Process pour le schéma de réponse complet et les valeurs d'état.


Étape 5 — Utiliser le humanToken​

Le humanToken est un identifiant stable et opaque (jusqu'à 100 caractères). La même personne est toujours résolue vers la même valeur.

const { humanToken } = process.data;

if (!humanToken?.value) {
// Inconclusive — retry or reject per your business rules
return;
}

const existing = await db.persons.findByHumanToken(humanToken.value);

if (existing) {
// Same person seen before — returning user or duplicate
} else {
// First time — create a new record
await db.persons.create({ humanToken: humanToken.value });
}
avertissement

Vérifiez toujours que data.humanToken.value n'est pas vide avant de le stocker ou de le comparer.


Étape 6 — Récupérer le selfie (optionnel)​

Appelez Get Selfie pour télécharger l'image capturée. Le selfie est disponible pendant 24 heures après la fin du processus — après quoi il est définitivement supprimé.

curl https://humantoken.unico.app/client/v1/process/$PROCESS_ID/selfie \
-H "x-unico-accesskey: $UNICO_ACCESS_KEY"

Consultez Get Selfie pour les détails de réponse et les codes d'erreur.


Endpoints en un coup d'œil​

MéthodeEndpointDescription
POST/client/v1/processCreate Process — démarrer une vérification
GET/client/v1/process/{processId}Get Process — récupérer le résultat
GET/client/v1/process/{processId}/selfieGet Selfie — télécharger le selfie (24 h)

Prochaines étapes​

  • Create Process — référence complète des paramètres pour les cinq flows
  • Authentication — générer et gérer vos clés d'accès
  • Build With LLM — collez un prompt dans votre assistant IA pour générer l'intégration complète