Skip to Content
CerebrumDocs
GuidesAPI referenceTrust & security

Get Order Details

Related workflow: Order lifecycle · Standard screening orders · Adding searches to orders

GET
/v1/orders/{id}

Retrieve a single order with optional expanded related data.

Related: Order · Score, Status and Alert

Authorization

apiKey
headerapikey<token>

Path Parameters

id*string

Query Parameters

expand?array<string>

Related data to include. Repeat the parameter for several values, for example ?expand=reportable_results&expand=vid_report (expand[]= is also accepted). Comma-separated values are not split. Unknown values are ignored. idVerificationData is a legacy alias of id_verification_data.

Allowed values"id_verification_data""idVerificationData""reportable_results""background_report_pdf""signed_disclosure""vid_report""verification_check_results""credentials""selfie""ip_address_details"

Response Body

The order. Expanded fields are included only when requested with expand.

application/json
  1. response
id*string

order id

monitoringEnrollmentId?string

ID of the latest monitoring enrollment for this order. Omitted when there is none.

Formatuuid
backgroundReportUrl*string

this is report url of completed order

reportDisputeUrl?string|null

Dispute Center URL for viewing the background report and submitting a dispute. This may be null if an email address or organization shortName is not available for the order.

disputeResolution?object

Latest dispute resolution summary for the order, including the order changes captured when the dispute resolution completed.

status*string

Workflow status. An order without a stored status is returned as PENDING. New values may be added; treat unknown values as not complete.

Value in"PENDING""IN_PROGRESS""IN_DISPUTE""COMPLETE""INCOMPLETE"
score*string|null

Order score as the same enum value accepted by Update Order, or null when not scored. New values may be added.

Value in"CLIENT_REVIEW""NO_ALERTS""ON_HOLD""ADVERSE_ACTION""REVIEW_REQUIRED""WITHDRAWN""ID_VERIFIED""ID_NOT_VERIFIED""ALERTS_FOUND""PENDING""PRE_ADVERSE""NO_DRUG_TEST""SCREENING_CLEAR""SCREENING_ALERT""SCREENING_NO_ALERT""SCREENING_PENDING""REVIEW_PASS"null
customScore*string|null

Free-text custom score set by your organization, or null.

alert*string|null
Value in"ALERTS_FOUND""NO_ALERTS_FOUND"null
additionalMetadata*object

this will be the same json object which was passed when creating order

selfieUrl?string
orderDeliveryType*string

Order delivery method

Value in"rapidRequest""vidScreen""standard""vIDWeb"
idVerificationData?object

Verified ID information. Included when the order has an ID verification result and expand contains id_verification_data (or the legacy alias idVerificationData).

ipAddressDetails?object|null

The submission IP address, derived location, and associated checks. Included when the "expand" query parameter contains "ip_address_details".

reportableResults?object

The reportable results information will be included in the response when the order has backgroud verification results attached and the "expand" query parameter contains "reportable_results" as an array element.

createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
reportCompletedAt?string|null
Formatdate-time
applicantContactDetails*object|null
signedDisclosurePdf?string
backgroundReportPdf?string
vIDReportPdf?string
verificationCheckResults?VerificationCheckResults
credentials?array<GetCredentialResponse>
Example Request
curl -X GET 'https://api.cerebrum.com/v1/orders/string?expand=reportable_results&expand=vid_report' \  -H 'apikey: CEREBRUM_API_KEY'
Example Response
{  "id": "0bb0f6f8-459f-482a-952e-7caf029517f6",  "applicantContactDetails": {    "email": "applicant@example.com",    "phoneNumber": ""  },  "backgroundReportUrl": "https://cognition.cerebrum.com/user/e4b7d1c3-9a2f-4f6e-8d1b-3c5a7e9f2b64?tab=Documents",  "reportDisputeUrl": "https://cognition.cerebrum.com/dispute/northwind-staffing/auth/0bb0f6f8-459f-482a-952e-7caf029517f6?email=applicant%40example.com",  "additionalMetadata": {    "clientReferenceId": "APP-1042"  },  "status": "PENDING",  "score": null,  "customScore": null,  "orderDeliveryType": "vIDWeb",  "alert": null,  "createdAt": "2026-11-03T16:20:00.000Z",  "updatedAt": "2026-11-03T16:20:00.000Z",  "reportCompletedAt": null}