Skip to main content
Este produto expõe consulta de KYC e compliance para pessoa física a partir do CPF. A plataforma trata autenticação, precificação e chamada à origem; o seu cliente fala apenas com a Proteo Data.

​
O que esperar do produto (escopo em alto nível)

Em termos de negócio, este tipo de consulta costuma devolver indicadores e registros úteis a due diligence — por exemplo PEP, listas de sanções ou restrições, quando existirem na origem e forem retornados naquele contrato. Os campos concretos vêm no objeto data da resposta. A forma exata depende da origem e pode evoluir com o tempo: modele a integração como JSON dinâmico, valide só o que consome e trate a ausência de campos com elegância. Mais detalhes em Resultados.

​
Contrato único da Proteo Data

  • Autenticação: uma única API Key no header Authorization: Bearer.
  • Corpo mínimo: apenas o campo document com o CPF — 11 dígitos, apenas números.
  • Uma entidade por chamada: a consulta é sempre para um documento informado.
O endpoint genérico continua sendo POST /v1/query/{slug}; para este produto, slug = cpf-kyc. Veja também Produtos e consultas.

​
Endpoint

POST /v1/query/cpf-kyc Mesmo contrato genérico de consultas por produto: o que muda é o slug na URL e o significado do campo document no corpo.

​
Autenticação

É obrigatório o header: Authorization: Bearer <sua_api_key> Detalhes em Autenticação.

​
Corpo da requisição

{
  "document": "00000000000"
}
CampoTipoObrigatórioDescrição
documentstringsimPara este produto: CPF com 11 dígitos, apenas números. A API não valida dígito verificador — apenas o formato do JSON e os limites do campo.

​
Concorrência e desempenho

Pedidos simultâneos com o mesmo produto e o mesmo document podem ser consolidados numa única chamada à origem; cada cliente recebe a sua própria resposta 200 e a cobrança segue o valor em meta.chargedCredits daquela chamada.

​
Resposta de sucesso (200)

{
  "data": {
    "MatchKeys": "doc{417***5008}",
    "KycData": {
      "IsCurrentlyPEP": false,
      "IsCurrentlySanctioned": false,
      "SanctionsHistory": []
    }
  },
  "meta": {
    "chargedCredits": "0.112000",
    "product": "cpf-kyc",
    "queryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}
  • data: payload do produto (normalmente o primeiro item útil quando a origem devolve um array Result; se a origem responder com sucesso e Result estiver vazio, data pode trazer um envelope com Result, Status, QueryId, etc. — veja Resultados).
  • meta.chargedCredits: valor em R$ debitado nesta requisição (string decimal).
  • meta.product: sempre cpf-kyc neste endpoint fixo.
  • meta.queryId: ID interno Proteo — use em suporte.

​
Erros comuns

Os códigos e formatos seguem o guia Erros e limites.

​
Privacidade e LGPD (uso responsável)

Dados de pessoa física exigem base legal e finalidade claras. Pratique minimização e defina retenção e controles de acesso. A responsabilidade pelo uso do retorno na sua aplicação continua sendo sua.

​
Exemplos prontos

Use os exemplos em Primeira consulta com SLUG_DO_PRODUTO = cpf-kyc e um CPF válido (apenas dígitos).

​
Referência da API

Na aba Referência da API: POST /v1/query/cpf-kyc.