curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSerasaCpf \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '{
  "consulta": {
    "documento": "<string>"
  }
}'
{
  "msg": "<string>",
  "messages": [
    {
      "messageType": 1,
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "hasError": true,
  "falha": true,
  "json": "<string>"
}

Por meio deste endpoint, o parceiro pode consultar documentos de Pessoa Física e Jurídica e obter um relatório detalhado em formato JSON.

O relatório apresenta uma visão da saúde financeira do documento consultado, incluindo informações como pendências financeiras, restrições, dívidas vencidas, cheques sem fundo e protestos, auxiliando na tomada de decisões seguras e informadas.

Authorizations

​
Authorization
string
header
required

Informe o token

Headers

​
IdempotencyKey
string
required

Body

Response

200
text/plain

Success

The response is of type object.