Skip to main content

​
Produto

Um produto representa um tipo de consulta disponível na plataforma (ex.: CPF básico com um fornecedor específico). Cada produto tem:
  • Um nome amigável.
  • Um slug: identificador único e estável usado na URL da API (/v1/query/{slug}).
  • Configurações técnicas internas gerenciadas pela Proteo.

​
Entrada (document)

A maioria das consultas envia um corpo JSON com o campo document: o valor que identifica a consulta (por exemplo, CPF ou CNPJ apenas com dígitos, conforme o produto). O significado exato de document depende do produto — confirme com a documentação do produto contratado ou com o suporte.

​
Disponibilidade

Um produto pode estar inativo ou sem preço para o seu plano. Nesses casos, a API retorna erro de recurso não encontrado (404) para aquele slug.

​
Produto documentado: dados básicos PF

O produto com slug cpf-basic é a primeira consulta documentada de ponta a ponta:
  • Guia completo: Dados básicos PF (CPF) — inclui escopo do produto, contrato de resposta (data + meta), cobrança por chamada, validação do document e notas de privacidade/LGPD
  • Exemplos de código: Primeira consulta
Endpoint: POST /v1/query/cpf-basic (Contrato HTTP na Referência da API, na seção de endpoints por produto.)

​
Produto documentado: dados básicos PJ

O produto com slug cnpj-basic segue o mesmo padrão da consulta PF: Endpoint: POST /v1/query/cnpj-basic

​
Produto documentado: KYC e compliance PF

Endpoint: POST /v1/query/cpf-kyc

​
Produto documentado: KYC e compliance PJ

Endpoint: POST /v1/query/cnpj-kyc