AKakahu
Identity

Verify your user's 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.

For more details about the data returned, see:

  • 📚 One-Off Verify Name
post/identity/{code}/verify/name

Request

  • Base URL
    https://api.oneoff.akahu.io/v1
  • URL
    https://api.oneoff.akahu.io/v1/identity/{code}/verify/name
  • Auth
    HTTP basic

Path parameters

codestring required

The one-off authorization code, provided to your application by redirection to your redirect_uri upon the user's successful completion of the authorization flow.

Headers

Content-Typestring

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

Changes

No recorded changes to this operation across all 1 revision of this API.