API Reference

[One-off access] Verify a name

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

Authentication This endpoint requires app-scoped authentication.

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, returned via the Identity Response.

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 Akahu identity identifier.

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
Responses

Updated 6 months ago

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

Updated 6 months ago