Skip to main content
POST
Criar um cliente

Cabeçalhos

X-API-Key
string
obrigatório

Chave de API de integração (pd_live_* para produção, pd_test_* para sandbox)

Corpo

application/json
name
string
obrigatório

Nome do cliente

Maximum string length: 255
Exemplo:

"João da Silva"

document
string
obrigatório

CPF (11 dígitos) ou CNPJ (14 dígitos), apenas números

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

"12345678909"

email
string<email>

E-mail do cliente

Maximum string length: 255
phone
string

Telefone do cliente com DDI

Pattern: ^\+\d{10,15}$
Exemplo:

"+5511999998888"

Resposta

Cliente criado com sucesso

id
string<uuid>
obrigatório

ID do cliente

name
string
obrigatório

Nome do cliente

Exemplo:

"João da Silva"

email
string<email>
obrigatório

E-mail do cliente

documentType
enum<string>
obrigatório

Tipo do documento

Opções disponíveis:
cpf,
cnpj
document
string
obrigatório

Número do documento mascarado

Exemplo:

"***456789**"

createdAt
string<date-time>
obrigatório

Data de criação

phone
string

Telefone do cliente com DDI

Exemplo:

"+5511999998888"