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 support@berbix.com or via your organization's shared Slack channel.

Docs & Guides    API Reference

Verify Flow Overview

Functional overview of the Berbix Verify end-user experience.

This document outlines the end-user experience when going through a Berbix Verify flow. The functionality included and the design of the flow are fully configurable through Templates and Themes.

Berbix Verify Photo ID Verification collects the following data from a user:

  • Front and Back image of ID
  • Selfie Image (optional)
  • Liveness Check Image (optional)

In addition the flow presented below, a user may optionally be presented an Intro screen and/or Outro screen based on your template settings.

Photo ID Verification

When a user begins the verification flow, they will be prompted to choose their ID type as configured by your template. This screen will not be shown if only one ID type is enabled.

Your user will then be prompted to provide their phone number to which they will receive a link to complete the flow on their mobile device. Alternatively, if they click the "Upload an image" button, they will be able to manually upload a picture of their ID from their computer.

If the user choses to provide their phone number, they will be prompted to follow the link sent to them via text message. This link directs a user to a verify.berbix.com URL though this domain can be customized for your organization if desired.

Front Scan

The link will take the user to a URL that prompts them to use their camera.

The user will then be prompted to scan the front of their ID. In most cases, this will be automatically detected but a user can also manually take a photo.

Back Scan

The user will be advanced to a back barcode scan. In most cases, this will be automatically detected but a user can also manually take a photo.

Selfie & Liveness Check (optional)

Selfie Image

If enabled, the user will be prompted to take a photo of themselves to compare against the photo ID.

Liveness Check

If enabled, the user will be prompted to either show an Emotion or change their Facial Direction and take another photo. This is used to compare against the provided selfie image.

Scan-Only Verification

On native mobile clients, Berbix supports a scan-only verification method where the user will only be prompted to scan the barcode on the back of their ID. In this case, the verification data returned will rely only on the information encoded on the back of ID and will not be cross-referenced against the data available on the front of the ID. If the user does not have a barcode supported ID, they are able to opt-into a standard front & back photo ID image verification.

Finishing Verification

If the user selected a mobile handoff, they will be prompted to return to your application after completing the image collection.

When submitted, the user will be presented an information summary and can be advanced through your application based on the actions returned.

Other Verification Methods

Berbix Verify can also be configured to include verify through the following methods:

  • Basic Personal Details: collection of basic personal details, including full name, date of birth and ID expiration.
  • Email: basic email verification, with standard code-based verification by default and OAuth based verification if the email provider is supported.
  • Phone: basic phone number verification, with standard code-based verification by text with voice call as an alternative.
  • Physical Address: collection of user’s physical address, including ensuring unit number is provided if required and US- or Canada-based.

Basic Personal Details Verification

The user will be prompted to verify a few basic pieces of information:

  • First Name
  • Middle Name
  • Last Name
  • Date of Birth
  • ID expiration date

If you're using Photo ID verification, this data will automatically be generated based on the Photo ID.

Email Verification

The user will be prompted to enter the email address and will then either receive a code via email or verify using Google OAuth (if available).

If receiving an email code, the user will then need to enter the provided code into the verification flow.

Phone Verification

The user will be prompted to enter their phone number and then receive a code to enter via text message. They can optionally receive a phone call instead.

Physical Address Verification

The user will be prompted to confirm their street address or enter a new address. If using Photo ID verification, this data will be automatically populated based on the information on the ID.

Verify Flow Overview


Functional overview of the Berbix Verify end-user experience.

Suggested Edits are limited on API Reference Pages

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