API keys are tied to a single environment — Sandbox or Production. A Sandbox key cannot call production endpoints, and vice versa.

Requests using revoked, expired, or invalid keys return 401 Unauthorized. Requests where the key's scopes do not include the required permission return 403 Forbidden.

Scopes & Permissions

Each API key is assigned one or more scopes at creation time. Scopes are permanent — to change them you must revoke the key and create a new one.

Scope	Grants access to
COMPANY_READ	List and retrieve companies
COMPANY_WRITE	Create and update companies
EMPLOYEE_READ	List and retrieve employees
EMPLOYEE_WRITE	Register employees, manage company links
BENEFIT_READ	List company benefit enrollments
BENEFIT_WRITE	Enroll and update company benefits
EWA_READ	View EWA settings, requests, and employee data
EWA_WRITE	Approve/reject requests, update EWA settings
PAYMENT_READ	View payment history and balances
PAYMENT_WRITE	Initialize repayments and EWA transfers

Environments

Environment	Key prefix	Base URL
Sandbox	wb_test_	https://api-v2.workbenefits.app
Production	wb_live_	https://api-v2.workbenefits.app

Sandbox and Production share the same base URL. The key prefix determines which environment your request runs in. Sandbox data is isolated from production data.

Ownership

You act on behalf of the company admins and employees you onboard. You can only access companies you created and employees you registered — requests for anything else return 404, exactly as if the record did not exist.

Pagination

List endpoints accept page (default 1) and pageSize (default 20, max 100) query parameters and return a paginated envelope inside data:

Hosted Flows

Some steps must be completed by the employee directly and are never handled by your integration. For these, the API returns a short-lived hosted url — open it in a browser or web view for the employee.

Flow	Started by
PIN setup	POST /employees/:employeeId/pin/initialize
EWA withdrawal	POST /employees/:employeeId/payments/ewa/transfer/initialize

Response Format

All responses are JSON. Successful responses follow this envelope:

Rate Limits

Requests are limited to 100 per minute per client IP address, across all endpoints. The window is a fixed 60 seconds. Sandbox and Production keys share the same limit.

Every response includes rate limit headers so you can track usage:

Header	Meaning
RateLimit-Policy	The policy in force, e.g. 100;w=60 (100 requests per 60 seconds)
RateLimit-Limit	Maximum requests allowed in the current window
RateLimit-Remaining	Requests left in the current window
RateLimit-Reset	Seconds until the window resets

When the limit is exceeded the API returns 429 Too Many Requests:

Error Codes

Status	Meaning
400	Bad request — validation failed or business rule violated
401	Missing, invalid, or expired API key
403	API key exists but lacks the required scope, or developer account is not active
404	Resource not found, or belongs to another developer
409	Conflict — duplicate record or violated unique constraint
429	Rate limit exceeded — see Rate Limits
500	Unexpected server error

Error responses include a message field describing what went wrong.

List endpoints are paginated with page and pageSize (default 20, max 100) and return this envelope inside data:

Field	Type		Notes
name	string	required	1–200 characters
emailDomain	string	required	Up to 100 characters, stored lowercase, e.g. acmecorp.com
isEmailDomainEnforced	boolean	required	If true, employees must use an email on this domain to link to the company
admin.firstName	string	required	1–100 characters
admin.lastName	string	required	1–100 characters
admin.email	string	required	Valid email, stored lowercase. Must not already belong to a company admin
admin.phoneNumber	string	optional	Include the country code, e.g. +233201234567. Must not already belong to a company admin
admin.position	string	optional	Up to 100 characters. Defaults to HR

Profile details (industry, pay cycle, website, etc.) are not accepted here — set them afterwards with Update Company.

Status	When
400	Validation failed
409	A company admin with this email or phone number already exists

Query param	Type	Notes
page	integer	Page number, starting at 1. Default 1
pageSize	integer	Items per page, 1–100. Default 20
search	string	Matches part of the company name (max 200 characters)
status	string	PENDING, ACCEPTED or REJECTED
industrySector	string	One of the industry sector values listed under Update Company
from / to	ISO date	Only companies created on/after from and on/before to

profile is null until a profile field has been set. totalPages is 0 when nothing matches.

profile is null until a profile field has been set; locations is [] when none exist.

