Obtenir le processusGET

Récupérez un processus existant par son identifiant. Selon le contrat API, le résultat est déjà retourné de manière synchrone à la création du processus — utilisez ce endpoint pour les re-requêtes, l'audit et le support.

avertissement

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

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ê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

Le contrat est unique — le champ idCloud.result porte le verdict consolidé des capacités utilisées.

Unico consolide les résultats des capacités exécutées en un seul idCloud.result, prêt à décider de la prochaine étape de votre flux — sans besoin d'orchestrer les résultats individuels.

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "idCloud": {
    "result": "approved"
  }
}

Valeurs possibles du résultat

idCloud.result	Meaning	Recommended action
approved	Real person and validated identity.	Proceed with the flow.
denied	Identity not validated, liveness check failed, or extreme risk identified.	End the flow or redirect to an alternative flow.
critical-risk	Critical risk level identified.	End the flow or route to manual review.
high-risk	High risk level identified.	Route to manual review or an alternative flow.
retry	Insufficient capture or score to evaluate.	Ask the user for a new capture.
inconclusive	Not enough evidence for a verdict.	Route to manual review or an alternative flow.

Les valeurs retournées dépendent de la recette configurée dans votre APIKey. Consultez Flux pour connaître les valeurs de résultat que chaque recette peut retourner.

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 a 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.

429 Too Many Requests

Rate limit reached. When your system receives an HTTP 429 error, you must implement mechanisms to prevent cascading failures and avoid worsening the restriction.

Best practices:

• Cool-down period (backoff): Immediately halt or throttle subsequent requests from your system. Do not continuously retry failed requests in a tight loop.
• Queueing & throttling: Buffer or queue outgoing requests on your end to control the traffic flow before re-sending them.
• Exponential backoff with jitter: When retrying, increase the waiting time exponentially between attempts (e.g., 1 s, 2 s, 4 s, 8 s) and add a small random delay ("jitter") to prevent a herd effect where all queued requests retry at the exact same millisecond.

avertissement

Continuously hitting a rate-limited endpoint without backing off can prolong the restriction period and severely impact your system's operational throughput. Properly throttling requests on your side ensures a smoother, more resilient integration.

For default limits, increase requests and additional details, see Rate Limits.

500 Internal Server Error

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

Flux

Une recette est la combinaison de capacités (détection de vie, vérification d'identité, signaux de risque, documents...) configurée dans l'APIKey de votre projet. Elle définit ce qu'Unico exécute dans chaque processus et comment les résultats sont consolidés dans le result unique — vous n'avez besoin de rien orchestrer de votre côté.

Unico maintient un catalogue de recettes préétablies, nommées et versionnées (ex. byunico-idlive-idunico-oneresponse-std). Certaines sont exclusives au Brésil, comme celles qui incluent le Score, Serpro ou la vérification de l'âge.

Quelles capacités votre processus exécute-t-il ?

La combinaison de capacités — le flux de votre projet — est définie dans la configuration de votre APIKey. Consultez les recettes préétablies ou contactez votre interlocuteur projet Unico pour la personnaliser.