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
| Environnement | URL |
|---|---|
| Production | POST https://api.idcloud.unico.app/client/v1/process/{processId}/document |
| Sandbox | POST https://api.idcloud.uat.unico.app/client/v1/process/{processId}/document |
Requête
En-têtes
| En-tête | Valeur |
|---|---|
Authorization | Bearer <access_token> (voir Authentification) |
Content-Type | application/json |
Paramètres de chemin
| Champ | Type | Requis | Description |
|---|---|---|---|
processId | string | oui | Identifiant du processus retourné dans process.id à la création. |
Paramètres du corps
| Champ | Type | Requis | Description |
|---|---|---|---|
duiType | enum | oui | Type 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. |
duiValue | string | oui | Numé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
- Node.js
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"
}'
import fetch from 'node-fetch';
const res = await fetch(
'https://api.idcloud.unico.app/client/v1/process/abc-123/document',
{
method: 'POST',
headers: {
'Authorization': `Bearer ${process.env.UNICO_ACCESS_TOKEN}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
duiType: 'DUI_TYPE_BR_CPF',
duiValue: '12345678901',
}),
}
);
const { process: proc } = await res.json();
// proc.id, proc.person.duiType, proc.person.duiValue
Réponses
200 OK
{
"process": {
"id": "abc-123",
"person": {
"duiType": "DUI_TYPE_BR_CPF",
"duiValue": "12345678901"
}
}
}
| Champ | Type | Description |
|---|---|---|
process.id | string | Identifiant du processus. |
process.person.duiType | string | Type de document défini sur le processus. |
process.person.duiValue | string | Valeur 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
- 400 Bad Request
- 401 Unauthorized
- 404 Not Found
- 429 Too Many Requests
- 500 Internal Server Error
| Code | Message | Description |
|---|---|---|
3 | process id is invalid | Lorsque l'identifiant du processus est invalide. |
3 | dui_type is required | Lorsque le type de document n'est pas fourni. |
3 | dui_value is required | Lorsque le numéro de document n'est pas fourni. |
3 | dui_value exceeds maximum length | Lorsque le numéro de document dépasse la limite maximale de caractères. |
9 | process is not awaiting for document | Lorsque le processus spécifié n'accepte pas la soumission de document. |
9 | process expired | Lorsque le processus spécifié a expiré. |
9 | document already set, cannot be modified | Lorsque le processus possède déjà un document associé. |
9 | process already finished | Lorsque le processus a déjà été finalisé. |
9 | flow does not allow optional document | Lorsque le document est obligatoire pour le flux exécuté par le processus. |
| Message | Description |
|---|---|
| Jwt header is an invalid JSON | Lorsque le token d'accès utilisé contient des caractères incorrects. |
| Jwt is expired | Lorsque le token d'accès utilisé a expiré. |
| Code | Message | Description |
|---|---|---|
5 | error getting process: rpc error: code = NotFound desc = process not found | Lorsque l'identifiant du processus est introuvable. |
Aucun code d'erreur détaillé n'est fourni pour ce statut — code de statut HTTP uniquement.
| Code | Message | Description |
|---|---|---|
99999 | Internal failure! Try again later | Lorsqu'une erreur interne se produit. |
É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.