Field	Type	Notes
name	string	1–200 characters
emailDomain	string	Up to 100 characters, stored lowercase. Applies to future employee links only
isEmailDomainEnforced	boolean	Applies to future employee links only
profile	object	At least one field when present
profile.industrySector	string	See values below
profile.employeeCountRange	string	See values below
profile.hasPhysicalOffice	boolean
profile.payrollSystem	string	Up to 100 characters
profile.incorporationCountry	string	Up to 100 characters
profile.website	string	URL, up to 500 characters
profile.linkedIn	string	URL, up to 500 characters
profile.facebook	string	URL, up to 500 characters
profile.logoUrl	string	URL, up to 500 characters
profile.incorporationCertUrl	string	URL, up to 500 characters
profile.workingDayStartDay	integer	1–31. First day of the pay cycle (default 1)
profile.workingDayEndDay	integer	1–31. Last day of the pay cycle (default 31)
profile.cutoffDay	integer	1–31. Monthly cutoff for EWA/payroll (default 25)
profile.repaymentDay	integer	1–31. Day the company repays each month (default 31)
profile.maxSalaryExposurePercentage	integer	0–100. Cap on benefit repayments plus earned wage as a share of salary (default 60)
profile.contactAdminId	integer	Must be the id of an admin of this company

Industry sector values
AGRICULTURE CONSTRUCTION EDUCATION ENERGY FINANCE HEALTHCARE HOSPITALITY MANUFACTURING MEDIA MINING RETAIL TECHNOLOGY TELECOMMUNICATIONS TRANSPORTATION OTHER

Employee count range values
ONE_TO_FIVE SIX_TO_TWENTY TWENTY_ONE_TO_FIFTY FIFTY_ONE_TO_TWO_HUNDRED TWO_HUNDRED_PLUS

Returns the updated company in the same shape as Get Company.

Status	When
400	Validation failed, empty body, or contactAdminId is not an admin of this company
404	Company not found

Benefits — /api/public/v1/companies/:companyId/benefits

A company benefit attaches a benefit from the catalogue (GET /api/public/v1/benefits) to a company. It has its own id, distinct from the catalogue benefitId: pass benefitId when adding a benefit, and the company benefit id when updating one.

benefit.tag is POPULAR, NEW or null. benefit.fixedPaymentOption is null, or the payment option the benefit is locked to (PAYROLL_DEDUCTION / EMPLOYEE_SELF_PAYMENT).

Field	Type		Notes
benefitId	integer	required	Catalogue benefit id

Status	When
404	Company or catalogue benefit not found
409	The company already has this benefit

Field	Type	Notes
status	string	ACTIVE or INACTIVE
paymentOption	string	PAYROLL_DEDUCTION or EMPLOYEE_SELF_PAYMENT. Rejected with 400 if the benefit's fixedPaymentOption is set

Benefit status	Description
ACTIVE	Live — enrolled employees can use it
INACTIVE	Disabled
WAITLISTED	Set automatically when the benefit is not yet available; employees are not enrolled yet
SUSPENDED	Set by Work Benefit only — cannot be set or changed through the API

Payment option	Description
PAYROLL_DEDUCTION	Company repays and deducts from employee salary
EMPLOYEE_SELF_PAYMENT	Employee pays directly

Status	When
400	Validation failed, or payment option change on a fixed-option benefit
403	The benefit is SUSPENDED
404	Company or company benefit not found

Earned Wage Access — /api/public/v1/companies/:companyId/ewa

Field	Type	Default	Notes
enabledAutoApprovalForAllEmployees	boolean	false	Master switch for auto-approval
hasPercentageOfAccruedWage	boolean	false	Enforce percentageOfAccruedWage
percentageOfAccruedWage	integer	50	0–100. Max share of accrued wage per request
hasPermanentOrConfirmedEmployeeStatus	boolean	false	Only auto-approve permanent/confirmed employees
hasRequestedLessThanMaxAmountPerCycle	boolean	false	Enforce maxAmountPerCycle
maxAmountPerCycle	number	100000	≥ 0. Max total withdrawn per pay cycle
hasMadeLessThanMaxRequestsPerMonth	boolean	false	Enforce each employee's maxRequestsPerMonth
hasPendingPaymentFromPriorCycles	boolean	false	Block auto-approval while prior cycles are unpaid
enabledBetweenTimePeriods	boolean	false	Only auto-approve within the time window below
smartAutoApprovalStartTime	string	08:00	24-hour HH:MM
smartAutoApprovalEndTime	string	17:00	24-hour HH:MM
smartAutoApprovalDays	string	WEEKDAYS	WEEKDAYS, WEEKENDS or EVERYDAY

