Skip to main content
POST
Retrieve benefit information

Authorizations

Authorization
string
header
required

API key for authentication. Provide the raw key as the value of the Authorization header (no "Bearer" prefix).

Body

BenefitInfoRequest
object

Response

Successful response

errorStatus
object
transactionStamp
object
benefitLimitAmt
object[]
benefitCombinedLimit
object[]
benefitCatchUpAmt
object[]
benefitAnnualWageLimit
object[]
benefitType
enum<string>
Available options:
Benefit125,
Benefit401K,
Benefit403B,
Benefit457,
BenefitCustom,
BenefitRoth401K,
BenefitRoth403B,
BenefitFSA,
BenefitHSA,
BenefitSimpleIRA,
BenefitRoth457,
BenefitFSADependentCare,
BenefitSimpleIRANonelective,
BenefitRothSimpleIRA,
BenefitRothSimpleIRANonelective,
BenefitStarter401K,
BenefitRothStarter401K,
BenefitEHTCashBenefit,
BenefitHSFCashBenefitQuebec,
BenefitEHTNonCashBenefit,
BenefitHSFNonCashBenefitQuebec,
BenefitEHTEarnings,
BenefitHSFEarningsQuebec,
BenefitEHTPayInLieu,
BenefitDependentCustodialAccount,
BenefitEducationalAssistance,
BenefitEducationalAssistanceLoanRepayment