Approve a draft as the filing

curl --request POST \
  --url https://reporter.sandbox.lerian.net/v1/regulatory/reports/{reportId}/approve \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://reporter.sandbox.lerian.net/v1/regulatory/reports/{reportId}/approve"

	req, _ := http.NewRequest("POST", 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: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://reporter.sandbox.lerian.net/v1/regulatory/reports/{reportId}/approve', 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/reports/{reportId}/approve"

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

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

print(response.text)

{
  "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,
  "filingPeriod": "dataBase=2026-09",
  "filters": {
    "accounts": {
      "account": {
        "status": {
          "eq": [
            "ACTIVE"
          ]
        }
      }
    }
  },
  "generatedIds": [
    {
      "field": "header.eventId",
      "value": "000123456789012345"
    }
  ],
  "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,
      "list": true
    }
  ],
  "parameters": {
    "dataBase": "2026-08"
  },
  "provenance": {
    "catalog": {
      "bindingVersion": 3,
      "documentId": "br.bcb.cadoc-4010",
      "documentVersion": "1.0.0",
      "subscriptionId": "<string>",
      "bindingOrigin": "reference",
      "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"
    }
  },
  "remittance": "original",
  "status": "Processing",
  "subscriptionId": "<string>",
  "supersededBy": "00000000-0000-0000-0000-000000000003",
  "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"
  }
}

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

Approve a draft as the filing

Requires the ‘regulatory-approval’ permission AND a person: an application token is refused (403 RPT-0201, or 401 RPT-0158 where M2M inversion is off), so a workflow can generate and follow a report but only a person approves it. The permission is deliberately NOT the one that generates and corrects — that separation is what lets a client put approval in a second pair of hands. Freezes the draft as Final — the file a person accepted, at the version they read (If-Match, required). A draft with a REQUIRED field still blank is refused with 409: an incomplete file must never become the filing. A second approval of the same version by the SAME approver answers 200 again — that is a retry, and the report is approved either way; by a DIFFERENT approver it is refused, because the record would otherwise name whoever won a race. A different version is a conflict, because what they read is not what they would be approving. After approval nothing changes it: corrections are refused and the provenance is frozen for good.

POST

regulatory

reports

{reportId}

approve

Approve a draft as the filing

curl --request POST \
  --url https://reporter.sandbox.lerian.net/v1/regulatory/reports/{reportId}/approve \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://reporter.sandbox.lerian.net/v1/regulatory/reports/{reportId}/approve"

	req, _ := http.NewRequest("POST", 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: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://reporter.sandbox.lerian.net/v1/regulatory/reports/{reportId}/approve', 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/reports/{reportId}/approve"

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

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

print(response.text)

{
  "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,
  "filingPeriod": "dataBase=2026-09",
  "filters": {
    "accounts": {
      "account": {
        "status": {
          "eq": [
            "ACTIVE"
          ]
        }
      }
    }
  },
  "generatedIds": [
    {
      "field": "header.eventId",
      "value": "000123456789012345"
    }
  ],
  "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,
      "list": true
    }
  ],
  "parameters": {
    "dataBase": "2026-08"
  },
  "provenance": {
    "catalog": {
      "bindingVersion": 3,
      "documentId": "br.bcb.cadoc-4010",
      "documentVersion": "1.0.0",
      "subscriptionId": "<string>",
      "bindingOrigin": "reference",
      "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"
    }
  },
  "remittance": "original",
  "status": "Processing",
  "subscriptionId": "<string>",
  "supersededBy": "00000000-0000-0000-0000-000000000003",
  "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"
  }
}

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

Encabezados

If-Match

string

Draft version the caller read and is approving. Required.

Parámetros de ruta

reportId

string

requerido

Report identifier.

Respuesta

allInstitutions

boolean

The caller chose every institution, so the report read every institution's rows unscoped.

Ejemplo:

false

approvedAt

string<date-time>

When the report was approved, when it was.

Ejemplo:

"2026-03-12T10:00:00Z"

approvedBy

string

Who approved it, as the Access Manager subject identifier the bearer token named. Absent until approval; never blank on a Final, because an approval whose actor the request did not identify is refused.

Ejemplo:

"9c1d7e34-2b6a-4f81-90a3-5e7f8d0a1b2c"