Query param	Type	Notes
status	string	PENDING, APPROVED or REJECTED
search	string	Matches employee first or last name
dateRange	string	today, this_week, this_month or this_year
from / to	ISO date	Explicit request-date range, used when dateRange is not given
page	integer	Page number, starting at 1. Default 1
pageSize	integer	Items per page, 1–100. Default 20

earnedWage is the employee's estimated earned wage so far this cycle (0 if their salary is unknown); percentageOfWage is the request as a share of it (null if unknown). linkId identifies the employee for Update Employee.

withinRuleLimit compares percentageOfAccrued with the employee's maxWithdrawalPercentage; it is null when either is unknown, as are estimatedEarnedSalary and percentageOfAccrued when the salary is unknown.

amount and serviceCharge are decimal strings. approvedById is always null for requests approved through the API.

Status	When
400	The request is not PENDING (e.g. Request is already approved)
404	Company or request not found

Query param	Type	Notes
search	string	Matches employee first or last name
sortBy	string	name, maxWithdrawalPercentage or approvalMode
sortOrder	string	asc (default) or desc
page	integer	Page number, starting at 1. Default 1
pageSize	integer	Items per page, 1–100. Default 20

Settings fields are null until they have been set for that employee. enrolled is true when the employee's EWA benefit is active.

Field	Type	Notes
enrolled	boolean	Turns the employee's EWA benefit on or off. A suspended EWA benefit is not changed
maxWithdrawalPercentage	integer	0–50. Max share of accrued wage the employee may withdraw
approvalMode	string	MANUAL or AUTOMATIC
maxRequestsPerMonth	integer	1–50

Status	When
400	Validation failed or empty body
404	Company or employee not found

Payments — /api/public/v1/companies/:companyId/payments

Query param	Type	Notes
page	integer	Page number, starting at 1. Default 1
pageSize	integer	Items per page, 1–100. Default 20
search	string	Matches employee name (EWA entries) or company name (repayments)
from / to	ISO date	Date range

Query param	Type	Notes
status	string	UNPAID, PARTIAL or PAID
search	string	Matches the month name, e.g. March
from / to	ISO date	Matched against each month's due date

owed is the remaining balance for the month (sum of ewaOwed, rentOwed, shopOwed); paid is what has been paid so far.

type is Earned Wage Access, Rent & Pay Monthly or Shop & Pay Monthly. totals.paid is the amount the company has already repaid for that month.

Field	Type		Notes
month	integer	required	1–12 (single-month form)
year	integer	required	≥ 2000 (single-month form)
months	array	required	At least one { month, year } (multiple-month form, instead of month/year)
amount	number	required	> 0
callbackUrl	string	required	URL Paystack redirects to after payment

The amount is applied to the listed months oldest first, up to what is still owed on each. Anything left over is recorded as an overpayment credit and returned as overpayment.

Status	When
400	Validation failed, the company has no outstanding EWA balance, or Paystack could not start the payment
404	Company not found, or the company has no admin

When pending is true nothing has been settled yet; status is the Paystack status. Call verify again later.

Status	When
400	Transaction has already been processed
404	Transaction not found

Transaction status is PENDING, COMPLETED or FAILED; EWA withdrawals return APPROVED. For EWA withdrawals paymentMethod is null.

Status	When
404	No transaction with this reference for the company

Query param	Type	Notes
page	integer	Page number, starting at 1. Default 1
pageSize	integer	Items per page, 1–100. Default 20
search	string	Matches employee name

status is UNPAID if any month has no payment yet, otherwise PARTIALLY_PAID. totals.owed covers every matching employee, not just the current page.

Query param	Type	Notes
status	string	UNPAID, PARTIAL or PAID — filters individual instalments
search	string	Matches the month name
from / to	ISO date	Matched against the instalment due date

Onboarding flow

Onboarding is not fully automated — it needs the employee. Verification codes (4-digit OTPs) are sent directly to the employee's phone by SMS and to their work email inbox. You cannot read these codes: the employee receives them and gives them back to you (for example, through your own UI), and you submit them to the API. Build a step into your flow to collect these codes from the employee.

Step	Endpoint	Notes
1. Register	POST /employees	Creates the employee and sends a phone OTP by SMS. Optionally links a company in the same call (also sends a work-email OTP).
2. Verify phone	POST /employees/:id/verify-phone	Submit the SMS code the employee received.
3. Upload selfie	POST /employees/:id/selfie	Required for KYC. Only allowed after the phone is verified.
4. Link company	POST /employees/:id/companies	Skip if you linked a company at registration. Sends a work-email OTP.
5. Verify work email	POST /employees/:id/verify-work-email	Submit the code the employee received at their work email.

