Creación de proceso

En esta sección, encontrarás cómo crear un proceso en la plataforma Unico IDCloud

Introducción

En esta sección, encontrarás la documentación detallada sobre el funcionamiento del endpoint para crear un proceso en la plataforma Unico IDCloud.

Se trata de un servicio con retorno síncrono, es decir, toda la integración ocurre utilizando un único endpoint y la respuesta se devolverá en el response de este mismo endpoint.

Las capacidades de la plataforma Unico IDCloud se gestionan a través de API Keys, utilizadas como un parámetro en el header de las solicitudes, que definen el alcance de acceso.

Como requisito previo, es necesario contar con una API Key configurada con las capacidades que utilizarás.

Habla con el responsable de tu proyecto para obtener la API Key con esta configuración.

Antes de comenzar

Tus solicitudes a la API se autentican mediante un access-token. Cualquier solicitud que no incluya un access-token válido retornará un error.

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

Endpoints:

UAT: https://api.id.uat.unico.app;
Producción: https://api.id.unico.app.

Creación de procesos

Puntos Importantes:

Si el status = 3, considere la respuesta del parámetro idCloud.result. La respuesta devuelta en este parámetro incluirá todas las validaciones realizadas por las capacidades de la plataforma Unico IDCloud;
- Los campos dentro del objeto de idCloud.details son sólo para fines informativos y no deben analizarse. (Si algún campo dentro de idCloud.details no es concluyente, se omitirá de la respuesta).
Si ocurre un error en el procesamiento de la biometría, la solicitud devolverá un status code = 200 y el proceso tendrá un status = 5, como en el siguiente ejemplo:

 {
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 5
  }

Consejos:

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

¿Dudas?

AnteriorAPI Reference PróximoErrores

Atualizado há 11 dias

Isto foi útil?

Crear Proceso

post

Endpoint para crear un nuevo proceso en by Client.

Header parameters

Authorizationstringrequired

Access-token válido.

APIKEYstringrequired

Clave con las capacidades habilitadas

Body

subjectobjectrequired

Información del usuario.

useCasestringrequired

Caso de uso de la operación.

Example: Apertura de cuenta

imageBase64stringrequired

Archivo encriptado generado por el SDK o en base64 (en caso de no utilizar prueba de vida/SDK).

Example: /9j/4AAQSkZJR...

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.id.uat.unico.app/processes/v1' \
  --header 'Authorization: text' \
  --header 'APIKEY: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "subject": {
      "code": "VNHK141228HQTFXW96",
      "name": "Luke Skywalker",
      "email": "luke@unico.io",
      "phone": "5215512345678"
    },
    "useCase": "Apertura de cuenta",
    "imageBase64": "/9j/4AAQSkZJR..."
  }'

200

400

500

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "idCloud.result": {
    "result": "yes"
  },
  "idCloud.details": "identity: isDocumentOwner: yes, isConsistent: yes; behavior: isTrustworthy: yes"
}

Proceso creado con éxito.