Initiate Identity Verification

Overview

initiate_identity_verification starts the IAL2 identity-verification process for the current user — a prerequisite for create_connection with integration_type IAL2. This orchestrates identity proofing through a Kantara-certified vendor. This takes real, immediate action (a live verification session is created with an external vendor) — only call it when the user actually wants to complete identity verification, not speculatively.

Optional Parameters

include_attribute_matching_check (boolean)

• Default: false
• Whether to also validate the user's demographics against their existing profile data during verification.

callback_url (string)

• Default: null (uses the configured default callback)
• Override the URL the user is redirected to after completing verification.

Returns

A URL (plain string) to present to the user.

Notes

• This cannot be completed by an LLM on the user's behalf. Present the returned URL in a real browser/webview session, not an in-context link. b.well's backend handles the identity-proofing flow itself and redirects back to the configured deeplink with a success/failure status once complete.
• After the user completes this, call get_verification_status to check the outcome before attempting an IAL2 connection.