26 - KYC Síncrona

cURL

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Bureau/KycSancoesPF \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "consulta": {
    "identificador": "<string>",
    "documento": "<string>"
  }
}
'

200

{
  "msg": "<string>",
  "messages": [
    {
      "messageType": 1,
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "hasError": true,
  "falha": true,
  "json": "<string>"
}

Este endpoint permite consultas básicas sobre uma pessoa física, no formato de resposta rápida (Síncrono). A resposta é uma ‘String JSON’ serializada que inclui as seguintes informações:

• PEP: indicação se a pessoa é PEP ou não;
• Sanções: histórico de sanções aplicadas;
• Contribuições eleitorais: histórico de contribuição eleitoral.

Mostrar Exemplo de retorno completo

O exemplo de retorno, mostrado no lado direito desta tela, está resumido. Na linha "json": "<string>" o retorno do Bureau vem de forma serializada, sendo necessário deserializar para melhor visualização. Aqui está um exemplo do retorno deserializado que vem no campo "json":.

{
    "Erro": Boolean,
    "MensagemOperador": "String",
    "ResultadoConsulta": {
        "PEPHistory": [
            {
                "Level": "String",
                "JobTitle": "String",
                "Department": "String",
                "Motive": "String",
                "Source": "String",
                "TaxId": "String",
                "StartDate": "Data",
                "EndDate": "Data"
            }
        ],
        "IsCurrentlyPEP": Boolean,
        "SanctionsHistory": [],
        "IsCurrentlySanctioned": Boolean,
        "WasPreviouslySanctioned": Boolean,
        "Last30DaysSanctions": int,
        "Last90DaysSanctions": int,
        "Last180DaysSanctions": int,
        "Last365DaysSanctions": int,
        "LastYearPEPOccurence": int,
        "Last3YearsPEPOccurence": int,
        "Last5YearsPEPOccurence": int,
        "Last5PlusYearsPEPOccurence": int,
        "FirstSanctionDate": null,
        "LastSanctionDate": null,
        "FirstPEPOccurenceDate": "Data",
        "LastPEPOccurenceDate": "Data",
        "IsCurrentlyElectoralDonor": Boolean,
        "IsHistoricalElectoralDonor": Boolean,
        "TotalElectoralDonations": int,
        "TotalElectoralDonationAmount": float,
        "ElectoralDonations": {
            "String": {
                "DonationsCount": int,
                "AmountDonated": float
            },
            "String": {
                "DonationsCount": int,
                "AmountDonated": float
            }
        },
        "Identificador": "String",
        "StatusConsulta": {
            "Code": int,
            "Message": "String"
        }
    }
}

Authorizations

Authorization · string · header · required

Informe o token

Headers

IdempotencyKey · string · required

Body

consulta · object

Mostrar atributos filhos

consulta. identificador · string | null

consulta. documento · string | null

Response

200

text/plain

Success

msg · string | null

messages · object[] | null

Mostrar atributos filhos

messages. messageType · enum<integer>

Opções disponíveis: 1, 2, 3

messages. code · string | null

messages. context · string | null

messages. description · string | null

messages. field · string | null

hasError · boolean

falha · boolean

json · string | null