Skip to main content
POST
Create regulatory report

Body

application/json
analysis_uuid
string<uuid>
required

Source analysis UUID to build the report from.

institution_type
enum<string>
required

Institution type selecting the sector norm (banco=BCB, seguradora=SUSEP).

Available options:
banco,
seguradora
operation
ReportOperationInput · object | null

Optional COAF/COS filing data the analysis does not carry (reporting institution, transactional values, occurrence code, involved parties, related operations). When provided, the generated XML is complete; otherwise it is produced partially from analysis data.

source
string | null

Optional caller-defined source label.

Maximum string length: 128
Example:

"frontend"

Response

Successful Response

Complete regulatory report returned by POST and GET /reports/{uuid}.

A synchronously-returned report is always COMPLETED; failures do not persist, so the queue-lifecycle fields (status/error/timestamps) are dropped. result carries the XML/PDF storage references (bucket/key/uri) — artifacts live in MinIO, not inline in the response.

analysis_uuid
string<uuid>
required

Source analysis UUID.

institution_type
enum<string>
required

Institution type used.

Available options:
banco,
seguradora
result
ReportResult · object | null
required

Complete assembled report result.

uuid
string<uuid>
required

Report execution UUID.