Webhooks

Webhook events are notifications that your Veriscope application sends when an event occurs. You can configure the endpoint where notifications are send in the Veriscope web-app > Backoffice > Constants > Webhook URL.

Webhook events are an important part of the peer-to-peer data transfer mechanism and should be well understood before implementing an solution.

The following section outlines the objects sent via webhook events and briefly describes the action that triggers each event. The corresponding request bodies are detailed in Webhook Events Examples.

Veriscope expects to receive a response (e.g. 200 OK) from VASP backend/server-side implementations to KYC template webhook events. Thus, each VASP must implement a solution that subscribes to and responds to events as needed.

If Veriscope doesn’t receive a response, it will retry up to three times.

Attestations

Event Type Receiving VASP Webhook trigger

NEW_ATTESTATION

All VASPs

Whenever a VASP posts an attestation

KYC Template

Event Type Receiving VASP Webhook trigger

OR_DATA_REQ

oVASP

Whenever a bVASP responds to an attestation with an initial KYC template

OR_KYC_REQ

oVASP

Whenever an oVASP responds to a bVASP with signature data - see note below

BE_KYC_REQ

bVASP

Whenever an oVASP responds to a bVASP with signature data - see note below

BE_ENC

oVASP

Whenever an oVASP receives encrypted IVMS from bVASP

OR_ENC

bVASP

Whenever an bVASP receives encrypted IVMS from oVASP

OR_KYC_REQ and BE_KYC_REQ are triggered at the same time, whenever an oVASP responds to a bVASP with signature data. The reason for this is that either VASP can send KYC/IVMS data first. So the next action for both VASPs is to send the data. It is up to VASPs to decide who should send the data first. It is possible that a VASP will have different workflows for different VASPs.