Recupere un proceso existente por su identificador. Según el contrato de la API, el resultado ya se devuelve de forma sincrónica al crear el proceso — utilice este endpoint para reconsultas, auditoría y soporte.
Antes de recuperar el proceso, revise la configuración de nuestro webhook y las estrategias de fallback — haga clic aquí.
Endpoint
| Entorno | URL |
|---|---|
| Producción | GET https://api.id.unico.app/processes/v1/{processId} |
| Sandbox | GET https://api.id.uat.unico.app/processes/v1/{processId} |
Solicitud
| Encabezado | Valor |
|---|---|
Authorization | Bearer <access_token> |
APIKEY | Clave API provisionada. |
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
processId | string (UUID) | sí | Identificador del proceso devuelto por Crear proceso. |
Ejemplo
- cURL
- Node.js
curl -X GET https://api.id.unico.app/processes/v1/$PROCESS_ID \
-H "Authorization: Bearer $TOKEN" \
-H "APIKEY: $API_KEY"
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();
Respuestas
El contrato es único — el campo idCloud.result contiene el veredicto consolidado de las capacidades utilizadas.
Unico consolida los resultados de las capacidades ejecutadas en un único idCloud.result, listo para decidir el siguiente paso de su flujo — sin necesidad de orquestar resultados individuales.
{
"id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
"status": 3,
"idCloud": {
"result": "approved"
}
}
| 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. |
Los valores devueltos dependen de la receta configurada en su APIKey. Consulte Flujos para conocer los valores de resultado que puede devolver cada receta.
Cuándo usar este endpoint
El contrato de la API devuelve los resultados de forma sincrónica, por lo que la mayoría de las integraciones no necesitan este endpoint. Utilícelo cuando:
- Solo persistió el
processIdy necesita recuperar el resultado completo más adelante (auditoría, soporte). - Sospecha que la respuesta original se perdió en tránsito (error de red después de que la plataforma completó el trabajo).
- Está creando una herramienta de back-office que revisa procesos históricos.
Códigos de error
- 400 Bad Request
- 404 Not Found
- 403 Forbidden
- 410 Gone
- 429 Too Many Requests
- 500 Internal Server Error
| Código | Mensaje | Descripción |
|---|---|---|
20023 | O parâmetro processId não foi informado. | Falta el parámetro de ID del proceso. |
20002 | O parâmetro APIKey não foi informado. | Falta el parámetro APIKEY en el encabezado de la solicitud. |
20001 | O parâmetro authtoken não foi informado. | Falta el parámetro del token de integración en el encabezado de la solicitud. |
| Código | Mensaje | Descripción |
|---|---|---|
50001 | O processo informado não foi encontrado. | El proceso no existe en la base de datos. |
| Código | Mensaje | Descripción |
|---|---|---|
30017 | User does not have permission to perform this action. | JWT malformado o usuario sin permiso para realizar esta operación. |
10502 | O token informado está expirado. | Cuando el token de acceso utilizado ha expirado. |
10501 | O token informado é inválido. | El token de autenticación es inválido. |
10201 | O AppKey informado é inválido. | El parámetro APIKEY no fue ingresado o no existe. |
El proceso existe pero resultó en un error. Devuelve solo id y status: 5.
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.
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.
| Código | Mensaje | Descripción |
|---|---|---|
99999 | Internal failure! Try again later | Cuando hay un error interno. |
Flujos
Una receta es la combinación de capacidades (detección de vida, verificación de identidad, señales de riesgo, documentos...) configurada en la APIKey de su proyecto. Define lo que Unico ejecuta en cada proceso y cómo los resultados se consolidan en el único result — no necesita orquestar nada de su lado.
Unico mantiene un catálogo de recetas preestablecidas, nombradas y versionadas (por ejemplo, byunico-idlive-idunico-oneresponse-std). Algunas son exclusivas de Brasil, como las que incluyen Score, Serpro o verificación de edad.
La combinación de capacidades — el flujo de su proyecto — se define en la configuración de su APIKey. Consulte las recetas preestablecidas o hable con su contacto de proyecto de Unico para personalizarla.