Visão geral
A API de Clientes permite gerenciar informações cadastrais dos seus clientes de forma centralizada. Você pode criar novos clientes, listar todos os cadastrados e consultar informações específicas.Funcionalidades
- Cadastro completo: Nome, email, telefone, CPF/CNPJ e endereço
- Validação automática: CPF/CNPJ e email são validados automaticamente
- Busca e filtros: Liste clientes com paginação e filtros
- Integração: Associe clientes a transações e links de pagamento
- Segurança: Todos os dados são criptografados e protegidos
Criando seu primeiro cliente
Requisição Básica
Resposta
Campos disponíveis
Campos obrigatórios
| Campo | Tipo | Descrição |
|---|---|---|
name | string | Nome completo do cliente. Mínimo 3 caracteres. |
email | string | Email válido do cliente. |
Campos opcionais
| Campo | Tipo | Descrição |
|---|---|---|
phone | string | Telefone com DDD. Apenas números. Exemplo: “11987654321”. |
document | string | CPF (11 dígitos) ou CNPJ (14 dígitos). Apenas números. |
address | object | Endereço completo do cliente. |
Estrutura do endereço (address)
| Campo | Tipo | Descrição |
|---|---|---|
street | string | Nome da rua/avenida. |
number | string | Número do imóvel. |
complement | string | Complemento (apto, sala, etc). |
neighborhood | string | Bairro. |
city | string | Cidade. |
state | string | Estado (UF). Exemplo: “SP”, “RJ”. |
zipCode | string | CEP. Apenas números. Exemplo: “01310100”. |
📖 Exemplos Completos
Cliente Pessoa Física Completo
Cliente Pessoa Jurídica
Cliente Simples (Apenas Dados Essenciais)
Listando clientes
Listar Todos os Clientes
Resposta
Parâmetros de Paginação
| Parâmetro | Tipo | Descrição | Padrão |
|---|---|---|---|
page | number | Número da página. | 1 |
limit | number | Quantidade de registros por página. Máximo: 100. | 20 |
Consultando um cliente específico
Resposta
Validações automáticas
CPF/CNPJ
- CPF deve ter 11 dígitos
- CNPJ deve ter 14 dígitos
- Validação de dígitos verificadores
- Apenas números são aceitos
- Formato válido de email
- Domínio válido
Telefone
- Apenas números
- DDD + número (10 ou 11 dígitos)
CEP
- Apenas números
- 8 dígitos
Casos de uso
E-commerce
Cadastre clientes durante o checkout e mantenha histórico de compras.Assinaturas
Gerencie base de assinantes com dados completos para cobrança recorrente.Marketplace
Centralize informações de compradores de múltiplos vendedores.CRM
Integre com seu sistema de CRM para gestão completa de relacionamento.Boas práticas
Dados mínimos: Colete apenas os dados necessários para sua operação. Nem sempre é preciso solicitar endereço completo.
Erros comuns
Email já cadastrado
CPF/CNPJ inválido
Campos obrigatórios ausentes
📚 Próximos Passos
Referência da API
Veja todos os endpoints disponíveis
Transações
Associe clientes a transações
Links de Pagamento
Crie links personalizados para seus clientes
Webhooks
Receba notificações em tempo real

