API reference

Reports

Signed reports, their envelope and files.

Get a report

GET/v1/reports/{report_id}

Scopes: reports:read

Parameters

Field	Type	Required
`report_id`path	`string (uuid)`	yes

Responses

200Report
400
401
403
404
409
412
413
415
422
428
429
503

Download a report

POST/v1/reports/{report_id}/download

Scopes: reports:download
Required header: Idempotency-Key

Parameters

Field	Type	Required
`report_id`path	`string (uuid)`	yes

Request body`DownloadRequest`

Field	Type	Required
`format`	`enum: json, pdf, zip`	yes

Responses

200Download
400
401
403
404
409
412
413
415
422
428
429
503

Get the signed report envelope

GET/v1/reports/{report_id}/envelope

Scopes: reports:read

Parameters

Field	Type	Required
`report_id`path	`string (uuid)`	yes

Responses

200ReportEnvelope
400
401
403
404
409
412
413
415
422
428
429
503