Usuarios

La API de Usuarios contiene todos los endpoints necesarios para administrar las bases de usuarios. Podrás usarla para crear, actualizar o incluso buscar usuarios bajo determinados parámetros.

Crear Usuario

El endpoint /users/v1/ te permite crear un nuevo usuario en nuestra base de datos.

La cantidad de parámetros requeridos para crear un usuario varía dependiendo del producto que hayas contratado, pero siempre te pediremos email y operation_country.

Consideraciones generales

Para los campos operation_country y nationality esperamos un código de 3 caracteres respetando el estándar ISO 3166 alpha-3.
Dejamos una lista de ejemplos:

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

Consideraciones sobre usuarios repetidos

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

Consideraciones sobre los documentos de identidad a utilizar

Para Argentina

Los tipos de documento de identidad aceptados son los siguientes:

  • DNI
  • LE
  • LC
  • CI
  • PASSPORT

En el caso del DNI, validaremos que su extensión sea de 7 u 8 caracteres.

El tipo de documento fiscal aceptado es:

  • CUIL

En el caso del CUIL, validaremos que los primeros dos dígitos sean 20, 23, 24, 27, 30, 33 o 34 y que su extensión sea de exactamente 11 caracteres

Para Brasil

Los tipos de documento de identidad aceptados son los siguientes:

  • RG
  • CNH

El tipo de documento fiscal aceptado es:

  • CPF

En el caso de CPF, validaremos que su extensión sea de exactamente 11 caracteres.

Para México

Los tipos de documento de identidad aceptados son los siguientes:

  • INE
  • PASSPORT

El documento fiscal no es obligatorio incluirlo, pero el tipo aceptado es:

  • RFC

En el caso de INE, validaremos que su extensión sea de 12 o 13 caracteres.

Para Colombia

Los tipos de documento de identidad aceptados son los siguientes:

  • CC
  • CE
  • PPT
  • PASSPORT

Para CC validaremos que su extensión sea entre 5 y 11 caracteres.

Para CE validaremos que su extensión sea entre 6 y 7 caracteres.

Para PPT validaremos que su extensión sea entre 1 y 8 caracteres.

El documento fiscal no es obligatorio incluirlo, pero el tipo aceptado es:

  • NIT

En el caso del NIT, validaremos que su extensión sea de exactamente 10 caracteres.

Para Perú

Los tipos de documento de identidad aceptados son los siguientes:

  • DNI
  • CE
  • PASSPORT

En el caso del DNI, validaremos que su extensión sea de exactamente 8 caracteres, todos numéricos

En el caso del CE, validaremos que su extensión sea de hasta 12 caracteres alfanuméricos

El tipo de documento fiscal aceptado es:

  • RUC

En el caso del RUC, validaremos que los primeros dos dígitos sean 10, 15 o 17 y que su extensión sea de 11 dígitos.

Para Chile

Los tipos de documento de identidad aceptados son los siguientes:

  • CI

En el caso del CI, validaremos que su extensión sea entre 8 y 11 caracteres.

El tipo de documento fiscal aceptado es:

  • RUT

En el caso del RUT, validaremos que su extensión sea de exactamente 9 caracteres, 8 dígitos y un caracter verificador, el cual puede ser un dígito o una letra k.

Consideraciones sobre el domicilio legal

Para Argentina

Si operas en Argentina, el domicilio legal del usuario tendrá que ser de alguna de estas provincias:

  • 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

Para Brasil

Si operas en Brasil, deberás completar el campo zipcode con un dato válido, ya que lo usaremos para determinar la dirección legal del usuario.

Para México

En caso que el país de operatoria sea México, no existe ningún requisito especial respecto a los campos de dirección legal del usuario.

Para Chile

En caso que el país de operatoria sea Chile, no existe ningún requisito especial respecto a los campos de dirección legal del usuario.

Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
x-idempotency-keystringrequired
ID único en cada request para utilizar nuestro esquema de idempotencia.
Ejemplo: fRwX12Dg3345AD
Body Parameters
namestring(maxLength: 100)
Pattern: ^[A-Za-zÀ-ÿ ]+$
Ejemplo: Diego
surnamestring(maxLength: 100)
Pattern: ^[A-Za-zÀ-ÿ ]+$
Ejemplo: Pomelo
identification_typestring
Enum: DNILELCCIPASSPORT
identification_valuestring(maxLength: 255)
Pattern: ^[A-Za-zÀ-ÿ0-9 -.,]+$
Ejemplo: 42345678
birthdatestring
ISO 8601
Ejemplo: 1998-08-20
genderstring(maxLength: 40)
Pattern: ^[A-Za-zÀ-ÿ ]+$
Ejemplo: MALE
emailstring(maxLength: 255)required
Pattern: [^@ \t\r\n]+@[^@ \t\r\n]+\.[^@ \t\r\n]+
Ejemplo: [email protected]
phonestring(maxLength: 255)
Pattern: ^[0-9]+$
Ejemplo: 1123456789
tax_identification_typestring
Ejemplo: CUIL
Enum: CUIL
tax_identification_valuestring
Pattern: ^[A-Za-zÀ-ÿ0-9 -.,]+$
Ejemplo: 20423456789
nationalitystring
ISO 3166 alpha-3
Pattern: ^[A-Za-zÀ-ÿ ]+$
Ejemplo: ARG
legal_addressobject
operation_countrystringrequired
ISO 3166 alpha-3
Ejemplo: ARG
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

