KYC

The Identity service lets you manage your users’ onboarding process 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 Individuals, based on one of our validation flows, and returns a unique identifier for it.

Consideration about the API integration method

When this type of integration is used, the documents are uploaded with the following endpoint Upload File

Available parameters
Header Parameters
Authorizationstringrequired
Example: Bearer {access_token}
Body Parameters
flow_typestringrequired
Flow Type
Example: kyc-accounts
Enum: kyc-accounts
countrystringrequired
Example: ARG
Enum: ARGBRACHL
integration_methodstringrequired
Integration Method
Example: API
Enum: APIWEB
dataobjectrequired
Response details
dataobject

Was this section helpful to you?

POST/identity/v2/sessions
{
"flow_type":
"kyc-accounts"
"country":
"ARG"
"integration_method":
"API"
"data":{
"user_id":
"usr-2HPUYx0n9USSNwSkP5G0gY1I2TO"
"personal_data":{
...
}
"terms_data":{
...
}
}
}
Response examples
{
"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- ..."
}
}

Upload File

The identity/v1/sessions/{session_id}/entities/{user_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: Picture of the person's face who wants to validate the session.

  • identity-card-front: Photo of the front of the identity document.

  • identity-card-back: Photo of the back of the identity document.

For Brazil

selfie: Picture of the person's face who wants to validate the session.

  • identity-card-front: Photo of the front of the identity document.

  • identity-card-back: Photo of the back of the identity document.

  • driver-license-front: Photo of the front of the driver's license.

  • driver-license-back: Photo of the back of the driver's license.

Available parameters
Body Parameters
filestring(format: binary)required
We accept files up to 20MB
Path Parameters
session_idstring(format: uuid)required
Example: iss-123e4567e89b12d3a456
user_idstringrequired
Example: usr-2HPUYx0n9USSNwSkP5G0gY1I2TO
type_documentstringrequired
Example: identity-card-front
Enum: selfieidentity-card-frontidentity-card-backdriver-license-frontdriver-license-back
Response details

Was this section helpful to you?

POST/identity/v1/sessions/{session_id}/entities/{user_id}/files/{type_document}
{
"file":
"string"
}
Response examples
{}

Clear user in test environment

The endpoint /clean_validations allows you to “clear” user data in a test environment, so you can create a new version with the same document.

Considerations

You will have to specify the ID or document number of the user you want to clear. If you send them both, the user ID will be used as priority to clear data.

Available parameters
Header Parameters
Authorizationstringrequired
Example: Bearer {access_token}
Body Parameters
user_idstring
User ID
Example: usr-2HPUYx0n9USSNwSkP5G0gY1I2TO
document_idstring(format: int64)
DOCUMENT ID
Example: 2038199391
Response details

Was this section helpful to you?

POST/identity/v1/clean_validations
{
"user_id":
"<UserId>"
"document_id":
"<DNI or CPF>"
}
Response examples

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/{session_id}
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/{session_id}
Response examples
{
"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"
}
}

Obtaining a Session Report

The identity/v1/sessions/{session_id}/report endpoint lets you obtain a user's data collected 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/{session_id}/report
Response examples
{
"data":{
"id":
"id de la session"
"document_data":{
...
}
"person_data":{
...
}
"identity_proof":{
...
}
"manual_review":{
...
}
}
}

Search session

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

Considerations

Filters must be specified as parameters following this pattern: filter[field]=value. For example: filter[status]=IN_PROGRESS

The results will be paginated and you can specify the amount of data per page and also which page you wish to view.

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

Sorting

You can specify the order of the results with certain parameters that you must send as list of strings in the sort filter type. For example: ?sort=created_at,updated_at.

The default sorting will be ascending. To specify a descending sorting, you must send the character '-' as a prefix of the attribute. For example: ?sort=created_at,-updated_at.

If a parameter is incorrect or misspelled, it will return an error.

Available parameters
Header Parameters
Authorizationstringrequired
Example: Bearer {access_token}
Query Parameters
filter[user_id]string
filter[status]string
Example: CREATED
Enum: CREATEDIN_PROGRESSPROCESSINGREJECTEDNOT_VALIDATEDCANCELLEDMANUAL_REVIEWEXPIREDVERIFIED
filter[created_at][from]string
ISO 8601
Example: 1998-08-20
filter[created_at][to]string
ISO 8601
Example: 1998-08-20
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":{
...
}
}
}