Enroll a New Customer in EWA Using a Tokenized Card

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 a new Customer in an EWA Program using a tokenized card. Use this API if you do not want to provide any personal information for the Customer, such as their name and contact information.

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

Create a new Individual Customer Account. Placeholder information will be inserted for the Customer’s first name, last name, email, and phone number. If a Customer Account with the same externalId already exists, the API will return an error.
Create a new external card Financial Account for the Customer’s tokenized card.
Enroll the Customer in the specified EWA Program.
Create an EWA Customer Profile for the Customer.

Endpoint

POST /v1/customer-profiles/tokenized

Authorization Header

Authorization: Bearer <access_token>

Request Body

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.

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.

programId

string

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

financialAccountData

object

Details for the Customer’s card, such as a debit or credit card. An external card Financial Account will be created for this card.

token REQUIRED

string, min length: 1, max length: 100

Token for the Customer’s card.

provider REQUIRED

string (UUID)

Provider for the Customer’s card, such as a financial institution or credit card company.

currency REQUIRED

string, min length: 3, max length: 3, default value: USD

Currency of the Financial Account. Must be an ISO 4217 alpha 3-character currency code.

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",
  "financialAccountData": {
    "token": "efvm5t4cw43ef4rfvcr",
    "provider": "provider",
    "currency": "USD"
  }
}

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"
}