POST/users/v1/
{
"name":
"Diego"
"surname":
"Pomelo"
"identification_type":
"DNI"
"identification_value":
42345678
"birthdate":
"1998-08-20"
"gender":
"MALE"
"email":
"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"
}
Ejemplo de respuestas
{
"data":{
"id":
"usr-203c6jQq0O3nVWXj6jRUQXy7QkC"
"name":
"Diego"
"surname":
"Pomelo"
"identification_type":
"DNI"
"identification_value":
42345678
"birthdate":
"1998-08-20"
"gender":
"MALE"
"email":
"phone":
"1123456789"
"tax_identification_type":
"CUIL"
"tax_identification_value":
20423456789
"nationality":
"ARG"
"status":
"ACTIVE"
"operation_country":
"ARG"
"legal_address":{
...
}
}
}

Buscar Usuarios

El endpoint /users/v1/ te permite buscar un grupo de usuarios y recibir una lista ordenada en base a los parámetros especificados.

Consideraciones

Tendrás que especificar tus filtros como parámetros siguiendo este patrón: filter[campo]=valor. Por ejemplo: /users/v1/?filter[status]=ACTIVE Para filtrar un atributo con varios valores posibles, deberás separar los valores con comas. Veamos un ejemplo: filter[status]=ACTIVE,BLOCKED

Los resultados serán paginados y podrás especificar la cantidad de datos por página y también qué página ver utilizando: page[number]=valor y page[size]=valor

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

El ordenamiento por defecto será ascendente. Para especificar un orden descendente, deberás enviar el carácter '-' como prefijo del atributo. Por ejemplo: /users/v1/?filter[status]=ACTIVE&sort=status,-gender

Los posibles atributos para ordenar son:

  • id
  • gender
  • identification_type
  • identification_value
  • status

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[identification_value]string
filter[identification_type]string
Enum: DNILELCCIPASSPORTRGCNHINECECCPPT
filter[tax_identification_type]string
Enum: CUILCPFRFCNITRUC
filter[tax_identification_value]string
filter[gender]string
Enum: MALEFEMALE
filter[birthdate]string
ISO 8601
Ejemplo: 1998-08-20
filter[name]string
Ejemplo: Juan
filter[surname]string
Ejemplo: Rodriguez
filter[email]string
Ejemplo: [email protected]
filter[status]string
filter[country_code]string
ISO 3166-1 alpha-3
filter[company_id]string(format: uuid)
Ejemplo: cmp-123e4567e89b12d3a456
page[size]number
Tamaño de página.
page[number]number
Número de página. El número de la primer página es 0.
sortstring
Ejemplo: id,-name
Detalle de respuestas
dataarray
metaobject

¿Te resultó útil esta sección?

GET/users/v1/
Ejemplo de respuestas
{
"data":[
0:{
...
}
]
"meta":{
"pagination":{
...
}
"filter":[
...
]
}
}

Obtener Usuario

El endpoint de /users/v1/{id} te permite consultar la información de un usuario a través de su id.

Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Path Parameters
idstringrequired
Id de usuario
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

GET/users/v1/{id}
Ejemplo de respuestas
{
"data":{
"id":
"usr-203c6jQq0O3nVWXj6jRUQXy7QkC"
"name":
"Diego"
"surname":
"Pomelo"
"identification_type":
"DNI"
"identification_value":
42345678
"birthdate":
"1998-08-20"
"gender":
"MALE"
"email":
"phone":
"1123456789"
"tax_identification_type":
"CUIL"
"tax_identification_value":
20423456789
"nationality":
"ARG"
"status":
"ACTIVE"
"operation_country":
"ARG"
"legal_address":{
...
}
}
}

Modificar Usuario

El endpoint /users/v1/{id} permite actualizar la información de un usuario a través de su id.

Consideraciones

Para bloquear un usuario deberás enviar el status con el valor BLOCKED y el valor CLIENT_INTERNAL_REASON en el campo status_reason.

Para reactivar un usuario que bloqueaste, deberás enviar status con valor ACTIVE.

Consideraciones sobre usuarios repetidos

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

Consideraciones sobre los documentos de identidad a utilizar

Para Argentina

Los tipos de documento de identidad aceptados son los siguientes:

  • DNI
  • LE
  • LC
  • CI
  • PASSPORT

En el caso del DNI, validaremos que su extensión sea de 7 u 8 caracteres.

El tipo de documento fiscal aceptado es:

  • CUIL

En el caso del CUIL, validaremos que los primeros dos dígitos sean 20, 23, 24, 27, 30, 33 o 34 y que su extensión sea de exactamente 11 caracteres

Para Brasil

