Create an Audit Report
Changed onUse Extensive Search to review candidates and resolve the screening result first. With no confirmed match, submit the same supported identity criteria; with a confirmed match, submit that record's UUID. Reports preserve evidence and do not replace candidate review or identity resolution. Each successfully completed Audit Report costs $7.99. Failed reports are not charged. Status checks, PDF downloads, and public verification do not incur additional report charges. No separate Search or Extensive API usage charges are added for report generation. Returns immediately; check the resource_uri for status. Testing keys cannot create reports. DOB is highly recommended for name-based reports. Without dob, the completed report always returns inconclusive, even when no candidates are found. A date of birth is needed to assess a candidate match. UUID reports use the selected record as the comparison input.
Request
- Base URLhttps://api.offenders.io
- Auth
- API key in header X-API-Key
- or HTTP bearer
- or API key in query parameter key
Request body
Example request
{
"request_metadata": {
"purpose": "Annual audit",
"reference": "CASE-123",
"requested_by": "Facility A",
"include_in_pdf": false
}
}Response
Queued report
Example response
{
"resource_uri": "/sexoffender/report/live/lr_0123456789abcdef0123456789abcdef"
}Changes
- breaking
removed
subschema #1subschema #2from the request bodyoneOflist - info
added
subschema #1subschema #2to the request bodyoneOflist
- breaking
- breaking
removed
subschema #1subschema #2from the request bodyoneOflist
1 more change in this revision
- breaking