Skip to main content
POST
Create customer

Authorizations

X-API-Key
string
header
required

Integration API Key (Integrations → New Integration).

Body

application/json
customer_name
string
required
address
string
required
country_id
string<uuid>
required
phone
string
required
email
string
required
business_type
enum<string>
required

Customer type.

Available options:
non-business,
natural,
legal
branch_id
string<uuid>
required
register_number
string

NRC.

tax_number
string

NIT.

document_type
string

Document type code (13 = DUI, 36 = NIT...).

document_number
string
state_id
string<uuid>

Required for El Salvador; optional if country_id is another country.

city_id
string<uuid>

Required for El Salvador; optional if country_id is another country.

state_name
string

Department or state as free text. Required if country_id is not El Salvador.

Maximum string length: 120
city_name
string

City or municipality as free text. Required if country_id is not El Salvador.

Maximum string length: 120
activity_id
string<uuid>

Response

Customer created