Pular para o conteúdo principal
POST
Criar um cliente

Autorizações

Authorization
string
header
obrigatório

Chave de API sk_vl_... criada no painel em Desenvolvedores → Chaves de API.

Corpo

application/json
name
string
obrigatório

Nome (até 120).

Maximum string length: 120
email
string<email>

E-mail. Único por negócio.

document
string

CPF (11) ou CNPJ (14 dígitos), só números.

Pattern: ^(\d{11}|\d{14})$
phone
string

Telefone, só dígitos (8 a 15), + opcional.

Pattern: ^\+?\d{8,15}$
external_reference
string

O seu identificador (id do pedido, SKU). Até 100 caracteres.

Maximum string length: 100
Exemplo:

"pedido-1001"

metadata
object

Até 20 pares chave/valor em texto (chave até 40, valor até 500 caracteres). Volta igual nas respostas e nos webhooks.

Exemplo:

Resposta

Cliente criado.

id
string

Id do cliente.

Pattern: ^cus_[A-Za-z0-9_-]{16}$
Exemplo:

"cus_Xk2v9QeR7tLmN3bA"

object
enum<string>

Sempre customer.

Opções disponíveis:
customer
name
string

Nome.

email
string | null

E-mail.

document
string | null

CPF ou CNPJ, só dígitos.

phone
string | null

Telefone, só dígitos.

external_reference
string | null

O seu identificador.

metadata
object

Até 20 pares chave/valor em texto (chave até 40, valor até 500 caracteres). Volta igual nas respostas e nos webhooks.

Exemplo:
created_at
string<date-time>

Criação.

updated_at
string<date-time>

Última alteração.