v9

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-071292691.1 MB
customers

Create customer

Registers a new customer within the caller account. The document is deduplicated per account.

post/api/v1/customers

Request body

documentstring nullable

CPF (11 digits) or CNPJ (14 characters). Optional.

type'PF' | 'PJ' nullable
birth_datestring

Date of birth.

metadataobject nullable
namestring required
emailstring nullable
phonestring nullable

Example request

{
  "birth_date": "1990-05-20"
}

Response

Customer created.

idstring required
documentstring nullable required
type'PF' | 'PJ' nullable required
namestring required
emailstring nullable required
phonestring nullable required
birth_datestring nullable required
metadataobject nullable required
created_atstring required
updated_atstring required