Skip to main content
POST
Create a customer

Authorizations

Authorization
string
header
required

YuvexPay API key. Include as Authorization: Bearer ypk_<env>_<kid>_<secret> where <env> is test (sandbox) or live (production). Create and manage keys in the dashboard under Settings > API Keys.

Headers

X-Idempotency-Key
string
required

A unique string to ensure the request is processed only once. Must be unique per request. Valid for 24 hours.

Maximum string length: 100

Body

application/json
externalId
string

Your own customer ID.

Maximum string length: 100
name
string
Required string length: 1 - 200
email
string<email>
Maximum string length: 255
document
string

CPF or CNPJ number.

Maximum string length: 20
documentType
enum<string>
Available options:
CPF,
CNPJ
phone
string
Maximum string length: 20
metadata
object

Response

Customer created.

customer
object