v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Users

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

Validates the Social Security Number (SSN) for the specified user. Returns validation status and any errors encountered during the process.

post/programs/{programCode}/accounts/{accountIdentifier}/users/{userIdentifier}/ValidateSsn

Path parameters

programCodestring required

The program code associated with the request.

accountIdentifierstring required

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

userIdentifierstring required

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

Headers

X-GD-RequestIdstring required

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

Request body

ssnHashCodestring nullable

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

Response

OK

mismatchCountinteger

The number of times the provided SSN did not match the expected value for the user.