fcra

Create an FCRA order

Changed on

One consumer, one end user, one permissible purpose, one consent attestation, and one or both search types. Returns 202 with the order at status received; the searches run in the background and report by webhook. The same Idempotency-Key with the same body within 24 hours returns the original order with Idempotent-Replayed: true; with a different body it is 409 idempotency_conflict.

post/v1/fcra/orders

Request

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

Headers

Idempotency-Keystring

Up to 200 characters. Replays are matched for 24 hours.

Request body

endUserIdstring required
permissiblePurpose'employment' | 'tenant_screening' | 'consumer_written_instructions' | 'legitimate_business_need' required
annualSalaryinteger nullable
clientReferencestring nullable
callbackUrlstring uri nullable
liveScope'relevant' | 'all'

Response

The order, accepted. A replayed request returns the original order.

idstring
status'received' | 'in_progress' | 'partial' | 'complete' | 'cancelled' | 'error'
createdAtstring date-time
updatedAtstring date-time
completedAtstring date-time nullable
cancelledAtstring date-time nullable
clientReferencestring nullable
endUserIdstring
permissiblePurpose'employment' | 'tenant_screening' | 'consumer_written_instructions' | 'legitimate_business_need'
controlVersionstring
liveScope'relevant' | 'all'
sandboxboolean

Example response

{
  "id": "fo_ee0b34c5b52fd35b",
  "controlVersion": "fcra-controls-2026-10-01.1",
  "searches": [
    {
      "id": "fs_452884eecde9a1f2"
    }
  ],
  "consumerPortal": {
    "accessCode": "K7QF-2MXP-9RDA"
  }
}

Changes