Consult data in Serasa by CPF

cURL

cURL

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

import requests

url = "https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSerasaCpf"

payload = { "consulta": { "documento": "<string>" } }
headers = {
    "IdempotencyKey": "<idempotencykey>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    IdempotencyKey: '<idempotencykey>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({consulta: {documento: '<string>'}})
};

fetch('https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSerasaCpf', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSerasaCpf",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'consulta' => [
        'documento' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json",
    "IdempotencyKey: <idempotencykey>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSerasaCpf"

	payload := strings.NewReader("{\n  \"consulta\": {\n    \"documento\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("IdempotencyKey", "<idempotencykey>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSerasaCpf")
  .header("IdempotencyKey", "<idempotencykey>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"consulta\": {\n    \"documento\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultaSerasaCpf")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["IdempotencyKey"] = '<idempotencykey>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"consulta\": {\n    \"documento\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

200

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

{
  "msg": "<string>",
  "messages": [
    {
      "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

application/jsontext/jsonapplication/*+json

consulta · object

Show child attributes

Response

200

text/plain

Success

msg · string | null

messages · object[] | null

Show child attributes

hasError · boolean

falha · boolean

json · string | null