Saltar al contenido principal
Obtener procesoGET

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.

advertencia

Antes de recuperar el proceso, revise la configuración de nuestro webhook y las estrategias de fallback — haga clic aquí.

Endpoint​

EntornoURL
ProducciónGET https://api.idcloud.unico.app/client/v1/process/{processId}
SandboxGET https://api.idcloud.uat.unico.app/client/v1/process/{processId}

Solicitud​

Encabezados
EncabezadoValor
AuthorizationBearer <access_token>
Parámetros de ruta
ParámetroTipoRequeridoDescripción
processIdstring (UUID)síIdentificador del proceso devuelto por Crear proceso.

Ejemplo​

curl -X GET https://api.idcloud.unico.app/client/v1/process/$PROCESS_ID \
  -H "Authorization: Bearer $TOKEN"

Respuestas​

200 OK
{
  "process": {
    "id": "226fd950-4b80-4da6-a476-ba9d397ddc91",
    "flow": "id_r2",
    "callbackUri": "/",
    "userRedirectUrl": "https://cadastro.uat.unico.app/flow?collect-data=true&dynamic-wrapper=true&id=226fd950-4b80-4da6-a476-ba9d397ddc91",
    "state": "PROCESS_STATE_FINISHED",
    "result": "PROCESS_RESULT_APPROVED",
    "createdAt": "2026-08-06T01:42:21.693615Z",
    "finishedAt": "2026-08-06T01:43:03.080508Z",
    "person": {
      "duiType": "DUI_TYPE_BR_CPF",
      "duiValue": "40*******50",
      "friendlyName": "teste",
      "email": "",
      "phone": "5511999999999",
      "notifications": [
        { "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP" }
      ],
      "phoneCountryCodeAlpha3": ""
    },
    "purpose": "personAuthentication",
    "services": [],
    "authenticationInfo": { "authenticationId": "55cba227-9828-49df-a16f-bcdaa7bdaa4d" },
    "capacities": ["PROCESS_CAPACITY_IDCLOUDONE"],
    "expiresAt": "2026-08-13T01:42:21.536500Z",
    "token": "",
    "companyData": { "branchId": "", "countryCode": "BRA" },
    "simulated": false
  }
}
Campos del proceso
CampoSignificado
idUUID del proceso; la clave utilizada para consultar y rastrear el flujo.
flowTipo de recorrido ejecutado (por ejemplo, id_r2, idlivetrust_r2, idtrust_r2, ...).
callbackUriURI de callback a la que se redirige la aplicación cliente al finalizar el flujo.
userRedirectUrlURL completa de la página CbU que el usuario abre para realizar el recorrido (incluye el id y los indicadores de comportamiento).
stateEstado del ciclo de vida del proceso. Valores PROCESS_STATE_* (por ejemplo, CREATED, FAILED, FINISHED, AWAITING_FOR_DOCUMENT, UNSPECIFIED).
resultVeredicto final de la evaluación. Valores PROCESS_RESULT_* (por ejemplo, APPROVED, AUTHENTICATED, NOT_APPROVED, ...). Solo es concluyente cuando state = PROCESS_STATE_FINISHED.
createdAtMarca de tiempo de creación del proceso (UTC).
finishedAtMarca de tiempo de finalización del proceso (UTC).
personSubobjeto con los datos de la persona que se está verificando.
purposePropósito del proceso (por ejemplo, personAuthentication, registro de persona).
servicesLista de servicios adicionales asociados al proceso; vacía cuando no hay ninguno.
authenticationInfo.authenticationIdID del evento de autenticación de identidad generado por el flujo.
capacitiesCapacidades/productos utilizados. Valores PROCESS_CAPACITY_* (por ejemplo, IDCLOUDONE).
expiresAtMarca de tiempo de expiración del proceso/enlace (UTC).
tokenToken de sesión/acceso asociado al proceso (puede estar vacío).
companyDataSubobjeto con los datos de la empresa/tenant propietario del proceso.
simulatedBooleano; indica si se trata de un proceso de simulación/sandbox (true) o real (false).
Campos de la persona
CampoSignificado
duiTypeTipo de documento único de identificación. Valores DUI_TYPE_* (por ejemplo, BR_CPF).
duiValueValor del documento (por ejemplo, el número de CPF).
friendlyNameNombre amigable/apodo de la persona (texto libre, no validado).
emailCorreo electrónico de la persona; puede estar vacío.
phoneNúmero de teléfono en formato E.164 (código de país + código de área + número).
notificationsLista de canales de notificación. Cada elemento incluye notificationChannel con valores NOTIFICATION_CHANNEL_* (por ejemplo, WHATSAPP, SMS, EMAIL).
phoneCountryCodeAlpha3Código de país ISO alfa-3 del número de teléfono (por ejemplo, BRA); puede estar vacío.
Campos de datos de la empresa
CampoSignificado
branchIdIdentificador de la sucursal del tenant; vacío cuando no hay segmentación por sucursal.
countryCodePaís de la empresa en ISO alfa-3 (por ejemplo, BRA).
Tipos de documento y campos de OCR

