Overview

QoreID webhooks deliver real-time verification events directly to your server. Each event contains data about a verification request and every step completed within a workflow. By listening to these events, you can react instantly to verification updates, streamline internal processes, and improve the end-user experience in your application.

Webhook Events

Event	Description
`identity`	Triggered when a real-time identity verification webhook is sent. This event only occurs when a third-party provider was unavailable at the time of the request and the user enabled`Network Downtime Handling` with valid webhook details.
`address`	Triggered when an address verification webhook is sent. This typically occurs at both the `initiation` and `completion` of the verification.
`employment`	Triggered when an employment verification webhook is sent. This usually happens on `initiation` and `completion` of the verification.
`property`	The property event happens when a property verification webhook is being sent. This usually happens on `initiation` and `completion` of the verification.
`guarantor`	Triggered when a guarantor verification webhook is sent. This usually happens on `initiation` and `completion` of the verification.
`workflow`	Triggered when an update is made to a workflow request. This usually happens on `initiation` and `completion` of the workflow verification request and every step in the workflow.

Webhook Event Types

Event Type	Description
`verification_started`	Sent when a verification request has been initiated. This event applies to `workflow`, `address`, `property`, `employment` and `guarantor` events.
`verification_completed`	Sent when a verification request has been completed. This could be a success or failed status. This event type applies to `workflow`, `identity`, `address`, `property`, `employment` and `guarantor` events. This event type also applies to `identity` events only in the case where a third-party provider was down or unavailable when the user made the request and the user set up their webhook details and enabled `Network Downtime Handling`.
`step_verification_started`	The `step_verification_started` event type occurs when a webhook is being sent to notify the user of the start of a verification request on a workflow component. This only applies to `workflow` events.
`step_verification_completed`	The `step_verification_completed` event type occurs when a webhook is being sent to notify the user that a verification request they initiated on a workflow component has been completed. This could be a success or failed status. This only applies to `workflow` events.