Create Webhook

Registers a new webhook URL to receive notifications for verification events. Users can optionally specify which events to subscribe to using the 'events' array. Supports 'verification.completed' (when verification finishes) and 'verification.historical' (when historical employment data becomes available) events. If events are not specified, the webhook subscribes to all available events by default.

Body Params
string

Description of the webhook.

uri
required

The URL to send the webhook notifications to.

events
array of strings
length ≥ 1
Defaults to verification.completed,verification.historical

Array of event types to subscribe to. If not provided, defaults to all available events.

authentication

Authentication configuration for the webhook.

Responses

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json