fcra

Cancel an order that has not finished

Changed on

The order becomes cancelled and its queued searches become cancelled. A search already running finishes.

post/v1/fcra/orders/{order_id}/cancel

Request

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

Response

The cancelled 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