Poll or retrieve an Audit Report

Changed on

Queued/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 URL
    https://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

report_idstring required
status'queued' | 'running' | 'completed' | 'failed' required
conclusion'match_identified' | 'no_match_identified' | 'inconclusive'

The report result, matching the PDF. Present on newly completed reports; omitted while pending or failed and may be absent on earlier reports.

created_atstring date-time required
completed_atstring date-time
resource_uristring

Present for queued, running and failed resources.

failure_codestring

Present when failed.

messagestring
actionstring
snapshot_sha256string
pdf_sha256string
pdf_uristring

Present when completed.

signed_manifestobject

Signed hashes and report metadata, present when completed.

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