Templates

Templates define the steps your end-users will take to verify their identity, and may be uniquely configured for different product paths and workflows.

Configurable template options include the types of verification to conduct (photo ID, selfie comparison, liveness) and settings for the verification flow (allowable ID types, consent collection, etc.).

Create New Template

Under "Configuration" in the menu, select Templates.
Click the Create Template button in the top right corner of the screen.
Add a name and select a template type, then click Save.

📘
Template Tip #1
If you will be creating multiple templates, name your templates to match the intended use case (e.g. New Registration, Returning Customer, Barcode Scanner, etc.).

📘
Template Tip #2
Hosted transactions can only be generated for Web type templates.

Once created, a Template Key will be generated that can be used when creating a transaction programmatically, and will be prefixed with tpk_.

Template Configuration

General Settings

Template Key

This value, prefixed with tpk_` is unique to this template and is required to create a transaction programmatically.

Action Map

Templates can use different Action Maps for business logic to suit the use case.

You may select an existing action map or create a new action map from the drop-down list. If you edit an existing action map or create a new one, you can return to the template editor using the "Back to template" button.

Theme

If your product paths require different branding, you can customize the look and feel of the end user experience per template by selecting the appropriate Theme.

You may select an existing theme or create a new theme from the drop-down list. If you edit an existing theme or create a new one, you can return to the template editor using the "Back to template" button.

Intro screen

You may choose to use our default introduction screen to set the end user's expectations for the identity verification process. For slight updates to the wording on your intro screen, you may reach out to [email protected], or you are welcome to develop your own custom UI for this purpose.

Selfie Reverification

Berbix supports a simplified re-verification flow for end-users that have been previously verified. If this setting is enabled, the template will require a selfie only, and will perform a check against the ID photo data collected during the original transaction.

This can be used to collect additional verification data from users or to re-verify existing users over time to ensure they are the same person.

To generate a reverification transaction, the original transaction associated with that user's Customer UID must be in an Accepted state.

Disable handoffs

If necessary for your use case, you may use this setting to restrict end users from handing off to their mobile device. If you are interested in disabling handoffs, we recommend checking in with our Solutions Engineering team at [email protected] to discuss potential risks and benefits.

Verifications

Collect Country

When enabled, the end user will be prompted to select the country that issued their ID document, giving you greater control over allowable ID issuers and types. We recommend this step to organizations with a global customer base.

Whether or not this step is enabled, Berbix will capture the issuing country during the verification.

Allowable ID Types

Customize what types of photo IDs are permitted in your verification flow. Use the checkboxes to select ID card or driver license and/or Passport, or select the Custom box for more granular control over allowable ID types from the US or Canada.

📘
Template Tip #3
In this context, 'ID card' refers to a government issued, non-driver photo ID.
The types of documents that fall into this category can vary by country, state, province, or region. For more details, check out our Supported ID Types.

Depending on the option you select, end users will be prompted to submit only the allowable ID types. If the end user submits an unallowable ID type, we'll do our best to prompt the user by reminding them which document type is expected and providing hints like "We can't find the barcode on your drivers license."

🚧
We recommend an Action Map fallback for allowable ID types
If you choose to only allow specific ID types, we strongly recommend incorporating this into the Action Map used with the template as a fallback.
For example, if your template does not permit passports, add a condition to your Action Map to reject the transaction if the id_type matches Passport.

Custom ID Types

If you select "Custom," you'll be presented with more granular filter options for the template.

For example, you could create a custom configuration to accept passports from any country, but allow drivers licenses issued in Canada or the U.S., as shown below.

The list of international ID documents we support is growing, but granular customizations for country-specific ID type restrictions are currently limited to the U.S. and Canada.

🚧
What if the user uploads a document type we don't allow?
If a user indicates they will use an allowed ID type, but then completes the flow with a different document, or a document issued by a country you do not accept, we'll raise a flag and route the transaction according to your Action Maps.

Collect machine readable component

When this setting is enabled, we capture both human-readable and machine-readable content to compare the data across sources. We highly recommend keeping this setting enabled for increased accuracy, confidence, and fraud detection capabilities.

Require handoff

When enabled, end users who initiate a transaction on a desktop or laptop computer will be required to handoff to a mobile device to complete the verification.

We highly recommend requiring mobile verification, as this provides additional security to ensure your end user is the same person that initiated the transaction, and it results in higher image quality than transactions completed via webcam.

Allow capture with webcam

Allow users to upload photos of their ID with the webcam on their desktop or laptop computer.

As noted above, allowing webcam image capture will have a negative impact on accuracy, confidence, and fraud detection rate.

Default handoff mechanism

You can choose whether to prompt the user to preform the handoff by scanning a QR code or by sending an SMS text message.

The option that is not selected here will still be available as a fallback method if the user has difficulty scanning the QR code or is not able to receive text messages. If "disable email handoff" is not enabled below, email will also be available as a fallback method.

Disable email handoff

Disabling email handoff limits handoff mechanisms to SMS text and QR code.

Use Selfie Check

Enabling this step allows Berbix to compare the face on the ID to the user's selfie(s).

Always perform selfie consent collection

❗️
This is a legacy setting. As of March 2023, all users are required to provide consent prior to engaging with the Berbix identity verification flow.
For more information, please review this Changelog article or reach out to [email protected]

Liveness Check

A Liveness Check captures a series of individual images to compare to the initial selfie, and to verify that the user is present and following the instructions on screen to look left and right.

📘
Template Tip #4
We recommend keeping the Liveness Check enabled!
Disabling the liveness check may simplify the verification experience for the end user, however it limits the data we are able to gather for comparison as well as our ability to confidently determine that the user is present and live.

Barcode scan

Enabling this setting configures the template to include a barcode scan only.

This workflow, which relies on the machine readable data in the barcode on the back of a US or Canadian driver license or ID card, is the template required for the Berbix Bouncer App.