Skip to main content
GET
Get one regulatory document

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

documentId
string
required

Document identifier, as the catalog publishes it.

Response

OK

hasReferenceBinding
boolean
required

Whether the catalog ships a starting mapping for this document.

id
string
required

Document identifier, as a subscription names it.

Example:

"br.bcb.cadoc-4010"

title
string
required

What the document is called.

Example:

"Balancete Patrimonial Analítico"

version
string
required

Catalog version of this document.

Example:

"1.0.0"

country
string
Example:

"BR"

document
string

The regulator's own name for it.

Example:

"4010"

family
string

Group of filings the document belongs to, as a lowercase code.

Example:

"cadoc"

institutionTypes
string[] | null

Types of institution required to file it, as the regulator codes them.

Example:
knownGaps
object[] | null

What this version of the document knowingly does not cover, as its contract declares it; absent when it declares nothing.

layout
object

Layout edition in force, on a document that has more than one.

officialSource
string

The regulator's own page for the document's layout.

Example:

"https://www.bcb.gov.br/estabilidadefinanceira/leiautedocumentoscrd"

output
string

File format the regulator receives; absent means xml.

Example:

"xml"

periodicity
string
Example:

"monthly"

regulator
string
Example:

"bcb"

status
string
Example:

"active"

summary
string

What the document is, in one or two sentences.

Example:

"Saldos por rubrica COSIF na data-base."