Skip to main content
GET
https://api.theary.ai
/
background-check
/
v1
/
orders
/
{id}
/
events
Get Order Events
curl --request GET \
  --url https://api.theary.ai/background-check/v1/orders/{id}/events \
  --header 'Authorization: Bearer <token>'
{
  "orderId": "<string>",
  "events": [
    {}
  ],
  "message": "<string>"
}

Get Order Events

Retrieves event history for a verification order including status changes, workflow transitions, and system notifications.
This endpoint is currently a stub for future implementation. The events system is not yet fully implemented.

Path Parameters

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

Response

Returns event history for the specified verification order.
orderId
string
The requested order ID (UUID format)
events
array
Array of event objects (currently empty - stub implementation)
message
string
Status message about events system implementation

Example Request

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

Example Response

{
  "orderId": "550e8400-e29b-41d4-a716-446655440000",
  "events": [],
  "message": "Events system not yet implemented"
}

Future Implementation

When implemented, this endpoint will provide:
  • Status Change Events: Order and search status transitions
  • Workflow Events: Research, outbound, and inbound phase completions
  • Communication Events: Email sends, responses, and other communications
  • System Events: Automated actions and system notifications
  • Error Events: Failed operations and retry attempts

Alternative: Track Using Activity

Until the events system is implemented, use the activity data from searches: