Aller au contenu principal
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.

MarkdownChatGPTClaude
avertissement

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

Point de terminaison​

EnvironnementURL
ProductionGET https://api.id.unico.app/processes/v1/{processId}
SandboxGET https://api.id.uat.unico.app/processes/v1/{processId}

Requête​

En-têtes
En-têteValeur
AuthorizationBearer <access_token>
APIKEYClé API provisionnée.
Paramètres de chemin
ParamètreTypeRequisDescription
processIdstring (UUID)ouiIdentifiant du processus retourné par Créer un processus.

Exemple​

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

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"
  }
}
ChampTypeDescription
idstring (UUID)Identifiant du processus.
statusinteger1 (en traitement), 2 (divergence), 3 (terminé avec succès), 4 (annulé), 5 (erreur).
Valeurs possibles du résultat
idCloud.resultSignificationAction recommandée
approvedPersonne réelle et identité validée.Poursuivez le flux.
deniedIdentité non validée, échec de la détection de vie, ou risque extrême identifié.Terminez le flux ou redirigez vers un flux alternatif.
critical-riskNiveau de risque critique identifié.Terminez le flux ou orientez vers une révision manuelle.
high-riskNiveau de risque élevé identifié.Orientez vers une révision manuelle ou un flux alternatif.
retryCapture ou score insuffisant pour l'évaluation.Demandez à l'utilisateur une nouvelle capture.
inconclusivePreuves insuffisantes pour un verdict.Orientez vers une révision manuelle ou un flux alternatif.

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.

BrazilLes clients au Brésil peuvent recevoir la réponse par capacité

La structure globale de la réponse reste la même — le résultat unique est la valeur par défaut.

Les intégrations au Brésil peuvent recevoir les résultats ouverts, par capacité. Chaque capacité activée dans l'APIKey ajoute son propre bloc à la réponse — les champs des capacités désactivées sont omis.

{
  "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,
  "idAge": {
    "result": "yes"
  },
  "cardholderVerification": {
    "result": "approved"
  }
}
ChampTypeDescription
unicoId.resultstringyes, no, inconclusive — voir Vérification d'identité.
riskLevel.resultstringnot_approved, critical_risk, high_risk, inconclusive — voir Classification du risque de fraude.
idFace.resultstringFOUND — voir Identifiant Facial.
idFace.personIdstringIdentifiant opaque stable pour le visage, retourné conjointement à idFace.result = FOUND. Lorsqu'aucun visage ne peut être identifié dans l'image, le processus retourne l'erreur 20532 au lieu d'un bloc idFace.
identityFraudsters.resultstringObsolète. Utilisez riskLevel à la place. Les clients ayant des intégrations en cours peuvent continuer à l'utiliser en coordonnant la migration avec leur équipe projet.
government.serprointegerScore de similarité Serpro (0–100, -1, -2). Disponible au Brésil uniquement. Voir Retour de similarité Serpro.
livenessinteger1 (réussi), 2 (échoué) — voir Détection de Vie.
idAge.resultstringyes, no, inconclusive — voir Vérification de l'âge. Disponible au Brésil uniquement.
scoreintegerScore 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.
cardholderVerification.resultstringapproved, unsure — voir Cardholder Verification. Absent lorsque status n'est pas encore 3 (terminé). Disponible au Brésil uniquement.
MexicoLes clients au Mexique peuvent recevoir le bloc RENAPO Verification

La réponse conserve la même structure et ajoute le bloc idGov.

Les intégrations au Mexique avec RENAPO Verification activé reçoivent un bloc `idGov` supplémentaire contenant l'enregistrement que le RENAPO détient pour la CURP de l'utilisateur. Il s'agit d'une réponse distincte du résultat d'identité.

{
  "id": "11111111-2222-3333-4444-555555555555",
  "status": 3,
  "idCloud": { "result": "approved" },
  "idGov": {
    "government_valid": true,
    "curp": "PUEA880304MDFRJN04",
    "government_name": "ANA PRUEBA EJEMPLO",
    "date_of_birth": "1988-03-04",
    "age": 38,
    "gender": "F",
    "deceased": false,
    "is_mexican": true,
    "citizenship": "MEXICO",
    "state_of_birth": "Ciudad de México",
    "state_iso": "MX-CMX",
    "issuing_entity_code": "DF",
    "municipality_registration": ""
  }
}
ChampTypeDescription
idGovobjectEnregistrement du RENAPO pour la CURP. Absent lorsque la capacité n'est pas activée. {} lorsque le RENAPO n'a pas répondu. Mexique uniquement. Voir RENAPO Verification.

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​

CodeMessageDescription
20023O parâmetro processId não foi informado.Le paramètre d'identifiant de processus est manquant.
20002O parâmetro APIKey não foi informado.Le paramètre APIKEY est manquant dans l'en-tête de la requête.
20001O 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.

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.

Dernière mise à jour le