Skip to main content
GET
https://api.theary.ai
/
background-check
/
v1
/
orders
/
{id}
Get Order
curl --request GET \
  --url https://api.theary.ai/background-check/v1/orders/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "status": "<string>",
  "applicant": {
    "firstName": "<string>",
    "lastName": "<string>",
    "ssn": "<string>",
    "email": "<string>",
    "phone": "<string>"
  },
  "entityName": "<string>",
  "jobTitle": "<string>",
  "employmentDates": {
    "startDate": "<string>",
    "endDate": "<string>"
  },
  "searchTypes": [
    {}
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "completedAt": "<string>"
}

​
Get Background Check Order

Retrieves details of a specific background check order including its current status and associated information.

​
Request

​
id
string
required
Unique identifier of the background check order

​
Response

Returns detailed information about the specified background check order.
​
id
string
Unique identifier of the background check order (UUID format)
​
status
string
Current status of the order: pending, in_progress, completed, cancelled, or failed
​
applicant
object
Applicant information
​
entityName
string
Name of the company or organization
​
jobTitle
string
Job title or position
​
employmentDates
object
Employment date range
​
searchTypes
array
Array of search types requested for this order
​
createdAt
string
Order creation timestamp
​
updatedAt
string
Last update timestamp
​
completedAt
string
Order completion timestamp (if completed)

​
Example Request

curl -X GET "https://api.theary.ai/background-check/v1/orders/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json"

​
Example Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "applicant": {
    "firstName": "John",
    "lastName": "Smith",
    "ssn": "***-**-6789",
    "email": "[email protected]",
    "phone": "+1-555-123-4567"
  },
  "entityName": "Apple Inc.",
  "jobTitle": "Senior Software Developer",
  "employmentDates": {
    "startDate": "2020-01-15",
    "endDate": "2023-06-30"
  },
  "searchTypes": [
    {
      "searchType": "EMPLOYMENT",
      "searchTitle": "Senior Software Developer"
    },
    {
      "searchType": "EDUCATION",
      "searchTitle": "Bachelor of Computer Science"
    }
  ],
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-16T14:45:00Z",
  "completedAt": "2024-01-16T14:45:00Z"
}

​
Use Cases

  • Order Status Check: Monitor the current status of a specific verification order
  • Order Details Review: Get comprehensive information about an order and its progress
  • Integration Monitoring: Check order status in automated workflows
  • Customer Support: Retrieve order details for customer inquiries
  • Audit and Compliance: Review order information for regulatory purposes