Do you offer webhooks?

Yes! Passbase offers five webhook events to provide your web or mobile application with real-time information regarding verifications, authentications, and watchlist checks. You can add webhook endpoints and select webhook events in just a few easy steps in your Passbase Dashboard. 

Getting Started

Webhooks deliver data to a connected application when a predefined event occurs. You can use these events to generate certain actions within your own system (i.e. enable your users to continue on-boarding, once their verification is processed and approved). This eliminates the time-consuming task of constantly pulling data manually, as you will be notified when to pull the data via the Passbase API, when needed.

Below is a graph that summarizes and displays which stage of the processing flow the Passbase system will send webhook events.

VERIFICATION_COMPLETED

The VERIFICATION_COMPLETED event is triggered when a verification has completed processing and awaits to be reviewed (accepted or declined) either manually or automatically through our Automated Thresholds feature. The value of the status property can either be pending if the verification lands in manual review, or approved or, declined if you have automated thresholds enabled.

VERIFICATION_REVIEWED

The VERIFICATION_REVIEWED event is triggered when a verification's status has changed. This will happen if the verification has been approved or declined in your dashboard, or the automation has automatically approved or declined based on the threshold set in your project settings. The value of the status property can be approved or declined.

After this event, it is time to use the Passbase API, to retrieve the details of this verification with the identity access key. Please take a look at the API section and integration best practices for more information.

DATAPOINT_UPDATED

The DATAPOINT_UPDATED event is triggered when an verification's data points have been updated. This will happen if the verification has already been processed, and one or more data points, including liveness score, facematch score, or id authenticity score, are updated. The webhook payload will include the type and value of the updated data points.

After this event, it is time to use the Passbase API, to retrieve the details of this verification with the identity access key. Please take a look at the API section and integration best practices for more information.

WATCHLIST_MONITORING

The WATCHLIST_MONITORING event will be triggered when an Identity's AML Profile returns as not clean from the adverse media and watchlist check. The value of the clean property will default to false. The WATCHLIST_MONITORING webhook event is only available within the Passbase Dashboard if the Watchlist Check feature is enabled. Click here to learn more.

After this event, it is time to use the Passbase API, to retrieve the details of this verification with the identity access key. Please take a look at the API section and integration best practices for more information.

IDENTITY_AUTHENTICATED

The IDENTITY_AUTHENTICATED event will be triggered when an authentication is created indicating an identity has successfully authenticated through the Biometric Authentication feature. The IDENTITY_AUTHENTICATED webhook event is only available within the developer dashboard if the Biometric Authentication feature is enabled. Click here to learn more.

After this event, it is time to use the Passbase API, to retrieve the details of this verification with the identity access key. Please take a look at the API section and integration best practices for more information.

Steps to Add Webhooks

1. Configure an endpoint on your own server that can process HTTPS POST requests with TLS encryption version 1.2

2. Issue a script on your endpoint that can receive either raw in text/plain if encrypted or application/json if no encryption is activated

3. Go to the Passbase dashboard, and login with the email address and password used to activate your account

4. In the bottom left corner, click Settings

   

5. In the Project section, click Webhooks

6. Click Add

7. Select the webhook events you want to receive:

   1. Verification Completed: The verification has been processed and is ready to be reviewed in your dashboard.
   2. Verification Reviewed: The verification has been approved or rejected, either manually or automatically, in your dashboard.
   3. Datapoint Updated: The verification's data points were updated post processing.
   4. Watchlist Monitoring: The identity is flagged as having a not clean watchlist check.
   5. Identity Authenticated: The identity has successfully authenticated through the Biometric Authentication feature.

8. Enter your Webhook Endpoint, the URL where Passbase will send the webhook result to

9. Optional - Add Webhook Secret, to enable encrypted payloads. You can set up a secret here and later use the same secret to decrypt the webhook payload in your backend. Encrypted webhook events will be sent in text/plain.

10. Click Add