QoreID's webhooks communicate verification events to your server. Verification events hold data on each verification request and each step completed in a workflow. By listening to these events, you can optimize your users' experience in your application.
Webhook Events
Event
Description
identity
The identity event happens when a realtime verification webhook is being sent. This only happens 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.
address
The address event happens when an address verification webhook is being sent. This usually happens on initiation and completion of the verification.
employment
The employment event happens when an employment verification webhook is being 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
The guarantor event happens when a guarantor verification webhook is being sent. This usually happens on initiation and completion of the verification.
workflow
The workflow event happens when an update is made to the user’s 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
The verification_started event type occurs when a webhook is being sent to notify the user of the start of a verification request. This event type applies to workflow, address, property, employment and guarantor events.
verification_completed
The verification_completed event type occurs when a webhook is being sent to notify the user that a verification request they initiated 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.
