Documentação APIs

Relatório de Ativação

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Consulta os cadastros de clientes de um parceiro por igualdade de email e/ou cpf_cnpj.

É obrigatório informar pelo menos um desses campos, com valor não vazio. Quando ambos são informados, os dois devem corresponder ao mesmo cadastro (AND).

Informe o e-mail completo ou o CPF/CNPJ completo, com ou sem máscara. Os documentos sem máscara são formatados antes da comparação por igualdade. Não há busca parcial nem busca por nome. O parâmetro search foi removido e deve ser substituído por email e/ou cpf_cnpj.

O filtro status e a paginação por limit e offset continuam disponíveis. A consulta retorna apenas os cadastros vinculados à firma autenticada e exclui vínculos inativos.

Sem email e cpf_cnpj, a API retorna HTTP 400 com a mensagem de validação: Informe pelo menos um dos campos: email ou cpf_cnpj. E-mail inválido ou campos enviados vazios também retornam HTTP 400. Se não houver correspondência, retorna HTTP 200 com results vazio e count igual a 0.

Query Params
string

E-mail completo do cliente, consultado por igualdade. Obrigatório quando cpf_cnpj não for informado. Se ambos forem enviados, os dois devem corresponder ao mesmo cadastro.

string

Status da conta do cliente (opcional) Available values : APPROVED, COMPLETE, ENABLED, IN_PROGRESS, PENDING, WAITING_DEPOSIT

string

CPF ou CNPJ completo, com ou sem máscara, consultado por igualdade após normalização para o formato cadastral. Obrigatório quando email não for informado. Se ambos forem enviados, os dois devem corresponder ao mesmo cadastro.

Headers
string
required

Token de autenticação de parceiro obtido após realizar o login no endpoint de autenticação.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json