Get specific order

curl --request GET \
  --url https://sandbox.theary.ai/background-check/v1/orders/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandbox.theary.ai/background-check/v1/orders/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox.theary.ai/background-check/v1/orders/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.theary.ai/background-check/v1/orders/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.theary.ai/background-check/v1/orders/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://sandbox.theary.ai/background-check/v1/orders/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.theary.ai/background-check/v1/orders/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "applicantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "proposedPosition": "<string>",
  "proposedSalary": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "statusCode": 400,
  "message": "Validation failed",
  "error": "Bad Request"
}

GET

background-check

orders

{id}

Get specific order

curl --request GET \
  --url https://sandbox.theary.ai/background-check/v1/orders/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sandbox.theary.ai/background-check/v1/orders/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sandbox.theary.ai/background-check/v1/orders/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.theary.ai/background-check/v1/orders/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.theary.ai/background-check/v1/orders/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://sandbox.theary.ai/background-check/v1/orders/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.theary.ai/background-check/v1/orders/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "applicantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "proposedPosition": "<string>",
  "proposedSalary": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "statusCode": 400,
  "message": "Validation failed",
  "error": "Bad Request"
}

Get Background Check Order

Use this endpoint for an order-level overview: overall orderStatus, 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 with applicant (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

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

Do not use this endpoint as your primary poll for verification outcomes — use Get order searches or webhooks.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string<uuid>

required

Response

Order details (or error body if not found — check for the error field)

string<uuid>

Order identifier

applicantId

string<uuid>

Applicant identifier

proposedPosition

string | null

Applied job title

proposedSalary

number | null

Proposed salary

orderStatus

enum<string>

Current order status

Available options:

IN_PROGRESS,

COMPLETED,

CANCELLED

createdAt

string<date-time>

Order creation timestamp

updatedAt

string<date-time>

Last update timestamp

List Orders Delete Order

Overview

Orders API

Search Management

Batches API

Inbound API

Files API

Closeout Events API

Request and order schemas

Webhook schemas

Get Order

Get Background Check Order

Request

Response

When to use this vs search endpoints

Example Request

Example Response

Order not found

Use Cases

Authorizations

Path Parameters

Response

​Get Background Check Order

​Request

​Response

​When to use this vs search endpoints

​Example Request

​Example Response

​Order not found

​Use Cases

Authorizations

Path Parameters

Response

Get Background Check Order

Request

Response

When to use this vs search endpoints

Example Request

Example Response

Order not found

Use Cases