Pular para o conteúdo principal
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"
  }
}'
{
  "msg": "<string>",
  "messages": [
    {
      "messageType": 1,
      "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
    }
  ]
}
Por meio desse endpoint é possível realizar a consulta do Relatório de Empréstimos e Financiamentos (SCR), onde mostra as dívidas de Pessoa Física e Pessoa Jurídica (em dia, vencidas e em prejuízos), com bancos e financeiras, além de outros compromissos financeiros em Reais e moeda estrangeira.
  • Tipo de operação;
  • Carteira ativa;
  • Em Atraso;
  • Com prejuízo;
  • Coobrigações;
  • Limite/Crédito disponíveis;
  • Desde quando tem relacionamento com Ifs;
  • Evolução do risco.

​
Modalidades

As modalidades de operação são os códigos que identificam os tipos de crédito registrados no SCR. Estrutura geral:
  • Tipo: mostra se o crédito está A VENCER ou VENCIDO na base de dados do SCR;
  • Modalidade: código que identifica a operação no SCR;
  • Domínio: categoria ampla de operações, por exemplo, Empréstimos, Financiamentos ou Direitos Creditórios.
  • Subdomínio: modalidade específica dentro do domínio, por exemplo Crédito Pessoal Consigna+do, Crédito Rotativo, Vendor, Financiamento de Veículos.
Cada código deve ser lido conforme sua descrição oficial.

​
Exemplo de Retorno com Modalidades

O campo modalidades do retorno completo do endpoint, representa a soma de todos os valores de uma determinada operação. Acesse as tabelas de referências dos códigos por modalidade abaixo.

​
Faixas de Vencimento

As faixas de vencimento, identificadas pelos códigos, classificam as operações de crédito conforme sua situação no tempo:
  • Quanto falta para vencer;
  • Quando os recursos serão liberados;
  • Há quanto tempo estão vencidas;
  • Se já foram baixadas.
Categorias e códigos aplicáveis:
  • Limites de Crédito: v20, v40;
  • Créditos a Liberar: v60, v80;
  • Créditos a Vencer: v110 a v199;
  • Créditos Vencidos: v205 a v290;
  • Créditos Baixados: v310 a v330;
Cada faixa deve ser usada conforme seu significado ao relizar consultas e regras de negócio, garantindo consistência na análise. Acesse as tabelas de referências dos códigos por Faixa de Vencimento abaixo.

Authorizations

​
Authorization
string
header
required

Informe o token

Headers

​
IdempotencyKey
string
required

Body

​
consulta
object

Response

Success

​
msg
string | null
​
messages
object[] | null
​
hasError
boolean
​
erro
boolean
​
mensagemOperador
string | null
​
periodo
string | null
​
resumoDoCliente
object
​
resumoDoClienteTraduzido
object
​
resumoModalidade
object[] | null