v1

latestOpenAPI 3.1.02026-07-1242526.8 KB

Results

Webhook Screening Result

post/unified/screening/results/webhook

Headers

x-account-idstring required

The account identifier

Preferstring

Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Request body

event'screening.results.created' | 'screening.results.updated' | 'screening.results.completed' | 'screening.results.failed' | 'screening.results.cancelled' required

The event type

Example request

{
  "event": "screening.result.completed",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "order_id": "12345",
    "score": {
      "label": "Overall Risk",
      "value": "75",
      "min": "0",
      "max": "100"
    },
    "start_date": "2023-01-01T00:00:00Z",
    "submission_date": "2023-01-02T00:00:00Z",
    "summary": "Background check completed successfully",
    "status": "completed",
    "result_url": "https://example.com/results/12345"
  }
}

Response

The screening result webhook was processed.

event'screening.results.created' | 'screening.results.updated' | 'screening.results.completed' | 'screening.results.failed' | 'screening.results.cancelled' required

The event type

Example response

{
  "event": "screening.result.completed",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "order_id": "12345",
    "score": {
      "label": "Overall Risk",
      "value": "75",
      "min": "0",
      "max": "100"
    },
    "start_date": "2023-01-01T00:00:00Z",
    "submission_date": "2023-01-02T00:00:00Z",
    "summary": "Background check completed successfully",
    "status": "completed",
    "result_url": "https://example.com/results/12345"
  }
}