process.services[].documents[].doc.code informa el tipo de documento como un código corto en mayúsculas. unico.moja.dictionary.br.cnh.v2.Cnh se convierte en CNH. El código no incluye ni el país ni la versión del esquema; la versión se devuelve por separado en doc.version.

Los tipos de documento que utilizan el esquema unificado — unified_schema en la referencia de campos — se informan como el tipo identificado durante la captura, en mayúsculas: IDCARD, DRIVERLICENSE, PASSPORT o VOTERID. Los pasaportes de EE. UU. conservan su variante en lugar de agruparse en PASSPORT, por lo que también se devuelven valores como POLYCARBONATEPASSPORT, PASSPORTCARD y PAPERPASSPORT. Por ejemplo, unico.moja.dictionary.ar.generic.v1.IdCard y unico.moja.dictionary.us.generic.v1.PolycarbonatePassport se informan como IDCARD y POLYCARBONATEPASSPORT.

Esquemas específicos

Los tipos de documento que utilizan su propio esquema de campos — listados bajo specific_document_schemas en la referencia de campos — se muestran en la tabla siguiente. Use el tipo del diccionario para buscar cada esquema en ese archivo.

Paísdoc.codeTipo del diccionarioDocumento
BRRGunico.moja.dictionary.br.rg.v2.RgRG
BRCNHunico.moja.dictionary.br.cnh.v2.CnhCNH (licencia de conducir)
BRCINunico.moja.dictionary.br.cin.v1.CinCIN
BRPASSAPORTEunico.moja.dictionary.br.passaporte.v1.PassaportePasaporte
MXINEunico.moja.dictionary.mx.ine.v1.IneCredencial para votar INE
MXLPCunico.moja.dictionary.mx.lpc.v1.LpcLicencia para conducir
MXPASAPORTEunico.moja.dictionary.mx.pasaporte.v1.PasaportePasaporte
—UNKNOWNunico.moja.dictionary.other.unknown.v1.UnknownNo se pudo identificar el tipo — doc.data está vacío
PASSAPORTE y PASAPORTE son documentos diferentes

El pasaporte brasileño es PASSAPORTE (con doble S) y el mexicano es PASAPORTE (con una sola S), cada uno reflejando la grafía de su propio diccionario. No es una errata — no trate ambos valores como equivalentes.

No se realiza extracción de OCR ni se informa ningún campo en doc.data cuando doc.code es UNKNOWN.

BrazilLos clientes en Brasil pueden recibir el payload completo del proceso

La estructura general de la respuesta se mantiene igual — el resultado único es el valor predeterminado.

Las integraciones en Brasil pueden recibir el objeto de proceso completo que se muestra a continuación, con resultados por capacidad en authenticationInfo.

