PluggyDocs
GET/items/{id}/scr

Recuperar SCR

Recupera o SCR (Sistema de Informações de Crédito do Bacen) para o documento por trás de um item conectado. O SCR é o registro oficial do Banco Central das operações de crédito: cada empréstimo, financiamento, limite e garantia acima de R$200, reportados por cada instituição financeira. A resposta é a própria carga do Bacen, encaminhada sem alterações. O item não é a fonte dos dados — o SCR é indexado apenas pelo documento. O item fornece o CPF/CNPJ e serve como evidência do consentimento do titular da conta, razão pela qual isso está disponível apenas para itens de Open Finance cujo documento é conhecido. Requer o recurso SCR na sua assinatura. Fale conosco se você quiser que ele seja ativado. As datas base são meses, não dias, e o Bacen consolida cada uma com alguns meses de atraso. Quando `from` e `to` são omitidos, as últimas 4 datas base disponíveis são consultadas, terminando 2 meses atrás a partir de hoje — solicitar o mês atual não retorna nada, porque o Bacen ainda não o fechou.

Parameters

Path Parameters

NameType
idrequired
string (uuid)

Query Parameters

NameType
from
string
to
string

Responses

200Dados SCR para o documento do Item
object

Bacen's SCR response, forwarded exactly as the Banco Central returns it — field names, codes and all. Nothing is renamed or normalised, so a value read here is the same value an institution reads at the source.

dtbConsultrequiredstring

As datas base consultadas

cdClirequiredstring

O documento consultado: o CPF de um indivíduo ou a raiz do CNPJ de 8 dígitos de uma empresa

tpClirequiredstring

Tipo de cliente: "1" para pessoa física, "2" para pessoa jurídica

12
lsDtbobject[]

Uma entrada por data base consultada. Uma data base sem dados para o cliente ainda é listada, sem operações.

itemsobject

One consulted base date, and what the SCR holds for the client in it

listaDeMensagensDeValidacaoobject[]

Mensagens de validação geradas pelo Bacen para esta solicitação

itemsobject

Example response

json
{
  "dtbConsult": "202604 a 202607",
  "cdCli": "string",
  "tpCli": "1",
  "lsDtb": [
    {
      "dtb": 202607,
      "msg": "string",
      "docProc": "string",
      "volProc": "string",
      "qtdIfs": 0,
      "qtdCongFinc": 0,
      "dtbIniRel": "string",
      "coobAss": 0,
      "coobRec": 0,
      "lsOp": [
        {
          "mod": "string",
          "oriRec": "string",
          "indx": "string",
          "varCamb": "string",
          "subJDisc": "string",
          "resVenc": {
            "v20": 0,
            "v40": 0,
            "v60": 0,
            "v80": 0,
            "v110": 0,
            "v120": 0,
            "v130": 0,
            "v140": 0,
            "v150": 0,
            "v160": 0,
            "v165": 0,
            "v170": 0,
            "v175": 0,
            "v180": 0,
            "v190": 0,
            "v199": 0,
            "v205": 0,
            "v210": 0,
            "v220": 0,
            "v230": 0,
            "v240": 0,
            "v245": 0,
            "v250": 0,
            "v255": 0,
            "v260": 0,
            "v270": 0,
            "v280": 0,
            "v290": 0,
            "v310": 0,
            "v320": 0
          },
          "lsGar": [
            {
              "tp": "string",
              "qtd": 0
            }
          ],
          "lsInfAd": [
            {
              "tp": "string",
              "cd": "string",
              "qtd": 0
            }
          ]
        }
      ]
    }
  ],
  "listaDeMensagensDeValidacao": [
    {
      "codigo": "string",
      "mensagem": "string"
    }
  ]
}
curl -X GET \
  'https://api.pluggy.ai/items/{id}/scr' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'
Resposta de exemplo
{
  "dtbConsult": "202604 a 202607",
  "cdCli": "string",
  "tpCli": "1",
  "lsDtb": [
    {
      "dtb": 202607,
      "msg": "string",
      "docProc": "string",
      "volProc": "string",
      "qtdIfs": 0,
      "qtdCongFinc": 0,
      "dtbIniRel": "string",
      "coobAss": 0,
      "coobRec": 0,
      "lsOp": [
        {
          "mod": "string",
          "oriRec": "string",
          "indx": "string",
          "varCamb": "string",
          "subJDisc": "string",
          "resVenc": {
            "v20": 0,
            "v40": 0,
            "v60": 0,
            "v80": 0,
            "v110": 0,
            "v120": 0,
            "v130": 0,
            "v140": 0,
            "v150": 0,
            "v160": 0,
            "v165": 0,
            "v170": 0,
            "v175": 0,
            "v180": 0,
            "v190": 0,
            "v199": 0,
            "v205": 0,
            "v210": 0,
            "v220": 0,
            "v230": 0,
            "v240": 0,
            "v245": 0,
            "v250": 0,
            "v255": 0,
            "v260": 0,
            "v270": 0,
            "v280": 0,
            "v290": 0,
            "v310": 0,
            "v320": 0
          },
          "lsGar": [
            {
              "tp": "string",
              "qtd": 0
            }
          ],
          "lsInfAd": [
            {
              "tp": "string",
              "cd": "string",
              "qtd": 0
            }
          ]
        }
      ]
    }
  ],
  "listaDeMensagensDeValidacao": [
    {
      "codigo": "string",
      "mensagem": "string"
    }
  ]
}