Get a report
Returns report information for the given ID.
Authorizations
JWT bearer token issued by the identity provider.
Path Parameters
Report ID
Response
OK
The caller chose every institution, so the report read every institution's rows unscoped.
false
When the report was approved, when it was.
"2026-03-12T10:00:00Z"
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.
"9c1d7e34-2b6a-4f81-90a3-5e7f8d0a1b2c"
Time when report generation completed, when available.
"2026-01-31T15:04:05Z"
When the draft was last corrected, when it was.
"2026-03-12T09:40:00Z"
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.
"3f9a1c2e-0f5b-4d9a-9b8e-1a2b3c4d5e6f"
Time when the report was created.
"2026-01-31T15:00:00Z"
Time when the report was soft-deleted, when applicable.
"2026-02-01T09:00:00Z"
Curated document this report generates.
"br.bcb.cadoc-4010"
Pinned version of the document it was generated against.
"1.0.0"
Version of the draft; a correction or an approval must present the one it read.
3
Filter conditions grouped by data source, table, and field.
Stable report identifier.
"00000000-0000-0000-0000-000000000001"
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.
Additional report metadata keyed by attribute name.
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.
Generation parameters recorded with the report, when supplied.
Everything this report was made of, frozen — what answers, months later, why it says what it says.
- Option 1
- Option 2
Current report generation status.
"Processing"
Subscription this report files under; present only on the regulatory flow.
Description copied from the template when the report was created.
"Monthly accounting report"
Template snapshot source identifier.
"00000000-0000-0000-0000-000000000002"
Output format selected for the generated report.
"pdf"
Time when the report was last updated.
"2026-01-31T15:04:05Z"

