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

post

https://example.com/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 Params

programCode

string

required

The program code associated with the request.

accountIdentifier

string

required

The unique identifier of the account associated with the user. Must be a valid GUID.

userIdentifier

string

required

The unique identifier of the user whose SSN is being validated. Must be a valid GUID.

Body Params

The Gd.Bos.DataTransfer.Request.ValidateSsnRequest object containing the SSN hash code to validate.

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 | null

The hash code of the user's Social Security Number (SSN) to be validated.

Headers

X-GD-RequestId

string

required

The unique request identifier for idempotency and tracking.
Must be provided in the X-GD-RequestId header.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

401

Unauthorized

200OK

400Bad Request

403Forbidden

500Internal Server Error

503Service Unavailable