List All EWA Customer Profiles

enrollmentBeginDateFrom  

string (date), format: yyyy-MM-dd

Start date of the Customer’s EWA enrollment period. This filter will return Customer Profiles with an enrollment period that started on or after this date.

Can be used in conjunction with enrollmentBeginDateTo to define a date range for the enrollment period start date.

enrollmentBeginDateTo  

string (date), format: yyyy-MM-dd

Start date of the Customer’s EWA enrollment period. This filter will return Customer Profiles with an enrollment period that started on or before this date.

Can be used in conjunction with enrollmentBeginDateFrom to define a date range for the enrollment period start date.

enrollmentEndDateFrom

string (date), format: yyyy-MM-dd

End date of the Customer’s EWA enrollment period. This filter will return Customer Profiles with an enrollment period that ends on or after this date.

Can be used in conjunction with enrollmentEndDateTo to define a date range for the enrollment period end date.

enrollmentEndDateTo

string (date), format: yyyy-MM-dd

End date of the Customer’s EWA enrollment period. This filter will return Customer Profiles with an enrollment period that ends on or before this date.

Can be used in conjunction with enrollmentEndDateFrom to define a date range for the enrollment period end date.

enrollmentStatus

string enum, values: ACTIVE, INACTIVE

Customer’s EWA enrollment status. The following values are supported:

• ACTIVE  The Customer Profile is enrolled in an active EWA Program.
• INACTIVE  The Customer Profile is not enrolled in an active EWA Program.

eligibilityStatus  

string enum, values: NEW, ELIGIBLE, INELIGIBLE, ARREARS, BAD_DEBT, DISABLED

Customer’s eligibility status for Earned Wage Access (EWA) programs. The following values are supported:

• NEW  An EWA Customer Profile has been created for the Customer. This is the default value when a Customer is created or onboarded to an EWA Program.
• ELIGIBLE  The EWA Customer Profile has access to an EWA Program. Funds can be disbursed to the Customer Profile from the EWA Program.
• INELIGIBLE  The EWA Customer Profile is no longer able to access the EWA Program. Funds will not be disbursed to the Customer Profile but recovery will still be attempted.
• ARREARS   The latest recovery attempt for the EWA Customer Profile was not processed successfully. Funds will not be disbursed to the Customer Profile.
• BAD_DEBT  Several recovery attempts for the EWA Customer Profile have failed and funds are no longer expected to be recovered. Funds will not be disbursed to or recovered from the Customer Profile.
• DISABLED  The EWA Customer Profile is no longer eligible for the EWA Program.

programName

string

Name of the Earned Wage Access (EWA) Program for the Customer.

programId  

string

ID of the Earned Wage Access (EWA) program for the Customer.

externalId  

string

Your organization’s Earned Wage Access (EWA) reference number for the employee. This should be a string that is used to identify the employee in your internal systems, such as your payroll software. The EWA reference number is added to the employee’s Customer Account, allowing you to easily locate the employee in RocketKOR. EWA reference numbers must be unique within the Business Account.

firstName  

string, min length: 1, max length: 40

Customer’s first name.

middleName

string, min length: 1, max length: 40

Customer’s middle name.

lastName  

string, min length: 1, max length: 40

Customer’s last name.

sort

array [string]

Sort the response by any field in ascending or descending order. The default sort order is createdAt,DESC. For more information, see Sorting and Pagination.

page

integer (int32)

Page number to return, based on zero-based page indexing.

size

integer (int32)

Maximum number of results to return per page.