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

Testing Guide

Berbix provides a testing framework to easily perform and automate end-to-end tests of the Berbix Verify Flow in your app. The framework enables you to mock the completion of a transaction without needing to submit any verification data such as photo ID or selfie images. When overriding the transaction result, all you need to do is specify the type of photo ID data (payload) and which flags you'd like returned in the API response.

You can override transaction results via the API on the server-side or interacting with the client-side JavaScript SDK directly. Instructions for both methods are included below.

Berbix currently provides the following sample verification payload values:

  • us-dl: a sample verification for a US driver license
  • us-id: a sample verification for a US identification card
  • passport: a sample verification for a US passport

Please reference the Sample Response Payload for a complete sample response payload and let us know if you need additional test cases!

Server-Side Testing

To override results via the API, simply call the Overrides endpoint (/transactions/override) after you have created a transaction via the API.

You will need to provide the response_payload and the list of flags (if any) desired in the transaction result. Possible values for the response_payload are enumerated below and you can read through all possible ID flags here.

After overriding the transaction data, you can fetch the verification overridden verification data as you would normally via the API.

Client-Side Testing

To get started, load the Berbix Verify Flow in test mode within your application or create a test transaction using our hosted flow.

In the verification flow, click Test mode. Click to override to start the verification result override process.

In the subsequent view, you can select which verification response Payload and Flags you'd like returned in the verification result. After selecting an ID type via the Payload, you can add as many flags as you'd like to simulate common verification scenarios and corresponding business logic based on your flag action mapping. For instance, adding the flag for id_under_21 flag for any of the ID types would mimic the payload for a valid underage ID.

The verification is overridden once you click Complete. The data is then available in the dashboard and for fetching via the API.

Viewing Overridden Transaction Data

To view overridden transactions, select All Transactions from the transactions list view or visit the transaction dashboard URL directly. Overridden transactions will be denoted by the >> icon in the transactions list view.

The transaction page will be presented similarly to other transactions however no image data will be available. Mock images are presented when fetching the transaction from the API.

Sample Response Payload

Berbix currently provides the following sample verification payload values:

  • us-dl: a sample verification for a US driver license
  • us-id: a sample verification for a US identification card
  • passport: a sample verification for a US passport

The API response for each payload option will be identical with the exception of the id_type field and the sources for each field. Let us know if you need additional test cases!

🚧

Fields returned vary based on customer

Please note that the specific fields returned via the API depend on your use case and account configuration. Let us know if you are expecting additional fields in your API response.

The example below is for a us-dl response with the id_under_21 flag included.

{
  "entity": "transaction_metadata",
  "id": 6257684466630656,
  "flags": [
    "id_under_21"
  ],
  "action": "review",
  "fields": {
    "given_name": {
      "value": "GIVEN",
      "confidence": "high",
      "sources": [
        {
          "value": "GIVEN",
          "type": "pdf417",
          "confidence": "high"
        },
        {
          "value": "GIVEN",
          "type": "ocr",
          "confidence": "medium"
        }
      ]
    },
    "middle_name": {
      "value": "MIDDLE",
      "confidence": "high",
      "sources": [
        {
          "value": "MIDDLE",
          "type": "pdf417",
          "confidence": "high"
        },
        {
          "value": "MIDDLE",
          "type": "ocr",
          "confidence": "medium"
        }
      ]
    },
    "family_name": {
      "value": "FAMILY",
      "confidence": "high",
      "sources": [
        {
          "value": "FAMILY",
          "type": "pdf417",
          "confidence": "high"
        },
        {
          "value": "FAMILY",
          "type": "ocr",
          "confidence": "medium"
        }
      ]
    },
    "id_type": {
      "value": "DL",
      "confidence": "high",
      "sources": [
        {
          "value": "DL",
          "type": "pdf417",
          "confidence": "high"
        },
        {
          "value": "DL",
          "type": "ocr",
          "confidence": "medium"
        }
      ]
    },
    "id_issuer": {
      "value": "US-CA",
      "confidence": "high",
      "sources": [
        {
          "value": "US-CA",
          "type": "pdf417",
          "confidence": "high"
        },
        {
          "value": "US-CA",
          "type": "ocr",
          "confidence": "medium"
        }
      ]
    }
  },
  "verifications": {},
  "created_at": "2020-04-16T22:14:35Z",
  "customer_uid": "",
  "duplicates": null,
  "dashboard_url": "https://dashboard.sandbox.berbix.com/transaction?orgId=[...]",
  "implementation_info": "The data for this transaction has been overridden with a test payload. Read more at https://docs.berbix.com/docs/testing"

Updated 3 months ago

Testing Guide


Suggested Edits are limited on API Reference Pages

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