Procurando a documentação anterior?Acesse v1.docs.pluggy.ai
PluggyDocs
GET/items/{id}/scr

Recuperar SCR

Retrieves the SCR (Bacen's *Sistema de Informações de Crédito*) for the document behind a connected item. The SCR is the Banco Central's official registry of credit operations: every loan, financing, limit and guarantee above R$200, reported by every financial institution. The response is Bacen's own payload, forwarded unchanged. The item is not the source of the data — the SCR is keyed by the document alone. The item supplies the CPF/CNPJ and stands as the evidence of the account holder's consent, which is why this is only available for Open Finance items whose document is known. Requires the SCR feature on your subscription. Talk to us if you want it enabled. Base dates are months, not days, and Bacen consolidates each one with a few months of delay. When `from` and `to` are omitted the last 4 available base dates are consulted, ending 2 months back from today — asking for the current month returns nothing, because Bacen has not closed it yet. **Sandbox.** An item created with the *Sandbox Open Finance* connector (`600`) returns a synthetic payload with exactly this schema, so you can integrate without connecting a real account. The values are deterministic — the same item and window always return the same response — no consultation reaches Bacen, and nothing is billed. The same checks apply as in production: the SCR feature must be enabled on your subscription, the item must be Open Finance, and `from`/`to` are validated; the sandbox additionally rejects windows longer than 60 base dates with `SCR_INVALID_REQUEST`.

Parameters

Path Parameters

NameType
idrequired
string (uuid)

Query Parameters

NameType
from
string
to
string

Responses

200Dados SCR para o documento do Item
object

Resposta do SCR do Bacen, encaminhada exatamente como o Banco Central a retorna — nomes de campos, códigos e tudo mais. Nada é renomeado ou normalizado, então um valor lido aqui é o mesmo valor que uma instituição lê na fonte.

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

Uma data base consultada e o que o SCR possui para o cliente nela

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"
    }
  ]
}