For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Truework.comAPI StatusGet your API key
HomeGuidesAPI referenceHelp
HomeGuidesAPI referenceHelp
    • Introduction
  • Using the API
    • Authentication
    • Versioning
    • Webhooks
      • Webhook security
        • POSTOrder Completed
        • POSTVerification Request State Change
    • Sandbox environment
    • Monitoring
    • Limits
  • Verification orders & reports
    • POSTCreate a target employer order
    • POSTCreate an employer search order
    • POSTCreate a Truework Direct order
    • GETGet one order
    • GETGet all orders
    • PUTCancel an order
    • GETGet one report
    • GETGet order events
    • POSTReverify a report
  • Public beta APIs
  • Previous API versions
    • API version 2022-08-01
    • API version 2020-12-07
    • API version 2019-10-15
LogoLogo
Truework.comAPI StatusGet your API key
Using the APIWebhooksWebhook event reference

Order Completed

Payload
1{
2  "version": "2023-10-30",
3  "hook": {
4    "id": 123,
5    "event": "order.completed",
6    "target": "https://example.com/your-webhook-endpoint",
7    "triggered_at": "2025-01-01T12:00:00Z"
8  },
9  "data": {
10    "order_id": "order_123",
11    "metadata": {
12      "test_key": "test_value"
13    }
14  }
15}
This webhook will be issued when all verifications associated with the order have been completed or canceled. Once you receive this webhook you can fetch the order results from the API.
Was this page helpful?
Previous

Verification Request State Change

Next
Built with

Payload

The payload of this webhook request is an object.
versionstringOptional
The version of the webhook payload
hookobjectOptional
dataobjectOptional

Response

200
any
Return a 200 status to indicate that the data was received successfully.