Error
A valid request URL is required to generate request examples{}Orders API
Get Order
Retrieve an order overview: status, applicant, and summary of related searches
GET
/
background-check
/
v1
/
orders
/
{id}
Error
A valid request URL is required to generate request examples{}Get Background Check Order
Use this endpoint for an order-level overview: overallorderStatus, applicant identity fields, and a summary of the searches on the order.
It does not return verification outcomes. Nested search objects are status summaries only (for example id, searchType, searchStatus). To read results or poll progress, use Get order searches. For outreach history on one search, use Get specific search.
Request
string
required
Unique identifier of the background check order
Response
Returns the order withapplicant (scalar fields) and a nested search array of summary search rows. If the order does not exist, returns { "error": "Order not found", "orderId": "<id>" } with HTTP 200.
string
Order identifier (UUID).
string
Applicant identifier (UUID).
string
Applied job title (from
businessContext.appliedJobTitle). May be null.number
Proposed salary (from
businessContext.proposedSalary). May be null.string
Order status:
IN_PROGRESS, COMPLETED, or CANCELLED.string
Order creation timestamp (ISO 8601).
string
Last update timestamp (ISO 8601).
object
Applicant information (scalar fields only — nested addresses/aliases are not included on this endpoint).
Show Applicant Properties
Show Applicant Properties
string
Applicant identifier (UUID).
string
First name.
string
Last name.
string
Social Security Number.
string
Date of birth (
YYYY-MM-DD), or null.string
Phone number, or
null.string
Email address, or
null.boolean
When
true, PII fields on this record have been cleared per your organization’s data retention terms.string
Creation timestamp.
string
Last update timestamp.
array
Summary of searches on this order (status and identifiers). Does not include
verificationResult, metadata, or activity. For those fields, call Get order searches or Get specific search.isRedacted indicates the applicant’s PII (SSN, address, and similar fields) has been redacted from the record. See Data handling and privacy for details.When to use this vs search endpoints
| Goal | Endpoint |
|---|---|
| Is the order still in progress or finished? | This endpoint (GET /orders/{id}) |
| What are the verification results for each search? | Get order searches |
| What outreach / inbound activity happened on one search? | Get specific search |
Example Request
curl -sS -X GET "https://sandbox.theary.ai/background-check/v1/orders/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_JWT_TOKEN" \
-H "Accept: application/json"
const orderId = '550e8400-e29b-41d4-a716-446655440000'
const response = await fetch(`/background-check/v1/orders/${orderId}`, {
method: 'GET',
headers: {
Authorization: 'Bearer YOUR_JWT_TOKEN',
'Content-Type': 'application/json',
},
})
const order = await response.json()
import requests
order_id = "550e8400-e29b-41d4-a716-446655440000"
headers = {
'Authorization': 'Bearer YOUR_JWT_TOKEN',
'Content-Type': 'application/json'
}
response = requests.get(
f'https://sandbox.theary.ai/background-check/v1/orders/{order_id}',
headers=headers
)
order = response.json()
Example Response
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"applicantId": "789e4567-e89b-12d3-a456-426614174002",
"proposedPosition": "Senior Software Engineer",
"proposedSalary": 100000,
"orderStatus": "COMPLETED",
"createdAt": "2026-01-15T10:30:00Z",
"updatedAt": "2026-01-16T14:45:00Z",
"applicant": {
"id": "789e4567-e89b-12d3-a456-426614174002",
"firstName": "John",
"lastName": "Smith",
"ssn": "123-45-6789",
"birthday": "1990-05-15",
"phone": "+1-555-123-4567",
"email": "john.smith@example.com",
"isRedacted": false,
"createdAt": "2026-01-15T10:30:00Z",
"updatedAt": "2026-01-15T10:30:00Z"
},
"search": [
{
"id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"orderId": "550e8400-e29b-41d4-a716-446655440000",
"applicantId": "789e4567-e89b-12d3-a456-426614174002",
"externalSearchId": "client-emp-001",
"searchType": "EMPLOYMENT",
"searchStatus": "COMPLETED",
"createdAt": "2026-01-15T10:30:00Z",
"updatedAt": "2026-01-16T14:45:00Z"
}
]
}
Order not found
{
"error": "Order not found",
"orderId": "550e8400-e29b-41d4-a716-446655440000"
}
Use Cases
- Confirm an order was created and see its overall
orderStatus - Look up applicant identity fields for support or internal tooling
- See which searches exist on the order (IDs, types, statuses) without loading results
- Cancel or escalate workflows that only need order-level state
Path Parameters
Response
200 - application/json
The response is of type object.