GEgetaxonflow
Compliance

Request a compliance report

Queue an asynchronous compliance report for a regulator and period. The job is returned immediately with status and progress; poll GET /api/v1/compliance/reports/{id} and then follow GET /api/v1/compliance/reports/{id}/download.

The request body is decoded with unknown fields REJECTED and a 32 KiB limit. period_start and period_end are RFC 3339.

This route is additionally gated by the tenant-wide audit export check, which refuses a caller without an admin or owner role with a 403 in the FLAT envelope rather than this module's own.

post/api/v1/compliance/reports

Request

Request body

regulatorstring required
frameworkstring
period_startstring date-time required
period_endstring date-time required
formatstring required

Response

Report job accepted

idstring
regulatorstring
frameworkstring
formatstring
period_startstring date-time
period_endstring date-time
statusstring
report_state'' | 'not_available' | 'enabled_empty' | 'populated'
progressinteger
record_countinteger
size_bytesinteger
checksumstring
errorstring
requested_bystring
created_atstring date-time
started_atstring date-time
completed_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.