Identity

[Enduring access] Verify a name

Changed on

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 match against all available sources from all accounts that the user has connected to your app.

For more details about the data returned, see:

  • 📚 Enduring Verify Name
post/verify/name

Request

  • Base URL
    https://api.akahu.io/v1
  • URL
    https://api.akahu.io/v1/verify/name
  • Auth
    HTTP bearer

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",
        "meta": {
          "value": "Mr. Homer Jay Simpson",
          "sources": [
            "conn_ckhe08hru0000b8x179gg2v73"
          ]
        },
        "match_result": "MATCH",
        "verification": {
          "family_name": true,
          "middle_name": true,
          "given_name": true,
          "middle_initial": false,
          "given_initial": false
        }
      }
    ],
    "name": {
      "given_name": "Homer",
      "middle_name": "Jay",
      "family_name": "Simpson"
    }
  }
}

Changes

    • warning

      removed the optional property ///////// from the response with the status

    • warning

      removed the optional property ///////// from the response with the status

    • warning

      removed the optional property ///////// from the response with the status

    • warning

      removed the optional property ///////// from the response with the status

    • warning

      removed the optional property ///////// from the response with the status

    • warning

      removed the optional property ///////// from the response with the status

    • warning

      removed the optional property ///////// from the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      the response property ///////// became required for the status

    • info

      added the required property ///////// to the response with the status

    • info

      added the required property ///////// to the response with the status

    • info

      added the required property ///////// to the response with the status

    • info

      added the required property ///////// to the response with the status