KYB

The Identity service lets you manage the onboarding process of companies, partners and employees in a flexible and simple manner, confirming their identity and preventing fraud.

Create session

The identity/v2/sessions endpoint allows you to create a new identity validation session for Legal Entities, based on one of our validation flows, and returns a unique identifier for it.

Available parameters
Header Parameters
Authorizationstringrequired
Example: Bearer {access_token}
Body Parameters
flow_typestringrequired
Flow Type
Example: kyb-cards
Enum: kyb-cardskyb-accountskyb-cards-additional
countrystringrequired
Example: BRA
Enum: BRAARG
integration_methodstringrequired
Integration Method
Example: API
Enum: API
dataobjectrequired
Response details
dataobject

Was this section helpful to you?

POST/identity/v2/sessions
{
"flow_type":
"kyb-cards"
"country":
"BRA"
"integration_method":
"API"
"data":{
"company":{
...
}
"partners":[
...
]
"terms_data":{
...
}
}
}
Response examples
{
"data":{
"id":
"iss-2l4awXX6xyZVcwp0xegBFr6ACu6"
"created_at":
"2021-07-27T14:04:31-03:00"
"expiration_at":
"2021-07-28T14:04:31-03:00"
}
}

Create session - Additional

The identity/v2/sessions endpoint allows you to create a new identity validation session for natural persons (employee), associated with the Company which was previously validated.

Available parameters
Header Parameters
Authorizationstringrequired
Example: Bearer {access_token}
Body Parameters
flow_typestringrequired
Flow Type
Example: kyb-cards-additional
Enum: kyb-cards-additionalkyb-cardskyb-accounts
countrystringrequired
Example: BRA
Enum: BRAARG
integration_methodstringrequired
Integration Method
Example: API
Enum: API
dataobjectrequired
Response details
dataobject

Was this section helpful to you?

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":{
...
}
}
}
Response examples
{
"data":{
"id":
"iss-2l4awXX6xyZVcwp0xegBFr6ACu6"
"created_at":
"2021-07-27T14:04:31-03:00"
"expiration_at":
"2021-07-28T14:04:31-03:00"
}
}

Upload File

The identity/v1/sessions/{session_id}/entities/{user_id or company_id}/files/{type_document} endpoint will be used with the “Session Creation” ones. The purpose is to be able to upload the supporting documents that are needed depending on each type of session.

The supported documents are:

For Argentina

  • selfie: photo of the person's face requesting session validation.

  • identity-card-front: frontal photo of the identification document.

  • identity-card-back: backside photo of the identification document.

  • company-document: according to the Company type, different types of documentation will be required.

For Brazil

  • selfie: photo of the person's face requesting session validation.

  • identity-card-front: frontal photo of the identification document.

  • identity-card-back: backside photo of the identification document.

  • driver-license-front: frontal photo of the driver's license.

  • driver-license-back: backside photo of the driver's license.

  • company-document: Articles of incorporation, statute, subscription bulletin, Articles of incorporation with sworn translation or updated document with a registration that proves the constitution of the company.

Available parameters
Body Parameters
filestring(format: binary)required
We accept files up to 20MB
Path Parameters
user_idstring(format: uuid)required
Example: usr-123e4567e89b12d3a456
company_idstring(format: uuid)required
Example: cmp-123e4567e89b12d3a456
type_documentstringrequired
Example: selfie
Enum: selfieidentity-card-frontidentity-card-backdriver-license-frontdriver-license-backcompany-document

Was this section helpful to you?

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

Cancel Session

The identity/v1/sessions/{session_id} endpoint lets you cancel an identity validation session.
Available parameters
Header Parameters
Authorizationstringrequired
Example: Bearer {access_token}
Path Parameters
uuidstring(format: uuid)required
Session ID
Response details

Was this section helpful to you?

DELETE/identity/v1/sessions/{uuid}
Response examples

Get session

The identity/v1/session/{session_id} endpoint lets you get data from an identity validation session.
Available parameters
Header Parameters
Authorizationstringrequired
Example: Bearer {access_token}
Path Parameters
uuidrequired
Session ID
Response details
dataobject

Was this section helpful to you?

GET/identity/v1/sessions/{uuid}
Response examples
{
"data":{
"id":
"123e4567-e89b-12d3-a456-426655440000"
"client_id":
"cli-1zmhPjOD2CAdCZ0Cw0dfZjp2R8F"
"operation_country":
"BRA"
"type":
"business"
"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"
}
}

Obtaining a Session Report

The identity/v1/sessions/{session_id}/report endpoint lets you obtain the data collected from company in an identity validation session.

Available parameters
Header Parameters
Authorizationstringrequired
Example: Bearer {access_token}
Path Parameters
uuidstringrequired
Response details
dataobject

Was this section helpful to you?

GET/identity/v1/sessions/{uuid}/report
Response examples
{
"data":{
"id":
"id de la session"
"company_data":{
...
}
"documentation_request":[
...
]
"documentation_proof":[
...
]
"partners":[
...
]
}
}

Search session

The /sessions endpoint allow you to perform a search with specific filters.

Date range

There is a filter for the created_at field, which can be used to get sessions created within a date range. For example: filter[created_at][from]=2021-07-27&filter[created_at][to]=2021-07-28

Available parameters
Header Parameters
Authorizationstringrequired
Example: Bearer {access_token}
Query Parameters
filter[user_id]string
Example: usr-34535dg-er2vd-234vsd234
filter[company_id]string
Example: cmp-35bdg35-er2vd-fgddf35d2
filter[type]string
Example: BUSINESS
Enum: BUSINESSCUSTOMER
filter[status]string
Example: CREATED
Enum: CREATEDIN_PROGRESSPROCESSINGREJECTEDNOT_VALIDATEDCANCELLEDMANUAL_REVIEWVERIFIED
filter[created_at][from]string
ISO 8601
Example: 1998-08-20
filter[created_at][to]string
ISO 8601
Example: 1998-08-20
filter[sort]string
Enum: user_idstatuscreated_at
page[size]number
page[number]number
sortstring
Example: -created_at
Enum: created_atupdated_at
Response details
dataarray
metaobject

Was this section helpful to you?

GET/identity/v1/sessions
Response examples
{
"data":[
0:{
...
}
]
"meta":{
"filters":[
...
]
"pagination":{
...
}
}
}