/users/v1/

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 9 a 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 5 y 9 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 o PASSPORT, 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

Validaremos que su extensión sea entre 8 y 12 caracteres, incluyendo el dígito verificador quel puede ser un dígito o una letra k.

El tipo de documento fiscal aceptado es:

  • RUT

Validaremos que su extensión sea entre 8 y 12 caracteres, incluyendo el dígito verificador quel 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

Para operaciones en Chile, no existen requisitos especiales para los campos de dirección legal del usuario.

Campos personalizados

De manera opcional, puedes incluir en el body un objeto custom_fields con pares clave-valor para guardar información adicional del usuario. Luego, podrás consultar los datos en las respuestas de las llamadas y también desde el Detalle de usuario vía Dashboard.

Formato

Las claves permitidas son custom_field_1 hasta custom_field_10. El valor de cada campo es un string de hasta 128 caracteres. Los caracteres permitidos son: letras (incluyendo acentos), números, espacios y los símbolos -_.,()'";&$#@!%&*:;/+.

Ejemplo

{
  "custom_fields": {
    "custom_field_1": "valor1",
    "custom_field_2": "valor2"
  }
}

Si envias custom_fields, la respuesta del usuario creado incluirá estos campos con display_name y key, siempre que exista un mapeo configurado para tu cliente.

Ver Reemplazar mapeos de campos custom para configurar los mapeos de cada slot.

Parámetros disponibles

Header Parameters
AuthorizationString
x-idempotency-keyString
Cuerpo de solicitud
application/json
namestring
surnamestring
identification_typeenum
identification_valuestring
birthdatestring
genderstring
emailstring
phonestring
tax_identification_typeenum
tax_identification_valuestring
nationalitystring
tax_conditionenum
company_idstring
external_idstring
legal_addressobject10 propiedades
operation_countrystring
custom_fieldsobject10 propiedades

Detalle de respuestas

401
No autorizado

Ejemplo de solicitud
{
  "name": "Diego",
  "surname": "Pomelo",
  "identification_type": "DNI",
  "identification_value": 42345678,
  "birthdate": "1998-08-20",
  "gender": "MALE",
  "email": "[email protected]",
  "phone": "1123456789",
  "tax_identification_type": "CUIL",
  "tax_identification_value": 20423456789,
  "nationality": "ARG",
  "tax_condition": "VAT_REGISTERED",
  "company_id": "cmp-123e4567e89b12d3a456",
  "external_id": "ext-12345",
  "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",
  "custom_fields": {
    "custom_field_1": "valor1",
    "custom_field_2": "valor2",
    "custom_field_3": "example_value",
    "custom_field_4": "example_value",
    "custom_field_5": "example_value",
    "custom_field_6": "example_value",
    "custom_field_7": "example_value",
    "custom_field_8": "example_value",
    "custom_field_9": "example_value",
    "custom_field_10": "example_value"
  }
}
Ejemplo de código
curl -X POST "https://api.pomelo.la/users/v1/" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-idempotency-key: fRwX12Dg3345AD" \
  -d '{
  "name": "Diego",
  "surname": "Pomelo",
  "identification_type": "DNI",
  "identification_value": 42345678,
  "birthdate": "1998-08-20",
  "gender": "MALE",
  "email": "[email protected]",
  "phone": "1123456789",
  "tax_identification_type": "CUIL",
  "tax_identification_value": 20423456789,
  "nationality": "ARG",
  "tax_condition": "VAT_REGISTERED",
  "company_id": "cmp-123e4567e89b12d3a456",
  "external_id": "ext-12345",
  "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",
  "custom_fields": {
    "custom_field_1": "valor1",
    "custom_field_2": "valor2",
    "custom_field_3": "example_value",
    "custom_field_4": "example_value",
    "custom_field_5": "example_value",
    "custom_field_6": "example_value",
    "custom_field_7": "example_value",
    "custom_field_8": "example_value",
    "custom_field_9": "example_value",
    "custom_field_10": "example_value"
  }
}'
Ejemplo de respuesta (201)Usuario creado
{
  "data": {
    "id": "usr-203c6jQq0O3nVWXj6jRUQXy7QkC",
    "name": "Diego",
    "surname": "Pomelo",
    "identification_type": "DNI",
    "identification_value": 42345678,
    "birthdate": "1998-08-20",
    "gender": "MALE",
    "email": "[email protected]",
    "phone": "1123456789",
    "tax_identification_type": "CUIL",
    "tax_identification_value": 20423456789,
    "nationality": "ARG",
    "tax_condition": "VAT_REGISTERED",
    "company_id": "cmp-123e4567e89b12d3a456",
    "external_id": "ext-12345",
    "status": "ACTIVE",
    "operation_country": "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"
    },
    "custom_fields": {
      "custom_field_1": {
        "value": "valor1",
        "display_name": "Sucursal",
        "key": "branch"
      },
      "custom_field_2": {
        "value": "valor1",
        "display_name": "Sucursal",
        "key": "branch"
      },
      "custom_field_3": {
        "value": "valor1",
        "display_name": "Sucursal",
        "key": "branch"
      },
      "custom_field_4": {
        "value": "valor1",
        "display_name": "Sucursal",
        "key": "branch"
      },
      "custom_field_5": {
        "value": "valor1",
        "display_name": "Sucursal",
        "key": "branch"
      },
      "custom_field_6": {
        "value": "valor1",
        "display_name": "Sucursal",
        "key": "branch"
      },
      "custom_field_7": {
        "value": "valor1",
        "display_name": "Sucursal",
        "key": "branch"
      },
      "custom_field_8": {
        "value": "valor1",
        "display_name": "Sucursal",
        "key": "branch"
      },
      "custom_field_9": {
        "value": "valor1",
        "display_name": "Sucursal",
        "key": "branch"
      },
      "custom_field_10": {
        "value": "valor1",
        "display_name": "Sucursal",
        "key": "branch"
      }
    }
  }
}

Pomelo AI

Asistente de inteligencia artificial para consultas sobre la API de Pomelo
¡Hola!¿Cómo puedo ayudarte hoy?