Open Finance e SCR

Consulta SCR (Modalidade por Situação de Vencimento)

O serviço de Consulta SCR - Pessoa Física (Modalidade por Situação de Vencimento) retorna a distribuição das modalidades por situação de vencimento no SCR.

Falar com o comercial Ver o catálogo

Quando usar

Descrição

O serviço de Consulta SCR (Modalidade por Situação de Vencimento) fornece acesso ao SCR do Banco Central do Brasil para obter informações de crédito de pessoa física, incluindo operações ativas, vencidas, sub judice e manifestações de discordância, organizando as operações por modalidade e situação de vencimento para avaliar atrasos e parcelas futuras.

O serviço de Consulta SCR (Modalidade por Situação de Vencimento) retorna informações detalhadas sobre a posição de crédito da pessoa física, incluindo quantidade de operações, instituições financeiras, operações sub judice, manifestações de discordância e coobrigações, detalhando a lista de vencimentos com o código da situação e o valor consolidado por faixa (aging).

Requisição

Autenticação por chave de API (cabeçalho Authorization: Bearer), criada no painel com esta consulta no escopo.

POST /api/v1/{tenant}/pessoas/consulta-scr-modalidade-por-situacao-de-vencimento

CampoObrigatórioDescrição
document sim CPF da pessoa, com ou sem máscara. 
{
  "document": "000.000.000-00"
}

Campos de retorno

Campos dentro de data. [] indica lista.

