Webhook

This documentation helps you set up the Webhooks to handle completed verifications.

General

As of this writing, this feature is only available for approved clients. However, it is easy for our tech support to get you set up quickly.

To be notified about changes in your Passbase project, you can configure event-based webhooks. You'll be notified about new verifications and changes in their status. Please reach out to our developer support and join our developer slack for help setting this up.

1. Events

Possible notification events:

Event

Description

AUTHENTICATION_CREATED

An authentication was created / initialized. Can be added with data (nationality, email address, documents, etc).

AUTHENTICATION_FINISHED

An authentication is finished (data ingestion) and is ready for processing.

AUTHENTICATION_PROCESSED

An authentication has been processed and is ready for reviewing.

AUTHENTICATION_REVIEW_STATUS_CHANGED

An authentication was reviewed and either accepted or rejected.

// Customizable Header Example:
{"Content-Type": "application/json"}
// or
{"Content-Type": "application/json", "Authorization": "APIKEY $$api_key$$"}
‚Äč
// Body Example:
{"api_key":"$$api_key$$",
"customer_user_id":"$$authentication.customer_user_id$$",
"created_at":"$$authentication.created_at$$",
"authentication_key":"$$authentication.key$$",
"authenticated_at":"$$authentication.authenticated_at$$",
"authenticated":"$$authentication.review_status$$",
"event":"$$event$$"}

Below is the most common webhook process and format:

  1. HTTPS POST request to a specified endpoint

  2. Http body type: application/json

  3. Seed code example for customizable header example but also any placeholder variable is possible.

  4. See code example for body

The variables resolve for the following values:

Variables

Description

$$api_key$$

Your API key, specified with the webhook configuration

$$customer_user_id$$

The customer_user_id references your internal user_id of the user authentication with Passbase. It can be sent with the initialization of the authentication with both the web button snippet and the mobile SDKs.

$$authentication.created_at$$

The date the authentication was created

$$authentication.key$$

The unique UUID-key of the authentication to be externally referenced through our API.

$$authentication.authenticated_at$$

Set to a date time string when the authentication is accepted or rejected. Otherwise, null.

$$authentication.review_status$$

Accepted = true, rejected = false, not reviewed yet = null.

$$authentication.review_status$$

The status of the authentication.

$$even$$

The event.

2. Setup & Integration

To get set up for webhooks we need some information from you:

  1. The Https endpoint that accepts application/json requests

  2. The list of event keys to fire a webhook

  3. Your API key, if required

  4. Adjusted header and body JSON objects.

Please reach out to us with that information on our developer support and our developer slack.