Error
A valid request URL is required to generate request examples{}Orders API
List Orders
List background check orders for specific tenant
GET
/
background-check
/
v1
/
orders
Error
A valid request URL is required to generate request examples{}List Background Check Orders
Retrieves a paginated list of background check orders for a specific authenticated tenant.Request
string
Page number for pagination (1-based). Defaults to
1 when omitted.string
Number of orders per page. Defaults to
10 when omitted.Response
array
Array of verification order objects. Each order includes its
applicant (scalar fields) and its search array.Show Order Properties
Show Order Properties
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 scalar fields (
id, firstName, lastName, ssn, birthday, phone, email, isRedacted, createdAt, updatedAt).array
Summary of searches on the order (identifiers and status). Does not include
verificationResult. To load results, call Get order searches for a specific order.object
page and limit are query strings that default to 1 and 10. Results are ordered by createdAt descending.isRedacted (on applicant) indicates the applicant’s PII (SSN, address, and similar fields) has been redacted from the record. See Data handling and privacy for details.Example Request
curl -sS -X GET "https://sandbox.theary.ai/background-check/v1/orders?page=1&limit=20" \
-H "Authorization: Bearer YOUR_JWT_TOKEN" \
-H "Accept: application/json"
const response = await fetch('https://sandbox.theary.ai/background-check/v1/orders?page=1&limit=20', {
method: 'GET',
headers: {
Authorization: 'Bearer YOUR_JWT_TOKEN',
'Content-Type': 'application/json',
},
})
const orders = await response.json()
import requests
headers = {
'Authorization': 'Bearer YOUR_JWT_TOKEN',
'Content-Type': 'application/json'
}
response = requests.get(
'https://sandbox.theary.ai/background-check/v1/orders',
params={'page': 1, 'limit': 20},
headers=headers
)
orders = response.json()
Example Response
{
"orders": [
{
"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",
"searchType": "EMPLOYMENT",
"searchStatus": "COMPLETED",
"externalSearchId": "client-emp-001"
}
]
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 150,
"totalPages": 8,
"hasNext": true,
"hasPrev": false
}
}