Identity

El servicio de Identity te permite gestionar el proceso de onboarding de tus usuarios de una manera ágil y sencilla, confirmando su identidad y previniendo fraudes.

Crear Sesión

El endpoint identity/v1/sessions te permite crear una nueva sesión de validación de identidad y te devuelve un identificador único de la misma.

Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Body Parameters
user_idstring(format: uuid)required
USER ID
Detalle de respuestas
dataobject
¿Te resultó útil esta sección?
POST/identity/v1/sessions
{
"user_id":
"a169451c-8525-4352-b8ca-070dd449a1a5"
}
Ejemplo de respuestas

Buscar Sesiones

El endpoint /sessions te permite realizar una búsqueda con filtros específicos.

Consideraciones

Tendrás que especificar tus filtros como parámetros siguiendo este patrón: filter[field]=value. Por ejemplo: filter[status]=IN_PROGRESS

Los resultados serán paginados y podrás especificar la cantidad de datos por página y también qué página ver.

Rango de fechas

Hay un filtro para el campo created_at, que podrás usar para obtener las sesiones creadas dentro un rango de fechas. Por ejemplo: filter[created_at][from]=2021-07-27&filter[created_at][to]=2021-07-28

Ordenamiento

Podrás especificar el orden de los resultados con determinados parámetros que deberás enviar como una lista de strings en el filtro de tipo sort. Por ejemplo: ?sort=status,user_id

El ordenamiento por defecto será ascendente. Para especificar un orden descendente, deberás enviar el carácter '-' como prefijo del atributo. Por ejemplo: ?sort=status,-user_id.

Los atributos para ordenar son user_id, status y created_at.

Si un parámetro es incorrecto o está mal escrito, responderemos con un error.

Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Query Parameters
filter[user_id]string
filter[status]string
Ejemplo: CREATED
Enum: CREATEDIN_PROGRESSPROCESSINGREJECTEDNOT_VALIDATEDCANCELLEDMANUAL_REVIEW
filter[created_at][from]string
ISO 8601
Ejemplo: 1998-08-20
filter[created_at][to]string
ISO 8601
Ejemplo: 1998-08-20
page[size]number
page[number]number
Detalle de respuestas
dataarray
metaobject
¿Te resultó útil esta sección?
GET/identity/v1/sessions
Ejemplo de respuestas

Crear Sesión Custom

El endpoint identity/v1/sessions/:flowType te permite crear una nueva sesión de validación de identidad, basada en alguno de nuestros flujos de validación, y te devuelve un identificador único de la misma.

Consideraciones sobre los flujos de validación de identidad

Para Brasil

Los flujos de validación de identidad disponibles son los siguientes:

  • corporate-credit-card
  • user-credit-card
Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Body Parameters
user_idstring(format: uuid)
USER ID
personal_dataobject
media_dataobject
Path Parameters
flowTypestringrequired
Flow Type
Enum: corporate-credit-carduser-credit-card
Detalle de respuestas
dataobject
¿Te resultó útil esta sección?
POST/identity/v1/sessions/{flowType}
{
"user_id":
"string"
"personal_data":{
"fiscal_id":
"123.456.789-10"
"full_name":
"Diego Pomelo"
"birthdate":
"1998-08-20"
"mother_name":
"Maria Pomelo"
"phone":
"+55 11 97487 2510"
"pep":
false
"salary":
48000
"address":{
...
}
}
"media_data":{
"document_front_side_img":
"<Base64>"
"document_back_side_img":
"<Base64>"
"selfie_img":
"<Base64>"
}
}
Ejemplo de respuestas

Subir documentación requerida

El endpoint identity/v1/sessions/:session_id/files/address-proof permite subir documentación adicional de manera automatizada en caso de ser necesario. El archivo debe ser una imagen, con extensión .jpg o .png, enviada en el body en formato base64.
Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Body Parameters
filestring(format: base64)required
File in Base64
Path Parameters
uuidoneOfrequired
Session ID
¿Te resultó útil esta sección?
POST/identity/v1/sessions/{uuid}/files/address-proof
{
"file":
"<Base64>"
}
Ejemplo de respuestas

Obtener Sesión

El endpoint identity/v1/sessions/{id} te permite obtener datos de una sesión de validación de identidad.
Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Path Parameters
uuidoneOfrequired
Session ID
Detalle de respuestas
dataobject
¿Te resultó útil esta sección?
GET/identity/v1/sessions/{uuid}
Ejemplo de respuestas

Cancelar Sesión

El endpoint identity/v1/sessions/{id} te permite cancelar una sesión de validación de identidad.
Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Path Parameters
uuidstring(format: uuid)required
Session ID
Detalle de respuestas
¿Te resultó útil esta sección?
DELETE/identity/v1/sessions/{uuid}
Ejemplo de respuestas

Obtener Reporte de Sesión

El endpoint identity/v1/sessions/{id}/report te permite obtener los datos de un usuario recabados en una sesión de validación de identidad.
Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Path Parameters
uuidstringrequired
Detalle de respuestas
dataobject
¿Te resultó útil esta sección?
GET/identity/v1/sessions/{uuid}/report
Ejemplo de respuestas

Limpiar usuario en ambiente de pruebas

El endpoint /clean_validations te permite “limpiar” los datos de un usuario en ambiente de prueba para que puedas crear una nueva sesión con su mismo documento.

Consideraciones

Tendrás que especificar el ID o el número de documento del usuario que quieras limpiar. Si envías ambos, tendrá prioridad para la limpieza el ID del usuario.

Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Body Parameters
user_idstring(format: uuid)
USER ID
Ejemplo: usr-...
document_idstring(format: int64)
DOCUMENT ID
Ejemplo: 2038199391
Detalle de respuestas
¿Te resultó útil esta sección?
POST/identity/v1/clean_validations
{
"user_id":
"<UserId>"
"document_id":
"<DNI or CPF>"
}
Ejemplo de respuestas