Poll or retrieve an Audit Report
Changed onQueued/running/failed resources remain JSON status resources. Completed resources include saved results, source evidence and a signed manifest. Unknown reports and reports outside your account return 404.
get/sexoffender/report/live/{reportId}
Request
- Base URLhttps://api.offenders.io
- Auth
- API key in header X-API-Key
- or HTTP bearer
- or API key in query parameter key
Path parameters
reportIdstring required
Opaque report ID returned when creating a report.
Response
Current status or completed report
Example response
{
"request_metadata": {
"purpose": "Annual audit",
"reference": "CASE-123",
"requested_by": "Facility A",
"include_in_pdf": false
}
}Changes
- warning
removed the optional property
/from the response with the status - info
added the optional property
to the response with the status - info
added the optional property
/to the response with the status
- warning