Skip to main content
Para dados básicos PF, use o slug cpf-basic e o CPF só com dígitos em document — Dados básicos PF. Para dados básicos PJ, use cnpj-basic e o CNPJ com 14 dígitos — Dados básicos PJ. Para KYC e compliance PF, use cpf-kyc — KYC e compliance PF. Para KYC familiares de 1º nível PF, use cpf-kyc-relatives — KYC familiares de 1º nível PF. Para Compliance casas de apostas PF, use cpf-betting-compliance — Compliance casas de apostas PF. Para KYC e compliance PJ, use cnpj-kyc — KYC e compliance PJ. Substitua os placeholders:
  • BASE_URL — URL base da API (sem barra no final), alinhada ao campo servers do OpenAPI.
  • SUA_API_KEY — sua API Key.
  • SLUG_DO_PRODUTO — ex.: cpf-basic, cnpj-basic, cpf-kyc, cpf-kyc-relatives, cpf-betting-compliance ou cnpj-kyc.
  • VALOR_DOCUMENTO — valor esperado pelo produto (ex.: CPF ou CNPJ só dígitos).

​
Checklist rápido (tour inicial)

  • Copie sua API key no Portal (ela é exibida apenas uma vez após a criação).
  • Abra a referência de Dados básicos PF.
  • Clique em Try it, informe Authorization: Bearer SUA_API_KEY e rode a chamada.
  • Confirmando 200, volte ao Dashboard e finalize o passo do onboarding.

​
Exemplos

curl -sS -X POST "${BASE_URL}/v1/query/SLUG_DO_PRODUTO" \
  -H "Authorization: Bearer SUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"document":"VALOR_DOCUMENTO"}'

​
Resposta de sucesso (formato)

{
  "data": { }
}
O conteúdo de data depende do produto. Veja também a Referência da API para o contrato e os detalhes do endpoint do produto que utilizar.