CampoTipo
codigoDoCliente texto
tipoDoCliente texto
nomeCliente texto
documentoFormatado texto
dataBases.mesAtual.dataBaseConsultada texto
dataBases.mesAtual.percentualDocumentosProcessados número
dataBases.mesAtual.percentualVolumeProcessado número
dataBases.mesAtual.quantidadeDeInstituicoes número
dataBases.mesAtual.quantidadeDeOperacoes número
dataBases.mesAtual.dataInicioRelacionamento texto
dataBases.mesAtual.quantidadeOperacoesDiscordancia número
dataBases.mesAtual.quantidadeOperacoesSubJudice número
dataBases.mesAtual.responsabilidadeTotalDiscordancia número
dataBases.mesAtual.responsabilidadeTotalSubJudice número
dataBases.mesAtual.listaDeResumoDasOperacoes[].modalidade texto
dataBases.mesAtual.listaDeResumoDasOperacoes[].origemRecursos texto
dataBases.mesAtual.listaDeResumoDasOperacoes[].indice texto
dataBases.mesAtual.listaDeResumoDasOperacoes[].variacaoCambial texto
dataBases.mesAtual.listaDeResumoDasOperacoes[].segmento texto
dataBases.mesAtual.listaDeResumoDasOperacoes[].listaDeVencimentos[].codigoVencimento texto
dataBases.mesAtual.listaDeResumoDasOperacoes[].listaDeVencimentos[].valorVencimento número
dataBases.mesAtual.listaDeResumoDasOperacoes[].subJDisc texto
dataBases.mesAtual.coobrigacaoAssumida número
dataBases.mesAtual.coobrigacaoRecebida número
dataBases.mesAtual.riscoIndiretoVendor número
dataBases.mesAtual.carteiraAtivaTotal_situacao.aVencer número
dataBases.mesAtual.carteiraAtivaTotal_situacao.vencido número
dataBases.mesAtual.carteiraAtivaTotal_situacao.prejuizo número
dataBases.mesAtual.carteiraAtivaTotal_situacao.total número
dataBases.mesAtual.carteiraAtivaTotal_situacao.percentualAVencer número
dataBases.mesAtual.carteiraAtivaTotal_situacao.percentualVencido número
dataBases.mesAtual.carteiraAtivaTotal_situacao.percentualPrejuizo número
dataBases.mesAtual.carteiraAtivaTotal_situacao.percentualTotalRiscoTotal número
dataBases.mesAtual.prejuizoTotal_situacao.aVencer número
dataBases.mesAtual.prejuizoTotal_situacao.vencido número
dataBases.mesAtual.prejuizoTotal_situacao.prejuizo número
dataBases.mesAtual.prejuizoTotal_situacao.total número
dataBases.mesAtual.prejuizoTotal_situacao.percentualAVencer número
dataBases.mesAtual.prejuizoTotal_situacao.percentualVencido número
dataBases.mesAtual.prejuizoTotal_situacao.percentualPrejuizo número
dataBases.mesAtual.prejuizoTotal_situacao.percentualTotalRiscoTotal número
dataBases.mesAtual.baixadoAte12m_situacao.aVencer número
dataBases.mesAtual.baixadoAte12m_situacao.vencido número
dataBases.mesAtual.baixadoAte12m_situacao.prejuizo número
dataBases.mesAtual.baixadoAte12m_situacao.total número
dataBases.mesAtual.baixadoAte12m_situacao.percentualAVencer número
dataBases.mesAtual.baixadoAte12m_situacao.percentualVencido número
dataBases.mesAtual.baixadoAte12m_situacao.percentualPrejuizo número
dataBases.mesAtual.baixadoAte12m_situacao.percentualTotalRiscoTotal número
dataBases.mesAtual.baixado12A48m_situacao.aVencer número
dataBases.mesAtual.baixado12A48m_situacao.vencido número
dataBases.mesAtual.baixado12A48m_situacao.prejuizo número
dataBases.mesAtual.baixado12A48m_situacao.total número
dataBases.mesAtual.baixado12A48m_situacao.percentualAVencer número
dataBases.mesAtual.baixado12A48m_situacao.percentualVencido número
dataBases.mesAtual.baixado12A48m_situacao.percentualPrejuizo número
dataBases.mesAtual.baixado12A48m_situacao.percentualTotalRiscoTotal número
dataBases.mesAtual.carteiraDeCreditoTotal_situacao.aVencer número
dataBases.mesAtual.carteiraDeCreditoTotal_situacao.vencido número
dataBases.mesAtual.carteiraDeCreditoTotal_situacao.prejuizo número
dataBases.mesAtual.carteiraDeCreditoTotal_situacao.total número
dataBases.mesAtual.carteiraDeCreditoTotal_situacao.percentualAVencer número
dataBases.mesAtual.carteiraDeCreditoTotal_situacao.percentualVencido número
dataBases.mesAtual.carteiraDeCreditoTotal_situacao.percentualPrejuizo número
dataBases.mesAtual.carteiraDeCreditoTotal_situacao.percentualTotalRiscoTotal número
dataBases.mesAtual.titulosDeCredito_situacao.aVencer número
dataBases.mesAtual.titulosDeCredito_situacao.vencido número
dataBases.mesAtual.titulosDeCredito_situacao.prejuizo número
dataBases.mesAtual.titulosDeCredito_situacao.total número
dataBases.mesAtual.titulosDeCredito_situacao.percentualAVencer número
dataBases.mesAtual.titulosDeCredito_situacao.percentualVencido número
dataBases.mesAtual.titulosDeCredito_situacao.percentualPrejuizo número
dataBases.mesAtual.titulosDeCredito_situacao.percentualTotalRiscoTotal número
dataBases.mesAtual.repassesInterfinanceiros_situacao.aVencer número
dataBases.mesAtual.repassesInterfinanceiros_situacao.vencido número
dataBases.mesAtual.repassesInterfinanceiros_situacao.prejuizo número
dataBases.mesAtual.repassesInterfinanceiros_situacao.total número
dataBases.mesAtual.repassesInterfinanceiros_situacao.percentualAVencer número
dataBases.mesAtual.repassesInterfinanceiros_situacao.percentualVencido número
dataBases.mesAtual.repassesInterfinanceiros_situacao.percentualPrejuizo número
dataBases.mesAtual.repassesInterfinanceiros_situacao.percentualTotalRiscoTotal número
dataBases.mesAtual.coobrigacaoTotal_situacao.aVencer número
dataBases.mesAtual.coobrigacaoTotal_situacao.vencido número
dataBases.mesAtual.coobrigacaoTotal_situacao.prejuizo número
dataBases.mesAtual.coobrigacaoTotal_situacao.total número
dataBases.mesAtual.coobrigacaoTotal_situacao.percentualAVencer número
dataBases.mesAtual.coobrigacaoTotal_situacao.percentualVencido número
dataBases.mesAtual.coobrigacaoTotal_situacao.percentualPrejuizo número
dataBases.mesAtual.coobrigacaoTotal_situacao.percentualTotalRiscoTotal número
dataBases.mesAtual.coobrigacaoAssumida_situacao.aVencer número
dataBases.mesAtual.coobrigacaoAssumida_situacao.vencido número
dataBases.mesAtual.coobrigacaoAssumida_situacao.prejuizo número
dataBases.mesAtual.coobrigacaoAssumida_situacao.total número
dataBases.mesAtual.coobrigacaoAssumida_situacao.percentualAVencer número
dataBases.mesAtual.coobrigacaoAssumida_situacao.percentualVencido número
dataBases.mesAtual.coobrigacaoAssumida_situacao.percentualPrejuizo número
dataBases.mesAtual.coobrigacaoAssumida_situacao.percentualTotalRiscoTotal número
dataBases.mesAtual.garantiasPrestadas_situacao.aVencer número
dataBases.mesAtual.garantiasPrestadas_situacao.vencido número
dataBases.mesAtual.garantiasPrestadas_situacao.prejuizo número
dataBases.mesAtual.garantiasPrestadas_situacao.total número
dataBases.mesAtual.garantiasPrestadas_situacao.percentualAVencer número
dataBases.mesAtual.garantiasPrestadas_situacao.percentualVencido número
dataBases.mesAtual.garantiasPrestadas_situacao.percentualPrejuizo número
dataBases.mesAtual.garantiasPrestadas_situacao.percentualTotalRiscoTotal número
dataBases.mesAtual.responsabilidadeTotal_situacao.aVencer número
dataBases.mesAtual.responsabilidadeTotal_situacao.vencido número
dataBases.mesAtual.responsabilidadeTotal_situacao.prejuizo número
dataBases.mesAtual.responsabilidadeTotal_situacao.total número
dataBases.mesAtual.responsabilidadeTotal_situacao.percentualAVencer número
dataBases.mesAtual.responsabilidadeTotal_situacao.percentualVencido número
dataBases.mesAtual.responsabilidadeTotal_situacao.percentualPrejuizo número
dataBases.mesAtual.responsabilidadeTotal_situacao.percentualTotalRiscoTotal número
dataBases.mesAtual.creditoALiberarTotal_situacao.aVencer número
dataBases.mesAtual.creditoALiberarTotal_situacao.vencido número
dataBases.mesAtual.creditoALiberarTotal_situacao.prejuizo número
dataBases.mesAtual.creditoALiberarTotal_situacao.total número
dataBases.mesAtual.creditoALiberarTotal_situacao.percentualAVencer número
dataBases.mesAtual.creditoALiberarTotal_situacao.percentualVencido número
dataBases.mesAtual.creditoALiberarTotal_situacao.percentualPrejuizo número
dataBases.mesAtual.creditoALiberarTotal_situacao.percentualTotalRiscoTotal número
dataBases.mesAtual.creditoALiberarAte360_situacao.aVencer número
dataBases.mesAtual.creditoALiberarAte360_situacao.vencido número
dataBases.mesAtual.creditoALiberarAte360_situacao.prejuizo número
dataBases.mesAtual.creditoALiberarAte360_situacao.total número
dataBases.mesAtual.creditoALiberarAte360_situacao.percentualAVencer número
dataBases.mesAtual.creditoALiberarAte360_situacao.percentualVencido número
dataBases.mesAtual.creditoALiberarAte360_situacao.percentualPrejuizo número
dataBases.mesAtual.creditoALiberarAte360_situacao.percentualTotalRiscoTotal número
dataBases.mesAtual.creditoALiberarAcima360_situacao.aVencer número
dataBases.mesAtual.creditoALiberarAcima360_situacao.vencido número
dataBases.mesAtual.creditoALiberarAcima360_situacao.prejuizo número
dataBases.mesAtual.creditoALiberarAcima360_situacao.total número
dataBases.mesAtual.creditoALiberarAcima360_situacao.percentualAVencer número
dataBases.mesAtual.creditoALiberarAcima360_situacao.percentualVencido número
dataBases.mesAtual.creditoALiberarAcima360_situacao.percentualPrejuizo número
dataBases.mesAtual.creditoALiberarAcima360_situacao.percentualTotalRiscoTotal número
dataBases.mesAtual.limitesCreditoTotal_situacao.aVencer número
dataBases.mesAtual.limitesCreditoTotal_situacao.vencido número
dataBases.mesAtual.limitesCreditoTotal_situacao.prejuizo número
dataBases.mesAtual.limitesCreditoTotal_situacao.total número
dataBases.mesAtual.limitesCreditoTotal_situacao.percentualAVencer número
dataBases.mesAtual.limitesCreditoTotal_situacao.percentualVencido número
dataBases.mesAtual.limitesCreditoTotal_situacao.percentualPrejuizo número
dataBases.mesAtual.limitesCreditoTotal_situacao.percentualTotalRiscoTotal número
dataBases.mesAtual.limiteCreditoAte360_situacao.aVencer número
dataBases.mesAtual.limiteCreditoAte360_situacao.vencido número
dataBases.mesAtual.limiteCreditoAte360_situacao.prejuizo número
dataBases.mesAtual.limiteCreditoAte360_situacao.total número
dataBases.mesAtual.limiteCreditoAte360_situacao.percentualAVencer número

