Usuários

A API de Usuários contém todos os endpoints necessários para administrar a base de usuários. É possível usá-la para criar, atualizar ou até mesmo pesquisar usuários sob determinados parâmetros.

Criar usuário

O endpoint /users/v1/ permite criar um novo usuário em nosso banco de dados.

O número de parâmetros necessários para criar um usuário varia de acordo com o produto que você contratou, mas sempre solicitaremos o e-mail e operation_country.

Considerações gerais

Para os campos operation_country e nationality, esperamos um código de 3 caracteres, respeitando o padrão ISO 3166 alpha-3.
Deixamos uma lista de exemplos:

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

Considerações sobre usuários repetidos

Cada usuário deve ter um e-mail único. A combinação de tipo de documento de identidade e valor também deve ser única.

Considerações sobre os documentos de identidade

Para Argentina

Os tipos de documento de identidade aceitos são os seguintes:

  • DNI
  • LE
  • LC
  • CI
  • PASSPORT

No caso do DNI, validaremos que sua extensão é de 7 ou 8 caracteres.

O tipo de documento fiscal aceito é o:

  • CUIL

No caso do CUIL, validaremos que os dois primeiros dígitos sejam 20, 23, 24, 27, 30, 33 ou 34 e que seu tamanho seja de exatamente 11 caracteres

Para o Brasil

Os tipos de documento de identidade aceitos são os seguintes:

  • RG
  • CNH

O tipo de documento fiscal aceito é o:

  • CPF

No caso do CPF, validaremos que seu tamanho seja de exatamente 11 caracteres.

Para o México

Os tipos de documento de identidade aceitos são os seguintes:

  • INE
  • PASSPORT

Não é obrigatório incluir o documento fiscal, mas o tipo aceito é:

  • RFC

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

Para a Colômbia

Os tipos de documento de identidade aceitos são os seguintes:

  • CC
  • CE
  • PPT
  • PASSPORT

Para CC, validaremos sua extensão com número de caracteres entre 5 e 11.

Para CE, validaremos que sua extensão seja entre 6 e 7 caracteres.

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

Não é obrigatório incluir o documento fiscal, mas o tipo aceito é:

  • NIT

No caso do NIT, validaremos que seu tamanho seja de exatamente 10 caracteres.

Para o Peru

Os tipos de documento de identidade aceitos são os seguintes:

  • DNI
  • CE
  • PASSPORT

No caso do DNI, verificaremos se possui exatamente 8 caracteres, todos numéricos

No caso do CE, verificaremos se possui até 12 caracteres alfanuméricos

O tipo de documento fiscal aceito é o:

  • RUC

No caso do RUC, validaremos que os dois primeiros dígitos sejam 10, 15 ou 17 e que seu tamanho seja de 11 dígitos.

Para o Chile

Os tipos de documento de identidade aceitos são os seguintes:

  • CI

No caso do CI, validaremos que sua extensão é de 8 ou 11 caracteres.

O tipo de documento fiscal aceito é o:

  • RUT

No caso da RUT, validaremos se sua extensão tem exatamente 9 caracteres, 8 dígitos e um caractere de verificação, que pode ser um dígito ou uma letra k.

Considerações sobre endereço legal

Para Argentina

Se você opera na Argentina, o endereço legal do usuário deve ser de uma das seguintes províncias:

  • 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 o Brasil

Se você opera no Brasil, precisará preencher o campo zipcode com dados válidos, pois vamos usá-los para determinar o endereço legal do usuário.

Para o México

Se você opera no México, não há requisitos especiais em relação aos campos de endereço legal do usuário.

Para o Chile

Caso o país de operação seja o Chile, não há nenhum requisito especial em relação aos campos de endereço legal do usuário.

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
x-idempotency-keystringrequired
ID exclusiva em cada solicitação para utilizar nosso esquema de idempotência.
Exemplo: fRwX12Dg3345AD
Body Parameters
namestring(maxLength: 100)
Pattern: ^[A-Za-zÀ-ÿ ]+$
Exemplo: Diego
surnamestring(maxLength: 100)
Pattern: ^[A-Za-zÀ-ÿ ]+$
Exemplo: Pomelo
identification_typestring
Enum: DNILELCCIPASSPORT
identification_valuestring(maxLength: 255)
Pattern: ^[A-Za-zÀ-ÿ0-9 -.,]+$
Exemplo: 42345678
birthdatestring
ISO 8601
Exemplo: 1998-08-20
genderstring(maxLength: 40)
Pattern: ^[A-Za-zÀ-ÿ ]+$
Exemplo: MALE
emailstring(maxLength: 255)required
Pattern: [^@ \t\r\n]+@[^@ \t\r\n]+\.[^@ \t\r\n]+
Exemplo: [email protected]
phonestring(maxLength: 255)
Pattern: ^[0-9]+$
Exemplo: 1123456789
tax_identification_typestring
Exemplo: CUIL
Enum: CUIL
tax_identification_valuestring
Pattern: ^[A-Za-zÀ-ÿ0-9 -.,]+$
Exemplo: 20423456789
nationalitystring
ISO 3166 alpha-3
Pattern: ^[A-Za-zÀ-ÿ ]+$
Exemplo: ARG
legal_addressobject
operation_countrystringrequired
ISO 3166 alpha-3
Exemplo: ARG
Detalhe de respostas
dataobject

