curl --request POST \
--url http://localhost:4005/v1/regulatory/reports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"parameters": {
"dataBase": "2026-03"
}
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:4005/v1/regulatory/reports"
payload := strings.NewReader("{\n \"subscriptionId\": \"00000000-0000-0000-0000-000000000000\",\n \"parameters\": {\n \"dataBase\": \"2026-03\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subscriptionId: '00000000-0000-0000-0000-000000000000',
parameters: {dataBase: '2026-03'}
})
};
fetch('http://localhost:4005/v1/regulatory/reports', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:4005/v1/regulatory/reports"
payload = {
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"parameters": { "dataBase": "2026-03" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"openGaps": [
{
"field": "saldos_cosif.valor",
"reason": "a consulta mapeada não devolve esta coluna",
"required": true
}
],
"report": {
"allInstitutions": false,
"approvedAt": "2026-03-12T10:00:00Z",
"approvedBy": "9c1d7e34-2b6a-4f81-90a3-5e7f8d0a1b2c",
"completedAt": "2026-01-31T15:04:05Z",
"correctedAt": "2026-03-12T09:40:00Z",
"correctedBy": "3f9a1c2e-0f5b-4d9a-9b8e-1a2b3c4d5e6f",
"createdAt": "2026-01-31T15:00:00Z",
"deletedAt": "2026-02-01T09:00:00Z",
"documentId": "br.bcb.cadoc-4010",
"documentVersion": "1.0.0",
"draftVersion": 3,
"filters": {
"accounts": {
"account": {
"status": {
"eq": [
"ACTIVE"
]
}
}
}
},
"id": "00000000-0000-0000-0000-000000000001",
"institution": {
"cnpj": "12ABC34501DE35",
"id": "00000000-0000-0000-0000-000000000000",
"name": "Banco Exemplo S.A.",
"scope": {}
},
"metadata": {
"source": "ledger",
"tenant": "sandbox"
},
"openGaps": [
{
"field": "saldos_cosif.valor",
"reason": "a consulta mapeada não devolve esta coluna",
"required": true
}
],
"parameters": {
"dataBase": "2026-08"
},
"provenance": {
"catalog": {
"bindingVersion": 3,
"documentId": "br.bcb.cadoc-4010",
"documentVersion": "1.0.0",
"subscriptionId": "<string>",
"institution": {
"cnpj": "12ABC34501DE35",
"id": "00000000-0000-0000-0000-000000000000",
"name": "Banco Exemplo S.A.",
"scope": {}
}
},
"generatedAt": "2023-11-07T05:31:56Z",
"artifactChecksum": "e3b0c44298fc1c149afbf4c8996fb924...",
"artifactSizeBytes": 20480,
"parameters": {
"dataBase": "2026-03"
},
"template": {
"category": "cadoc4010",
"revision": 4,
"revisionChecksum": "9f2c...",
"templateId": "7c1e2f40-77d1-4a8a-9d0f-6b0e2c4a1111"
}
},
"status": "Processing",
"subscriptionId": "<string>",
"templateDescription": "Monthly accounting report",
"templateId": "00000000-0000-0000-0000-000000000002",
"templateOutputFormat": "pdf",
"updatedAt": "2026-01-31T15:04:05Z"
}
}{
"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"
}
}{
"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"
}
}Generate a filing of a subscribed document
Asks the worker to generate one filing: the binding in force is frozen into the request, the version is the one the subscription pinned, and the report comes out a DRAFT a person corrects and approves. The answer carries the fields nothing fills yet, so the blanks in the draft arrive expected rather than looking broken. Everything refusable cheaply is refused here: an inactive subscription, a missing required parameter, a binding that no longer plans.
curl --request POST \
--url http://localhost:4005/v1/regulatory/reports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"parameters": {
"dataBase": "2026-03"
}
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:4005/v1/regulatory/reports"
payload := strings.NewReader("{\n \"subscriptionId\": \"00000000-0000-0000-0000-000000000000\",\n \"parameters\": {\n \"dataBase\": \"2026-03\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
subscriptionId: '00000000-0000-0000-0000-000000000000',
parameters: {dataBase: '2026-03'}
})
};
fetch('http://localhost:4005/v1/regulatory/reports', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:4005/v1/regulatory/reports"
payload = {
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"parameters": { "dataBase": "2026-03" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"openGaps": [
{
"field": "saldos_cosif.valor",
"reason": "a consulta mapeada não devolve esta coluna",
"required": true
}
],
"report": {
"allInstitutions": false,
"approvedAt": "2026-03-12T10:00:00Z",
"approvedBy": "9c1d7e34-2b6a-4f81-90a3-5e7f8d0a1b2c",
"completedAt": "2026-01-31T15:04:05Z",
"correctedAt": "2026-03-12T09:40:00Z",
"correctedBy": "3f9a1c2e-0f5b-4d9a-9b8e-1a2b3c4d5e6f",
"createdAt": "2026-01-31T15:00:00Z",
"deletedAt": "2026-02-01T09:00:00Z",
"documentId": "br.bcb.cadoc-4010",
"documentVersion": "1.0.0",
"draftVersion": 3,
"filters": {
"accounts": {
"account": {
"status": {
"eq": [
"ACTIVE"
]
}
}
}
},
"id": "00000000-0000-0000-0000-000000000001",
"institution": {
"cnpj": "12ABC34501DE35",
"id": "00000000-0000-0000-0000-000000000000",
"name": "Banco Exemplo S.A.",
"scope": {}
},
"metadata": {
"source": "ledger",
"tenant": "sandbox"
},
"openGaps": [
{
"field": "saldos_cosif.valor",
"reason": "a consulta mapeada não devolve esta coluna",
"required": true
}
],
"parameters": {
"dataBase": "2026-08"
},
"provenance": {
"catalog": {
"bindingVersion": 3,
"documentId": "br.bcb.cadoc-4010",
"documentVersion": "1.0.0",
"subscriptionId": "<string>",
"institution": {
"cnpj": "12ABC34501DE35",
"id": "00000000-0000-0000-0000-000000000000",
"name": "Banco Exemplo S.A.",
"scope": {}
}
},
"generatedAt": "2023-11-07T05:31:56Z",
"artifactChecksum": "e3b0c44298fc1c149afbf4c8996fb924...",
"artifactSizeBytes": 20480,
"parameters": {
"dataBase": "2026-03"
},
"template": {
"category": "cadoc4010",
"revision": 4,
"revisionChecksum": "9f2c...",
"templateId": "7c1e2f40-77d1-4a8a-9d0f-6b0e2c4a1111"
}
},
"status": "Processing",
"subscriptionId": "<string>",
"templateDescription": "Monthly accounting report",
"templateId": "00000000-0000-0000-0000-000000000002",
"templateOutputFormat": "pdf",
"updatedAt": "2026-01-31T15:04:05Z"
}
}{
"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"
}
}{
"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
JWT bearer token issued by the identity provider.
Corpo
Subscription this filing is generated under.
"00000000-0000-0000-0000-000000000000"
Generation parameters, keyed by name as the contract declares them. A parameter the contract does not declare is refused. At most 50 parameters, each value at most 512 characters.
Show child attributes
Show child attributes
{ "dataBase": "2026-03" }
Esta página foi útil?