{
  "process": {
    "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
    "flow": "idchecktrust",
    "callbackUri": "https://example.com/callback",
    "userRedirectUrl": "https://example.com/redirect",
    "state": "PROCESS_STATE_FINISHED",
    "result": "PROCESS_RESULT_OK",
    "createdAt": "2024-01-01T10:00:00Z",
    "finishedAt": "2024-01-01T10:15:00Z",
    "expiresAt": "2024-01-08T10:00:00Z",
    "purpose": "VERIFICATION",
    "clientReference": "client-ref-abc",
    "useCase": "smart_revalidation",
    "capacities": ["liveness", "face_match"],
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "person": {
      "duiType": "DUI_TYPE_BR_CPF",
      "duiValue": "12345678909",
      "friendlyName": "Luke Skywalker",
      "notifications": [
        {
          "notificationChannel": "email"
        }
      ]
    },
    "authenticationInfo": {
      "authenticationId": "auth-123",
      "livenessResult": "LIVENESS_RESULT_LIVE",
      "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
      "identityFraudstersResult": "TRUST_RESULT_INCONCLUSIVE",
      "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
      "smartRevalidationResult": "SMART_REVALIDATION_RESULT_UNSPECIFIED",
      "idAgeResult": "ID_AGE_RESULT_UNSPECIFIED",
      "scoreEngineResult": {
        "scoreEnabled": "SCORE_ENABLED_TRUE",
        "score": 85.5
      }
    },
    "companyData": {
      "branchId": "branch-123",
      "countryCode": "BR"
    },
    "bioTokenData": {
      "referenceProcessId": "ref-proc-123",
      "authenticationId": "auth-ref-123"
    },
    "services": [
      {
        "envelopeId": "4d4f3d90-04a3-4259-b63b-930ab10d2e47",
        "documentIds": ["doc-abc-123"],
        "consent_granted": true,
        "documents": [
          {
            "doc_id": "doc-abc-123",
            "typified": true,
            "cpf_match": true,
            "face_match": true,
            "validate_doc": true,
            "reused_doc": false,
            "signed_url": "https://example.com/doc?token=xyz",
            "doc": {
              "version": 1,
              "code": "CNH",
              "data": {
                "numero": "044589731564",
                "cpfNumero": "12345678909",
                "nomeCivil": "Luke Skywalker",
                "dataNascimento": "1990-05-12T00:00:00Z",
                "dataExpiracao": "2027-12-07T00:00:00Z",
                "categoria": "B"
              }
            }
          }
        ]
      }
    ]
  }
}
Campos de nivel superior
CampoTipoDescripción
process.idstring (UUID)Identificador del proceso.
process.flowstringIdentificador del flujo enviado en la creación.
process.callbackUristringURL de callback configurada para eventos del proceso.
process.userRedirectUrlstringURL para redirigir al usuario después de completar el recorrido.
process.stateenumEstado actual del proceso. Consulte los valores a continuación.
process.resultenumResultado de la verificación. Presente solo cuando state = PROCESS_STATE_FINISHED.
process.createdAtstring (datetime)Marca de tiempo ISO 8601 de cuando se creó el proceso.
process.finishedAtstring (datetime)Marca de tiempo ISO 8601 de cuando finalizó el proceso. Presente solo cuando state = PROCESS_STATE_FINISHED.
process.expiresAtstring (datetime)Marca de tiempo ISO 8601 de cuando expira el proceso.
process.purposestringPropósito del proceso según lo configurado en el flujo.
process.clientReferencestringReferencia opcional del lado del cliente para indexación en el portal.
process.useCasestringIdentificador del escenario asociado al flujo.
process.capacitiesarray of stringsLista de capacidades activadas en este proceso.
process.tokenstringJWT firmado para integración con el SDK.
process.personobjectIdentificación proporcionada en la creación.
process.person.notificationsarrayCanales de notificación configurados para el recorrido (por ejemplo, email).
process.authenticationInfoobjectResultados por capacidad. Consulte a continuación.
process.companyDataobjectContexto de empresa y sucursal.
process.companyData.branchIdstringIdentificador de sucursal.
process.companyData.countryCodestringCódigo de país ISO 3166-1 alfa-2.
process.bioTokenDataobjectInformación del proceso de referencia — presente solo en flujos de Validación 1:1 y Revalidación Inteligente.
process.servicesarraySobres firmados, documentos capturados y otras salidas de servicio. Consulte a continuación.
Valores de process.state
ValorSignificado
PROCESS_STATE_CREATEDProceso creado; el usuario aún no ha completado el recorrido.
AWAITING_FOR_DOCUMENTProceso creado sin documento de identificación; a la espera de que se establezca mediante Establecer documento del proceso. Presente solo cuando el flujo personalizado permite documento opcional.
PROCESS_STATE_FINISHEDRecorrido completado. Verifique result y authenticationInfo.
PROCESS_STATE_FAILEDError de procesamiento.
Inconsistencia en el nombre del estado

AWAITING_FOR_DOCUMENT no sigue la convención de prefijo PROCESS_STATE_* utilizada por los demás estados. Esta es una inconsistencia de nomenclatura conocida en la API actual.

Valores de process.result
ValorSignificado
PROCESS_RESULT_OKTodas las capacidades devolvieron resultados positivos.
PROCESS_RESULT_INVALID_IDENTITYAl menos una capacidad devolvió un negativo definitivo (por ejemplo, detección de vida fallida, identidad no coincidente).
PROCESS_RESULT_ERRORError durante el procesamiento del resultado.
PROCESS_RESULT_EXPIREDEl proceso expiró antes de completar el recorrido.
PROCESS_RESULT_UNSPECIFIEDProceso aún no finalizado.
Resultados de capacidades en authenticationInfo

Todos los campos se devuelven siempre, independientemente del flujo. Los campos de las capacidades no utilizadas en el flujo devuelven *_UNSPECIFIED.