Phone numbers are accepted in international format with the country code, e.g. +233558371654. Local Ghana numbers such as 0558371654 are also accepted. Numbers are validated, stored and returned in E.164 format (+233558371654). An invalid number returns 400.

Field	Type		Notes
firstName	string	required	1–100 characters
lastName	string	required	1–100 characters
phoneNumber	string	required	Valid phone number with country code (see phone format). Must be unique across the platform.
companyId	integer	optional	A company owned by your developer account. Must be sent together with workEmail.
workEmail	string	optional	Valid email, lowercased. Must be sent together with companyId. Must use the company's domain if the company enforces its email domain.

companyLinks is an empty array when no company was linked. Errors: 400 validation or work-email domain mismatch, 404 company not found, 409 phone number already registered.

Query param	Notes
search	Matches first name, last name or phone number. Max 200 characters.
page / pageSize	Defaults: 1 / 20 (max 100)

Field	Type		Notes
code	string	required	Exactly 4 characters

Errors: 409 if the code is invalid or expired, or the phone number is already verified. Each wrong code uses up one of the 3 attempts.

Errors: 409 if the phone number is already verified.

Field	Type		Notes
companyId	integer	required	A company owned by your developer account
workEmail	string	required	Valid email, lowercased. Must use the company's domain if the company enforces its email domain.

Linking rule	Result
An employee can have only one active company link. An existing approved, suspended, on-hold, or verified-pending link must be revoked first.	409
A link that was rejected by the same company cannot be attempted again.	409
A work email already verified and active at the company cannot be reused.	409
The company enforces its email domain and workEmail does not match it.	400
Unverified pending links, and any earlier link to the same company, are replaced automatically.	—

Field	Type		Notes
companyId	integer	required	The company the employee is linking to
code	string	required	Exactly 4 characters

Errors: 400 domain mismatch on a company that enforces its domain, 404 no link to this company, 409 invalid or expired code, or email already verified.

Field	Type		Notes
companyId	integer	required	The company of the pending link

Errors: 404 no link to this company, 409 email already verified, link no longer pending, or code expired.

Link status	Description
PENDING	Work email not yet verified, or verified and awaiting company admin approval (check emailVerified)
APPROVED	Active — the employee has access to the company's benefits
REJECTED	Rejected by a company admin. The employee cannot re-link to the same company.
SUSPENDED	Temporarily suspended by the company
HOLD	Placed on hold by the company
REVOKED	Link ended. The employee can link to a new company.

Profile — /api/public/v1/employees/:employeeId/profile

Field	Type		Notes
firstName	string	optional	Non-empty
lastName	string	optional	Non-empty
dateOfBirth	string	optional	ISO 8601 date, e.g. 1995-06-15
gender	string	optional	MALE or FEMALE

selfie, personalEmail and salary are null until set. salary.amount is a decimal string.

Field	Type		Notes
email	string	required	Valid email address

Errors: 409 if this email is already verified for the employee, or is in use by another employee.

Field	Type		Notes
code	string	required	Exactly 4 characters

Errors: 409 if there is no pending verification, or the code is invalid or expired.

Selfie — /api/public/v1/employees/:employeeId/selfie

Field	Type		Notes
selfie	file	required	JPEG or PNG image, max 5 MB. Must show exactly one clear, well-lit face.

Errors: 400 if no image is sent, the phone is not verified, or the image fails the face check (no face, more than one face, too blurry, too dark or too bright — the message says which). 415 for an unsupported file type.

Emergency Contact — /api/public/v1/employees/:employeeId/emergency-contact

Field	Type		Notes
firstName	string	required
lastName	string	required
relationship	string	required	Free text, e.g. Sister
phoneNumber	string	required	Valid phone number with country code (see phone format)
residentialAddress	string	required

Identity Verification — /api/public/v1/employees/:employeeId/identity-verification

Field	Type		Notes
documentType	text	required	GHANA_CARD or PASSPORT
documentId	text	required	The document number, max 100 characters
frontImage	file	required	Front of the document. Image (JPEG, PNG, WebP, GIF) or PDF, max 5 MB.
backImage	file	optional	Back of the document (e.g. for a Ghana Card). Same format and size limits.

