Aller au contenu principal

Définir le document du processus

Définit le document d'identification (CPF, CURP, SSN ou autre duiType) sur un processus qui a été créé sans document. Une fois défini, le document est immuable.

Disponible uniquement pour les processus dont le flux personnalisé autorise la création sans document — c'est-à-dire les processus à l'état AWAITING_FOR_DOCUMENT.

Point de terminaison

EnvironnementURL
ProductionPOST https://api.idcloud.unico.app/client/v1/process/{processId}/document
SandboxPOST https://api.idcloud.uat.unico.app/client/v1/process/{processId}/document

Requête

En-têtes
En-têteValeur
AuthorizationBearer <access_token> (voir Authentification)
Content-Typeapplication/json
Paramètres de chemin
ChampTypeRequisDescription
processIdstringouiIdentifiant du processus retourné dans process.id à la création.
Paramètres du corps
ChampTypeRequisDescription
duiTypeenumouiType de document. Valeurs : DUI_TYPE_BR_CPF, DUI_TYPE_MX_CURP, DUI_TYPE_US_SSN. Cet endpoint prend en charge un sous-ensemble des types de documents acceptés par Créer un processus — les flux personnalisés qui autorisent la création de document optionnel sont actuellement validés par rapport à cette liste plus restreinte.
duiValuestringouiNuméro de document, sans formatage. Maximum 320 caractères (permet les identifiants encodés ou composites ; les numéros de documents standard tels que CPF ou CURP sont significativement plus courts).

Exemple

curl -X POST https://api.idcloud.unico.app/client/v1/process/abc-123/document \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"duiType": "DUI_TYPE_BR_CPF",
"duiValue": "12345678901"
}'

Réponses

200 OK
{
"process": {
"id": "abc-123",
"person": {
"duiType": "DUI_TYPE_BR_CPF",
"duiValue": "12345678901"
}
}
}
ChampTypeDescription
process.idstringIdentifiant du processus.
process.person.duiTypestringType de document défini sur le processus.
process.person.duiValuestringValeur du document définie sur le processus.
400 Bad Request

Retourné lorsque le contenu de la requête est malformé, que des champs obligatoires sont manquants, ou que l'état du processus n'autorise pas l'opération.

401 Unauthorized

Jeton Bearer manquant, expiré ou invalide. Voir Authentification.

404 Not Found

Processus introuvable.

429 Too Many Requests

Limite de débit atteinte. Aucun code d'erreur détaillé n'est fourni — statut HTTP uniquement.

Codes d'erreur

CodeMessageDescription
3process id is invalidLorsque l'identifiant du processus est invalide.
3dui_type is requiredLorsque le type de document n'est pas fourni.
3dui_value is requiredLorsque le numéro de document n'est pas fourni.
3dui_value exceeds maximum lengthLorsque le numéro de document dépasse la limite maximale de caractères.
9process is not awaiting for documentLorsque le processus spécifié n'accepte pas la soumission de document.
9process expiredLorsque le processus spécifié a expiré.
9document already set, cannot be modifiedLorsque le processus possède déjà un document associé.
9process already finishedLorsque le processus a déjà été finalisé.
9flow does not allow optional documentLorsque le document est obligatoire pour le flux exécuté par le processus.

Étapes suivantes

  • Après avoir défini le document, le processus poursuit son pipeline. Appelez Obtenir le processus pour récupérer le résultat, ou attendez le webhook.