Propose bank-evidenced IRA/HSA owner eligibility and contribution declarations
/retirement/customers/{id}/eligibilityFresh dedicated retirement writer and independent approval. Verified living consumer DOB, own compensation, modified AGI, twelve month-start HSA eligibility determinations, evidenced spouse family-base allocation, all declared outside-bank IRA/Roth/HSA amounts and Roth first tax year are retained. Inherited accounts, spousal-compensation inference and the HSA last-month testing exception are unsupported.
Path parameters
idstringRequiredHeaders
Idempotency-KeystringRequiredSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
compensation_minorintegerRequiredEvidenced own taxable compensation; spousal sharing is not inferred
evidence_refstringRequiredevidence_sha256stringRequiredexpected_versionintegerRequiredfiling_statusstringRequiredSingle, joint, separate_lived_with_spouse
hsa_coveragearray of stringsRequired12 month-start eligibility values: none, self, family
hsa_dependentbooleanRequiredhsa_last_month_rulebooleanRequiredUnsupported: this workflow uses the monthly limit
inheritedbooleanRequiredUnsupported; requires inherited-account servicing
modified_agi_minorintegerRequiredoutside_hsa_minorintegerRequiredEmployee/employer/other-person amounts outside this bank
outside_ira_minorintegerRequiredAll regular traditional + Roth contributions outside this bank
outside_roth_minorintegerRequiredSubset of outside_ira_minor
reasonstringRequiredroth_first_tax_yearintegerOptionalrule_idstringRequiredspouse_hsa_regular_minorintegerRequiredSpouse family-base share, excluding their separate catch-up
tax_yearintegerRequiredReturns
200 OK
customer_idstringRequiredExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
date_of_birthstringRequireddecided_atstring · date-time or nullOptionaldecided_bystringOptionalidstringRequiredlimitsobjectRequired3 child attributes
hsa_minorintegerRequiredira_combined_minorintegerRequiredroth_minorintegerRequiredproposed_atstring · date-timeRequiredproposed_bystringRequiredrequestobjectRequired18 child attributes
compensation_minorintegerRequiredEvidenced own taxable compensation; spousal sharing is not inferred
evidence_refstringRequiredevidence_sha256stringRequiredexpected_versionintegerRequiredfiling_statusstringRequiredSingle, joint, separate_lived_with_spouse
hsa_coveragearray of stringsRequired12 month-start eligibility values: none, self, family
hsa_dependentbooleanRequiredhsa_last_month_rulebooleanRequiredUnsupported: this workflow uses the monthly limit
inheritedbooleanRequiredUnsupported; requires inherited-account servicing
modified_agi_minorintegerRequiredoutside_hsa_minorintegerRequiredEmployee/employer/other-person amounts outside this bank
outside_ira_minorintegerRequiredAll regular traditional + Roth contributions outside this bank
outside_roth_minorintegerRequiredSubset of outside_ira_minor
reasonstringRequiredroth_first_tax_yearintegerOptionalrule_idstringRequiredspouse_hsa_regular_minorintegerRequiredSpouse family-base share, excluding their separate catch-up
tax_yearintegerRequiredstatusstringRequiredversionintegerRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503