backImage is null when not supplied. Errors: 400 invalid documentType, missing documentId or missing frontImage; 415 unsupported file type.

Earned Wage Access — /api/public/v1/employees/:employeeId/ewa

Field	Description
earnedWage	Salary earned so far in the current pay cycle
availableToUse	Amount the employee can still request this cycle (the upper limit for Submit Request)
maxAmountAllowed	Cycle cap, based on the employee's withdrawal limit and the company's salary-exposure limit
availableToWithdraw	Approved EWA balance that can be paid out now (the upper limit for a withdrawal)
serviceChargePercentage	Service charge as a fraction of the requested amount (0.049 = 4.9%)
totalRequestedAmount / totalRequests	Pending and approved requests in the current cycle
cutoffDate / repaymentDate	Last day to request in this cycle / date the advance is recovered from salary

Query param		Notes
status	optional	PENDING, APPROVED or REJECTED
page	optional	Integer ≥ 1. Default 1
pageSize	optional	Integer 1–100. Default 20

Field	Type		Notes
amount	number	required	≥ 1 and ≤ availableToUse from EWA Details

Error	When
400	The employee already has a PENDING request, the cycle's cut-off date has passed, or amount exceeds availableToUse
403	Employee is deactivated, EWA is not active for the company, the employee is not enrolled in EWA, or their salary is not yet verified
404	Employee not found for this developer, or not linked to an active company

Field	Type		Notes
isSaved	boolean	required

Payments — /api/public/v1/employees/:employeeId/payments

Step	What happens
1. Initialize	Call Initialize PIN Setup or Initialize Withdrawal. The response contains url and expiresAt.
2. Send the employee	Redirect the employee's browser to url, or open it in a new tab / in-app browser / WebView. Do not fetch it server-side.
3. Employee completes	PIN setup: the employee enters and confirms a new PIN. Withdrawal: the employee chooses a bank (and account number) or mobile money network (and phone number), then enters their PIN.
4. Return	If you passed redirectUrl, the page sends the employee there on success. For withdrawals, ?reference=<ref>&status=success is appended. Without redirectUrl, a success screen is shown on the hosted page.

Query param		Notes
type	optional	requests, withdrawals, rent or shop. Omit to return all groups. rent and shop both return the external list (each item tagged with benefitType)
page	optional	Integer ≥ 1. Default 1
pageSize	optional	Integer 1–100. Default 20

Query param		Notes
accountType	required	BANK or MOBILE_MONEY
amount	required	Positive number

Field	Type		Notes
amount	number	required	≥ 1, at most 2 decimal places (e.g. 150.75). Fixed for the session
accountType	string	required	BANK or MOBILE_MONEY. Decides which destination form the hosted page shows
redirectUrl	string	optional	Valid URI. Where the employee is sent after a successful withdrawal, with reference and status=success appended

Error	When
400	Validation failed
403	Employee account is deactivated
404	Employee not found for this developer

PIN — /api/public/v1/employees/:employeeId/pin

Field	Type		Notes
redirectUrl	string	optional	Valid URI. Where the employee is sent after the PIN is created. The body may be empty

Income — /api/public/v1/employees/:employeeId/income

Field	Type		Notes
salary	number	required	800 – 1,000,000

Field	Description
status	PENDING, APPROVED or REJECTED
incomeAmount / verifiedAmount	Declared monthly income / amount confirmed by review (decimal strings)
documents[].documentType	BANK_STATEMENT, MOMO_STATEMENT, PAY_SLIP, OFFER_LETTER, BUSINESS_REGISTRATION or OTHER
documentVerificationFee	paid, unpaid or waived
salaryReview	When an approved verification exists and a newer submission is pending, the pending submission (same shape); otherwise null

Field	Type		Notes
monthlyIncome	number	required	≥ 0
bank	array	optional	Bank statements. Each item: name (string, required — include the file extension, e.g. .pdf), file (base64 string, required), bankName (string, optional), password (string, optional — for password-protected PDFs)
momo	array	optional	Mobile money statements. Same item shape as bank
otherFiles	array	optional	Supporting documents. Each item: type (required — PAY_SLIP, OFFER_LETTER, BUSINESS_REGISTRATION or OTHER), file (base64 string, required)

Field	Type		Notes
monthlyIncome	number	optional	≥ 0
bank	array	optional	Replaces all current bank statements. Item shape as in Submit Verification
momo	array	optional	Replaces all current mobile money statements
otherFiles	array	optional	Replaces current documents of the same type (other types are kept)

