Skip to main content
GET
https://api.theary.ai
/
background-check
/
v1
/
orders
/
{id}
/
searches
Get Order Searches
curl --request GET \
  --url https://api.theary.ai/background-check/v1/orders/{id}/searches \
  --header 'Authorization: Bearer <token>'
{
  "searches": [
    {
      "id": "<string>",
      "orderId": "<string>",
      "applicantId": "<string>",
      "externalSearchId": "<string>",
      "searchType": "<string>",
      "searchStatus": "<string>",
      "searchTitle": "<string>",
      "entityName": "<string>",
      "entityLocation": "<string>",
      "startDate": "<string>",
      "endDate": "<string>",
      "additionalComments": "<string>",
      "completedAt": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "applicant": {},
      "verificationResult": [
        {}
      ]
    }
  ]
}

​
Get Order Searches

Retrieves all searches associated with a specific verification order, including their current status and verification results.

​
Path Parameters

​
id
string
required
Unique identifier of the verification order (UUID format)

​
Response

Returns all searches associated with the specified verification order. The response includes detailed information about each search, including status, results, and metadata.
​
searches
array
Array of search objects

​
Example Request

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

​
Example Response

[
  {
    "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "orderId": "550e8400-e29b-41d4-a716-446655440000",
    "applicantId": "app_789e4567-e89b-12d3-a456-426614174002",
    "externalSearchId": "EXT-12345",
    "searchType": "EMPLOYMENT",
    "searchStatus": "IN_PROGRESS",
    "searchTitle": "Senior Software Engineer",
    "entityName": "Apple Inc.",
    "entityLocation": "Cupertino, CA",
    "startDate": "2020-01-15",
    "endDate": "2023-06-30",
    "additionalComments": "Verify salary and job responsibilities",
    "completedAt": null,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z",
    "applicant": {
      "id": "app_789e4567-e89b-12d3-a456-426614174002",
      "firstName": "John",
      "lastName": "Smith",
      "ssn": "123-45-6789"
    },
    "verificationResult": []
  },
  {
    "id": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
    "orderId": "550e8400-e29b-41d4-a716-446655440000",
    "applicantId": "app_789e4567-e89b-12d3-a456-426614174002",
    "searchType": "EDUCATION",
    "searchStatus": "COMPLETED",
    "searchTitle": "Bachelor of Computer Science",
    "entityName": "Stanford University",
    "entityLocation": "Stanford, CA",
    "startDate": "2016-09-01",
    "endDate": "2020-06-15",
    "completedAt": "2024-01-14T15:45:00Z",
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-14T15:45:00Z",
    "applicant": {
      "id": "app_789e4567-e89b-12d3-a456-426614174002",
      "firstName": "John",
      "lastName": "Smith",
      "ssn": "123-45-6789"
    },
    "verificationResult": [
      {
        "id": "result_123e4567-e89b-12d3-a456-426614174004",
        "outcome": "VERIFIED",
        "resultDetails": "Degree verified successfully",
        "submittedAt": "2024-01-14T16:00:00Z"
      }
    ]
  }
]

​
Use Cases

  • Track Progress: Monitor the status of individual searches within an order
  • Get Results: Retrieve verification results as they become available
  • Debugging: Troubleshoot specific search issues
  • Reporting: Generate detailed reports on verification activities
  • Order Review: See all searches performed for a specific background check
  • Status Monitoring: Check the status of all searches within an order