Skip to main content
POST
/
v1
/
query
/
cpf-kyc
KYC e compliance PF (CPF)
curl --request POST \
  --url https://proteo-data.ngrok.app/v1/query/cpf-kyc \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document": "12345678909"
}
'
{
  "data": {
    "MatchKeys": "doc{417***5008}",
    "KycData": {
      "IsCurrentlyPEP": false,
      "IsCurrentlySanctioned": false,
      "SanctionsHistory": []
    }
  },
  "meta": {
    "chargedCredits": "0.112000",
    "product": "cpf-kyc",
    "queryId": "e2b91c44-9a0f-4c1d-8e33-1a2b3c4d5e6f"
  }
}

Authorizations

​
Authorization
string
header
required

API Key no formato Bearer (mesmo valor da chave gerada no painel).

Body

application/json
​
document
string
required

Identificador da consulta. Depende do produto: ex. cpf-basic / cpf-kyc — CPF com 11 dígitos; cnpj-basic / cnpj-kyc — CNPJ com 14 dígitos; apenas números. A API não valida dígitos verificadores; formatos inválidos podem falhar na origem.

Required string length: 1 - 100

Response

Consulta concluída

Consulta concluída

​
data
object
required

Payload do produto. Normalmente é o primeiro elemento do array Result quando a resposta do fornecedor segue esse formato. Se a origem responder com sucesso e Result for um array vazio, data pode incluir Result, Status, QueryId, ElapsedMilliseconds, QueryDate e Evidences. Sem transformação no produto, pode ser o JSON bruto. Pode ser null quando não há item útil a extrair.

​
meta
object
required

Metadados da cobrança e rastreio (sem detalhes de infraestrutura).