Remove a Customer from EWA

Remove a Customer from an Earned Wage Access (EWA) program. If the Customer has an outstanding recovery amount, their Customer Profile will not be removed from the program immediately. Instead, the Customer Profile’s eligibility status will be changed to INELIGIBLE until the funds are fully recovered.

Endpoint

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

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

None

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