API Reference

[Enduring access] Verify a name against an account

post
https://api.akahu.io/v1/verify/name/

To verify your user's identity, you may wish to match the name that you have on file against an official record such as the bank account holder name or Party name.

This will only use identity sources derived from the specified account, rather than all accounts.

For more details about the data returned, see:

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

A unique identifier for the account in the Akahu system. It is always prefixed by acc_ so that you can tell that it belongs to an account.

Body Params
string

The given name/first name to match against, if available

string

The middle name to match against, if available

string
required

The family name/surname to match against

initials
array of strings

An array of initials to match against, if available

initials
Headers
string
required

Your App ID Token.

Responses

Updated 6 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago