KYC e Sanções
O serviço Know-Your-Customer (KYC) retorna informações sobre pessoas politicamente expostas (PEP), sanções e restrições, com cobertura nacional e internacional.
Quando usar
Descrição
O serviço de KYC e Sanções fornece informações abrangentes para atender às exigências regulatórias e legais de know-your-customer.
Ele retorna dados sobre pessoas politicamente expostas (PPE ou PEP), sanções e restrições, com cobertura nacional e internacional.
Também são incluídas flags que indicam se o indivíduo é PEP ou possui alguma restrição associada, além dos registros históricos dessas situações.
O serviço ainda contempla o conceito de PEP Estendido, que relaciona a pessoa a outros PEPs por vínculos familiares ou outros tipos de relacionamento.
O retorno indica separadamente se a pessoa é PEP direto, PEP indireto e PEP geral (Sim quando qualquer um dos dois é Sim).
Requisição
Autenticação por chave de API (cabeçalho Authorization: Bearer), criada no painel com esta consulta no escopo.
POST /api/v1/{tenant}/pessoas/kyc-e-sancoes
| Campo | Obrigatório | Descrição |
|---|---|---|
document |
sim | CPF da pessoa, com ou sem máscara. |
{
"document": "000.000.000-00"
}
Campos de retorno
Campos dentro de data. [] indica lista.
| Campo | Tipo |
|---|---|
SanctionsNationalOutros[].description |
texto |
SanctionsNationalOutros[].source_count |
número |
SanctionsNationalOutros[].sanctions[].type |
texto |
SanctionsNationalOutros[].sanctions[].motive |
texto |
SanctionsNationalOutros[].sanctions[].created_at |
texto |
SanctionsNationalOutros[].sanctions[].updated_at |
texto |
SanctionsNationalOutros[].sanctions[].start_date |
texto |
SanctionsNationalOutros[].sanctions[].end_date |
texto |
SanctionsNationalOutros[].sanctions[].match_rate |
número |
SanctionsNational[].description |
texto |
SanctionsNational[].source_count |
número |
SanctionsInternational[].description |
texto |
SanctionsInternational[].source_count |
número |
SanctionsList[].description |
texto |
SanctionsList[].target |
texto |
SanctionsList[].sanctions_count |
número |
Sanctions[].Source |
texto |
Sanctions[].Type |
texto |
Sanctions[].StandardizedSanctionType |
texto |
Sanctions[].MatchRate |
número |
Sanctions[].StartDate |
data |
Sanctions[].EndDate |
data |
IsCurrentlyPEP |
booleano |
PepDirect |
texto |
PepIndirect |
texto |
PepGeneral |
texto |
Exemplo de resposta
Estrutura real da resposta, com valores fictícios.
{
"execution_id": "00000000-0000-0000-0000-000000000000",
"status": "success",
"message": "Consulta realizada com sucesso",
"query_name": "KYC e Sanções",
"query_slug": "kyc-e-sancoes",
"data": {
"SanctionsNationalOutros": [
{
"description": "texto",
"source_count": 0,
"sanctions": [
{
"type": "texto",
"motive": "texto",
"created_at": "texto",
"updated_at": "texto",
"start_date": "texto",
"end_date": "texto",
"match_rate": 0
}
]
}
],
"SanctionsNational": [
{
"description": "texto",
"source_count": 0,
"sanctions": [
]
}
],
"SanctionsInternational": [
{
"description": "texto",
"source_count": 0,
"sanctions": [
]
}
],
"SanctionsList": [
{
"description": "texto",
"target": "texto",
"sanctions_count": 0
}
],
"Sanctions": [
{
"Source": "texto",
"Type": "texto",
"StandardizedSanctionType": "texto",
"MatchRate": 0,
"StartDate": "2026-01-01",
"EndDate": "2026-01-01"
}
],
"PEPHistory": [
],
"IsCurrentlyPEP": false,
"PepDirect": "texto",
"PepIndirect": "texto",
"PepGeneral": "texto"
},
"consulted_at": "2026-01-01T12:00:00Z",
"query_cost": "0.100"
}
Cobrança e respostas
- O valor é cobrado por consulta bem-sucedida.
- 200 — consulta processada (veja status no corpo da resposta)
- 401 — token ausente, inválido, inativo ou expirado
- 403 — serviço fora do escopo da chave, IP não autorizado ou limite de consumo excedido
- 422 — campo obrigatório ausente/inválido ou payload acima do limite do serviço
- 429 — limite de requisições por minuto da chave excedido
- 504 — tempo máximo de execução do serviço excedido