---
title: "Verify your user's name"
method: POST
path: "/identity/{code}/verify/name"
tags: ["Identity"]
---

# Verify your user's name

`POST /identity/{code}/verify/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](/docs/oneoff-verify-name)

## Path parameters

- `code` string, required

## Headers

- `Content-Type` string

## Request body

- VerifyNameData
  - `given_name` string — The given name/first name to match against, if available
  - `middle_name` string — The middle name to match against, if available
  - `family_name` string, required — The family name/surname to match against
  - `initials` string[] — An array of initials to match against, if available

## Response `200`

Success

- union
  - object
    - `success` true, required
    - `item` object, required
      - `sources` VerifyNameSource[], required
        - union
          - VerifyNamePartySource
            - `type` 'PARTY_NAME', required — The name was matched against a Party
            - `meta` object, required — The Party name data that this name was verified against
              - …
            - `match_result` 'MATCH' | 'PARTIAL_MATCH', required — What is the quality of the Match? - `MATCH` → All name components matched - `PARTIAL_MATCH` → Some of the name components matched, but not all
            - `verification` VerifyNameMatchedComponents, required — A collection of flags indicating which name components matched
              - …
          - VerifyNameHolderSource
            - `type` 'HOLDER_NAME', required — The name was matched against an Account Holder
            - `meta` object, required — The Account data that this name was verified against
              - …
            - `match_result` 'MATCH' | 'PARTIAL_MATCH', required — What is the quality of the Match? - `MATCH` → All name components matched - `PARTIAL_MATCH` → Some of the name components matched, but not all
            - `verification` VerifyNameMatchedComponents, required — A collection of flags indicating which name components matched
              - …
      - `name` VerifyNameData, required
        - `given_name` string — The given name/first name to match against, if available
        - `middle_name` string — The middle name to match against, if available
        - `family_name` string, required — The family name/surname to match against
        - `initials` string[] — An array of initials to match against, if available
  - object
    - `success` false, required
    - `message` string

## Other responses

- `400` — Your request was malformed or otherwise unacceptable. More details are provided under the `message` key in the response.
- `401` — You are not authorised to access this content.
- `403` — You are not allowed to access this content.
- `404` — The item you are trying to access doesn't exist.
- `500` — An internal error has prevented us from processing the request. More detail may be supplied in the `message` key.

---

[API](https://skmtc.net/akahu/apis/akahu-enduring-api.md) · [All operations](https://skmtc.net/akahu/apis/akahu-enduring-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/akahu/akahu-enduring-api/versions/b2de9915920d/schema)