KYB

El servicio de Identity te permite gestionar el proceso de onboarding de empresas, socios y empleados de una manera ágil y sencilla, confirmando su identidad y ayudando a prevenir fraudes.

Crear Sesión

El endpoint identity/v2/sessions permite crear una nueva sesión de validación de identidad para Personas Jurídicas, basada en alguno de nuestros flujos de validación, y te devuelve un identificador único de la misma.

Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Body Parameters
flow_typestringrequired
Flow Type
Ejemplo: kyb-cards
Enum: kyb-cardskyb-accountskyb-cards-additional
countrystringrequired
Ejemplo: BRA
Enum: BRAARG
integration_methodstringrequired
Integration Method
Ejemplo: API
Enum: API
dataobjectrequired
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/identity/v2/sessions
{
"flow_type":
"kyb-cards"
"country":
"BRA"
"integration_method":
"API"
"data":{
"company":{
...
}
"partners":[
...
]
}
}
Ejemplo de respuestas
{
"data":{
"id":
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
"created_at":
"2021-07-27T14:04:31-03:00"
"expiration_at":
"2021-07-28T14:04:31-03:00"
}
}

Crear Sesión - Adicionales

El endpoint identity/v2/sessions permite crear una nueva sesión de validación de identidad para Personas Físicas (Empleados), asociadas a la Compañía qué previamente se tuvo que validar.

Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Body Parameters
flow_typestringrequired
Flow Type
Ejemplo: kyb-cards-additional
Enum: kyb-cards-additionalkyb-cardskyb-accounts
countrystringrequired
Ejemplo: BRA
Enum: BRAARG
integration_methodstringrequired
Integration Method
Ejemplo: API
Enum: API
dataobjectrequired
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/identity/v2/sessions
{
"flow_type":
"kyb-cards-additional"
"country":
"BRA"
"integration_method":
"API"
"data":{
"company_id":
"cmp-f3d23x0n9USSNwSkP5G0gY1I2TO"
"user_id":
"usr-2HPUYx0n9USSNwSkP5G0gY1I2TO"
"personal_data":{
...
}
}
}
Ejemplo de respuestas
{
"data":{
"id":
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
"created_at":
"2021-07-27T14:04:31-03:00"
"expiration_at":
"2021-07-28T14:04:31-03:00"
}
}

Subir Archivo

El endpoint identity/v1/sessions/{session_id}/entities/{user_id or company_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 del 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.

  • company-document: dependiendo el tipo de Company, se requerirá diferente tipo de documentación.

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.

  • company-document: Contrato social, estatuto, boletín de suscripción, Contrato Social con traducción jurada o documento actualizado con registro que acredite la constitución de la sociedad.

Parámetros disponibles
Body Parameters
filestring(format: binary)required
Aceptamos archivos de hasta 20MB
Path Parameters
user_idstring(format: uuid)required
Ejemplo: usr-123e4567e89b12d3a456
company_idstring(format: uuid)required
Ejemplo: cmp-123e4567e89b12d3a456
type_documentstringrequired
Ejemplo: selfie
Enum: selfieidentity-card-frontidentity-card-backdriver-license-frontdriver-license-backcompany-document

¿Te resultó útil esta sección?

POST/identity/v1/sessions/{uuid}/entities/{user_id|company_id}/files/{type_document}
{
"file":
"string"
}
Ejemplo de respuestas
"ERROR":{
"message":
"src property must be a valid json object"
}

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/{uuid}
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/{uuid}
Ejemplo de respuestas
{
"data":{
"id":
"123e4567-e89b-12d3-a456-426655440000"
"user_id":
"usr-123e4567e89b12d3a456"
"company_id":
"cmp-123e4567e89b12d3a456"
"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":
"kyb-banking"
}
}

Obtener Reporte de Sesión

El endpoint identity/v1/sessions/{session_id}/report te permite obtener los datos recabados de una compañia 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
{
"data":{
"id":
"id de la session"
"company_data":{
...
}
"documentation_request":[
...
]
"documentation_proof":[
...
]
"partners":[
...
]
}
}

Buscar Sesiones

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

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

Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Query Parameters
filter[user_id]string
Ejemplo: usr-34535dg-er2vd-234vsd234
filter[company_id]string
Ejemplo: cmp-35bdg35-er2vd-fgddf35d2
filter[type]string
Ejemplo: BUSINESS
Enum: BUSINESSCUSTOMER
filter[status]string
Ejemplo: CREATED
Enum: CREATEDIN_PROGRESSPROCESSINGREJECTEDNOT_VALIDATEDCANCELLEDMANUAL_REVIEWVERIFIED
filter[created_at][from]string
ISO 8601
Ejemplo: 1998-08-20
filter[created_at][to]string
ISO 8601
Ejemplo: 1998-08-20
filter[sort]string
Enum: user_idstatuscreated_at
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":{
...
}
}
}