Sign in

v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB
Identity

[Enduring access] Verify a name against an account

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:

  • 📚 Enduring Verify Name
post/verify/name/{id}

Path parameters

idstring cuid 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.

Example:acc_c01234567890123456789012345

Headers

X-Akahu-Idstring required

Your App ID Token.

Request body

given_namestring

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

middle_namestring

The middle name to match against, if available

family_namestring required

The family name/surname to match against

initialsstring[]

An array of initials to match against, if available

Example request

{
  "given_name": "Homer",
  "middle_name": "Jay",
  "family_name": "Simpson"
}

Response

Success

OR

Example response

{
  "item": {
    "sources": [
      {
        "type": "PARTY_NAME",
        "match_result": "MATCH",
        "meta": {
          "initials": [
            "H",
            "J"
          ],
          "given_name": "Homer",
          "middle_name": "Jay",
          "family_name": "Simpson",
          "prefix": "MR",
          "gender": "MALE"
        },
        "verification": {
          "family_name": true,
          "middle_name": true,
          "given_name": true,
          "middle_initial": true,
          "given_initial": true
        }
      }
    ],
    "name": {
      "given_name": "Homer",
      "middle_name": "Jay",
      "family_name": "Simpson"
    }
  }
}