Skip to main content
Este produto expõe consulta de KYC e compliance dos familiares de primeiro nível de pessoa física (mãe, pai, irmãos e filhos), a partir do CPF do titular consultado.

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

O retorno concentra sinais agregados e registros individuais relacionados aos familiares identificados, incluindo dados análogos ao KYC individual (PEP, sanções e restrições, quando houver na origem). Os campos concretos vêm em data e podem evoluir na origem. Modele a integração como JSON dinâmico e valide somente os campos que sua aplicação realmente consome.

​
Faixas de preço de referência (origem)

Faixas publicadas para o dataset técnico first_level_relatives_kyc:
Volume mensalValor por consulta
1 a 10.000R$ 0,130
10.001 a 50.000R$ 0,124
50.001 a 100.000R$ 0,118
100.001 a 500.000R$ 0,112
500.001 a 1.000.000R$ 0,106
1.000.001 a 5.000.000faixa contratual fixa na origem
5.000.001+sob negociação
A cobrança final na Proteo Data aparece em meta.chargedCredits conforme seu plano/contrato.

​
Contrato único da Proteo Data

  • Autenticação por API key no header Authorization: Bearer.
  • Corpo mínimo com document (CPF de 11 dígitos, apenas números).
  • Uma entidade por chamada.

​
Endpoint

POST /v1/query/cpf-kyc-relatives

​
Autenticação

Authorization: Bearer <sua_api_key>

​
Corpo da requisição

{
  "document": "00000000000"
}

​
Concorrência e desempenho

Chamadas simultâneas para mesmo produto + mesmo document podem ser consolidadas internamente; cada resposta mantém seu meta.queryId e meta.chargedCredits.

​
Resposta de sucesso (200)

{
  "data": {
    "MatchKeys": "doc{417***5008}",
    "FirstLevelRelativesKycData": {
      "HasRelativesWithSanctions": false,
      "HasRelativesWhoAreCurrentlyPEP": false,
      "Relatives": []
    }
  },
  "meta": {
    "chargedCredits": "0.291200",
    "product": "cpf-kyc-relatives",
    "queryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

​
Erros comuns

400, 401, 402, 404 e 502, seguindo o mesmo contrato de Erros e limites.

​
Privacidade e tratamento de dados

Como envolve dados de pessoa física e familiares, aplique base legal adequada, minimização e controles de retenção/acesso conforme LGPD e política interna.

​
Exemplos prontos

Use Primeira consulta com SLUG_DO_PRODUTO = cpf-kyc-relatives.

​
Referência OpenAPI

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

​
Documentação da origem