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

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

documentId

string

obrigatório

Document identifier, as the catalog publishes it.

Resposta

hasReferenceBinding

boolean

obrigatório

Whether the catalog ships a starting mapping for this document.

string

obrigatório

Document identifier, as a subscription names it.

Exemplo:

"br.bcb.cadoc-4010"

title

string

obrigatório

What the document is called.

Exemplo:

"Balancete Patrimonial Analítico"

version

string

obrigatório

Catalog version of this document.

Exemplo:

"1.0.0"

country

string

Exemplo:

"BR"

document

string

The regulator's own name for it.

Exemplo:

"4010"

family

string

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

Exemplo:

"cadoc"

institutionTypes

string[] | null

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

Exemplo:

["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.

Exemplo:

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

output

string

File format the regulator receives; absent means xml.

Exemplo:

"xml"

periodicity

string

Exemplo:

"monthly"

regulator

string

Exemplo:

"bcb"

status

string

Exemplo:

"active"

summary

string

What the document is, in one or two sentences.

Exemplo:

"Saldos por rubrica COSIF na data-base."

Primeiros passos

API de Templates

API do Construtor de Templates

API de Relatórios

API de Prazos

API de Fontes de Dados

API de Instituições

API de Catálogo Regulatório

API de Subscriptions Regulatórias

API de Mapeamentos Regulatórios

API de Relatórios Regulatórios

API de Métricas

API de Streaming

Tratamento de erros

Eventos

Get one regulatory document

Autorizações

Parâmetros de caminho

Resposta