fcra

The furnished report, as JSON or the stored PDF

Changed on
get/v1/fcra/orders/{order_id}/report

Request

  • Base URL: https://api.offendersearch.app
  • URL: https://api.offendersearch.app/v1/fcra/orders/{order_id}/report
  • Auth: API key in header X-API-Key

Query parameters

format'json' | 'pdf'

json (the default) or pdf (the stored PDF, rendered once when the order completed).

Response

format=json: the report object. format=pdf: the stored PDF bytes, with X-Report-SHA256 and X-PDF-SHA256 headers.

orderIdstring
status'complete' | 'error'
createdAtstring date-time
completedAtstring date-time nullable
permissiblePurpose'employment' | 'tenant_screening' | 'consumer_written_instructions' | 'legitimate_business_need'
clientReferencestring nullable
controlVersionstring
sandboxboolean
liveScope'relevant' | 'all'

Example response

{
  "searches": [
    {
      "id": "fs_452884eecde9a1f2"
    }
  ],
  "evidence": [
    {
      "captureId": "fc_461d419f538a882c"
    }
  ]
}

Changes