Enroll an Existing Customer in EWA

An employee who is enrolled in an Earned Wage Access (EWA) Program is treated as a RocketKOR Customer. An Individual Customer Account is created for the employee, and a Financial Account is created for the account (such as a debit card) the employee is using for EWA disbursements.

Use this API to enroll an existing Customer with an existing external card Financial Account in an EWA Program.

The API will perform the following operations as part of the EWA enrollment process:

Lookup the existing Customer Account using the Customer’s externalId or customerId.
Lookup the Customer’s existing external card Financial Account.
Enroll the Customer in the specified EWA Program.
Create an EWA Customer Profile for the Customer.

Endpoint

POST /v1/customer-profiles/onboard

Authorization Header

Authorization: Bearer <access_token>

Request Body

externalId CONDITIONAL

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.

Either externalId or customerId (or both) must be provided.

customerId CONDITIONAL

string (UUID)

ID of the Customer Account.

Either externalId or customerId (or both) must be provided.

eligibilityStatus REQUIRED

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.

programId CONDITIONAL

string

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

Either programId or financialAccountId (or both) must be provided.

financialAccountId CONDITIONAL

string (UUID)

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

Either programId or financialAccountId (or both) must be provided.

Returns

Returns the Earned Wage Access (EWA) Customer Profile object. This object contains unique IDs for the Customer’s EWA Customer Profile, Customer Account, and Financial Account; your EWA reference number for the Customer; and details for the Customer’s EWA Program.

SAMPLE REQUEST

				
					{
  "externalId": "52cb212e-d6d2-4afe-b9dc-4f9fe5c12c3b",
  "eligibilityStatus": "NEW",
  "programId": "abcdefg",
  "customerId": "ed51e0b5-ddbb-43e0-b14d-d66044bf81ac",
  "financialAccountId": "6aadfb7a-fc4f-481a-8f25-2d84810a4b9e"
}

SAMPLE RESPONSE

				
					{
  "id": "28562c80-155b-4ddc-bc4b-aedb7dcdeed2",
  "externalId": "52cb212e-d6d2-4afe-b9dc-4f9fe5c12c3b",
  "customerId": "ed51e0b5-ddbb-43e0-b14d-d66044bf81ac",
  "financialAccountId": "6aadfb7a-fc4f-481a-8f25-2d84810a4b9e",
  "latestEligibilityStatus": {
    "id": "2294d74b-c0e0-4a7f-9ea0-3a2117e83a4c",
    "eligibilityUpdateReason": "New application",
    "status": "NEW",
    "createdAt": "2024-01-22T22:20:55.610Z"
  },
  "firstName": "Sarah",
  "middleName": "Jane",
  "lastName": "Green",
  "programId": "abcdefg",
  "programName": "EWA"
}