Overview

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

📘

Prerequisites

• Deploy the "MobileMatch to BioGovID or KBA" Workflow by following the directions here.
• Obtain the access keys for your new workflow by following the directions here
• Download and use the MobileMatch to BioGovID or KBA Postman Project to try it out

👍

RECAP:

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

• MobileMatch Walkthrough
• BioGovID
• KBA Walkthrough

Escalating from MobileMatch to BioGovID or KBA

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

• 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 Additional Verification API Key:

"forwardApiKey": "47aaf7cccfa14d42", //your Additional Verfication API key
"policyObligation": true,
"policyDecision": "obligation"

Your application should then make the following request to select whether to further verify the user by BioGovID or KBA

{
    "apikey": "your-mobilematch-pii-apikey",
    "credential": "[email protected]",
    "appID": "My ID Proofing Application",
    "asi": "start of session", // Obtained during the country selection step of mobilematch.
    "userAttributes": [
        {
            "attributeType": "BioGovOrKBA",
            "values": {
                "bioGovOrKBA": "kba" // Or "biogov"
            }
        }
    ]
}

🚧

Note: You'll need to include logic in your application to begin the BioGovID or KBA experience when the forwardApiKey you receive matches that of your workflow's BioGovID API key, or KBA API key. Be sure to also include the same asi or transaction_id used to conduct MobileMatch in your BioGovID requests. That way, the same userAttributes you've already collected remain available during BioGovID verification.

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.

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