KYC

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/v2/sessions permite crear una nueva sesión de validación de identidad para Personas Físicas, basada en alguno de nuestros flujos de validación, y te devuelve un identificador único de la misma.

Consideración sobre el método de integración API

Cuando se usa este tipo de integración, los documentos se suben con el siguiente endpoint Subir Archivo

Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Body Parameters
flow_typestringrequired
Flow Type
Ejemplo: kyc-accounts
Enum: kyc-accounts
countrystringrequired
Ejemplo: ARG
Enum: ARGBRACHL
integration_methodstringrequired
Integration Method
Ejemplo: API
Enum: APIWEB
dataobjectrequired
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/identity/v2/sessions
{
"flow_type":
"kyc-accounts"
"country":
"ARG"
"integration_method":
"API"
"data":{
"user_id":
"usr-2HPUYx0n9USSNwSkP5G0gY1I2TO"
"personal_data":{
...
}
"terms_data":{
...
}
}
}
Ejemplo de respuestas
{
"data":{
"id":
"iss-2lG0Yvy1fqyFX1ghT6kiAhrc2fR"
"created_at":
"2021-07-27T14:04:31-03:00"
"expiration_at":
"2021-07-28T14:04:31-03:00"
"url":
"https://identity.pomelo.com/session/iss- ..."
}
}

Subir Archivo

El endpoint identity/v1/sessions/{session_id}/entities/{user_id}/files/{type_document} se usará en conjunto con los de “Creación de Sesión”. El objetivo del mismo es poder subir los documentos respaldatorios que se necesitan dependiendo de cada tipo de sesión.

Los tipos de documentos soportados son:

Para Argentina

  • selfie: Foto del rostro de la persona que quiere validar la sesión.

  • identity-card-front: Foto del frente del documento de identidad.

  • identity-card-back: Foto del dorso del documento de identidad.

Para Brasil

  • selfie: Foto del rostro de la persona que quiere validar la sesión.

  • identity-card-front: Foto del frente del documento de identidad.

  • identity-card-back: Foto del dorso del documento de identidad.

  • driver-license-front: Foto del frente de la licencia de conducir.

  • driver-license-back: Foto del dorso de la licencia de conducir.

Parámetros disponibles
Body Parameters
filestring(format: binary)required
Aceptamos archivos de hasta 20MB
Path Parameters
session_idstring(format: uuid)required
Ejemplo: iss-123e4567e89b12d3a456
user_idstringrequired
Ejemplo: usr-2HPUYx0n9USSNwSkP5G0gY1I2TO
type_documentstringrequired
Ejemplo: identity-card-front
Enum: selfieidentity-card-frontidentity-card-backdriver-license-frontdriver-license-back
Detalle de respuestas

¿Te resultó útil esta sección?

POST/identity/v1/sessions/{session_id}/entities/{user_id}/files/{type_document}
{
"file":
"string"
}
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
Id de usuario
Ejemplo: usr-2HPUYx0n9USSNwSkP5G0gY1I2TO
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

Cancelar Sesión

El endpoint identity/v1/sessions/{session_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/{session_id}
Ejemplo de respuestas

Obtener Sesión

El endpoint identity/v1/sessions/{session_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
uuidrequired
Session ID
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

GET/identity/v1/sessions/{session_id}
Ejemplo de respuestas
{
"data":{
"id":
"123e4567-e89b-12d3-a456-426655440000"
"user_id":
"usr-2HPUYx0n9USSNwSkP5G0gY1I2TO"
"expiration_at":
"2021-07-28T14:04:31-03:00"
"created_at":
"2021-07-28T14:04:31-03:00"
"status":
"CREATED"
"steps":[
...
]
"failed_reasons":[
...
]
"flow_type":
"default"
}
}

Obtener Reporte de Sesión

El endpoint identity/v1/sessions/{session_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/{session_id}/report
Ejemplo de respuestas
{
"data":{
"id":
"id de la session"
"document_data":{
...
}
"person_data":{
...
}
"identity_proof":{
...
}
"manual_review":{
...
}
}
}

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=created_at,updated_at.

El ordenamiento por defecto será ascendente. Para especificar un orden descendente, deberás enviar el carácter '-' como prefijo del atributo. Por ejemplo: ?sort=created_at,-updated_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_REVIEWEXPIREDVERIFIED
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
sortstring
Ejemplo: -created_at
Enum: created_atupdated_at
Detalle de respuestas
dataarray
metaobject

¿Te resultó útil esta sección?

GET/identity/v1/sessions
Ejemplo de respuestas
{
"data":[
0:{
...
}
]
"meta":{
"filters":[
...
]
"pagination":{
...
}
}
}