latestOpenAPI 3.1.02026-08-102051102.0 KB

40ed0bdb89e1

Customers

Create a new customer

post/api/v1/customer

Headers

idempotency-keystring uuid required

Required for mutating calls. Use a V4 UUID. The server stores the first result for 24h and returns it on subsequent retries with the same key.

Required for mutating calls. Use a V4 UUID. The server stores the first result for 24h and returns it on subsequent retries with the same key.

Request body

OR

Response

Default Response

customer_idstring uuid required

Customer UUID

external_customer_idstring nullable required
customer_type'individual' | 'business' required

Type of customer in display format

emailstring email required
phonestring e164

Phone number in E.164 format (e.g., +14155552671)

first_namestring

First name (for individuals)

last_namestring

Last name (for individuals)

company_namestring

Company name (for businesses)

created_atstring date-time required
updated_atstring date-time required
metadataMetadata
statusstring

Customer compliance status