Valores de enum abreviados

Los valores abreviados (por ejemplo, livenessResult = LIVE, authenticationResult = INCONCLUSIVE) se corresponden directamente con los valores de enum completos documentados aquí (LIVENESS_RESULT_LIVE, AUTHENTICATION_RESULT_INCONCLUSIVE, etc.) — el prefijo se omite por brevedad.

CampoCapacidadValores posibles
authenticationId—Identificador único para este intento de autenticación.
livenessResultDetección de VidaLIVENESS_RESULT_LIVE, LIVENESS_RESULT_NOT_LIVE, LIVENESS_RESULT_UNSPECIFIED
authenticationResultVerificación de IdentidadAUTHENTICATION_RESULT_POSITIVE, AUTHENTICATION_RESULT_NEGATIVE, AUTHENTICATION_RESULT_INCONCLUSIVE, AUTHENTICATION_RESULT_UNSPECIFIED
identityFraudstersResultClasificación de Riesgo de FraudeTRUST_RESULT_YES, TRUST_RESULT_INCONCLUSIVE, TRUST_RESULT_UNSPECIFIED
bioTokenEngineResultValidación 1:1BIO_TOKEN_ENGINE_RESULT_POSITIVE, BIO_TOKEN_ENGINE_RESULT_NEGATIVE, BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED
smartRevalidationResultRevalidación InteligenteSMART_REVALIDATION_RESULT_POSITIVE, SMART_REVALIDATION_RESULT_NEGATIVE, SMART_REVALIDATION_RESULT_UNSPECIFIED
idAgeResultVerificación de EdadID_AGE_RESULT_POSITIVE, ID_AGE_RESULT_NEGATIVE, ID_AGE_RESULT_INCONCLUSIVE, ID_AGE_RESULT_UNSPECIFIED
scoreEngineResult.scoreEnabledScore de RiesgoSCORE_ENABLED_TRUE, SCORE_ENABLED_FALSE, SCORE_ENABLED_UNSPECIFIED
scoreEngineResult.scoreScore de RiesgoNúmero de -100 a +100. Presente cuando authenticationResult = AUTHENTICATION_RESULT_INCONCLUSIVE y Score de Riesgo está habilitado.
serproResult.scoreRetorno de Similitud Serpro0–100 (similitud); -1 (sin rostro en archivo para este CPF); -2 (error de integración).
Campos de process.services
Convenciones de nomenclatura mixtas en services

El array services utiliza camelCase para los campos a nivel de sobre (envelopeId, documentIds) y snake_case para los campos a nivel de documento (doc_id, consent_granted, face_match, etc.). Esto refleja la respuesta real de la API — ambas convenciones son intencionales y no constituyen un error de documentación.

CampoTipoDescripción
envelopeIdstring (UUID)Identificador del sobre firmado.
documentIdsarray of stringsIDs de documentos capturados en este servicio.
consent_grantedbooleanSi el usuario otorgó consentimiento para compartir datos.
documentsarrayDocumentos capturados con datos OCR y resultados de validación.
documents[].doc_idstringIdentificador del documento.
documents[].typifiedbooleanSi el tipo de documento fue identificado exitosamente.
documents[].cpf_matchbooleanSi el CPF del documento coincide con el CPF proporcionado (solo Brasil).
documents[].face_matchbooleanSi el selfie coincide con la foto del documento.
documents[].validate_docbooleanSi el documento pasó la validación de autenticidad.
documents[].reused_docbooleanSi este documento fue reutilizado de un proceso anterior.
documents[].signed_urlstringURL prefirmada para descargar el PDF del documento (válida por 5 minutos — vuelva a consultarla para renovarla).
documents[].doc.versionintegerVersión del esquema OCR.
documents[].doc.codestringCódigo corto del tipo de documento (por ejemplo, CNH). Consulte Tipos de documento y campos de OCR para conocer todos los valores y cómo se deriva el código.
documents[].doc.dataobjectCampos OCR extraídos. El contenido varía según el tipo de documento — consulte la referencia completa de campos para el catálogo completo. Los nombres de campo dentro de doc.data (por ejemplo, nomeCivil, dataNascimento) se devuelven en portugués — estos son los valores reales producidos por el motor OCR.

Códigos de error​

CódigoMensajeDescripción
3process id is invalidCuando el ID del proceso es inválido.

Polling vs webhook​

Puede hacer polling a este endpoint para verificar el progreso, pero el patrón recomendado es suscribirse a un webhook y solo llamar a este endpoint como respaldo. Consulte Webhooks y Eventos.

Qué sigue​

Última actualización el