Independently decide customer/year IRA/HSA eligibility

POST/retirement/customers/{id}/eligibility/{eligibility}/decisions

Path parameters

idstringRequired

eligibilitystringRequired

Headers

Idempotency-KeystringRequired

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

decisionstringRequired

Approve/reject

evidence_refstringRequired

evidence_sha256stringRequired

reasonstringRequired

Returns

200 OK

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

date_of_birthstringRequired

decided_atstring · date-time or nullOptional

decided_bystringOptional

idstringRequired

limitsobjectRequired

3 child attributes

hsa_minorintegerRequired

ira_combined_minorintegerRequired

roth_minorintegerRequired

proposed_atstring · date-timeRequired

proposed_bystringRequired

requestobjectRequired

18 child attributes

compensation_minorintegerRequired

Evidenced own taxable compensation; spousal sharing is not inferred

evidence_refstringRequired

evidence_sha256stringRequired

expected_versionintegerRequired

filing_statusstringRequired

Single, joint, separate_lived_with_spouse

hsa_coveragearray of stringsRequired

12 month-start eligibility values: none, self, family

hsa_dependentbooleanRequired

hsa_last_month_rulebooleanRequired

Unsupported: this workflow uses the monthly limit

inheritedbooleanRequired

Unsupported; requires inherited-account servicing

modified_agi_minorintegerRequired

outside_hsa_minorintegerRequired

Employee/employer/other-person amounts outside this bank

outside_ira_minorintegerRequired

All regular traditional + Roth contributions outside this bank

outside_roth_minorintegerRequired

Subset of outside_ira_minor

reasonstringRequired

roth_first_tax_yearintegerOptional

rule_idstringRequired

spouse_hsa_regular_minorintegerRequired

Spouse family-base share, excluding their separate catch-up

tax_yearintegerRequired

statusstringRequired

versionintegerRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503