PluggyDocs
GET/items/{id}/scr

Retrieve 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.

Parameters

Path Parameters

NameType
idrequired
string (uuid)

Query Parameters

NameType
from
string
to
string

Responses

200SCR data for the item document
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

The base dates consulted

cdClirequiredstring

The consulted document: the CPF for an individual, or the 8-digit CNPJ root for a company

tpClirequiredstring

Type of client: "1" for an individual, "2" for a legal entity

12
lsDtbobject[]

One entry per consulted base date. A base date with no data for the client is still listed, with no operations

itemsobject

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

listaDeMensagensDeValidacaoobject[]

Validation messages raised by Bacen for this request

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

Code Examples

bash
curl -X GET 'https://api.pluggy.ai/items/{id}/scr' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'

Try It

Path Parameters
Query Parameters