Berbix

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

ID Flags

A list of all possible ID flags that Berbix Verify provides.

ID Flags indicate something of note with the photo ID verification. It doesn’t necessarily imply that the ID is fraudulent, but there is something important to consider when writing systems to accept or reject verifications. These are items such as id_under_18 or id_duplicate_detected.

ID Flags are returned in the flags array of the Get transaction verifications response and are associated with Actions through Flag Action Mapping in the Berbix Dashboard.

Data Flags

Summary Data

Flags associated with the data on an ID:

  • id_expired: the expiry date was in the past
  • id_expiry_unknown: the expiry date is unknown
  • id_under_18: the date of birth was less than 18 years ago
  • id_under_21: the date of birth was less than 21 years ago
  • id_age_unknown: the date of birth is unknown
  • id_user_confirmed: the user was presented with the information automatically extracted and confirmed accuracy. Users are prompted to confirm their basic details when Berbix extracts human readable data from an ID but cannot extract data from a machine readable component.
  • id_sample_detected: the provided ID was a sample ID that is inauthentic for that user

Comparison Data

Flags associated with comparisons across multiple users:

  • id_duplicate_possible: based on the name and date of birth listed on the ID provided by the verifying user, Berbix Verify found another user who previously provided an ID with similar information.
  • id_duplicate_detected: based on the name and date of birth listed on the ID provided by the verifying user, along with other datapoints unique to that specific ID (such as its expiry date and serial number), Berbix Verify found another user who previously provided an ID with the same information.
  • id_blocked_possible: based on the name and date of birth listed on the ID provided by the verifying user, Berbix Verify found a blocked user who previously provided an ID with similar information.
  • id_blocked: based on the name and date of birth listed on the ID provided by the verifying user, along with other datapoints unique to that specific ID (such as its expiry date and serial number), Berbix Verify found a blocked user who previously provided an ID with the same information.

Flags associated with comparisons across multiple users are only available if you provide a customer UID in the Create transaction request.

Consistency Flags

Flags associated with comparison issues across images provided:

  • id_selfie_face_mismatch: the similarity score between the selfie and the photo from the ID was too low
  • id_selfie_face_comparison_unavailable: a similarity score between the front and selfie could not be determined
  • id_liveness_face_mismatch: the similarity score between the selfie and the liveness photo was too low
  • id_liveness_face_comparison_unavailable: a similarity score between selfie and liveness could not be determined
  • id_selfie_consent_declined: the user did not provide consent to digitally compare the faces across images where applicable. Note: this will force the verification into a pending state.
  • id_front_back_mismatch: the information scanned for the front is sufficiently different from the information drawn from the back

Fake ID Flags

Flags associated with the potential validity of an ID:

  • id_fake_possible: the ID is possibly a fake ID
  • id_fake_likely: the ID likely a fake ID

These flags are currently only populated for state or provincial issued IDs or driver licenses in the United States and Canada.

Issue Flags

The following issue flags force the transaction into a pending state.

Summary Data

Flags associated with the data on an ID:

  • id_manual_entry: some data about the photo ID returned was provided manually by the user and have not been verified by Berbix. A user can manually enter data when prompted to confirm their basic details if Berbix does not verify data through decoding a machine readable component (see id_user_confirmed). In such cases, we may not return certain flags (for example, if we cannot extract a date of birth, and the user enters one, we won't return flags relating to their date of birth), to avoid the risk of you relying on such data points as being verified by us when they've been entered by the user and not corroborated by us. We typically recommend mapping this to a review action.

Front Flags

Flags associated with issues with the front of an ID:

  • id_text_unreadable: insufficient text was detected in the front image
  • id_no_face_detected: no face was detected in the front image of the ID
  • id_too_many_faces_detected: the image provided included more faces than expected for the ID type
  • id_mrz_parse_error: the machine readable zone was unreadable based on the scanned image
  • id_partial_mrz_read: only part of the machine readable zone was successfully read from the scanned image
  • id_front_error_unknown: an unspecified error occurred when attempting to read the front image of the ID
  • id_front_suspicious: the user provided front image(s) were flagged as suspicious and warrant further review. Suspicious flags get added, for example, when a screen photo is detected, or when the picture provided at the selfie or liveness stage appears to be the picture on the front of the ID.

In the cases where front OCR extraction is unsuccessful but a PDF417 barcode is decoded from the back, Berbix will template match the front of the ID. If this template match is successful, these IDs will be marked as complete rather than pending.

Back Flags

If we're expecting a barcode on the back, and that barcode cannot be successfully decoded, one of the following flag gets added:
id_no_barcode_detected, id_incomplete_barcode_detected, id_barcode_decode_failed, or id_barcode_parse_error. Similarly, if we're expecting text on the back (e.g. as is the case for most European IDs) and cannot find any, the id_back_text_unreadable flag gets added.

Flags associated with issues with the back of an ID:

  • id_back_text_unreadable: insufficient text was detected in the back image
  • id_no_barcode_detected: no 2D barcode was detected in the back image of the ID
  • id_incomplete_barcode_detected: a partial 2D barcode was detected in the back image
  • id_barcode_decode_failed: a full 2D barcode was detected in the back image but could not be decoded
  • id_barcode_parse_error: a full 2D barcode was detected and decoded but the data was in an unsupported format
  • id_back_error_unknown: an unspecified error occurred when attempting to read the back image of the ID
  • id_back_suspicious: The user provided back image(s) were flagged as suspicious and warrant further review. Suspicious flags get added, for example, when a screen photo is detected, or when the picture provided at the selfie or liveness stage appears to be the picture on the front of the ID.

Selfie Flags

Flags associated with issues with the user selfie:

  • id_selfie_no_face_detected: no face was detected in the selfie image
  • id_selfie_too_many_faces_detected: the selfie was rejected for having too many faces
  • id_selfie_direction_failed: the user was unable to take a valid selfie looking at the camera
  • id_selfie_suspicious: the user provided selfie images that were unlikely to be genuine. Suspicious flags get added, for example, when a screen photo is detected, or when the picture provided at the selfie or liveness stage appears to be the picture on the front of the ID.
  • id_selfie_error_unknown: an unspecified error occurred when attempting to process the selfie

Liveness Flags

Flags associated with issues with the liveness check:

  • id_liveness_no_face_detected: no face was detected in the liveness image
  • id_liveness_too_many_faces_detected: the liveness image was rejected for having too many faces
  • id_liveness_challenge_failed: the user was unable to satisfy the presented liveness challenge
  • id_liveness_suspicious: the user provided liveness images that were unlikely to be genuine. Suspicious flags get added, for example, when a screen photo is detected, or when the picture provided at the selfie or liveness stage appears to be the picture on the front of the ID.
  • id_liveness_error_unknown: an unspecified error occurred when attempting to process the liveness image

Updated 2 months ago

ID Flags

A list of all possible ID flags that Berbix Verify provides.

Suggested Edits are limited on API Reference Pages

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