Skip to main content

​
Visão geral

Use este endpoint para cadastrar um novo cliente na sua conta. Os clientes podem ser associados a transações, assinaturas e links de pagamento, facilitando a gestão de relacionamento e a conciliação financeira.

​
Endpoint

curl -X POST https://api.avanttifinance.com/v1/customers \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Maria da Silva",
    "email": "maria.silva@email.com",
    "document": "12345678900",
    "phone": "+5511999999999"
  }'

​
Parâmetros do corpo

​
name
string
required
Nome completo ou razão social do cliente.
​
email
string
required
Endereço de e-mail do cliente, utilizado para comunicações e identificação.
​
document
string
required
CPF ou CNPJ do cliente, sem pontuação.
​
phone
string
Número de telefone do cliente, no formato E.164 (ex: +5511999999999).
​
metadata
object
Conjunto de pares chave-valor para armazenar informações adicionais sobre o cliente.

​
Resposta

​
id
string
Identificador único do cliente, no formato cus_xxxxxxxxxxxx.
​
name
string
Nome completo ou razão social do cliente.
​
email
string
Endereço de e-mail do cliente.
​
document
string
CPF ou CNPJ do cliente.
​
phone
string
Número de telefone do cliente.
​
created_at
string
Data e hora de criação do cliente, no formato ISO 8601.

​
Exemplo de resposta

{
  "id": "cus_8f72a1b3c4d5",
  "name": "Maria da Silva",
  "email": "maria.silva@email.com",
  "document": "12345678900",
  "phone": "+5511999999999",
  "metadata": {},
  "created_at": "2025-01-15T10:30:00Z"
}
Verifique se o e-mail e o documento informados são válidos e únicos. Tentativas de cadastro com documentos já existentes retornarão erro 409 Conflict.

​
Erros comuns

Código HTTPSignificado
400Dados inválidos ou campos obrigatórios ausentes
401Token de autenticação inválido ou ausente
409Já existe um cliente cadastrado com este documento ou e-mail

​
Próximos passos

Listar clientes

Consulte todos os clientes cadastrados.

Editar cliente

Atualize os dados de um cliente existente.