Users

The Users API contains all the endpoints needed to manage the user bases. You can use it to create, update or even search for users within certain parameters.

Create user

The /users/v1/ endpoint allows you to create a new user in our database.

The number of parameters required to create a user varies depending on the product you have signed up for, but we will always ask you for email and operation_country.

General considerations

For the 'operation_country' and 'nationality' fields we expect a 3-character code respecting the ISO 3166 alpha-3 standard.
Here is a list of examples:

  • ARG
  • BRA
  • MEX
  • COL
  • PER
  • CHL

Considerations for repeat users

Cada usuario debe tener un email único, También debe ser única la combinación de tipo de documento de identidad y valor.

Considerations on the identity documents

For Argentina

The types of identity documents accepted are the following:

  • DNI
  • LE
  • LC
  • CI
  • PASSPORT

In the case of the DNI, we will validate that its extension is 7 or 8 characters.

The type of fiscal document accepted is the CUIL.

For Brazil

The types of identity documents accepted are the following:

  • RG
  • CNH

The type of fiscal document accepted is the CPF. We will validate that its extension is 11 characters.

For Mexico

The types of identity documents accepted are the following:

  • INE
  • PASSPORT

The type of tax document accepted is the RFC, but it will not be mandatory to include it.

For Colombia

The types of identity documents accepted are the following:

  • CC
  • CE
  • PASSPORT

El tipo de documento fiscal aceptado es el NIT. Validaremos que su extensión sea de 10 caracteres, pero no será obligatorio incluirlo.

Para Perú

The types of identity documents accepted are the following:

  • DNI
  • CE
  • PASSPORT

En el caso del DNI o CE, validaremos que su extensión sea de 9 caracteres

El tipo de documento fiscal aceptado es el RUC. Validaremos que su extensión sea de 11 caracteres.

For Argentina

If you operate in Argentina, the user’s legal address must be from one of these provinces:

  • Buenos Aires
  • Catamarca
  • Chaco
  • Chubut
  • Ciudad Autónoma de Buenos Aires
  • Corrientes
  • Córdoba
  • Entre Ríos
  • Formosa
  • Jujuy
  • La Pampa
  • La Rioja
  • Mendoza
  • Misiones
  • Neuquén
  • Río Negro
  • Salta
  • San Juan
  • San Luis
  • Santa Cruz
  • Santa Fe
  • Santiago del Estero
  • Tierra del Fuego
  • Tucumán

For Brazil

If you operate in Brazil, you must fill out the zipcode field with valid data, as we use it to determine the user's legal address.

For Mexico

If you operate in Mexico, there are no special requirements regarding the user's legal address fields.

Available parameters
Header Parameters
Authorizationstringrequired
Example: Bearer {access_token}
x-idempotency-keystringrequired
Unique ID on each request to use our idempotency schema.
Example: fRwX12Dg3345AD
Body Parameters
namestring
Pattern: ^[A-Za-zÀ-ÿ ]+$
Example: Diego
surnamestring
Pattern: ^[A-Za-zÀ-ÿ ]+$
Example: Pomelo
identification_typestring
Enum: DNILELCCIPASSPORT
identification_valuestring
Pattern: ^[A-Za-z\u00C0-\u00ff0-9 -.,]+$
birthdatestring
ISO 8601
Example: 1998-08-20
genderstring
Pattern: ^[A-Za-z\u00C0-\u00ff ]+$
Example: MALE
emailstringrequired
Pattern: [^@ \t\r\n][email protected][^@ \t\r\n]+\.[^@ \t\r\n]+
phonestring
Pattern: ^[0-9]+$
Example: 1123456789
tax_identification_typestring
Example: CUIL
Enum: CUIL
tax_identification_valuestring
Pattern: ^[A-Za-z\u00C0-\u00ff0-9 -.,]+$
nationalitystring
ISO 3166 alpha-3
Pattern: ^[A-Za-zÀ-ÿ ]+$
Example: ARG
legal_addressobject
operation_countrystringrequired
ISO 3166 alpha-3
Example: ARG
Response details
dataobject
Was this section helpful to you?
POST/users/v1/
{
"name":
"Diego"
"surname":
"Pomelo"
"identification_type":
"DNI"
"identification_value":
42345678
"birthdate":
"1998-08-20"
"gender":
"MALE"
"phone":
"1123456789"
"tax_identification_type":
"CUIL"
"tax_identification_value":
20423456789
"nationality":
"ARG"
"legal_address":{
"street_name":
"Av. Corrientes"
"street_number":
300
"floor":
1
"apartment":
"A"
"zip_code":
1414
"neighborhood":
"Villa Crespo"
"city":
"CABA"
"region":
"Buenos Aires"
"additional_info":
"Torre 2"
"country":
"ARG"
}
"operation_country":
"ARG"
}
Response examples

Search user

The /users/v1/ endpoint allows you to search for a group of users and receive a list sorted according to the parameters specified.

Considerations

Filters must be specified as parameters following this pattern: filter[campo]=valor. For example: /users/v1/?filter[status]=ACTIVE To filter an attribute for several possible values, separate the values with commas. Let's look at an example: filter[status]=ACTIVE,BLOCKED

The results are paginated and you can specify the amount of data per page and also which page to view using: page[number]=value and page[size]=value

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: ?filter[status]=ACTIVE&sort=status,gender

