Récupérer un processus
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.
Point de terminaison
| 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ête | Valeur |
|---|---|
Authorization | Bearer <access_token> |
APIKEY | Clé API provisionnée. |
| Paramètre | Type | Requis | Description |
|---|---|---|---|
processId | string (UUID) | oui | Identifiant du processus retourné par Créer un processus. |
Exemple
- cURL
- Node.js
curl -X GET https://api.id.unico.app/processes/v1/$PROCESS_ID \
-H "Authorization: Bearer $TOKEN" \
-H "APIKEY: $API_KEY"
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
{
"id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
"status": 3,
"unicoId": { "result": "yes" },
"identityFraudsters": { "result": "inconclusive" },
"government": { "serpro": 87 },
"liveness": 1
}
| 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é. |
identityFraudsters.result | string | yes, inconclusive — voir Alerte comportementale. |
government.serpro | integer | Score de similarité Serpro (0–100, -1, -2). Voir Similarité Serpro. |
liveness | integer | 1 (réussi), 2 (échoué) — voir Liveness. |
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é. |
Le paramètre de chemin processId est manquant ou mal formé. Voir Codes d'erreur ci-dessous.
Jeton Bearer ou APIKEY manquant, expiré ou invalide.
Le processId n'existe pas ou n'appartient pas au locataire authentifié.
Le processus existe mais a abouti à une erreur. Retourne uniquement id et status: 5.
Limite de débit atteinte. Voir Limites de débit.
Erreur serveur inattendue.
Quand utiliser ce point de terminaison
Le contrat API retourne les résultats de manière synchrone, donc la plupart des intégrations n'ont pas besoin de ce point de terminaison. Utilisez-le lorsque :
- Vous avez persisté uniquement le
processIdet devez récupérer le résultat complet ultérieurement (audit, support). - Vous suspectez que la réponse originale a été perdue en transit (erreur réseau après que la plateforme a terminé le traitement).
- Vous construisez un outil back-office qui examine les processus historiques.
Codes d'erreur
- 400 Bad Request
- 404 Not Found
- 403 Forbidden
- 410 Gone
- 500 Internal Server Error
| Code | Message | Description |
|---|---|---|
20023 | O parâmetro processId não foi informado. | Le paramètre process id est manquant. |
20002 | O parâmetro APIKey não foi informado. | Le paramètre APIKEY est absent de 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 absent de l'en-tête de la requête. |
| Code | Message | Description |
|---|---|---|
50001 | O processo informado não foi encontrado. | Le processus n'existe pas dans la base de données. |
| 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. |
Le processus existe mais a abouti à une erreur. Retourne uniquement id et status: 5.
| Code | Message | Description |
|---|---|---|
99999 | Internal failure! Try again later | Lorsqu'une erreur interne survient. |