Get Process

avertissement

Avant de récupérer le processus, consultez notre configuration webhook et nos stratégies de repli — cliquez ici.

Dans le contrat API, la réponse POST /processes/v1 est déjà le résultat final. Ce point de terminaison existe pour les nouvelles requêtes — par exemple, lorsque vous devez inspecter un processus que vous avez persisté précédemment, ou auditer une transaction antérieure. Dans le contrat API, la réponse de POST /processes/v1 est déjà le résultat final. Ce endpoint existe pour les re-requêtes, par exemple lorsque vous devez inspecter un processus que vous avez enregistré auparavant, ou auditer une transaction précédente.

Endpoint

Environnement	URL
Production	GET https://api.id.unico.app/processes/v1/{processId}
Sandbox	GET https://api.id.uat.unico.app/processes/v1/{processId}

Requête

En-têtes

En-tête	Valeur
Authorization	Bearer <access_token>
APIKEY	Clé API provisionnée.

Paramètres de chemin

Paramètre	Type	Requis	Description
processId	string (UUID)	oui	Identifiant du processus retourné par Créer un processus.

Exemple

cURL

curl -X GET https://api.id.unico.app/processes/v1/$PROCESS_ID \
  -H "Authorization: Bearer $TOKEN" \
  -H "APIKEY: $API_KEY"

Node.js

import fetch from 'node-fetch';

const res = await fetch(
  `https://api.id.unico.app/processes/v1/${processId}`,
  {
    headers: {
      Authorization: `Bearer ${accessToken}`,
      APIKEY: apiKey
    }
  }
);
const result = await res.json();

Réponses

200 OK

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": {
    "result": "yes"
  },
  "riskLevel": {
    "result": "inconclusive"
  },
  "idFace": {
    "personId": "a1b2c3d4e5f67890a1b2c3d4e5f67890a1b2c3d4e5f67890a1b2c3d4e5f67890",
    "result": "FOUND"
  },
  "identityFraudsters": {
    "result": "inconclusive"
  },
  "government": {
    "serpro": 87
  },
  "liveness": 1
}

Les champs de réponse dépendent de votre APIKey

L'exemple ci-dessus présente tous les champs de capacité possibles. Votre réponse réelle n'inclura que les champs correspondant aux capacités activées dans votre configuration APIKey — les champs des capacités désactivées sont entièrement omis. Contactez votre chef de projet Unico pour activer ou ajuster des capacités.

Champ	Type	Description
id	string (UUID)	Identifiant du processus.
status	integer	1 (en traitement), 2 (divergence), 3 (terminé avec succès), 4 (annulé), 5 (erreur).
unicoId.result	string	yes, no, inconclusive -- voir Vérification d'identité.
riskLevel.result	string	not_approved, critical_risk, high_risk, inconclusive -- voir Classification du risque de fraude.
idFace.result	string	FOUND, NOT_FOUND -- voir Face Identifier.
idFace.personId	string	Identifiant opaque stable pour le visage. Présent uniquement lorsque idFace.result = FOUND.
identityFraudsters.result	string	Obsolète. Utilisez riskLevel à la place. Les clients dont les intégrations sont en cours peuvent continuer à l'utiliser pendant qu'ils coordonnent la migration avec l'équipe responsable du projet.
government.serpro	integer	Score de similarité Serpro (0-100, -1, -2). Disponible au Brésil uniquement. Voir Retour de similarité Serpro.
liveness	integer	1 (réussi), 2 (échoué) -- voir Détection de Vie.
score	integer	Score de risque probabiliste. Présent lorsque unicoId.result = inconclusive et que l'orchestration du score de risque est active. Les valeurs positives indiquent une probabilité plus élevée d'être le titulaire ; les valeurs négatives indiquent un risque plus élevé. Disponible au Brésil uniquement.

400 Bad Request

Le paramètre de chemin processId est manquant ou malformé. Voir les Codes d'erreur ci-dessous.

403 Forbidden

Le Bearer token ou l'APIKEY est manquant, expiré ou invalide.

404 Not Found

Le processId n'existe pas ou n'appartient pas au tenant authentifié.

410 Gone

Le processus existe mais a résulté en une erreur. Retourne uniquement id et status: 5.

429 Too Many Requests

Limite de débit atteinte. Lorsque votre système reçoit une erreur HTTP 429, vous devez implémenter des mécanismes pour prévenir les défaillances en cascade et éviter d'aggraver la restriction.

Bonnes pratiques :

• Période de refroidissement (backoff) : Arrêtez ou limitez immédiatement les requêtes suivantes de votre système. Ne réessayez pas continuellement les requêtes échouées en boucle serrée.
• Mise en file d'attente et limitation : Mettez en tampon ou en file d'attente les requêtes sortantes de votre côté pour contrôler le flux de trafic avant de les renvoyer.
• Backoff exponentiel avec jitter : Lors des nouvelles tentatives, augmentez le temps d'attente de manière exponentielle entre les tentatives (ex. : 1 s, 2 s, 4 s, 8 s) et ajoutez un petit délai aléatoire (« jitter ») pour éviter un effet de troupeau où toutes les requêtes en file d'attente réessaient exactement à la même milliseconde.

avertissement

Frapper continuellement un endpoint limité en débit sans faire de backoff peut prolonger la période de restriction et impacter sévèrement le débit opérationnel de votre système. Limiter correctement les requêtes de votre côté assure une intégration plus fluide et plus résiliente.

Pour les limites par défaut, l'augmentation des requêtes et des détails supplémentaires, voir Limites de débit.

500 Internal Server Error

Erreur serveur inattendue.

Quand utiliser ce endpoint

Le contrat API retourne les résultats de manière synchrone, donc la plupart des intégrations n'ont pas besoin de ce endpoint. Utilisez-le lorsque :

• Vous avez enregistré uniquement le processId et devez récupérer le résultat complet plus tard (audit, support).
• Vous suspectez que la réponse originale a été perdue en transit (erreur réseau après que la plateforme ait terminé le travail).
• Vous construisez un outil de back-office qui examine les processus historiques.

Codes d'erreur

400 Bad Request

Code	Message	Description
20023	O parâmetro processId não foi informado.	Le paramètre d'identifiant de processus est manquant.
20002	O parâmetro APIKey não foi informado.	Le paramètre APIKEY est manquant dans l'en-tête de la requête.
20001	O parâmetro authtoken não foi informado.	Le paramètre de jeton d'intégration est manquant dans l'en-tête de la requête.

404 Not Found

Code	Message	Description
50001	O processo informado não foi encontrado.	Le processus n'existe pas dans la base de données.

403 Forbidden

Code	Message	Description
30017	User does not have permission to perform this action.	JWT malformé ou utilisateur sans permission pour effectuer cette opération.
10502	O token informado está expirado.	Lorsque le jeton d'accès utilisé a expiré.
10501	O token informado é inválido.	Le jeton d'authentification est invalide.
10201	O AppKey informado é inválido.	Le paramètre APIKEY n'a pas été saisi ou n'existe pas.

410 Gone

Le processus existe mais a résulté en une erreur. Retourne uniquement id et status: 5.

500 Internal Server Error

Code	Message	Description
99999	Internal failure! Try again later	Lorsqu'il y a une erreur interne.