Los tipos de documento de identidad aceptados son los siguientes:

  • RG
  • CNH

El tipo de documento fiscal aceptado es:

  • CPF

En el caso de CPF, validaremos que su extensión sea de exactamente 11 caracteres.

Para México

Los tipos de documento de identidad aceptados son los siguientes:

  • INE
  • PASSPORT

El documento fiscal no es obligatorio incluirlo, pero el tipo aceptado es:

  • RFC

Para Colombia

Los tipos de documento de identidad aceptados son los siguientes:

  • CC
  • CE
  • PPT
  • PASSPORT

Para CC validaremos que su extensión sea entre 5 y 11 caracteres.

Para CE validaremos que su extensión sea entre 6 y 7 caracteres.

Para PPT validaremos que su extensión sea entre 1 y 8 caracteres.

El documento fiscal no es obligatorio incluirlo, pero el tipo aceptado es:

  • NIT

En el caso del NIT, validaremos que su extensión sea de exactamente 10 caracteres.

Para Perú

Los tipos de documento de identidad aceptados son los siguientes:

  • DNI
  • CE
  • PASSPORT

En el caso del DNI, validaremos que su extensión sea de exactamente 8 caracteres, todos numéricos

En el caso del CE, validaremos que su extensión sea de hasta 12 caracteres alfanuméricos

El tipo de documento fiscal aceptado es:

  • RUC

En el caso del RUC, validaremos que los primeros dos dígitos sean 10, 15 o 17 y que su extensión sea de 11 dígitos.

Para Chile

Los tipos de documento de identidad aceptados son los siguientes:

  • CI

En el caso del CI, validaremos que su extensión sea entre 8 y 11 caracteres.

El tipo de documento fiscal aceptado es:

  • RUT

En el caso del RUT, validaremos que su extensión sea de exactamente 9 caracteres, 8 dígitos y un caracter verificador, el cual puede ser un dígito o una letra k.

Consideraciones sobre el domicilio legal

Para Argentina

Si operas en Argentina, el domicilio legal del usuario tendrá que ser de alguna de estas provincias:

  • 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

Para Brasil

Si operas en Brasil, deberás completar el campo zipcode con un dato válido, ya que lo usaremos para determinar la dirección legal del usuario.

Para México

En caso que el país de operatoria sea México, no existe ningún requisito especial respecto a los campos de dirección legal del usuario.

Para Chile

En caso que el país de operatoria sea Chile, no existe ningún requisito especial respecto a los campos de dirección legal del usuario.

Parámetros disponibles
Header Parameters
Authorizationstringrequired
Ejemplo: Bearer {access_token}
Body Parameters
namestring(maxLength: 100)
Pattern: ^[A-Za-zÀ-ÿ ]+$
Ejemplo: Diego
surnamestring(maxLength: 100)
Pattern: ^[A-Za-zÀ-ÿ ]+$
Ejemplo: Pomelo
identification_typestring
Enum: DNILELCCIPASSPORT
identification_valuestring(maxLength: 255)
Pattern: ^[A-Za-zÀ-ÿ0-9 -.,]+$
Ejemplo: 42345678
birthdatestring
ISO 8601
Ejemplo: 1998-08-20
genderstring(maxLength: 40)
Pattern: ^[A-Za-zÀ-ÿ ]+$
Ejemplo: MALE
emailstring(maxLength: 255)
Pattern: [^@ \t\r\n]+@[^@ \t\r\n]+\.[^@ \t\r\n]+
Ejemplo: [email protected]
phonestring(maxLength: 255)
Pattern: ^[0-9]+$
Ejemplo: 1123456789
tax_identification_typestring
Ejemplo: CUIL
Enum: CUIL
tax_identification_valuestring
Pattern: ^[A-Za-zÀ-ÿ0-9 -.,]+$
Ejemplo: 20423456789
nationalitystring
ISO 3166 alpha-3
Pattern: ^[A-Za-zÀ-ÿ ]+$
Ejemplo: ARG
statusstring
Enum: ACTIVEBLOCKED
status_reasonstring
Enum: CLIENT_INTERNAL_REASON
legal_addressobject
Path Parameters
idstringrequired
Id de usuario
Detalle de respuestas
dataobject

¿Te resultó útil esta sección?

PATCH/users/v1/{id}
{
"name":
"Diego"
"surname":
"Pomelo"
"identification_type":
"DNI"
"identification_value":
42345678
"birthdate":
"1998-08-20"
"gender":
"MALE"
"email":
"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"
}
}
Ejemplo de respuestas
{
"data":{
"id":
"usr-203c6jQq0O3nVWXj6jRUQXy7QkC"
"name":
"Diego"
"surname":
"Pomelo"
"identification_type":
"DNI"
"identification_value":
42345678
"birthdate":
"1998-08-20"
"gender":
"MALE"
"email":
"phone":
"1123456789"
"tax_identification_type":
"CUIL"
"tax_identification_value":
20423456789
"nationality":
"ARG"
"status":
"ACTIVE"
"operation_country":
"ARG"
"legal_address":{
...
}
}
}