Creación de procesos

En esta sección, encontrarás cómo crear un proceso en by Unico a través de la API REST.

---

Introducción

---

En esta sección, encontrarás la documentación detallada sobre el funcionamiento del endpoint de Creación de Procesos en by Unico. Ten en cuenta que, para utilizar las capacidades de la plataforma IDCloud en este medio de integración, solo es necesario modificar el valor del parámetro "flow" al momento de crear el proceso, y Unico será responsable de orquestar todas las capacidades que deseas utilizar.

Entiende más sobre el uso de las capacidades en by Unico en la sección Visión General.

Antes de comenzar

---

Tus solicitudes de API se autentican utilizando un access-token. Cualquier solicitud que no incluya un access-token válido devolverá un error.

Puedes ver más sobre cómo generar un access-token aquí.

Endpoints:

• UAT: https://api.cadastro.uat.unico.app;

• Producción: https://api.cadastro.unico.app.

---

Creación del Proceso

---

Crear Proceso

post

Endpoint para crear un nuevo proceso en by Unico.

Authorizations

Body

callbackUristringrequired

Define a dónde será redirigido el usuario al final del proceso. Los valores posibles son: una URL https para redirigir a páginas web (ej: https://developers.unico.io/callback), una URL Schema para redireccionamiento en aplicaciones móviles nativas (ej: br.com.meupacote.app://callback - el callback debe estar registrado en tu aplicación móvil) o sin redireccionamiento (incluir solo '/').

Example: /

flowstring · enumrequired

Tipo de flujo. Consulta los detalles de los flujos en la sección 'Visión General' en esta misma documentación.

Example: idAvailable options:

companyBranchIdstringoptional

Es el ID de la sucursal donde se creará el proceso. Si solo hay una sucursal asociada a la cuenta de servicio, no es necesario pasar este parámetro. Si hay separación de procesos por sucursal, recibirás los IDs de las sucursales del equipo de Unico.

Example: 60837cd3-ed3c-4038-ad7c-0a85ad64b03a

bioTokenIdstringoptional

Identificación del token biométrico. Obligatorio para los flujos "idtoken y idtokentrust" y se debe utilizar un ID de un proceso concluido de cualquier otro flujo de verificación de identidad.

Example: 60837cd3-ed3c-4038-ad7c-0a85ad64b03a

personobjectoptional

Información del usuario.

purposestring · enumrequired

Propósito del proceso.

Example: creditprocessAvailable options:

expiresInstringoptional

Es el tiempo de expiración del proceso en segundos a partir de su creación. Debe proporcionarse un valor en el formato "10080s", con "s" al final. Si este parámetro no se proporciona, se usará el valor predeterminado de 7 días.

Example: 3600s

contextualizationobjectoptional

Información contextual sobre el proceso. Estos campos se presentan en el recorrido para el usuario final, mejorando la conversión al contextualizarlo sobre el motivo de la captura de la biometría.

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.cadastro.uat.unico.app/client/v1/process' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "callbackUri": "/",
    "flow": "id",
    "companyBranchId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
    "bioTokenId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
    "person": {
      "duiType": "DUI_TYPE_MX_CURP",
      "duiValue": "VNHK141228HQTFXW96",
      "friendlyName": "Luke Skywalker",
      "phone": "5215512345678",
      "email": "[e-mail]",
      "notifications": [
        {
          "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
        }
      ]
    },
    "purpose": "creditprocess",
    "expiresIn": "3600s",
    "contextualization": {
      "currency": "MXN",
      "price": 15990.9,
      "locale": "esMX"
    }
  }'

200

400

401

500

200

{
  "process": {
    "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
    "companyBranchId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
    "flow": "id",
    "callbackUri": "/path/to/callback-url/",
    "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
    "state": "PROCESS_STATE_CREATED",
    "createdAt": "2023-10-09T15:15:25.417105Z",
    "person": {
      "duiType": "DUI_TYPE_MX_CURP",
      "duiValue": "VNHK141228HQTFXW96",
      "friendlyName": "Luke Skywalker",
      "phone": "5215512345678",
      "email": "[e-mail]",
      "notifications": [
        {
          "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
        }
      ]
    },
    "purpose": "creditprocess",
    "authenticationInfo": {},
    "capacities": [
      [
        "PROCESS_CAPACITY_IDUNICO",
        "PROCESS_CAPACITY_IDCHECK",
        "PROCESS_CAPACITY_IDDOCS"
      ]
    ],
    "expiresAt": "2023-10-09T15:15:25.417105Z",
    "token": "eyJhbGciOiJSUzI1[...]d_jhQ",
    "companyData": {
      "branchId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
      "countryCode": "MEX"
    }
  }
}

Proceso creado con éxito.

Los procesos deben ser creados exclusivamente en una comunicación backend-to-backend, debido a nuestra política de CORS, que impide la creación de procesos en una comunicación frontend-to-backend.

La obligatoriedad de los parámetros en la creación del proceso puede variar dependiendo de los flows utilizados. Ejemplo:

• En los flows que incluyen Validación (1:1), es obligatorio enviar la propiedad bioTokenId.

Consejos:

• Para más información sobre los posibles errores de este endpoint, consulta la sección Errores.

---

¿Dudas?

¿No encontraste algo o aún necesitas ayuda? Si ya eres cliente o socio, puedes ponerte en contacto a través del Centro de Ayuda.