Skip to main content

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

CampoTipoDescrição
namestringNome completo do cliente. Mínimo 3 caracteres.
emailstringEmail válido do cliente.

Campos opcionais

CampoTipoDescrição
phonestringTelefone com DDD. Apenas números. Exemplo: “11987654321”.
documentstringCPF (11 dígitos) ou CNPJ (14 dígitos). Apenas números.
addressobjectEndereço completo do cliente.

Estrutura do endereço (address)

CampoTipoDescrição
streetstringNome da rua/avenida.
numberstringNúmero do imóvel.
complementstringComplemento (apto, sala, etc).
neighborhoodstringBairro.
citystringCidade.
statestringEstado (UF). Exemplo: “SP”, “RJ”.
zipCodestringCEP. Apenas números. Exemplo: “01310100”.
Exemplo:

📖 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âmetroTipoDescriçãoPadrão
pagenumberNúmero da página.1
limitnumberQuantidade 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

Email

  • 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.
LGPD: Certifique-se de ter consentimento do cliente para armazenar seus dados pessoais. Implemente políticas de privacidade adequadas.
Validação no frontend: Valide CPF/CNPJ e email no frontend antes de enviar para a API para melhor experiência do usuário.

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