Berbix Docs

Welcome to the Berbix docs! Here you’ll find comprehensive information for integrating Berbix Verify and its associated APIs as well as an overview of Berbix Dashboard functionality.

The fastest way to integrate Berbix Verify is to follow our Integration Guide, which walks through your entire Berbix integration step-by-step. You’ll integrate Berbix Verify into your site or app and then use one of our SDKs to retrieve the data you need from our API. You'll also be guided through the configuration of verification workflow rules to map to your existing business logic.

You can see the full Berbix Verify API specification in our API Reference Docs and find functional documentation for the Berbix Dashboard here.

If you have any questions, please don't hesitate to reach out to us at [email protected] or via your organization's shared Slack channel.

Docs & Guides    API Reference

Templates

Templates enable you to specify differing levels of verification required for different user account types. Certain templates may be subject to more verification than others based, on the needs of your product. Templates include the types of verification you'd like to conduct (photo ID, selfie, etc.) and settings for the verification flow (number of attempts, timeouts, etc.).

Create New Template

To create a new template, visit the Templates tab in the Berbix Dashboard and click Create Template. From there, give the template a name based on the intended use case (such as New User), select the required verifications, and click Save.

Once created, a Template Key will be generated that can be used when creating a transaction and will be prefixed with tpk_.

Template Configuration

Photo ID Flow Customization

Allowable ID Type

Customize what types of photo IDs are permitted in your verification flow. You can select from the following options:

  • ID Card or Driver License
  • Passport
  • ID Card, Drivers License, or Passport

Require Selfie

This setting determines if Berbix also captures a selfie from the end-user to compare their selfie image to the face on their ID.

Liveness Check

Enabling the "Perform liveness check" function will prompt the user to take a photo looking straight, to the left and to the right. This is our recommended selfie verification. Also provided is an option to collect facial recognition consent from all end-users, regardless of their location.

UI Customization

Theme

Select the Theme to render for the template from your list of Themes or use the Berbix Default Theme.

Intro Message

You can also provide your end-users a custom Intro Message shown at the beginning of the Berbix Verify flow.

Session Settings

Toggle the following settings to customize additional parameters of the Berbix flow outside of the verifications selected:

  • Show intro screen: shows an introductory screen to end-users at the beginning of the flow.
  • Show step layout: shows users the steps of the verification process in the flow.

Intro screen

If an intro screen is enabled, your users will be presented an intro message and the verification methods that will be required.

Photo ID only verification

All verification methods

Use of V1 Template

You may contact Berbix support to configure the template to allow for the v1 frontend for all transactions or test-mode only transactions.

Updated about a month ago

Templates


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.