API References
Loan and Financing Report (SCR)
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,
"limitesdeCredito": 123,
"limitesdeCreditoAte360dias": 123,
"limitesdeCreditoAcima360dias": 123,
"riscoIndiretoVendor": 123,
"riscoTotal": 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
Informe o token
Headers
Body
Response
200
text/plain
Success
The response is of type object
.
Was this page helpful?
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,
"limitesdeCredito": 123,
"limitesdeCreditoAte360dias": 123,
"limitesdeCreditoAcima360dias": 123,
"riscoIndiretoVendor": 123,
"riscoTotal": 123
},
"resumoModalidade": [
{
"tipo": "<string>",
"modalidade": "<string>",
"dominio": "<string>",
"subdominio": "<string>",
"valorVencimento": 123
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.