Glossary & Overview
This document defines the concepts you'll encounter in Berbix, and presents a sample end-to-end application workflow.
Key Concepts
The following Berbix concepts will be referenced throughout this guide:
- Transactions: When your end-user verifies their identity, the end-to-end process is called a Transaction. The data captured in each transaction may be viewed individually in the Berbix dashboard, or may be retrieved programmatically via integration.
- Transaction ID: The unique identifier we assign to a transaction when it is generated.
- Customer UID: When you create transactions, we strongly recommend that you assign a unique identifier to the individual end-user. For best practices, check out our Frequently Asked Questions.
- Templates: When you configure a Template, you are defining the steps your end-users will take to verify their identity. This may include selecting an allowed document type, uploading photos of the front and back of their ID, taking selfies, and more.
- Action Map: An Action Map uses possible transaction flags to set business logic. When your end-users complete transactions, we use this logic to decide on an Action;
accept
,reject
, orreview
. - Themes: Customize the look and feel of the end-user experience to match your branding with Themes.
- Review Queues: Transactions that result in a
review
action are routed to Review Queues for manual verification.
Token Types
There are three token types associated with any given transaction within Berbix:
access_token
: short-lived (one hour) token that enables your backend to fetch data about a given transaction.client_token
: short-lived (one hour) token that connects the Berbix frontend with a given transaction.refresh_token
: long-lived token that may be used to regenerate the other two tokens.
End-to-End Application Workflow
Before integrating Berbix, it's helpful to understand how all of the key integration concepts fit together.

The typical end-to-end application workflow is:
- An end-user in your application flow needs to perform some form of identity verification.
- Before initiating the verification flow, your application creates a new Berbix transaction associated with a
customer_uid
andtemplate_key
, which returns an associatedaccess_token
,refresh_token
, andclient_token
. - Your application stores the
refresh_token
alongside your user record, which is used to generate anaccess_token
andclient_tokens
in future requests. - Your application sends the generated
client_token
for the transaction to your frontend to initialize the Berbix flow. - The end-user performs the selected form of identity verification and their details are sent directly to Berbix for validation.
- Upon completion, the Berbix frontend SDK triggers a successful callback hook or an error if verification is unsuccessful.
- Your application fetches the metadata for a successful verification using the transaction's
access_token
. - Your backend sends the returned action to your client to determine the user experience.
To check out how this is experienced by the end-user, we recommend that you review the End-User Verification Flow.
© Berbix Inc. All rights reserved.
Updated about 1 year ago