EWA Customer Profile Object

The Earned Wage Access (EWA) Customer Profile object represents a Customer who has been enrolled in an EWA Program. The object includes information about the Customer, their Financial Account, their EWA eligibility status, and the EWA Program in which they are enrolled.

Attributes

string (UUID)

ID of the Customer’s Earned Wage Access (EWA) Profile in RocketKOR.

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.

customerId

string (UUID)

ID of the Customer Account.

financialAccountId

string (UUID)

ID of the Customer’s external card Financial Account. This Financial Account is used for the EWA Program.

latestEligibilityStatus

object

Customer’s current eligibility status for the Earned Wage Access (EWA) program.

string (UUID)

ID of the status.

eligibilityUpdateReason

string

Reason the Customer’s status has been updated.

status

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

Customer’s current eligibility status. 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 and can be used to disburse funds.
INELIGIBLE The EWA Customer Profile is no longer able to access the EWA Program. Funds will not be disbursed 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.
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 or recovered.
DISABLED The EWA Customer Profile is no longer valid for the EWA Program.

createdAt

string (date-time)

Date and time the status was assigned to the Customer.

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.

programId

string

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

programName

string

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

EWA Customer Profile Object

				
					{
  "id": "string(UUID)",
  "externalId": "string(UUID)",
  "customerId": "string(UUID)",
  "financialAccountId": "string(UUID)",
  "latestEligibilityStatus": {
    "id": "string(UUID)",
    "eligibilityUpdateReason": "string",
    "status": "NEW | ELIGIBLE | INELIGIBLE | ARREARS | BAD_DEBT | DISABLED",
    "createdAt": "string(date-time)"
  },
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "programId": "string",
  "programName": "string"
}