Get one regulatory document

curl --request GET \
  --url https://reporter.sandbox.lerian.net/v1/regulatory/documents/{documentId} \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://reporter.sandbox.lerian.net/v1/regulatory/documents/{documentId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://reporter.sandbox.lerian.net/v1/regulatory/documents/{documentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://reporter.sandbox.lerian.net/v1/regulatory/documents/{documentId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "hasReferenceBinding": true,
  "id": "br.bcb.cadoc-4010",
  "title": "Balancete Patrimonial Analítico",
  "version": "1.0.0",
  "country": "BR",
  "document": "4010",
  "family": "cadoc",
  "institutionTypes": [
    "IP",
    "SCD",
    "SCFI"
  ],
  "layout": {
    "mandatoryFrom": "2025-01-02",
    "version": "2025-01"
  },
  "officialSource": "https://www.bcb.gov.br/estabilidadefinanceira/leiautedocumentoscrd",
  "output": "xml",
  "periodicity": "monthly",
  "regulator": "bcb",
  "status": "active",
  "summary": "Saldos por rubrica COSIF na data-base."
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

GET

regulatory

documents

{documentId}

Get one regulatory document

curl --request GET \
  --url https://reporter.sandbox.lerian.net/v1/regulatory/documents/{documentId} \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://reporter.sandbox.lerian.net/v1/regulatory/documents/{documentId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://reporter.sandbox.lerian.net/v1/regulatory/documents/{documentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://reporter.sandbox.lerian.net/v1/regulatory/documents/{documentId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "hasReferenceBinding": true,
  "id": "br.bcb.cadoc-4010",
  "title": "Balancete Patrimonial Analítico",
  "version": "1.0.0",
  "country": "BR",
  "document": "4010",
  "family": "cadoc",
  "institutionTypes": [
    "IP",
    "SCD",
    "SCFI"
  ],
  "layout": {
    "mandatoryFrom": "2025-01-02",
    "version": "2025-01"
  },
  "officialSource": "https://www.bcb.gov.br/estabilidadefinanceira/leiautedocumentoscrd",
  "output": "xml",
  "periodicity": "monthly",
  "regulator": "bcb",
  "status": "active",
  "summary": "Saldos por rubrica COSIF na data-base."
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "body.templateId",
      "message": "expected string to match 'uuid' format",
      "value": "not-a-uuid"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

documentId

string

requerido

Document identifier, as the catalog publishes it.

Respuesta

hasReferenceBinding

boolean

requerido

Whether the catalog ships a starting mapping for this document.

string

requerido

Document identifier, as a subscription names it.

Ejemplo:

"br.bcb.cadoc-4010"

title

string

requerido

What the document is called.

Ejemplo:

"Balancete Patrimonial Analítico"

version

string

requerido

Catalog version of this document.

Ejemplo:

"1.0.0"

country

string

Ejemplo:

"BR"

document

string

The regulator's own name for it.

Ejemplo:

"4010"

family

string

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

Ejemplo:

"cadoc"

institutionTypes

string[] | null

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

Ejemplo:

["IP", "SCD", "SCFI"]

layout

object

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

Show child attributes

officialSource

string

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

Ejemplo:

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

output

string

File format the regulator receives; absent means xml.

Ejemplo:

"xml"

periodicity

string

Ejemplo:

"monthly"

regulator

string

Ejemplo:

"bcb"

status

string

Ejemplo:

"active"

summary

string

What the document is, in one or two sentences.

Ejemplo:

"Saldos por rubrica COSIF na data-base."

Primeros pasos

API de Plantillas

API del Constructor de Plantillas

API de Informes

API de Plazos

API de Fuentes de Datos

API de Instituciones

API de Catálogo Regulatorio

API de Suscripciones Regulatorias

API de Mapeos Regulatorios

API de Informes Regulatorios

API de Métricas

API de Streaming

Manejo de errores

Eventos

Get one regulatory document

Autorizaciones

Parámetros de ruta

Respuesta