GRgreendot
Users

Get Validate Identity – Retrieves the identity validation status for a user.

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

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

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

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 identity validation status is being retrieved. 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.

Response

OK

identityIsMatchedboolean

Indicates whether the provided identity information matches the user's records. true if all identity fields match; false if there are mismatches.

mismatchCountinteger

The number of fields that did not match during identity validation. A value of 0 indicates a complete match; any positive value indicates the count of mismatched fields.

Changes

No recorded changes to this operation across all 2 revisions of this API.