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

Verify Flow Overview

Functional overview of the Berbix Verify end-user experience.

This document outlines the verification methods available in Berbix and their respective end-user experiences. The components of the verification flow are configurable using Templates and the design is customized via Themes.

Berbix offers three main components of the verification flow:

  • ID Check
  • Selfie Match
  • Liveness Check
  • Barcode scan (only)

ID checks on native-mobile are also available through a barcode scan-only method for US & Canadian IDs & driver's licenses.

ID Check

Document Selection

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.

Mobile Handoff (Desktop Only)

On desktop, your user will be prompted to provide their phone number or email address to receive a link to complete the flow on their mobile device. This step is only included when users visit the web experience from a non-mobile device. Alternatively, if they click "I don't have a phone", they'll be able to use the "Upload an image" button to manually upload a picture of their ID from their computer (this option is excluded if you select the Force Mobile Handoff configuration option).

Handoff screen.Handoff screen.

Handoff screen.

In the event that the phone number provided could not receive our hand-off link, the user may use a QR code instead.

QR code fallback.QR code fallback.

QR code fallback.

Scanning the QR code will produce a link to the verify flow.

QR code fallback.QR code fallback.

QR code fallback.

Front Image Capture

Once the user is in our flow, they 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

Selfie Image

The user is prompted to take a photo of themselves to compare against the photo ID.

Liveness Check

The user is 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.

Facial Recognition Consent

Berbix will present the user with a consent collection screen when Berbix is able to determine that an end-user of the Berbix Verify flow is located in a state where the end-user's consent is legally required for performing automated facial recognition on pictures of their face (e.g. Illinois, and several other states). Templates may also be configured for Berbix to collect consent from all end-users regardless of their location.

If the user does not consent to the use of facial recognition, Berbix will not make a biometric comparison and will return the id_selfie_consent_declined flag which we recommend mapping to a review action for manual review. When this flag is returned, you will also see a grey "uncertain" comparison made between the selfie image(s) signifying that no facial recognition comparison was made.

Scan-Only Verification

On either native mobile clients or on web, 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 relay 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 fall-back to a standard front & back photo ID image verification.

Scan back of ID instructions.Scan back of ID instructions.

Scan back of ID instructions.

The scanning experience for the user will be the same as it is in the front-and-back flow.

Barcode scan on mobile web.Barcode scan on mobile web.

Barcode scan on mobile web.

Supported Versions

We currently support the Berbix user flow on iOS version 11.0 and up, and Android version 5.0 and later. Broadly speaking, our web flow is compatible with a wide variety of browsers and devices, but performance may vary particularly if using our webcam-based features on desktop devices.

Updated 3 months ago

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.