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

Transactions

View All Transactions

A Transaction refers to a unique set of verifications requested for a given user. You might create multiple transactions for a given user, but Berbix will keep those distinct. The history of all transactions for your account is available in the Transactions tab within the Berbix Dashboard.

Within this view, you're presented the Berbix UID for each transaction, which is a unique identifier corresponding to a given transaction. You'll also see the Customer UID for each transaction, which is a unique identifier provided by you and intended to designates a given user (e.g. a given Customer UID may correspond to multiple transactions). In addition, the type of verification(s) completed for the transaction, the last user interaction with the transaction, and when the transaction was created are also shown.

You can filter transaction by the completion status of the transaction, the action corresponding to it (if it has been completed), as well as the template used for the transaction.

Filter by CustomerUID

Within the transactions view, you can filter for a given Customer UID to find all transactions for that user.

View an Individual Transaction

Basic Info

The top of the view for an individual transaction will present a variety of information about the transaction. This includes:

  • User information: Name, Date of Birth, Age, etc.
  • Document information: Document Type, Expiry Date, Issue Date, etc.
  • Flags: ID Flags returned for the transaction.

Each field is accompanied by confidence indicators that provide more insight into the sources for the extractions.

The mapped action is also shown at the top of the transaction in its associated color. In the example below, the provided ID is a sample ID which returned a id_sample_detected flag mapped to reject.

When Berbix detects inconsistencies in the information submitted by the user (e.g. because the data from the front and the back of the ID do not match, or because some of the data entered by the user is inconsistent with Berbix's extractions), those are surfaced with the addition of an exclamation mark next to the mismatching fields. By hovering over the confidence bars, you can see the various data sources on which Berbix's inconsistency detection is based.

Document Details

By clicking on the thumbnail images, you'll see the user-provided front or back images of the ID that can be used for manual review. Note: If any of the images shown on the details page are partially cropped, clicking on the image will reveal alternative scaled shots.

Face Match

Beneath the document details, Berbix provides a cropped photo from the Photo ID alongside the user provided selfie and liveness check image (if enabled). The document photo will be compared to the selfie image and the selfie image will also be compared to the liveness check.

In the example below, the provided selfie was an unlikely match when compared to the document photo but was a likely match when compared to the liveness check image. The unlikely match also caused Berbix to return the id_selfie_face_mismatch flag, which was mapped to the review action.

Watermarking

Images exposed in the dashboard (and via the API) are watermarked in an effort for Berbix to be the best possible steward of sensitive data. Image watermarks are generated on a per-access basis and therefore can be traced to the IP address accessing the image and the timestamp at which the image was accessed.

Image can include up to two watermarks: one in the bottom-left corner and one that covers the sensitive data in the image (such as an ID or a face). The IP address and timestamp associated with the image are also rendered in a notice at the bottom of the image to discourage storing or sharing of this sensitive information.

Watermarked images are also surfaced at a lower resolution than that of the original raw image. Please contact us if the resolution or watermark prevents you from reviewing the contents of a given ID or selfie image!

Watermarks and reviews in the dashboard

When a transaction's action is review, Berbix automatically hides the larger watermarks within the dashboard in order to facilitate reviewers' efforts. In addition, for transaction that are not marked for review, or have previously been reviewed, Berbix offers the ability to selectively hide watermarks. To use that ability, click on the image you'd like to see without a watermark, and press the "Show Without Watermark" button at the bottom of the modal that gets presented to you. Please note that all uses of that functionality are logged and listed in the Logs page, and are moreover subject to a daily and monthly cap.

Deleting, Blocking, or Escalating a Transaction

You have the option to Delete or Escalate a transaction by clicking the More Actions button to open a modal. If a customer UID is provided, you're also able to Block a given transaction.

Delete Transaction

Deleting a transaction permanently deletes any data for a given transaction and has the same effect as using our Delete transaction API.

Block Transaction

Blocking a transaction enables you to prevent bad actors from reentering your platform. When set, Berbix will raise a blocked flag that can be mapped to a reject action if this ID is seen in the future.

Escalate Transaction

Escalating a transaction notifies the Berbix team with a provided escalation reason to review or investigate a transaction. You should escalate transactions if there is an error or bug associated with a transaction or if you'd like the Berbix team to review a fraudulent actor.

Updated 4 days ago

Transactions


Suggested Edits are limited on API Reference Pages

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