Loan and Financing Report (SCR)

cURL

cURL

curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultarSCR \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '
{
  "consulta": {
    "documento": "<string>",
    "dataBaseMes": "<string>",
    "dataBaseAno": "<string>",
    "dtAceiteCliente": "2023-11-07T05:31:56Z"
  }
}
'

import requests

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

payload = { "consulta": {
        "documento": "<string>",
        "dataBaseMes": "<string>",
        "dataBaseAno": "<string>",
        "dtAceiteCliente": "2023-11-07T05:31:56Z"
    } }
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>',
      dataBaseMes: '<string>',
      dataBaseAno: '<string>',
      dtAceiteCliente: '2023-11-07T05:31:56Z'
    }
  })
};

fetch('https://api.bmpdigital.moneyp.dev.br/Bureau/ConsultarSCR', 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/ConsultarSCR",
  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>',
        'dataBaseMes' => '<string>',
        'dataBaseAno' => '<string>',
        'dtAceiteCliente' => '2023-11-07T05:31:56Z'
    ]
  ]),
  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/ConsultarSCR"

	payload := strings.NewReader("{\n  \"consulta\": {\n    \"documento\": \"<string>\",\n    \"dataBaseMes\": \"<string>\",\n    \"dataBaseAno\": \"<string>\",\n    \"dtAceiteCliente\": \"2023-11-07T05:31:56Z\"\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/ConsultarSCR")
  .header("IdempotencyKey", "<idempotencykey>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"consulta\": {\n    \"documento\": \"<string>\",\n    \"dataBaseMes\": \"<string>\",\n    \"dataBaseAno\": \"<string>\",\n    \"dtAceiteCliente\": \"2023-11-07T05:31:56Z\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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    \"dataBaseMes\": \"<string>\",\n    \"dataBaseAno\": \"<string>\",\n    \"dtAceiteCliente\": \"2023-11-07T05:31:56Z\"\n  }\n}"

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

200

{
  "msg": "<string>",
  "messages": [
    {
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "hasError": true,
  "erro": true,
  "mensagemOperador": "<string>",
  "periodo": "<string>",
  "resumoDoCliente": {
    "cnpjDaIfSolicitante": "<string>",
    "codigoDoCliente": "<string>",
    "coobrigacaoAssumida": 123,
    "coobrigacaoAssumidaSpecified": true,
    "coobrigacaoRecebida": 123,
    "coobrigacaoRecebidaSpecified": true,
    "dataBaseConsultada": "<string>",
    "dataInicioRelacionamento": "<string>",
    "listaDeMensagensDeValidacao": [
      {
        "codigo": "<string>",
        "mensagem": "<string>"
      }
    ],
    "listaDeResumoDasOperacoes": [
      {
        "listaDeVencimentos": [
          {
            "codigoVencimento": "<string>",
            "valorVencimento": 123,
            "valorVencimentoSpecified": true
          }
        ],
        "modalidade": "<string>",
        "variacaoCambial": "<string>"
      }
    ],
    "percentualDocumentosProcessados": "<string>",
    "percentualVolumeProcessado": "<string>",
    "quantidadeDeInstituicoes": 123,
    "quantidadeDeOperacoes": 123,
    "quantidadeOperacoesDiscordancia": 123,
    "quantidadeOperacoesSubJudice": 123,
    "responsabilidadeTotalDiscordancia": 123,
    "responsabilidadeTotalDiscordanciaSpecified": true,
    "responsabilidadeTotalSubJudice": 123,
    "responsabilidadeTotalSubJudiceSpecified": true,
    "riscoIndiretoVendor": 123,
    "riscoIndiretoVendorSpecified": true,
    "tipoDoCliente": "<string>"
  },
  "resumoDoClienteTraduzido": {
    "dtInicioRelacionamento": "<string>",
    "qtdeInstituicoes": 123,
    "qtdeOperacoes": 123,
    "qtdeOperacoesDiscordancia": 123,
    "vlrOperacoesDiscordancia": 123,
    "qtdeOperacoesSobJudice": 123,
    "vlrOperacoesSobJudice": 123,
    "carteiraVencer": 123,
    "carteiraVencerAte30diasVencidosAte14dias": 123,
    "carteiraVencer31a60dias": 123,
    "carteiraVencer61a90dias": 123,
    "carteiraVencer91a180dias": 123,
    "carteiraVencer181a360dias": 123,
    "carteiraVencerAcima360dias": 123,
    "carteiraVencerPrazoIndeterminado": 123,
    "moedaEstrangeiraValor": 123,
    "moedaEstrangeiraValor15a30dias": 123,
    "moedaEstrangeiraValor31a60dias": 123,
    "moedaEstrangeiraValor61a90dias": 123,
    "moedaEstrangeiraValor91a180dias": 123,
    "moedaEstrangeiraValor181a360dias": 123,
    "moedaEstrangeiraValorAcima360dias": 123,
    "carteiraVencido": 123,
    "carteiraVencido15a30dias": 123,
    "carteiraVencido31a60dias": 123,
    "carteiraVencido61a90dias": 123,
    "carteiraVencido91a180dias": 123,
    "carteiraVencido181a360dias": 123,
    "carteiraVencidoAcima360dias": 123,
    "prejuizo": 123,
    "prejuizoAte12meses": 123,
    "prejuizoAcima12meses": 123,
    "carteiradeCredito": 123,
    "repasses": 123,
    "coobrigacoes": 123,
    "responsabilidadeTotal": 123,
    "creditosaLiberar": 123,
    "creditosaLiberarAte360dias": 123,
    "creditosaLiberarAcima360dias": 123,
    "limitesdeCredito": 123,
    "limitesdeCreditoAte360dias": 123,
    "limitesdeCreditoAcima360dias": 123,
    "riscoIndiretoVendor": 123,
    "riscoTotal": 123,
    "tituloDeCredito": 123,
    "tituloDeCreditoCPR": 123,
    "tituloDeCreditoEN": 123,
    "tituloDeCreditoDebentures": 123,
    "tituloDeCreditoNotaComercial": 123,
    "tituloDeCreditoOutros": 123
  },
  "resumoModalidade": [
    {
      "tipo": "<string>",
      "modalidade": "<string>",
      "dominio": "<string>",
      "subdominio": "<string>",
      "valorVencimento": 123
    }
  ]
}

{
  "msg": "<string>",
  "messages": [
    {
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "hasError": true,
  "erro": true,
  "mensagemOperador": "<string>",
  "periodo": "<string>",
  "resumoDoCliente": {
    "cnpjDaIfSolicitante": "<string>",
    "codigoDoCliente": "<string>",
    "coobrigacaoAssumida": 123,
    "coobrigacaoAssumidaSpecified": true,
    "coobrigacaoRecebida": 123,
    "coobrigacaoRecebidaSpecified": true,
    "dataBaseConsultada": "<string>",
    "dataInicioRelacionamento": "<string>",
    "listaDeMensagensDeValidacao": [
      {
        "codigo": "<string>",
        "mensagem": "<string>"
      }
    ],
    "listaDeResumoDasOperacoes": [
      {
        "listaDeVencimentos": [
          {
            "codigoVencimento": "<string>",
            "valorVencimento": 123,
            "valorVencimentoSpecified": true
          }
        ],
        "modalidade": "<string>",
        "variacaoCambial": "<string>"
      }
    ],
    "percentualDocumentosProcessados": "<string>",
    "percentualVolumeProcessado": "<string>",
    "quantidadeDeInstituicoes": 123,
    "quantidadeDeOperacoes": 123,
    "quantidadeOperacoesDiscordancia": 123,
    "quantidadeOperacoesSubJudice": 123,
    "responsabilidadeTotalDiscordancia": 123,
    "responsabilidadeTotalDiscordanciaSpecified": true,
    "responsabilidadeTotalSubJudice": 123,
    "responsabilidadeTotalSubJudiceSpecified": true,
    "riscoIndiretoVendor": 123,
    "riscoIndiretoVendorSpecified": true,
    "tipoDoCliente": "<string>"
  },
  "resumoDoClienteTraduzido": {
    "dtInicioRelacionamento": "<string>",
    "qtdeInstituicoes": 123,
    "qtdeOperacoes": 123,
    "qtdeOperacoesDiscordancia": 123,
    "vlrOperacoesDiscordancia": 123,
    "qtdeOperacoesSobJudice": 123,
    "vlrOperacoesSobJudice": 123,
    "carteiraVencer": 123,
    "carteiraVencerAte30diasVencidosAte14dias": 123,
    "carteiraVencer31a60dias": 123,
    "carteiraVencer61a90dias": 123,
    "carteiraVencer91a180dias": 123,
    "carteiraVencer181a360dias": 123,
    "carteiraVencerAcima360dias": 123,
    "carteiraVencerPrazoIndeterminado": 123,
    "moedaEstrangeiraValor": 123,
    "moedaEstrangeiraValor15a30dias": 123,
    "moedaEstrangeiraValor31a60dias": 123,
    "moedaEstrangeiraValor61a90dias": 123,
    "moedaEstrangeiraValor91a180dias": 123,
    "moedaEstrangeiraValor181a360dias": 123,
    "moedaEstrangeiraValorAcima360dias": 123,
    "carteiraVencido": 123,
    "carteiraVencido15a30dias": 123,
    "carteiraVencido31a60dias": 123,
    "carteiraVencido61a90dias": 123,
    "carteiraVencido91a180dias": 123,
    "carteiraVencido181a360dias": 123,
    "carteiraVencidoAcima360dias": 123,
    "prejuizo": 123,
    "prejuizoAte12meses": 123,
    "prejuizoAcima12meses": 123,
    "carteiradeCredito": 123,
    "repasses": 123,
    "coobrigacoes": 123,
    "responsabilidadeTotal": 123,
    "creditosaLiberar": 123,
    "creditosaLiberarAte360dias": 123,
    "creditosaLiberarAcima360dias": 123,
    "limitesdeCredito": 123,
    "limitesdeCreditoAte360dias": 123,
    "limitesdeCreditoAcima360dias": 123,
    "riscoIndiretoVendor": 123,
    "riscoTotal": 123,
    "tituloDeCredito": 123,
    "tituloDeCreditoCPR": 123,
    "tituloDeCreditoEN": 123,
    "tituloDeCreditoDebentures": 123,
    "tituloDeCreditoNotaComercial": 123,
    "tituloDeCreditoOutros": 123
  },
  "resumoModalidade": [
    {
      "tipo": "<string>",
      "modalidade": "<string>",
      "dominio": "<string>",
      "subdominio": "<string>",
      "valorVencimento": 123
    }
  ]
}

Through this endpoint, it is possible to consult the Loan and Financing Report (SCR), which shows the debts of Individuals and Legal Entities (up to date, overdue and in losses) with banks and financial institutions, in addition to other financial commitments in Reais and foreign currency.

• Type of transaction
• Active portfolio
• In arrears
• At a loss
• Co-obligations
• Available limit/credit
• Since when the relationship with IFs has been established.
• Risk evolution

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

erro · boolean

mensagemOperador · string | null

periodo · string | null

resumoDoCliente · object

Show child attributes

resumoDoClienteTraduzido · object

Show child attributes

resumoModalidade · object[] | null

Show child attributes