API Integration of MobileMatch to BioGovID

Overview

This guide will show you how to use the AXN Verify API to verify an individual by MobileMatch to BioGovID.

πŸ“˜

Prerequisites

πŸ“˜

An example MobileMatch to BioGovID application is also made available for you to download here

πŸ‘

RECAP:

This workflow is a combination of two single method verification workflows. To learn how to implement either workflow:

Escalating from MobileMatch to BioGovID

There are two conditions which should trigger a step up to BioGovID:

  • the user's selected country does not support MobileMatch
  • the user fails either the MobileMatch - PII, or MobileMatch - OTP

If either condition is met during the MobileMatch phase of the transaction, the /slverify output will include a policyDecision of obligation, and the forwardApiKey will equal that of your BioGovID (Picker) API Key:

"forwardApiKey": "47aaf7cccfa14d42", //your BioGovID "document picker" api key
"policyObligation": true,
"policyDecision": "obligation"

Your application should then start the BioGovID process of API calls, as outlined here.

🚧

Note: You'll need to include logic in your application to begin the BioGovID experience when the forwardApiKey you receive matches that of your workflow's BioGovID (Picker) api key.

Result

Whether the user was asked to complete MobileMatch or BioGovID, the conclusion of either workflow will be a policyDecision of either approve or deny.

policyDecision is a standard output of /slverify, the endpoint used to verify user information. Additional information on the output of SLVerify can be found here.