v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Account

Get Auth Customer Enrollment

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

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

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.