Integration Design Guide and Checklist

add hosted transaction template links

Choose an integration type

There are three main ways to get started using Berbix for ID verification. Which option is best for your circumstances will vary based on your expected volumes, technical resources, and desired user experience. Be sure to check out some additional tips and considerations at the bottom that apply to all integration types.

No-Code: Use the Berbix Dashboard to Create and Review Transactions

Advantages of this approach:

  • Get up and running quickly, with no development work required.
  • Empower operational teams to create and manage verifications on a per-user basis, to supplement existing workflows.
  • Prototype ID verification with your internal team, or as an interim process while building a full integration.

Disadvantages:

  • Subsequent processing is a manual task, adding operational overhead.
  • Providing links to users may introduce delays or friction to your user flows

What to consider when choosing this option:

  • When and how will you provide users with verification links?
  • Does your team already have a workflow for guiding users through ID verification? What processes might need to change or be added to account for the new steps?
  • How will ID verification fit into your existing product and user journey? Will this be a blocker for users, and if so what SLAs will you target? Note that there will be two manual steps to consider: creation of links and later reviewing results for completed transactions.
  • How will you train your team to review and action transaction results? Will they need to take any further steps to migrate user data out of Berbix and into your other systems?

Set-up Checklist:

  • Create a test transaction by navigating to “Transactions” and clicking “Create Transaction”. The resulting link will produce a single-use verification for the given customer ID. To see the full Transaction Report, be sure to add your information to the list of Test ID’s, accessible through the side navigation.
  • Customize your configuration options.
  • Create a Hosted Link Configuration to automatically generate hosted transactions.
  • Read the Hosted Flow Overview.
  • Consider planning to upgrade to a Low-Code integration for increased scalability when your resourcing needs shift and/or volumes grow.

Low-Code: Use Hosted Links for a backend-only integration

Advantages of this approach:

  • Integrate with our API (or backend library); no frontend development is required.
  • Programmatically create transaction links at high volumes.
  • Embed the resulting links in user emails, or wherever you’d like!
  • Fetch transaction data automatically for use elsewhere in your systems.

Disadvantages:

  • ID verification will be a clearly discreet step in the user experience, rather than imbedded in the existing product.

What to consider when choosing this option:

  • What will trigger the creation of a Berbix transaction in your product? How will the resulting links be provided to users?
  • Should a user be able to re-attempt verification if they are initially rejected?
  • Will users ever need to verify more than once during your data retention period? (If so, be sure they will have the same Customer UID in your system so Berbix doesn’t flag subsequent transactions as duplicates.)
  • Will your team manually review any transactions? If so, what SLAs will you target? Will a “review” status block users from completing other steps in your user journey?
  • What data will you need to consume from the data results, and where will it be stored?

Set-up Checklist:

  • Review the Integration Guide, following the instructions for the Hosted Flow, instead of using a Client-side SDK.
  • Customize your configuration options, including a Templates, Action Map, and (optional) Theme.
  • In “Integrations”, create a test API key and set up webhooks. You should listen for both transaction completion events and changes in transaction status (necessary if any actions are mapped to Review).
  • Use one of our API Libraries, or integrate with the API directly, to develop the back-end portion of the integration, specifying the hosted_options when you create a transaction.

Full Integration: Get the most out of Berbix with a seamless experience

Advantages of this approach:

  • Insert Berbix seamlessly into your user flows, whether on web or in native mobile applications.
  • Use our SDKs and backend libraries as a foundation for your integration.
  • Minimize user friction by allowing Berbix to transition users to their mobile device as needed.
  • Fetch transaction data automatically for use elsewhere in your systems.

Disadvantages:

  • A full frontend and backend integration will require more development work, and potentially more QA. You may also need to account for release cycles in your launch timeline, particularly for native mobile apps.

What to consider when choosing this option:

  • Where in your product will the verification take place? (Putting verification later in the user journey generally results in the best conversion because more of the traffic will be high-intent.) Will verification be a blocking step?
  • Should a user be able to re-attempt verification if they are initially rejected?
  • Will the user ever need to verify more than once during your data retention period? (If so, be sure they will have the same Customer UID in your system so Berbix doesn’t flag subsequent transactions as duplicates.)
  • Will your team manually review any transactions? If so, what SLAs will you target? Will a “review” status block users from completing other steps in your user journey?
  • What data will you need to consume from the data results, and where will it be stored?

Set-up Checklist:

  • Review the Integration Guide, following the instructions for the Hosted Flow, instead of using a Client-side SDK.
  • Customize your configuration options, including a Template, Action Map, and (optional) Theme.
  • In “Integrations”, create a test API key and specify a domain for transaction creation requests. Set up a webhook endpoint to listen for changes in transaction status (necessary if any actions are mapped to Review).
  • Install the relevant Berbix Client-Side SDK(s) used to display the Berbix i-frame or modal.
  • Use one of our API Libraries, or integrate with the API directly, to develop the back-end portion of the integration.

Finishing Touches

Regardless of which integration type you choose, you’ll want to account for the following:

  • Set context with your users for why they need to complete ID verification, as they’re being directed to Berbix. This will lead to higher completion rates and less confusion/frustration for your users.
  • Review our Testing Guide and set up Test IDs to QA your integration prior to go-live.
  • Add Team members (anyone who needs to be able to manually generate links or (re)view transaction results).