Saltar al contenido principal

Establecer Documento del Proceso

Establece el documento de identificación (CPF, CURP, SSN u otro duiType) en un proceso que fue creado sin uno. Una vez establecido, el documento es inmutable.

Solo disponible para procesos cuyo Custom Flow permite la creación sin documento — es decir, procesos en el estado AWAITING_FOR_DOCUMENT.

Endpoint

EntornoURL
ProducciónPOST https://api.idcloud.unico.app/client/v1/process/{processId}/document
SandboxPOST https://api.idcloud.uat.unico.app/client/v1/process/{processId}/document

Solicitud

Cabeceras
CabeceraValor
AuthorizationBearer <access_token> (ver Autenticación)
Content-Typeapplication/json
Parámetros de ruta
CampoTipoRequeridoDescripción
processIdstringID del proceso devuelto en process.id al momento de la creación.
Parámetros del cuerpo
CampoTipoRequeridoDescripción
duiTypeenumTipo de documento. Valores: DUI_TYPE_BR_CPF, DUI_TYPE_MX_CURP, DUI_TYPE_US_SSN. Este endpoint admite un subconjunto de los tipos de documento aceptados por Crear Proceso — los Custom Flows que permiten la creación de documentos opcionales se validan actualmente frente a esta lista más reducida.
duiValuestringNúmero del documento, sin formato. Máximo 320 caracteres (para identificadores codificados o compuestos; los números de documento estándar como CPF o CURP son significativamente más cortos).

Ejemplo

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"
}'

Respuestas

200 OK
{
"process": {
"id": "abc-123",
"person": {
"duiType": "DUI_TYPE_BR_CPF",
"duiValue": "12345678901"
}
}
}
CampoTipoDescripción
process.idstringIdentificador del proceso.
process.person.duiTypestringTipo de documento establecido en el proceso.
process.person.duiValuestringValor del documento establecido en el proceso.
400 Bad Request

Se devuelve cuando el payload de la solicitud está mal formado, faltan campos requeridos o el estado del proceso no permite la operación.

401 Unauthorized

Token Bearer ausente, expirado o inválido. Ver Autenticación.

404 Not Found

Proceso no encontrado.

429 Too Many Requests

Límite de tasa alcanzado. No se proporciona un código de error detallado — solo el estado HTTP.

Códigos de Error

CódigoMensajeDescripción
3process id is invalidCuando el ID del proceso es inválido.
3dui_type is requiredCuando no se proporciona el tipo de documento.
3dui_value is requiredCuando no se proporciona el número de documento.
3dui_value exceeds maximum lengthCuando el número de documento supera el límite máximo de caracteres.
9process is not awaiting for documentCuando el proceso especificado no acepta envío de documentos.
9process expiredCuando el proceso especificado ha expirado.
9document already set, cannot be modifiedCuando el proceso ya tiene un documento vinculado.
9process already finishedCuando el proceso ha ya sido finalizado.
9flow does not allow optional documentCuando el documento es obligatorio para el flujo ejecutado por el proceso.

Próximos pasos

  • Después de establecer el documento, el proceso continúa su pipeline. Llame a Obtener Proceso para obtener el resultado, o espere el webhook.