Reports API¶
The Reports API generates compliance and reconciliation reports and provides download/status endpoints.
Endpoints¶
Generate Compliance Report¶
Request Body¶
| Field | Type | Required | Description |
|---|---|---|---|
workbook_id | string (UUID) | Yes | Source workbook ID |
format | string | No | pdf (default) or xlsx |
filename | string | No | Optional filename base |
options | object | No | Export options (PII redaction, formatting) |
Response¶
Returns the generated report metadata.
Generate Reconciliation Report¶
Request Body¶
| Field | Type | Required | Description |
|---|---|---|---|
tape_id | string (UUID) | Yes | Trustee tape ID |
format | string | No | pdf (default) or xlsx |
filename | string | No | Optional filename base |
options | object | No | Export options (PII redaction, formatting) |
List Reports¶
Query Parameters¶
| Parameter | Type | Default | Description |
|---|---|---|---|
skip | integer | 0 | Offset for pagination |
limit | integer | 20 | Page size (1-100) |
report_type | string | - | compliance or reconciliation |
sort_by | string | created_at | created_at, completed_at, report_type, status |
sort_dir | string | desc | asc or desc |
Get Report Status¶
Returns report metadata for polling status (including download URL once complete).
Download Report File¶
Downloads the exported file once the report is complete.
Export Options¶
The options object supports redaction and formatting controls:
| Field | Type | Description |
|---|---|---|
sanitize_pii | boolean | Redact PII values |
classification_threshold | string | Minimum classification level to redact |
redaction_strategy | string | mask, hash, or remove |
xlsx_include_styles | boolean | Include styles in Excel output |
xlsx_freeze_header | boolean | Freeze header row |
xlsx_auto_width | boolean | Auto-fit column widths |
Refer to API schemas for the full list of supported options.