Rent — /api/public/v1/employees/:employeeId/rent

Rent financing lets an employee have their rent paid up front and repay it in monthly instalments. You manage the whole application on the employee's behalf. Every endpoint below only works for employees that belong to your developer account; any other employee returns 404.

Each application has a stage that moves forward as the employee completes each step:

Step	What you do	Stage afterwards
1. Check	Estimate with Calculate and Rent Limit, then run Check Qualification.	—
2. Apply	Create Application. Add or correct landlord and property details with Update Application.	CREATED_APPLICATION
3. Inspection fee	Inspection Payment — the employee pays on a checkout page. WorkBenefit then inspects the property and proposes a payment plan.	PAID_PHYSICAL_INSPECTION
4. Sign agreement	Share the agreement (Agreement Link or Email), then Sign Agreement.	AGREED_TO_PAYMENT_PLAN
5. Move-in deposit	Deposit Payment — the employee pays the move-in deposit on a checkout page.	PAID_INITIAL_DEPOSIT
6. Repay	Show the Payment Plan, collect instalments with Pay Rent, and review Payment History.	COMPLETED_RENT_PAYMENT once the balance is fully paid

Query param	Type		Notes
amount	number	required	Total rent amount to finance (GHS), ≥ 1
paybackDuration	integer	required	Repayment period in months, ≥ 1
premiumRate	number	optional	Monthly premium rate, ≥ 0. Defaults to 0.025 (2.5% per month)

Query param	Type		Notes
amount	number	required	Total rent amount to finance (GHS), ≥ 1
paybackDuration	integer	required	Repayment period in months, ≥ 1

Field	Type		Notes
monthlyRentBudget	number	required	Monthly rent (GHS), ≥ 1
durationOfRent	integer	required	Length of the tenancy in months, ≥ 1
rentPaybackPeriod	integer	required	Months to repay, ≥ 1
fullNameOfLandlord	string	optional
phoneNumberOfLandlord	string	optional	Phone number with country code, e.g. +233201234567
propertyGpsAddress	string	optional	Ghana GPS address, e.g. GA-123-4567

Field	Notes
applicationId	Use as :applicationId in the endpoints below
stage	CREATED_APPLICATION, PAID_PHYSICAL_INSPECTION, AGREED_TO_PAYMENT_PLAN, PAID_INITIAL_DEPOSIT or COMPLETED_RENT_PAYMENT
hasPaymentPlan	true once a payment plan has been proposed
hasSigned	"yes" once the tenancy agreement is signed, otherwise "no"
monthlyPayment	Monthly repayment (GHS), or null until a plan is set
monthlyRentValue	Monthly rent (GHS), or null

Field	Notes
moveInDepositBreakdown.totalMoveInDeposit	Amount the employee pays with Deposit Payment
moveInDepositBreakdown.*	All amounts in GHS; 0 until a plan is set

Field	Type		Notes
monthlyRentBudget	number	optional	≥ 1
durationOfRent	integer	optional	Months, ≥ 1
rentPaybackPeriod	integer	optional	Months, ≥ 1
fullNameOfLandlord	string	optional
phoneNumberOfLandlord	string | null	optional	Phone number with country code; null or "" clears it
locationOfLandlord	string	optional
locationOfProperty	string | null	optional
propertyGpsAddress	string | null	optional	Ghana GPS address

Field	Type		Notes
expressServiceForPhysicalInspection	boolean	optional	true for express inspection (higher fee). Default: standard
dateAndTimeForVerification	string	optional	Preferred inspection date, format YYYY-MM-DD (date only)

Field	Type		Notes
email	string	required	Valid email address

Field	Notes
amount	Instalment due for the month
fines	Late fines added to the month
totalAmountDue	What is still owed for the month, including fines
paymentStatus	e.g. Paid, Partial, Unpaid
isLate	true when fines have been added
daysDelayed	Days past the expected payment date

Field	Type		Notes
amount	number	required	Amount to pay (GHS), ≥ 1

Field	Notes
code	Stable identifier, e.g. RENT, BNPL, CAR_FINANCING, EWA, GROUP_LIFE_INSURANCE, GROUP_HEALTH_INSURANCE
status	ACTIVE, INACTIVE, WAITLIST or ARCHIVED
tag	POPULAR, NEW or null
fixedPaymentOption	If set, the only repayment option for this benefit: PAYROLL_DEDUCTION or EMPLOYEE_SELF_PAYMENT. null means the company can choose.