Skip to main content
GET
https://api.theary.ai
/
background-check
/
v1
/
orders
/
{id}
/
searches
/
{searchId}
Get Specific Search
curl --request GET \
  --url https://api.theary.ai/background-check/v1/orders/{id}/searches/{searchId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "orderId": "<string>",
  "applicantId": "<string>",
  "externalSearchId": "<string>",
  "searchType": "<string>",
  "searchStatus": "<string>",
  "searchTitle": "<string>",
  "entityName": "<string>",
  "entityLocation": "<string>",
  "startDate": "<string>",
  "endDate": "<string>",
  "additionalComments": "<string>",
  "questionnaireUrl": "<string>",
  "questionnaireAccessCode": "<string>",
  "completedAt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "applicant": {},
  "verificationResult": [
    {
      "id": "<string>",
      "outcome": "<string>",
      "resultDetails": "<string>",
      "submittedAt": "<string>"
    }
  ],
  "activity": [
    {
      "id": "<string>",
      "activityType": "<string>",
      "channel": "<string>",
      "channelValue": "<string>",
      "description": "<string>",
      "createdAt": "<string>"
    }
  ]
}

​
Get Specific Search

Retrieves detailed information about a specific search within a verification order, including verification results and activity history.

​
Path Parameters

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

​
Response

​
id
string
Unique search identifier (UUID format)
​
orderId
string
Parent order identifier (UUID format)
​
applicantId
string
Applicant identifier
​
externalSearchId
string
External system search identifier
​
searchType
string
Type of search: EMPLOYMENT, EDUCATION, or CRIMINAL
​
searchStatus
string
Current status: IN_PROGRESS, COMPLETED, CANCELLED, or REASSIGNED
​
searchTitle
string
Title or description of the search
​
entityName
string
Name of the entity being verified
​
entityLocation
string
Location of the entity
​
startDate
string
Employment/education start date
​
endDate
string
Employment/education end date
​
additionalComments
string
Additional comments or notes for the search
​
questionnaireUrl
string
URL to online verification questionnaire (if applicable)
​
questionnaireAccessCode
string
Access code for online questionnaire
​
completedAt
string
Search completion timestamp
​
createdAt
string
Search creation timestamp
​
updatedAt
string
Last update timestamp
​
applicant
object
Complete applicant information
​
verificationResult
array
Array of verification results for this search
​
activity
array
Array of activity records for this search

​
Example Request

curl -X GET "https://api.theary.ai/background-check/v1/orders/550e8400-e29b-41d4-a716-446655440000/searches/6ba7b810-9dad-11d1-80b4-00c04fd430c8" \
  -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": "6ba7b812-9dad-11d1-80b4-00c04fd430c8",
  "externalSearchId": "EXT-12345",
  "searchType": "EMPLOYMENT",
  "searchStatus": "COMPLETED",
  "searchTitle": "Senior Software Engineer",
  "entityName": "Apple Inc.",
  "entityLocation": "Cupertino, CA",
  "startDate": "2020-01-15",
  "endDate": "2023-06-30",
  "additionalComments": "Verify salary and job responsibilities",
  "questionnaireUrl": "https://verify.theary.ai/form/abc123",
  "questionnaireAccessCode": "VERIFY2024",
  "completedAt": "2024-01-16T14:30:00Z",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-16T14:30: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": "Employment verified: John Smith worked as Senior Software Engineer at Apple Inc. from 2020-01-15 to 2023-06-30. Salary confirmed.",
      "submittedAt": "2024-01-16T15:00:00Z"
    }
  ],
  "activity": [
    {
      "id": "activity_789e4567-e89b-12d3-a456-426614174005",
      "activityType": "OUTBOUND",
      "channel": "EMAIL",
      "channelValue": "[email protected]",
      "description": "Employment verification request sent",
      "createdAt": "2024-01-15T11:00:00Z"
    },
    {
      "id": "activity_012e4567-e89b-12d3-a456-426614174006",
      "activityType": "INBOUND",
      "channel": "EMAIL",
      "channelValue": "[email protected]",
      "description": "Employment verification response received",
      "createdAt": "2024-01-16T14:15:00Z"
    }
  ]
}

​
Use Cases

  • Detailed Tracking: Get complete information about a specific verification search
  • Result Monitoring: Check verification results and their submission status
  • Activity Audit: Review all communication and activity for the search
  • Troubleshooting: Debug specific search issues with detailed logs