Sign in

v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB
Identity

[One-off access] Verify a 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:

  • 📚 One-Off Verify Name
  • 📖 Identity model
post/identity/{id}/verify/name

Path parameters

idstring cuid required

A unique Akahu identity identifier.

Example:id_c01234567890123456789012345

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"
    }
  }
}