AccountFundingSummary
A summary of the funding an account has received. Funding corresponds only to deposit transactions
Account
An Account belonging to a Health Wallet.
ActivateCardResult
No description
AddBrokerToFirmResult
No description
AnnualTaxForms
An Individual's tax forms for a single tax year.
ApproveClaimResult
No description
AssignOrganizationsToFirmResult
The result of assigning organizations to a brokerage firm. Returned even when every element failed —
BadRequestError
Returned when there is an error in the request.
BenefitConfiguration
The Benefit Configuration describes the parameters and controls all aspects of the Benefit.
BenefitFundingConfiguration
Describes the parameters and behaviors of Funding for the Benefit.
BenefitFundingLimitsConfiguration
The Funding Limits for a Benefit govern the maximum amount of funds that can be made available
BenefitInitialFundingConfiguration
The Initial Funding for a Benefit defines the initial amount of Funds made available to an Individual.
BenefitTemplate
Represents a template used when creating a benefit
BenefitTemplatesResults
Represents a page of benefit templates
Benefit
A Benefit offered to an individual in a Benefits Program
BenefitsProgram
A program containing benefits offered to individuals
BenefitsProgramsResults
Represents a page of benefits programs
BrandsResults
The set of brands available to the calling partner
BrokerageFirmBroker
No description
BrokerageFirmOrganization
No description
BrokerageFirm
A brokerage firm. The Broker-of-Record relationship is with the firm, not with individual brokers.
BrokerageFirmsResults
No description
CancelBenefitResult
The successful result of cancelling a benefit
CancelCardResult
No description
Card
A physical or virtual card issued to an Individual for a Benefits Program.
CardsResults
No description
ClaimDenial
Why a claim, or part of a claim, was denied.
ClaimDocumentUpload
A link for uploading one file. Treat the URL and headers as secrets: together they can write the file.
ClaimInformationRequest
A request for more information about a claim.
ClaimMerchant
The merchant recorded for a claim.
ClaimProvider
A care provider recorded for a claim. A provider belongs to the Individual and can be used on several of their claims.
Claim
A request from an Individual to be reimbursed from a Benefit for an expense they paid. Amounts describe
ClaimsResults
A page of claims.
ContributionsTaxFormData
Box-level data for a 5498-SA (HSA contributions), matching the values printed on the member's form. Only the
CoverageLevel
A coverage level configured for a Benefit offering.
CreateBenefitResult
The successful result of creating a benefit
CreateBenefitsProgramResult
The successful result of creating a benefits program
CreateBrokerageFirmResult
The successful result of creating a brokerage firm
CreateDependentBenefitEnrollmentResult
Successful result of creating a new enrollment
CreateDependentResult
Successful result of creating a dependent
CreateDivisionResult
The successful result of creating a Division
CreateIndividualResult
The successful result of creating an Individual
CreateOrUpdateOrganizationMembershipResult
The successful result of creating or updating an organization membership
CreateOrganizationGroupResult
The successful result of creating an Organization Group
CreateOrganizationResult
The successful result of creating an Organization
DeactivateOrganizationMembershipResult
The successful result of deactivating an organization membership
DenyClaimResult
No description
DependentBenefitEnrollment
Association between a dependent and a benefit offering
Dependent
A dependent associated with an account holder
DependentsResults
Paginated list of dependents
DistributionsTaxFormData
Box-level data for a 1099-SA (HSA distributions), matching the values printed on the member's form. Only the
Division
A Division is a subdivision of an Organization — for example, a department, office,
DivisionsResults
Represents a page of Divisions
DownloadLink
A secure link to download a page of content.
EnrollIndividualInBenefitResult
The successful result of enrolling an Individual in a Benefit
FundBenefitForIndividualResult
The successful result of funding an individual in a benefit
HealthWalletBalanceSummary
A summary object describing Balance aggregates across all accounts in a Health Wallet.
HealthWallet
A Health Wallet belonging to an Individual
IndividualName
An Individual's name
IndividualTaxForm
Metadata for a single tax form version.
Individual
An Individual
IndividualsResults
Represents a page of Individuals
InitialContribution
An initial contribution for an account
InternalServerError
Returned when an error is encountered that is not expected.
IssueCardResult
No description
LinkedExternalPlatform
An external platform linked to your account
LinkedExternalPlatformsResults
The set of external platforms linked to the calling partner
LockCardResult
No description
Money
Represents an amount of money, e.g. an account balance which may be positive or negative.
OrganizationAssignmentResult
The outcome of assigning one organization to a brokerage firm
OrganizationGroupOrganizationsResults
A page of Organizations belonging to an Organization Group
OrganizationGroup
An Organization Group is an administrative container that groups related Organizations
OrganizationGroupsResults
Represents a page of Organization Groups
OrganizationMembership
Organization membership details including external user ID
OrganizationMembershipsResults
Results for organization memberships query with pagination
OrganizationUnassignmentResult
The outcome of removing one organization from a brokerage firm
Organization
An Organization manages Benefits Programs on behalf of Individuals. An example of an Organization
OrganizationsResults
Represents a page of Organizations
PageInfo
Metadata used when paging over a list of items
PartnerBrand
A brand available to the calling partner. name is the value to pass as brand on brand-aware
PersonName
The full name of a cardholder.
PhysicalAddress
A physical address
PrepareClaimDocumentUploadResult
No description
RecurringContribution
A recurring contribution for an account
RedeliverWebhooksResult
No description
RemoveDependentBenefitEnrollmentResult
Successful result of removing an enrollment
ReportExecution
This is the success return type from generateReport, and it contains metadata that uniquely identifies the
ReportFile
One output file of a report. Reports generated before per-file details were recorded still list every file, with
ReportResults
ReportResults represents a single result page containing the data output from a report generation.
Report
Report contains information about a generated report.
RequestClaimInformationResult
No description
ResubmitClaimResult
No description
ReverseBenefitFundingForIndividualResult
The successful result of reversing a benefit funding for an individual.
SetElectionAmountForBenefitAndIndividualResult
The successful result of setting the election amount for a benefit and individual
SetInitialContributionsForBenefitAndIndividualResult
The successful result of setting initial contributions for a benefit and individual
SetRecurringContributionScheduleForBenefitResult
The successful result of setting the recurring contribution schedule for a benefit
SetRecurringContributionsForBenefitAndIndividualResult
The successful result of setting recurring contributions for a benefit and individual
StatementSummary
A summary of a single statement. Fetch full data with the statement query.
StatementTransaction
A single transaction appearing on a statement.
Statement
Structured data for a single account statement.
StatementsResults
Paginated list of statement summaries
SubmitClaimResult
No description
TaxFormDetail
A tax form with its box-level data.
TaxFormDownloadLinkResult
The success result for the taxFormDownloadLink query.
TaxFormsResults
The success result for the taxForms query.
TransactionResults
Represents a page of Transactions against an Account
Transaction
A Transaction posted against an Account.
TransferBenefitForIndividualResult
The successful result of transferring a Benefit for an Individual
UnassignOrganizationsFromFirmResult
The result of removing organizations from a brokerage firm. Returned even when every element failed —
UnenrollIndividualFromBenefitResult
The successful result of unenrolling an individual from a benefit
UnlockCardResult
No description
UpdateBenefitResult
The successful result of updating a benefit
UpdateBenefitsProgramResult
The successful result of updating a benefits program
UpdateClaimResult
No description
UpdateDependentBenefitEnrollmentResult
Successful result of updating an existing enrollment
UpdateDependentResult
Successful result of updating a dependent
UpdateDivisionResult
The successful result of updating a Division
UpdateIndividualResult
The successful result of updating an Individual
UpdateOrganizationGroupResult
The successful result of updating an Organization Group
UpdateOrganizationResult
The successful result of updating an Organization
Verification
A Verification
VerifyIndividualResult
The successful result of Verifying an Individual.
VisibleBrokerageFirm
No description
WebhookAttempt
One POST of a delivery to its endpoint.
WebhookDeliveriesResults
A page of webhook deliveries, newest first.
WebhookDelivery
One event sent to one endpoint. Its id is the webhook-id header and is stable across retries.
WebhookEndpoint
An HTTPS receiver for webhook events.
WebhookEndpointsResults
A page of webhook endpoints, newest first.
WebhookEventType
No description
WebhookSigningSecret
Store signingSecret securely. It is returned only by creation and rotation.