---
title: "Get Validate SSN – Retrieves the SSN validation status for a user."
method: GET
path: "/programs/{programCode}/accounts/{accountIdentifier}/users/{userIdentifier}/ValidateSsn"
tags: ["Users"]
---

# Get Validate SSN – Retrieves the SSN validation status for a user.

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

Retrieves the SSN validation status for the specified user and account. Returns the validation status and any related information.

## Path parameters

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

## Headers

- `X-GD-RequestId` string, required

## Response `200`

OK

- GetValidateSsnResponse — Represents the response returned after validating or retrieving a user's Social Security Number (SSN) association for an account. Inherits standard response metadata and details from Gd.Bos.DataTransfer.Response.ResponseBase. Contains a flag indicating whether the SSN matched and the number of mismatches encountered. Used to communicate the result of SSN validation for compliance, onboarding, or identity verification processes.
  - `ssnIsMatched` boolean — Indicates whether the provided SSN matches the expected value for the user.
  - `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

- `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)
