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

Hosted Flow Overview

Using the Hosted Flow, you can start verifying users in seconds if you don't need an embedded experience or simply don't have the engineering time or resources to integrate Berbix within your application.

The Hosted Flow is the same verification experience as the Berbix web SDK — the only difference is that it's hosted on a Berbix domain as opposed to being integrated in your app!

When using the Hosted Flow workflow, you generate unique verification links that you provide to your users. Using those links, your users can proceed through a verification flow as defined by your web Template with your own unique logo and Theme applied. At the end of the verification, they can optionally be redirected to a custom URL when they finish the verification.

Once complete, the full verification results will be available in the Berbix dashboard on the Transactions page. Moreover, you can optionally opt to receive an email with a link to the completed verification.

Hosted Flow verification links can be generated manually on an ad-hoc basis within the Berbix dashboard or programmatically via our API. When generating Hosted Flow verification links programmatically, you can also fetch the transaction information programmatically, allowing you to perform an integration of Berbix that only involve backend work.

Manually Creating a Hosted Transaction

To get started, all you need to do is click Create Transaction on the Transactions page to instantly generate a hosted flow verification link that you can provide to your users.

When creating a hosted transaction, you can specify the following options:

  • Template (required): the Template to use for the transaction. Only Web templates are supported for Hosted Flow verification links.
  • Completion notification email (optional): an email address to which Berbix will send a notification upon transaction completion, alongside a link to the relevant Transaction page. This can be useful if you want to be able to manually review the transaction as soon as it is completed.
  • Expires in (required): Hosted Flow verification links have a default expiration duration of 30 days after their creation. If needed, you can make that period shorter. If the transaction is not completed before its expiration, an user attempting to access the link will receive an error message.
  • Customer UID (optional): an optional unique identifier for the user to be verified. This is useful if you want to be able to tie the transaction to a specific account. Moreover, providing this field enables duplicate detection (i.e. identical IDs submitted for distinct Customer UIDs will raise a flag). We recommend using an unique identifier that does not include personal information about the user.

Upon clicking Submit, you'll receive a unique one-time link to the hosted verification that you can share with your end-user. You can copy that link into your clipboard by clicking the file icon in the upper right corner of the box containing the link.

A hosted verification will include the template-specified verification, with an optional custom logo. When complete, the verification will re-direct your end user to your specified redirect URL. Both of these options can be configured within the dashboard's general settings .

Create Hosted Transactions Programmatically

If you're looking to use the Berbix hosted flow at high-volumes, or if you want to be able to retrieve transaction data programmatically, you can programmatically create hosted transactions via our API.


Benefits of creating hosted transactions programmatically

Opting to create hosted transactions programmatically provides you with a lightweight way of leveraging Berbix's Verify Flow without performing any frontend work.

All you need to do to creating hosted transactions programmatically is to perform a backend-only integration, where your backend both creates transactions and fetches results upon completion. You can then use your result in your application or business processes, instantly.

If you're looking to create a proof of concept of what Berbix can do for your organization, using programmatically created hosted transactions is the best way to quickly get the benefits of Berbix's instant results with very little software development work!

To do so, please refer to the Integration Guide, and in particular the section covering creating a transaction and fetching transaction data.

In order to create a hosted transaction, you'll need to include the hosted_options parameter in your Create transaction request. This parameter can be an empty object (hosted_options={}) if you don't require additional configuration. When provided, Berbix will return a hosted verification link that is unique to each transaction in the hosted_url response field.

Updated 4 months ago

Hosted Flow Overview

Suggested Edits are limited on API Reference Pages

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