Lista parcial: os 150 primeiros campos.

Exemplo de resposta

Estrutura real da resposta, com valores fictícios.

{
  "execution_id": "00000000-0000-0000-0000-000000000000",
  "status": "success",
  "message": "Consulta realizada com sucesso",
  "query_name": "Consulta SCR (Modalidade por Situação de Vencimento)",
  "query_slug": "consulta-scr-modalidade-por-situacao-de-vencimento",
  "data": {
    "codigoDoCliente": "texto",
    "tipoDoCliente": "texto",
    "nomeCliente": "texto",
    "documentoFormatado": "texto",
    "dataBases": {
      "mesAtual": {
        "dataBaseConsultada": "texto",
        "percentualDocumentosProcessados": 0,
        "percentualVolumeProcessado": 0,
        "quantidadeDeInstituicoes": 0,
        "quantidadeDeOperacoes": 0,
        "dataInicioRelacionamento": "texto",
        "quantidadeOperacoesDiscordancia": 0,
        "quantidadeOperacoesSubJudice": 0,
        "responsabilidadeTotalDiscordancia": 0,
        "responsabilidadeTotalSubJudice": 0,
        "listaDeResumoDasOperacoes": [
          {
            "modalidade": "texto",
            "origemRecursos": "texto",
            "indice": "texto",
            "variacaoCambial": "texto",
            "segmento": "texto",
            "listaDeVencimentos": [
              {
                "codigoVencimento": "texto",
                "valorVencimento": 0
              }
            ],
            "subJDisc": "texto"
          }
        ],
        "coobrigacaoAssumida": 0,
        "coobrigacaoRecebida": 0,
        "riscoIndiretoVendor": 0,
        "carteiraAtivaTotal_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "prejuizoTotal_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "baixadoAte12m_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "baixado12A48m_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "carteiraDeCreditoTotal_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "titulosDeCredito_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "repassesInterfinanceiros_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "coobrigacaoTotal_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "coobrigacaoAssumida_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "garantiasPrestadas_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "responsabilidadeTotal_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "creditoALiberarTotal_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "creditoALiberarAte360_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "creditoALiberarAcima360_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "limitesCreditoTotal_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "limiteCreditoAte360_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "limiteCreditoAcima360_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "riscoIndireto_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "riscoGarantidor_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "riscoTotal_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "coobrigacaoRecebida_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "situacao_por_modalidade": [
          {
            "aVencer": 0,
            "vencido": 0,
            "prejuizo": 0,
            "total": 0,
            "percentualAVencer": 0,
            "percentualVencido": 0,
            "percentualPrejuizo": 0,
            "percentualTotalRiscoTotal": 0
          }
        ],
        "totais_grupos_situacao": {
          "EMPRESTIMOS": {
            "aVencer": 0,
            "vencido": 0,
            "prejuizo": 0,
            "total": 0,
            "percentualAVencer": 0,
            "percentualVencido": 0,
            "percentualPrejuizo": 0,
            "percentualTotalRiscoTotal": 0
          },
          "FINANCIAMENTOS": {
            "aVencer": 0,
            "vencido": 0,
            "prejuizo": 0,
            "total": 0,
            "percentualAVencer": 0,
            "percentualVencido": 0,
            "percentualPrejuizo": 0,
            "percentualTotalRiscoTotal": 0
          },
          "FINANCIAMENTOS_RURAIS": {
            "aVencer": 0,
            "vencido": 0,
            "prejuizo": 0,
            "total": 0,
            "percentualAVencer": 0,
            "percentualVencido": 0,
            "percentualPrejuizo": 0,
            "percentualTotalRiscoTotal": 0
          },
          "FINANCIAMENTOS_HABITACIONAIS": {
            "aVencer": 0,
            "vencido": 0,
            "prejuizo": 0,
            "total": 0,
            "percentualAVencer": 0,
            "percentualVencido": 0,
            "percentualPrejuizo": 0,
            "percentualTotalRiscoTotal": 0
          },
          "OUTROS_CREDITOS": {
            "aVencer": 0,
            "vencido": 0,
            "prejuizo": 0,
            "total": 0,
            "percentualAVencer": 0,
            "percentualVencido": 0,
            "percentualPrejuizo": 0,
            "percentualTotalRiscoTotal": 0
          }
        }
      },
      "mesAnterior": {
        "dataBaseConsultada": "texto",
        "percentualDocumentosProcessados": 0,
        "percentualVolumeProcessado": 0,
        "quantidadeDeInstituicoes": 0,
        "quantidadeDeOperacoes": 0,
        "dataInicioRelacionamento": "texto",
        "quantidadeOperacoesDiscordancia": 0,
        "quantidadeOperacoesSubJudice": 0,
        "responsabilidadeTotalDiscordancia": 0,
        "responsabilidadeTotalSubJudice": 0,
        "listaDeResumoDasOperacoes": [
          {
            "modalidade": "texto",
            "origemRecursos": "texto",
            "indice": "texto",
            "variacaoCambial": "texto",
            "segmento": "texto",
            "listaDeVencimentos": [
              {
                "codigoVencimento": "texto",
                "valorVencimento": 0
              }
            ],
            "subJDisc": "texto"
          }
        ],
        "coobrigacaoAssumida": 0,
        "coobrigacaoRecebida": 0,
        "riscoIndiretoVendor": 0,
        "carteiraAtivaTotal_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "prejuizoTotal_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "baixadoAte12m_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "baixado12A48m_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "carteiraDeCreditoTotal_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "titulosDeCredito_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "repassesInterfinanceiros_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "coobrigacaoTotal_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "coobrigacaoAssumida_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "garantiasPrestadas_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "responsabilidadeTotal_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "creditoALiberarTotal_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "creditoALiberarAte360_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "creditoALiberarAcima360_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "limitesCreditoTotal_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "limiteCreditoAte360_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "limiteCreditoAcima360_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "riscoIndireto_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "riscoGarantidor_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "riscoTotal_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "coobrigacaoRecebida_situacao": {
          "aVencer": 0,
          "vencido": 0,
          "prejuizo": 0,
          "total": 0,
          "percentualAVencer": 0,
          "percentualVencido": 0,
          "percentualPrejuizo": 0,
          "percentualTotalRiscoTotal": 0
        },
        "situacao_por_modalidade": [
          {
            "aVencer": 0,
            "vencido": 0,
            "prejuizo": 0,
            "total": 0,
            "percentualAVencer": 0,
            "percentualVencido": 0,
            "percentualPrejuizo": 0,
            "percentualTotalRiscoTotal": 0
          }
        ],
        "totais_grupos_situacao": {
          "EMPRESTIMOS": {
            "aVencer": 0,
            "vencido": 0,
            "prejuizo": 0,
            "total": 0,
            "percentualAVencer": 0,
            "percentualVencido": 0,
            "percentualPrejuizo": 0,
            "percentualTotalRiscoTotal": 0
          },
          "FINANCIAMENTOS": {
            "aVencer": 0,
            "vencido": 0,
            "prejuizo": 0,
            "total": 0,
            "percentualAVencer": 0,
            "percentualVencido": 0,
            "percentualPrejuizo": 0,
            "percentualTotalRiscoTotal": 0
          },
          "FINANCIAMENTOS_RURAIS": {
            "aVencer": 0,
            "vencido": 0,
            "prejuizo": 0,
            "total": 0,
            "percentualAVencer": 0,
            "percentualVencido": 0,
            "percentualPrejuizo": 0,
            "percentualTotalRiscoTotal": 0
          },
          "FINANCIAMENTOS_HABITACIONAIS": {
            "aVencer": 0,
            "vencido": 0,
            "prejuizo": 0,
            "total": 0,
            "percentualAVencer": 0,
            "percentualVencido": 0,
            "percentualPrejuizo": 0,
            "percentualTotalRiscoTotal": 0
          },
          "OUTROS_CREDITOS": {
            "aVencer": 0,
            "vencido": 0,
            "prejuizo": 0,
            "total": 0,
            "percentualAVencer": 0,
            "percentualVencido": 0,
            "percentualPrejuizo": 0,
            "percentualTotalRiscoTotal": 0
          }
        }
      }
    }
  },
  "consulted_at": "2026-01-01T12:00:00Z",
  "query_cost": "0.160"
}

Cobrança e respostas

  • O valor é cobrado por consulta bem-sucedida.
  • 200 — consulta processada (veja status no corpo da resposta)
  • 401 — token ausente, inválido, inativo ou expirado
  • 403 — serviço fora do escopo da chave, IP não autorizado ou limite de consumo excedido
  • 422 — campo obrigatório ausente/inválido ou payload acima do limite do serviço
  • 429 — limite de requisições por minuto da chave excedido
  • 504 — tempo máximo de execução do serviço excedido