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

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! In the Hosted Flow workflow, your users will:

  1. Be provided a unique verification link hosted on verify.berbix.com
  2. Proceed through a verification flow as defined by your web Template with your own unique logo and Theme applied
  3. 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 corresponding transactions page.

Hosted Flow verification links can be generated manually on an ad-hoc basis within the Berbix dashboard or programmatically via our API.

Create 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'll need to select a Web Template and optionally provide a unique Customer UID. Upon creation, you'll receive a unique one-time link to the hosted verification that you can share with your end-user.

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 general settings .

Create Hosted Transactions Programmatically

If you're looking to use the Berbix hosted flow at high-volumes, you can also programmatically create hosted transactions via our API. To do so, 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 8 months ago

Hosted Flow


Suggested Edits are limited on API Reference Pages

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