completedAt

string<date-time> | null

Time when report generation completed, when available.

Ejemplo:

"2026-01-31T15:04:05Z"

correctedAt

string<date-time>

When the draft was last corrected, when it was.

Ejemplo:

"2026-03-12T09:40:00Z"

correctedBy

string

Who last corrected it, as the Access Manager subject identifier the bearer token named. Absent until the first correction; never blank on a report that has one, because a correction whose actor the request did not identify is refused.

Ejemplo:

"3f9a1c2e-0f5b-4d9a-9b8e-1a2b3c4d5e6f"

createdAt

string<date-time>

Time when the report was created.

Ejemplo:

"2026-01-31T15:00:00Z"

deletedAt

string<date-time> | null

Time when the report was soft-deleted, when applicable.

Ejemplo:

"2026-02-01T09:00:00Z"

documentId

string

Curated document this report generates.

Ejemplo:

"br.bcb.cadoc-4010"

documentVersion

string

Pinned version of the document it was generated against.

Ejemplo:

"1.0.0"

draftVersion

integer<int64>

Version of the draft; a correction or an approval must present the one it read.

Ejemplo:

3

filingPeriod

string

The filing period this generation is for, as the pinned contract's filing.period spells it: name=value of each period parameter in name order, joined by &, or * when the contract declares the document has no period (one filing for the document and the institution). Two generations of the same document for the same declarant CNPJ with the same filingPeriod and remittance are the same filing, whichever subscription generated them. Absent on an operational report and on a filing generated before the period was recorded.

Ejemplo:

"dataBase=2026-09"

filters

object

Filter conditions grouped by data source, table, and field.

Show child attributes

Ejemplo:

{
  "accounts": {
    "account": { "status": { "eq": ["ACTIVE"] } }
  }
}

generatedIds

object[] | null

Values the engine generated into the document's generated fields when the draft was made, each unique across the tenant's reports. A correction re-renders the same values; a new generation draws new ones. Present wherever the report is read, the list endpoint included; absent when the document generates nothing.

Show child attributes

string

Stable report identifier.

Ejemplo:

"00000000-0000-0000-0000-000000000001"

institution

object

The institution the report read for, frozen when it was requested: its scope is the part applied to the tables the report reads. Absent on a report that read for no institution.

Show child attributes

metadata

object

Additional report metadata keyed by attribute name.

Show child attributes

Ejemplo:

{ "source": "ledger", "tenant": "sandbox" }

openGaps

object[]

What a regulatory Draft still cannot fill, computed on read from the same stored state the approval refusal reads, each field flagged required or not. Present when a Draft is read by id; absent on a Final, on a non-regulatory report, and in the list endpoint, which does not compute it. Absent means unknown, an empty list means nothing is missing, and only a required gap refuses an approval.

Show child attributes

parameters

object

Generation parameters recorded with the report, when supplied.

Show child attributes

Ejemplo:

{ "dataBase": "2026-08" }

provenance

object

Everything this report was made of, frozen — what answers, months later, why it says what it says.

Option 1
Option 2

Show child attributes

remittance

string

original or replacement, as the pinned contract's filing.remittance reads the generation's parameters. Absent when the contract declares no remittance.

Ejemplo:

"original"

status

string

Current report generation status.

Ejemplo:

"Processing"

subscriptionId

string

Subscription this report files under; present only on the regulatory flow.

supersededBy

string

The newest Draft or Final of the same declarant (document and institution CNPJ, across subscriptions), filing period and remittance created after this report, which therefore stands in its place. Computed on read for regulatory filings that are not Final; absent when nothing supersedes the report, on a Final, on a filing without a recorded period and on an operational report.

Ejemplo:

"00000000-0000-0000-0000-000000000003"

templateDescription

string

Description copied from the template when the report was created.

Ejemplo:

"Monthly accounting report"

templateId

string

Template snapshot source identifier.

Ejemplo:

"00000000-0000-0000-0000-000000000002"

templateOutputFormat

string

Output format selected for the generated report.

Ejemplo:

"pdf"

updatedAt

string<date-time>

Time when the report was last updated.

Ejemplo:

"2026-01-31T15:04:05Z"

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

Approve a draft as the filing

Autorizaciones

Encabezados

Parámetros de ruta

Respuesta