Skip to main content
POST
Create a Customer

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

Full name of the customer.

Minimum string length: 1
email
string<email>
required

Primary email address of the customer.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
document
object

Optional government-issued document information for the customer.

phone
string

Optional customer phone number in E.164-like numeric format with 11 digits.

Pattern: ^\d{11}$
externalRef
string

Optional external reference from your system used to correlate this customer.

address
object

Optional billing or residential address of the customer.

ip_address
string

Optional IP address associated with the customer creation request.

Response

Customer created

success
boolean
required
requestId
string
required

Request correlation identifier.

data
object
required