The default sorting will be ascending. To specify a descending sorting, you must send the character '-' as a prefix of the attribute. For example: /users/v1/?filter[status]=ACTIVE&sort=status,-gender

The possible sorting attributes are:

  • id
  • gender
  • identification_type
  • identification_value
  • status

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

Available parameters
Header Parameters
Authorizationstringrequired
Example: Bearer {access_token}
Query Parameters
filter[identification_value]string
filter[identification_type]string
Enum: DNILELCCIPASSPORTRGCNHINECE
filter[tax_identification_type]string
Enum: CUILCPFRFCNITRUC
filter[tax_identification_value]string
filter[gender]string
Enum: MALEFEMALE
filter[birthdate]string
ISO 8601
Example: 1998-08-20
filter[name]string
Example: Juan
filter[surname]string
Example: Rodriguez
filter[email]string
filter[status]string
filter[country_code]string
ISO 3166-1 alpha-3
page[size]number
Page size.
page[number]number
Page number The number on the first page is 0.
sortstring
Example: id,-name
Response details
dataarray
metaobject
Was this section helpful to you?
GET/users/v1/
Response examples

Get user

The /users/v1/{id} endpoint allows you to query a user’s information through their user_id.

Available parameters
Header Parameters
Authorizationstringrequired
Example: Bearer {access_token}
Path Parameters
idstringrequired
User ID
Response details
dataobject
Was this section helpful to you?
GET/users/v1/{id}
Response examples

Modify user

The endpoint /users/v1/{id} allows you to update a user’s information with their ID.

Considerations

To block a user you must send the status with the value BLOCKED and the value CLIENT_INTERNAL_REASON in the status_reason field.

To reactivate a user you have blocked, you will need to send status with value ACTIVE.

Considerations for repeat users

Each user must have a unique email, and the combination of identity document type and value must also be unique.

Considerations on the identity documents

For Argentina

The types of identity documents accepted are the following:

  • DNI
  • LE
  • LC
  • CI
  • PASSPORT

In the case of the DNI, we will validate that its extension is 7 or 8 characters.

The type of fiscal document accepted is the CUIL.

For Brazil

The types of identity documents accepted are the following:

  • RG
  • CNH

The type of fiscal document accepted is the CPF. We will validate that its extension is 11 characters.

For Mexico

The types of identity documents accepted are the following:

  • INE
  • PASSPORT

The type of tax document accepted is the RFC, but it will not be mandatory to include it.

For Argentina

If you operate in Argentina, the user’s legal address must be from one of these provinces:

  • Buenos Aires
  • Catamarca
  • Chaco
  • Chubut
  • Ciudad Autónoma de Buenos Aires
  • Corrientes
  • Córdoba
  • Entre Ríos
  • Formosa
  • Jujuy
  • La Pampa
  • La Rioja
  • Mendoza
  • Misiones
  • Neuquén
  • Río Negro
  • Salta
  • San Juan
  • San Luis
  • Santa Cruz
  • Santa Fe
  • Santiago del Estero
  • Tierra del Fuego
  • Tucumán

For Brazil

If you operate in Brazil, you must fill out the zipcode field with valid data, as we use it to determine the user's legal address.

For Mexico

If you operate in Mexico, there are no special requirements regarding the user's legal address fields.

Available parameters
Header Parameters
Authorizationstringrequired
Example: Bearer {access_token}
Body Parameters
namestring
Pattern: ^[A-Za-zÀ-ÿ ]+$
Example: Diego
surnamestring
Pattern: ^[A-Za-zÀ-ÿ ]+$
Example: Pomelo
identification_typestring
Enum: DNILELCCIPASSPORT
identification_valuestring
Pattern: ^[A-Za-z\u00C0-\u00ff0-9 -.,]+$
birthdatestring
ISO 8601
Example: 1998-08-20
genderstring
Pattern: ^[A-Za-z\u00C0-\u00ff ]+$
Example: MALE
emailstring
Pattern: [^@ \t\r\n][email protected][^@ \t\r\n]+\.[^@ \t\r\n]+
phonestring
Pattern: ^[0-9]+$
Example: 1123456789
tax_identification_typestring
Example: CUIL
Enum: CUIL
tax_identification_valuestring
Pattern: ^[A-Za-z\u00C0-\u00ff0-9 -.,]+$
nationalitystring
ISO 3166 alpha-3
Pattern: ^[A-Za-zÀ-ÿ ]+$
Example: ARG
statusstring
Enum: ACTIVEBLOCKED
status_reasonstring
Enum: CLIENT_INTERNAL_REASON
legal_addressobject
Path Parameters
idstringrequired
User ID
Response details
dataobject
Was this section helpful to you?
PATCH/users/v1/{id}
{
"name":
"Diego"
"surname":
"Pomelo"
"identification_type":
"DNI"
"identification_value":
42345678
"birthdate":
"1998-08-20"
"gender":
"MALE"
"phone":
"1123456789"
"tax_identification_type":
"CUIL"
"tax_identification_value":
20423456789
"nationality":
"ARG"
"status":
"ACTIVE"
"status_reason":
"CLIENT_INTERNAL_REASON"
"legal_address":{
"street_name":
"Av. Corrientes"
"street_number":
300
"floor":
1
"apartment":
"A"
"zip_code":
1414
"neighborhood":
"Villa Crespo"
"city":
"CABA"
"region":
"Buenos Aires"
"additional_info":
"Torre 2"
"country":
"ARG"
}
}
Response examples