Pré-requisitos
- URL base da API em produção ou homologação (fornecida pela Proteo).
- Uma API Key ativa, gerada no painel para o seu tenant.
- O slug do produto que você vai consultar (ex.:
cpf-basic,cnpj-basic,cpf-kyc,cnpj-kyc).
Fluxo típico
- Obtenha a API Key com o time administrativo ou pelo painel.
- Chame
GET /health(opcional) para validar conectividade. - Envie
POST /v1/query/{slug}com headerAuthorization: Bearer <sua_chave>e corpo{ "document": "..." }.
Onde ir depois
- Autenticação
- Dados básicos PF (CPF)
- Dados básicos PJ (CNPJ)
- KYC e compliance PF (CPF)
- KYC e compliance PJ (CNPJ)
- Primeira consulta (exemplos em várias linguagens)
- Aba Referência da API para o contrato dos endpoints por produto.
Variável de ambiente sugerida
Defina no seu ambiente algo comoPROTEO_DATA_BASE_URL apontando para a URL base sem barra final, por exemplo https://api.suaempresa.com.