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 emdata 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écnicofirst_level_relatives_kyc:
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
Concorrência e desempenho
Chamadas simultâneas para mesmo produto + mesmodocument podem ser consolidadas internamente; cada resposta mantém seu meta.queryId e meta.chargedCredits.
Resposta de sucesso (200)
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 comSLUG_DO_PRODUTO = cpf-kyc-relatives.
Referência OpenAPI
Na aba Referência da API:POST /v1/query/cpf-kyc-relatives.