---
title: "Validate Identity – Validates the identity information for a user."
method: POST
path: "/programs/{programCode}/accounts/{accountIdentifier}/users/{userIdentifier}/ValidateIdentity"
tags: ["Users"]
---

# Validate Identity – Validates the identity information for a user.

`POST /programs/{programCode}/accounts/{accountIdentifier}/users/{userIdentifier}/ValidateIdentity`

Validates the identity information for the specified user. Returns validation status and any errors encountered during the process.

## Path parameters

- `programCode` string, required
- `accountIdentifier` string, required
- `userIdentifier` string, required

## Headers

- `X-GD-RequestId` string, required

## Request body

- ValidateIdentityRequest — Represents a request to validate a user's identity information for compliance and verification purposes. Contains the user and account identifiers, along with the identity hash code to be validated. Used in the Validate Identity API to confirm the user's identity against stored or provided data as part of KYC (Know Your Customer) or onboarding processes. Inherits standard request metadata from Gd.Bos.DataTransfer.Request.RequestBase.
  - `identityHashCode` string, nullable — The hash code of the user's identity information to be validated.

## Response `200`

OK

- ValidateIdentityResponse — Represents the response returned after validating a user's identity information. Inherits standard response metadata and details from Gd.Bos.DataTransfer.Response.ResponseBase. Contains the mismatch count, indicating the number of times the provided identity information did not match the expected value for the user. Used to communicate the result of identity validation as part of KYC (Know Your Customer) or onboarding processes.
  - `mismatchCount` integer — The number of times the provided identity information did not match the expected value for the user.
  - `responseDetails` ResponseDetail[], nullable — Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation.
    - `code` integer — The primary status or error code for the response (e.g., 200 for success, 400 for validation error).
    - `subCode` integer, nullable — An optional subcode providing more granular detail about the response or error.
    - `description` string, nullable — A human-readable description of the response, error, or status.
    - `url` string, nullable — A URL linking to documentation or a web page with more information about the response code.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/revisions/666553766b78/schema)
