activateCard
Activates a card that an Individual has received.
addBrokerToFirm
Adds a broker to an existing active brokerage firm in the caller's partner scope.
approveClaim
Approves a claim, in full or in part. The claim must be in PENDING, IN_REVIEW,
assignOrganizationsToFirm
Assigns organizations to a brokerage firm, so the firm services them.
cancelBenefit
Cancels a Benefit. This operation cannot be undone.
cancelCard
Permanently cancels a card. Optionally issues a replacement card in the same
createBenefit
Create a new Benefit
createBenefitsProgram
Create a new Benefits Program
createBrokerageFirm
Creates a brokerage firm and its first firm admin.
createDependentBenefitEnrollment
Create a new enrollment for a dependent in a benefit offering.
createDependent
Create a new dependent with optional benefit enrollments
createDivision
Create a new Division within an Organization
createIndividual
Create Individual
createOrUpdateOrganizationMembership
Create or update an organization membership for a single individual
createOrganizationGroup
Create a new Organization Group
createOrganization
Create a new Organization
createWebhookEndpoint
Registers an HTTPS endpoint. Store the returned signingSecret; reads never return it.
deactivateOrganizationMembership
Deactivate an organization membership for a single individual
deleteWebhookEndpoint
Deletes an endpoint. Its pending deliveries are skipped instead of sent, and it no longer appears in reads.
denyClaim
Denies a claim, which moves it to REJECTED and releases any amount held on the Individual's Benefit
enrollIndividualInBenefit
Enroll an Individual in a Benefit
fundBenefitForIndividual
Adds an amount of funds to a Benefit for an Individual. On success, the total funds available to the Individual
generateReport
Submits a report generation request. Report generation is asynchronous, so the generated reports can be retrieved
issueCard
Issues a new card to an Individual for a Benefits Program. The Individual may
lockCard
Temporarily locks a card, blocking new transactions. Locks with reason LOST,
prepareClaimDocumentUpload
Prepares secure upload links for claim documents, such as receipts and invoices. Specify exactly one
redeliverWebhook
Starts a new retry cycle with the same webhook-id. The delivery must be finished or waiting for a retry.
redeliverWebhooks
Redelivers finished deliveries whose occurredAt is in the range, newest first.
removeDependentBenefitEnrollment
Remove a dependent from a benefit offering (soft delete).
requestClaimInformation
Asks the Individual for more information about a claim, which moves it to INFORMATION_REQUESTED.
resubmitClaim
Resubmits a claim in INFORMATION_REQUESTED status, which moves it to RESUBMITTED for review. To
reverseBenefitFundingForIndividual
Reverses a funding deposit for an Individual. A deposit can be reversed whether it was made by
rotateWebhookSigningSecret
Issues a new signing secret. The previous one keeps signing for 24 hours; rotating again in that window revokes it.
sendTestWebhook
Queues webhook.test. Poll webhookDelivery for attempts.
setElectionAmountForBenefitAndIndividual
Sets the election amount for a Benefit and Individual. This operation is only available for PENDING enrollments.
setInitialContributionsForBenefitAndIndividual
Sets the initial contributions for a Benefit and Individual. This operation is only available for Benefits with a pending status.
setRecurringContributionScheduleForBenefit
Sets the recurring contribution schedule for a Benefit. This operation is only available for Benefits
setRecurringContributionsForBenefitAndIndividual
Sets the recurring contributions for a Benefit and Individual. This operation is only available for Benefits
submitClaim
Submits a reimbursement claim on behalf of an Individual. The claim is reimbursed to the Individual's
transferBenefitForIndividual
Transfers an Individual's Benefit Enrollment from one Organization to another. This operation is only available
unassignOrganizationsFromFirm
Removes organizations from a brokerage firm, so the firm no longer services them.
unenrollIndividualFromBenefit
Unenroll an individual from a Benefit.
unlockCard
Removes a temporary lock from a card, allowing transactions again. A card
updateBenefit
Update an existing Benefit
updateBenefitsProgram
Update an existing Benefits Program
updateClaim
Corrects details of a claim before it is decided. The claim must be in PENDING, IN_REVIEW,
updateDependentBenefitEnrollment
Update an existing enrollment for a dependent in a benefit offering.
updateDependent
Update an existing dependent's information
updateDivision
Update an existing Division
updateIndividual
Update an existing Individual
updateOrganizationGroup
Update an existing Organization Group
updateOrganization
Update an existing Organization
updateWebhookEndpoint
Changes the fields you pass; omitted fields keep their values.
verifyIndividual
Creates a new Verification for an Individual