Verify Name
id_verify_nameVerify a name against the account holder via Akahu identity checks, scoped to a specific account or all connected identity sources.
Instructions
Verify a name against the account holder via Akahu's identity check.
If account_id is provided, the check is scoped to that one account (POST /verify/name/{account_id}); otherwise Akahu matches against every identity source the user has connected (POST /verify/name).
Requires the appropriate Personal-App scope grant in your Akahu portal; without it Akahu returns 403 Forbidden. May incur a per-call charge from your bank. Always elicits user confirmation (not bypass-eligible).
Returns {"success": bool, "item": dict | None, "message": str | None} where item is Akahu's match-result envelope (shape documented at https://developers.akahu.nz/docs/enduring-verify-name).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| initials | No | Optional list of initial strings (e.g. ["J", "R"]). | |
| account_id | No | Optional account scope; omit to check all sources. | |
| given_name | No | Optional first name. | |
| family_name | Yes | Required. Surname to verify. | |
| middle_name | No | Optional middle name. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||