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>"
}

Through this endpoint, the partner can consult documents of individuals and legal entities and obtain a detailed report in JSON format.

The report provides an overview of the financial health of the consulted document, including information such as financial liabilities, restrictions, overdue debts, bounced checks and protests, helping to make safe and informed decisions.

Authorizations

​
Authorization
string
header
required

Informe o token

Headers

​
IdempotencyKey
string
required

Body

Response

200
text/plain

Success

The response is of type object.