v1

latestOpenAPI 3.0.12026-07-243407211.3 MB

Users

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

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

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

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 validation status is being retrieved. Must be a valid GUID.

X-GD-RequestIdstring required

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

ssnIsMatchedboolean

Indicates whether the provided SSN matches the expected value for the user.

mismatchCountinteger

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