Skip to main content
POST
cURL

Document types

document_type is a country-prefixed code, not the local document name. RUT is rejected with 422. Chile is CL_RUT, Colombia is CO_RUT, and Uruguay is UY_RUT. Send document_type and document_number together. country is a separate field (an English name such as Chile) and is not checked against the prefix.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Schema for registering a new customer. For anonymous customers, only id and is_anonymous: true are required. For regular customers, id, name, email, and registration_date are required.

id
string
required

Your customer unique identifier

platforms
string[] | null

Platforms associated with the customer

is_anonymous
boolean
default:false

Set to true to create an anonymous customer. When true, name and email are not required.

name
string

The full name of the customer. Required unless is_anonymous is true.

Example:

"John Smith"

email
string<email>

The email of the customer. Required unless is_anonymous is true.

gender
enum<string> | null

The gender of the customer

Available options:
MALE,
FEMALE
dob
string<date-time> | null

The date of birth of the customer

document_type
enum<string> | null

The document type of the customer. If provided, document_number is required.

Available options:
AR_DNI,
AR_CUIT,
AR_CUIL,
AR_PASSPORT,
AR_DRIVER_LICENSE,
AR_OTHER,
BO_CI,
BO_NIT,
BO_PASSPORT,
BO_DRIVER_LICENSE,
BO_OTHER,
BR_RG,
BR_CPF,
BR_PASSPORT,
BR_DRIVER_LICENSE,
BR_OTHER,
CL_RUN,
CL_RUT,
CL_PASSPORT,
CL_DRIVER_LICENSE,
CL_OTHER,
CO_CC,
CO_RUT,
CO_NIT,
CO_PASSPORT,
CO_DRIVER_LICENSE,
CO_OTHER,
CR_CI,
CR_PASSPORT,
CR_DRIVER_LICENSE,
CR_OTHER,
DO_CI,
DO_PASSPORT,
DO_DRIVER_LICENSE,
DO_OTHER,
EC_CC,
EC_RUC,
EC_PASSPORT,
EC_DRIVER_LICENSE,
EC_OTHER,
SV_DUI,
SV_NIT,
SV_PASSPORT,
SV_DRIVER_LICENSE,
SV_OTHER,
GT_DPI,
GT_PASSPORT,
GT_DRIVER_LICENSE,
GT_OTHER,
HN_CI,
HN_RTN,
HN_PASSPORT,
HN_DRIVER_LICENSE,
HN_OTHER,
MX_CURP,
MX_RFC,
MX_INE,
MX_PASSPORT,
MX_DRIVER_LICENSE,
MX_OTHER,
NI_CI,
NI_PASSPORT,
NI_DRIVER_LICENSE,
NI_OTHER,
PA_CIP,
PA_PASSPORT,
PA_DRIVER_LICENSE,
PA_OTHER,
PY_CI,
PY_RUC,
PY_PASSPORT,
PY_DRIVER_LICENSE,
PY_OTHER,
PE_DNI,
PE_RUC,
PE_PASSPORT,
PE_DRIVER_LICENSE,
PE_OTHER,
UY_CI,
UY_RUT,
UY_PASSPORT,
UY_DRIVER_LICENSE,
UY_OTHER,
VE_CI,
VE_RIF,
VE_PASSPORT,
VE_DRIVER_LICENSE,
VE_OTHER
Example:

"CL_RUT"

document_number
string | null

The document number of the customer. If provided, document_type is required.

Maximum string length: 50
country
enum<string> | null

The country of the customer. English name, independent of the document_type prefix.

Available options:
Argentina,
Bolivia,
Brazil,
Chile,
Colombia,
Costa Rica,
Dominican Republic,
Ecuador,
El Salvador,
Guatemala,
Honduras,
Mexico,
Nicaragua,
Panama,
Paraguay,
Peru,
Uruguay,
Venezuela
Example:

"Chile"

phone
string | null

The customer's phone number in international format. Required for WhatsApp delivery.

Example:

"+593 99 123 4567"

registration_date
string<date-time>

The date when the customer was registered. Defaults to now.

tags
object

Include your conditions customer tags here

devices
object[]

Customer devices for push notifications

The customer's consent preferences

metadata
object

The metadata of the customer

referral_code
string

Optional referral code if customer was referred

Response

Customer created

data
object