Update a Customer’s EWA Eligibility

Update a Customer’s eligibility to enroll in new or existing Earned Wage Access (EWA) programs.

Endpoint

POST /v1/customer-profiles/{externalId}/eligibility

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

externalId REQUIRED

string

Your organization’s Earned Wage Access (EWA) reference number for the employee.

Request Body

eligibilityUpdateReason

string

Reason the Customer’s status has been updated.

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.

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

				
					{
  "eligibilityUpdateReason": "New application",
  "eligibilityStatus": "NEW"
}

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