GRgreendot
Account

Get Auth Customer Enrollment

Retrieves the enrollment information for the specified user on the account.

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

Request

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

Path parameters

programCodestring required

Partner program code for the account.

accountIdentifierstring required

Unique account identifier (UID or GUID).

userIdentifierstring required

Unique user identifier (UID or GUID).

Headers

X-GD-RequestIdstring required

Unique request tracking identifier (X-GD-RequestId header).

Response

OK

enrollmentStatusCodeinteger

The numeric enrollment status code for the customer.

enrollmentStatus'UserNotEnrolled' | 'Enrolled'

The enrollment status as an enumerated value.

customerIdstring nullable

The unique identifier of the customer.

Changes

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