---
title: "Validate SSN – Validates the Social Security Number (SSN) for a user."
method: POST
path: "/programs/{programCode}/accounts/{accountIdentifier}/users/{userIdentifier}/ValidateSsn"
tags: ["Users"]
---

# Validate SSN – Validates the Social Security Number (SSN) for a user.

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

Validates the Social Security Number (SSN) 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

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

## Response `200`

OK

- ValidateSsnResponse — Represents the response returned after validating a user's Social Security Number (SSN). Inherits standard response metadata and details from Gd.Bos.DataTransfer.Response.ResponseBase. Contains the mismatch count, indicating the number of times the provided SSN did not match the expected value for the user. Used to communicate the result of SSN validation as part of KYC (Know Your Customer) or identity verification processes.
  - `mismatchCount` integer — The number of times the provided SSN 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/versions/666553766b78/schema)