Esta seção foi útil para você?

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"
}
Respostas de amostra
{
"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 usuários

O endpoint /users/v1/ permite buscar um grupo de usuários e receber uma lista ordenada com base nos parâmetros especificados.

Considerações

Será necessário especificar os filtros desejados como parâmetros de acordo com o seguinte padrão: filter[campo]=valor. Por exemplo: /users/v1/?filter[status]=ACTIVE Para filtrar um atributo com vários valores possíveis, você deve separar os valores com vírgulas. Vejamos um exemplo: filter[status]=ACTIVE,BLOCKED

Os resultados serão apresentados por página e é possível especificar a quantidade de dados por página usando page[size]=valor e o número de página a ser exibido utilizando page[number]=valor

Ordenação

É possível especificar a ordem dos resultados com certos parâmetros que deverão ser enviados como uma lista de strings no filtro do tipo sort. Por exemplo: ?filter[status]=ACTIVE&sort=status,gender

A ordenação padrão será crescente. Para especificar uma ordem decrescente, deve-se enviar o caractere '-' como prefixo do atributo. Por exemplo: /users/v1/?filter[status]=ACTIVE&sort=status,-gender

Os atributos que podem ser ordenados são:

  • id
  • gender
  • identification_type
  • identification_value
  • status

Se um parâmetro estiver errado ou mal redigido, responderemos com um erro.

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: 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
Exemplo: 1998-08-20
filter[name]string
Exemplo: Juan
filter[surname]string
Exemplo: Rodriguez
filter[email]string
Exemplo: [email protected]
filter[status]string
filter[country_code]string
ISO 3166-1 alpha-3
filter[company_id]string(format: uuid)
Exemplo: cmp-123e4567e89b12d3a456
page[size]number
Tamanho de página.
page[number]number
Número de página. O número da primeira página é 0.
sortstring
Exemplo: id,-name
Detalhe de respostas
dataarray
metaobject

Esta seção foi útil para você?

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

Obter usuário

O endpoint de /users/v1/{id} permite consultar as informações de um usuário por meio do seu Id.

Parâmetros disponíveis
Header Parameters
Authorizationstringrequired
Exemplo: Bearer {access_token}
Path Parameters
idstringrequired
ID do usuário
Detalhe de respostas
dataobject

Esta seção foi útil para você?

GET/users/v1/{id}
Respostas de amostra
{
"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 usuário

O endpoint '/users/v1/{id}' permite atualizar as informações de um usuário por meio do seu ID.

Considerações

Para bloquear um usuário você deve enviar o status com o valor BLOCKED e o valor CLIENT_INTERNAL_REASON no campo status_reason.

Para reativar um usuário que você bloqueou, você precisará enviar status com valor ACTIVE.

Considerações sobre usuários repetidos

Cada usuário deve ter um e-mail único. A combinação de tipo de documento de identidade e valor também deve ser única.

Considerações sobre os documentos de identidade

Para Argentina

Os tipos de documento de identidade aceitos são os seguintes:

  • DNI
  • LE
  • LC
  • CI
  • PASSPORT

No caso do DNI, validaremos que sua extensão é de 7 ou 8 caracteres.

O tipo de documento fiscal aceito é o:

  • CUIL

No caso do CUIL, validaremos que os dois primeiros dígitos sejam 20, 23, 24, 27, 30, 33 ou 34 e que seu tamanho seja de exatamente 11 caracteres

Para o Brasil

Os tipos de documento de identidade aceitos são os seguintes:

  • RG
  • CNH

O tipo de documento fiscal aceito é o:

  • CPF

No caso do CPF, validaremos que seu tamanho seja de exatamente 11 caracteres.

Para o México

Os tipos de documento de identidade aceitos são os seguintes:

  • INE
  • PASSPORT

Não é obrigatório incluir o documento fiscal, mas o tipo aceito é:

  • RFC

Para a Colômbia

Os tipos de documento de identidade aceitos são os seguintes:

  • CC
  • CE
  • PPT
  • PASSPORT

Para CC, validaremos sua extensão com número de caracteres entre 5 e 11.

Para CE, validaremos que sua extensão seja entre 6 e 7 caracteres.

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

Não é obrigatório incluir o documento fiscal, mas o tipo aceito é:

  • NIT

No caso do NIT, validaremos que seu tamanho seja de exatamente 10 caracteres.

Para o Peru

Os tipos de documento de identidade aceitos são os seguintes:

  • DNI
  • CE
  • PASSPORT

No caso do DNI, verificaremos se possui exatamente 8 caracteres, todos numéricos

No caso do CE, verificaremos se possui até 12 caracteres alfanuméricos

O tipo de documento fiscal aceito é o:

  • RUC

No caso do RUC, validaremos que os dois primeiros dígitos sejam 10, 15 ou 17 e que seu tamanho seja de 11 dígitos.

Para o Chile

Os tipos de documento de identidade aceitos são os seguintes:

  • CI

No caso do CI, validaremos que sua extensão é de 8 ou 11 caracteres.

O tipo de documento fiscal aceito é o:

  • RUT

No caso da RUT, validaremos se sua extensão tem exatamente 9 caracteres, 8 dígitos e um caractere de verificação, que pode ser um dígito ou uma letra k.

Considerações sobre endereço legal

Para Argentina

Se você opera na Argentina, o endereço legal do usuário deve ser de uma das seguintes províncias:

  • 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 o Brasil

Se você opera no Brasil, precisará preencher o campo zipcode com dados válidos, pois vamos usá-los para determinar o endereço legal do usuário.

Para o México

Se você opera no México, não há requisitos especiais em relação aos campos de endereço legal do usuário.

Para o Chile

Caso o país de operação seja o Chile, não há nenhum requisito especial em relação aos campos de endereço legal do usuário.

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

Esta seção foi útil para você?

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"
}
}
Respostas de amostra
{
"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":{
...
}
}
}