{"openapi":"3.1.0","info":{"title":"TaxFileAPI","version":"1.0.0","description":"IRIS transmission and TY2026 MeF preparation previews. All filing activity in this deployment is synthetic. Provider enrollment is paused."},"servers":[{"url":"/"}],"security":[],"paths":{"/v1/transmissions":{"post":{"operationId":"submitTransmission","summary":"Submit an IRIS batch fixture","parameters":[{"in":"header","name":"Idempotency-Key","required":true,"schema":{"type":"string","minLength":8,"maxLength":100,"pattern":"^[a-zA-Z0-9_.:-]+$"}},{"in":"header","name":"X-TaxFileAPI-Sandbox-Approve","schema":{"type":"string","enum":["true"]},"description":"Explicit approval for synthetic quickstart calls."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransmissionInput"},"example":{"form":"1099-NEC","tax_year":2026,"header":{"payer_ref":"demo-payer"},"records":[{"record_id":"demo-001","fields":{"recipient_ref":"demo-recipient","nonemployee_compensation":"1250.00"}},{"record_id":"demo-002","fields":{"recipient_ref":"demo-recipient","nonemployee_compensation":"870.00"}}],"sandbox_scenario":"accepted"}}}},"responses":{"200":{"description":"Identical retry","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transmission"}}}},"201":{"description":"Batch created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transmission"}}}},"400":{"description":"Invalid key or JSON","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Invalid bearer key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Insufficient simulated credits. Add credits and retry with the original key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditError"}}}},"409":{"description":"Idempotency conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"Request too large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"415":{"description":"Unsupported media type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Field validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Production or workspace unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["IRIS batches"],"description":"Submit 1–50 synthetic records, up to 24,000 bytes. Use unique demo-prefixed record IDs. 1099-NEC uses nonemployee_compensation as a positive decimal string. Other forms use fixture_ref. Partial acceptance needs at least two records.","x-availability":"Sandbox","x-authentication":"Sandbox bearer key","security":[{"sandboxBearer":[]}]}},"/v1/transmissions/{id}":{"get":{"operationId":"trackTransmission","summary":"Read status and acknowledgment","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string","pattern":"^tx_[0-9a-f]{32}$"}}],"responses":{"200":{"description":"Transmission found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Transmission"}}}},"401":{"description":"Invalid bearer key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Transmission not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Production or workspace unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"tags":["IRIS batches"],"description":"Poll with the same sandbox bearer key that created the batch. The delayed fixture spends six seconds queued after approval. The approval URL is null in this response.","x-availability":"Sandbox","x-authentication":"Sandbox bearer key","security":[{"sandboxBearer":[]}]}},"/v1/iris/filing-season":{"get":{"tags":["Discovery"],"description":"Check TY2026 IRS opening expectations, TaxFileAPI live status, and the planned payment method.","x-availability":"Available","x-authentication":"None","operationId":"readFilingSeason","summary":"Get IRIS filing season status","responses":{"200":{"description":"Current launch status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingSeason"},"example":{"channel":"iris","tax_year":2026,"processing_year":2027,"sandbox":{"available":true,"price_cents":0,"synthetic_only":true},"production":{"status":"awaiting_launch","live_transmission_enabled":false,"expected_irs_opening_month":"2027-01","confirmed_irs_opening_at":null,"payment_method":"prepaid_account_credits"},"irs_source_url":"https://www.irs.gov/pub/irs-efile/iris-working-group-meeting-10142026.pdf"}}}}}}},"/v1/iris/forms":{"get":{"tags":["Discovery"],"description":"List supported sandbox form-and-year pairs, upstream input-schema links and account-credit pricing rules.","x-availability":"Available","x-authentication":"None","operationId":"listIRISForms","summary":"List the IRIS form catalog","responses":{"200":{"description":"IRIS catalog","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IRISCatalog"}}}}}}},"/v1/iris/schema":{"get":{"tags":["Discovery"],"description":"Fetch the input schema for one listed form and tax year. Schema availability is distinct from production eligibility.","x-availability":"Available","x-authentication":"None","operationId":"readIRISFormSchema","summary":"Get an IRIS form input schema","parameters":[{"in":"query","name":"tax_year","required":true,"schema":{"type":"integer","enum":[2025,2026]}},{"in":"query","name":"form","required":true,"schema":{"type":"string","enum":["1042-S","1097-BTC","1098","1098-C","1098-E","1098-F","1098-Q","1098-T","1098-VLI","1099-A","1099-B","1099-C","1099-CAP","1099-DA","1099-DIV","1099-G","1099-INT","1099-K","1099-LPS","1099-LS","1099-LTC","1099-MISC","1099-NEC","1099-OID","1099-PATR","1099-Q","1099-QA","1099-R","1099-S","1099-SA","1099-SB","15397","3921","3922","5498","5498-ESA","5498-QA","5498-SA","5498-TA","8027","8596","8809","8955-SSA","W-2G"]}}],"responses":{"200":{"description":"Input schema","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IRISFormSchema"}}}},"404":{"description":"Form or year unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Schema temporarily unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/sandbox/keys":{"post":{"tags":["Keys, approvals and credits"],"description":"Generate a 24-hour key in the signed-in developer console. The response contains the key and an optional webhook secret. Browser POST must be same-origin.","x-availability":"Sandbox","x-authentication":"Signed-in TaxFileAPI sandbox session","operationId":"issueSandboxKey","summary":"Issue a sandbox key","security":[],"responses":{"201":{"description":"Key issued","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxKey"}}}},"401":{"description":"Sign-in required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Same-origin required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Sandbox unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/approve/{token}":{"get":{"tags":["Keys, approvals and credits"],"description":"Open the approval_url returned on submission. The link is sensitive and expires with the sandbox key.","x-availability":"Sandbox","x-authentication":"Approval URL token","operationId":"viewApproval","summary":"View the hosted approval page","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-f0-9]{64}$"}}],"responses":{"200":{"description":"Hosted review page","content":{"text/html":{"schema":{"type":"string"}}}},"404":{"description":"Expired or invalid link","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Sandbox unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Keys, approvals and credits"],"description":"Use the hosted same-origin form while signed in as the wallet owner. A successful transition applies one test credit per record.","x-availability":"Sandbox","x-authentication":"Signed-in TaxFileAPI sandbox session","operationId":"approveSandboxBatch","summary":"Approve with sandbox credits","security":[],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-f0-9]{64}$"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"confirm":{"const":"yes"}},"required":["confirm"],"additionalProperties":false}}}},"responses":{"303":{"description":"Redirect to the review page","headers":{"Location":{"schema":{"type":"string"}}}},"400":{"description":"Confirmation required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Insufficient test credits on the review page","content":{"text/html":{"schema":{"type":"string"}}}},"403":{"description":"Wrong origin or wallet owner","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Expired or invalid link","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Legacy batch requires a fresh sandbox key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"415":{"description":"Expected browser form encoding","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Sandbox unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/sandbox/credits":{"get":{"tags":["Keys, approvals and credits"],"description":"Read the signed-in account’s simulated credit wallet. Keys issued to the same account share the wallet.","x-availability":"Sandbox","x-authentication":"Signed-in TaxFileAPI sandbox session","operationId":"readSandboxWallet","summary":"Read sandbox credits","security":[],"responses":{"200":{"description":"Balance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxWallet"},"example":{"environment":"sandbox","available":2,"payment_charged":false}}}},"401":{"description":"Sign-in required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Wallet unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/sandbox/credits/topups":{"post":{"tags":["Keys, approvals and credits"],"description":"Add up to 2,000 test credits per request from a same-origin signed-in browser. The operation has no Stripe payment.","x-availability":"Sandbox","x-authentication":"Signed-in TaxFileAPI sandbox session","operationId":"topUpSandboxWallet","summary":"Add sandbox credits","security":[],"parameters":[{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","pattern":"^[a-zA-Z0-9_.:-]{8,100}$"},"description":"Reuse the original key for an identical retry. Use a new key when the request changes."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxTopUp"},"example":{"quantity":100}}}},"responses":{"200":{"description":"Identical retry","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxWallet"}}}},"201":{"description":"Top-up applied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxWallet"}}}},"400":{"description":"Invalid JSON or request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Sign-in required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Same-origin required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Top-up key reused with a different quantity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"Request size limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"415":{"description":"Content-Type must be application/json","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Invalid fields or fixture","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Wallet unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/sandbox/forms":{"get":{"tags":["Single-fixture simulator"],"description":"Discover form fixtures for individual simulated IRIS requests.","x-availability":"Sandbox","x-authentication":"None","operationId":"listSingleFixtures","summary":"List single-fixture forms","responses":{"200":{"description":"Grouped fixture catalog","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleFixtureCatalog"}}}}}}},"/v1/sandbox/transmissions":{"post":{"tags":["Single-fixture simulator"],"description":"Submit one IRIS fixture of up to 1,024 bytes. Every call generates a new simulated receipt. No wallet or batch approval is involved.","x-availability":"Sandbox","x-authentication":"None","operationId":"submitSingleFixture","summary":"Submit a single IRIS fixture","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleFixtureInput"},"example":{"channel":"iris","form":"1099-NEC","scenario":"accepted"}}}},"responses":{"202":{"description":"Simulated receipt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleReceipt"}}},"headers":{"Location":{"schema":{"type":"string"}}}},"400":{"description":"Invalid JSON or request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"MeF transmission is in development","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"Request size limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"415":{"description":"Content-Type must be application/json","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Invalid fields or fixture","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/sandbox/acknowledgments/{receipt_id}":{"get":{"tags":["Single-fixture simulator"],"description":"Fetch the acknowledgment using the receipt from the simulator. A pending fixture remains pending. Older simulator receipts may identify MeF.","x-availability":"Sandbox","x-authentication":"None","operationId":"readSingleAcknowledgment","summary":"Get a single-fixture acknowledgment","parameters":[{"name":"receipt_id","in":"path","required":true,"schema":{"type":"string","pattern":"^SIM-(iris|mef)\\.[A-Za-z0-9-]+\\.(accepted|rejected|pending)\\.[a-f0-9]{32}$"}}],"responses":{"200":{"description":"Simulated acknowledgment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleAcknowledgment"}}}},"404":{"description":"Invalid receipt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/sandbox/tax-returns":{"get":{"tags":["Tax Returns preparation"],"description":"List TY2026 MeF form and fixture options. Production remains disabled.","x-availability":"Sandbox","x-authentication":"None","operationId":"listMeFFixtures","summary":"List TY2026 MeF prep fixtures","responses":{"200":{"description":"MeF prep catalog","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeFCatalog"}}}}}},"post":{"tags":["Tax Returns preparation"],"description":"Prepare a synthetic TY2026 draft preview, up to 2,048 bytes. The missing-information fixture returns a successful response with findings. The result is a simulation.","x-availability":"Sandbox","x-authentication":"None","operationId":"prepareMeFFixture","summary":"Prepare a synthetic MeF draft","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeFFixture"},"example":{"tax_year":2026,"form":"1040","fixture":"complete"}}}},"responses":{"200":{"description":"Synthetic draft preview or preparation findings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeFDraft"}}}},"400":{"description":"Invalid JSON or request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"Request size limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"415":{"description":"Content-Type must be application/json","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Invalid fields or fixture","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/provider-applications":{"get":{"tags":["Provider verification"],"description":"When enabled, lists up to 30 applications belonging to the signed-in account and whether review is configured.","x-availability":"Paused · production onboarding","x-authentication":"Signed-in TaxFileAPI sandbox session","operationId":"listProviderApplications","summary":"List your provider applications","security":[],"responses":{"200":{"description":"Provider applications","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderApplications"}}}},"401":{"description":"Sign-in required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Provider preview is paused or an existing record changed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Verification service unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"tags":["Provider verification"],"description":"When enabled, submits an ERO or Online Provider application for review. Use a secure evidence reference. Returned EFINs are masked.","x-availability":"Paused · production onboarding","x-authentication":"Signed-in TaxFileAPI sandbox session","operationId":"createProviderApplication","summary":"Submit a provider application","security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderApplicationInput"}}}},"responses":{"201":{"description":"Application is pending review","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderApplication"}}}},"400":{"description":"Invalid JSON or request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Sign-in required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Same-origin required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Provider preview is paused or an existing record changed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"Request size limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"415":{"description":"Content-Type must be application/json","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Invalid fields or fixture","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Account application limit reached","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Verification service unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/provider-applications/{id}/review":{"post":{"tags":["Provider verification"],"description":"When enabled, an assigned reviewer records a decision after comparing the applicant’s active role and EFIN with IRS evidence. Verified status expires after 90 days.","x-availability":"Paused · production onboarding","x-authentication":"Assigned reviewer account","operationId":"reviewProviderApplication","summary":"Record a provider verification decision","security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderReview"}}}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^prov_[a-f0-9]{32}$"}}],"responses":{"200":{"description":"Decision recorded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderApplication"}}}},"400":{"description":"Invalid JSON or request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Sign-in required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Assigned reviewer or same-origin required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Application not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Provider preview is paused or an existing record changed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"Request size limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"415":{"description":"Content-Type must be application/json","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Invalid fields or fixture","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Verification service unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/provider-verification/check":{"post":{"tags":["Provider verification"],"description":"When enabled, checks that the provider record belongs to the authenticated owner and matches the role and EFIN. Verification must remain active.","x-availability":"Paused · production onboarding","x-authentication":"Filing-service bearer","operationId":"checkProviderVerification","summary":"Verify provider eligibility","security":[{"filingServiceBearer":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderCheckInput"}}}},"responses":{"200":{"description":"Active verification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderCheck"}}}},"400":{"description":"Invalid JSON or request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Service credential invalid or provider unverifiable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Provider preview is paused or an existing record changed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"Request size limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"415":{"description":"Content-Type must be application/json","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Invalid fields or fixture","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Verification service unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"webhooks":{"transmission.acknowledged":{"post":{"summary":"A configured sandbox transmission has a final acknowledgment","parameters":[{"in":"header","name":"TaxFileAPI-Signature","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string"},"type":{"const":"transmission.acknowledged"},"data":{"$ref":"#/components/schemas/Transmission"}},"required":["id","type","data"]}}}},"responses":{"2XX":{"description":"Event received"}},"security":[]}}},"components":{"securitySchemes":{"sandboxBearer":{"type":"http","scheme":"bearer"},"filingServiceBearer":{"type":"http","scheme":"bearer","description":"Server-side credential for the trusted filing backend. Provider preview is currently paused."}},"schemas":{"TransmissionInput":{"type":"object","additionalProperties":false,"properties":{"form":{"type":"string","enum":["1042-S","1097-BTC","1098","1098-C","1098-E","1098-F","1098-Q","1098-T","1098-VLI","1099-A","1099-B","1099-C","1099-CAP","1099-DA","1099-DIV","1099-G","1099-INT","1099-K","1099-LPS","1099-LS","1099-LTC","1099-MISC","1099-NEC","1099-OID","1099-PATR","1099-Q","1099-QA","1099-R","1099-S","1099-SA","1099-SB","15397","3921","3922","5498","5498-ESA","5498-QA","5498-SA","5498-TA","8027","8596","8809","8955-SSA","W-2G"],"description":"See GET /v1/iris/forms for form-by-year availability."},"tax_year":{"type":"integer","enum":[2025,2026]},"header":{"type":"object","additionalProperties":false,"properties":{"payer_ref":{"const":"demo-payer"}},"required":["payer_ref"]},"records":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"object","additionalProperties":false,"properties":{"record_id":{"type":"string","pattern":"^demo-[a-z0-9-]{1,40}$"},"fields":{"oneOf":[{"type":"object","additionalProperties":false,"properties":{"recipient_ref":{"const":"demo-recipient"},"nonemployee_compensation":{"type":"string","pattern":"^(?:0|[1-9][0-9]{0,7})\\.[0-9]{2}$"}},"required":["recipient_ref","nonemployee_compensation"]},{"type":"object","additionalProperties":false,"properties":{"fixture_ref":{"const":"demo-form-record"}},"required":["fixture_ref"]}]}},"required":["record_id","fields"]}},"sandbox_scenario":{"enum":["accepted","rejected","partially_accepted","delayed"]}},"required":["form","tax_year","header","records","sandbox_scenario"]},"CreditError":{"type":"object","additionalProperties":false,"properties":{"error":{"type":"object","additionalProperties":false,"properties":{"code":{"const":"insufficient_account_credits"},"message":{"type":"string"},"credits_required":{"type":"integer"},"transmission_id":{"type":"string"},"approval_url":{"type":"string"},"sandbox_wallet_url":{"type":"string"}},"required":["code","message","credits_required","transmission_id","approval_url","sandbox_wallet_url"]}},"required":["error"]},"Finding":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"record_id":{"type":["string","null"]},"field":{"type":"string"},"message":{"type":"string"}},"required":["code","record_id","field","message"]},"Error":{"type":"object","additionalProperties":false,"properties":{"error":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/Finding"}}},"required":["code","message"]}},"required":["error"]},"Acknowledgment":{"type":"object","additionalProperties":false,"properties":{"status":{"enum":["accepted","rejected","partially_accepted"]},"simulated":{"const":true},"records":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"record_id":{"type":"string"},"status":{"enum":["accepted","rejected"]},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Finding"}}},"required":["record_id","status","errors"]}}},"required":["status","simulated","records"]},"Transmission":{"type":"object","additionalProperties":false,"properties":{"transmission_id":{"type":"string"},"environment":{"const":"sandbox"},"status":{"enum":["awaiting_approval","queued","accepted","rejected","partially_accepted"]},"form":{"type":"string"},"tax_year":{"type":"integer"},"record_count":{"type":"integer"},"price":{"type":"object","additionalProperties":false,"properties":{"currency":{"const":"USD"},"amount_cents":{"const":0}},"required":["currency","amount_cents"]},"credits":{"type":"object","additionalProperties":false,"properties":{"required":{"type":"integer"},"applied":{"type":"integer"},"simulated":{"const":true}},"required":["required","applied","simulated"]},"approval_url":{"type":["string","null"]},"status_url":{"type":"string"},"receipt_id":{"type":["string","null"]},"acknowledgment":{"anyOf":[{"$ref":"#/components/schemas/Acknowledgment"},{"type":"null"}]},"sent_to_irs":{"const":false},"irs_acceptance_verified":{"const":false},"payment_charged":{"const":false}},"required":["transmission_id","environment","status","form","tax_year","record_count","price","credits","approval_url","status_url","receipt_id","acknowledgment","sent_to_irs","irs_acceptance_verified","payment_charged"]},"FilingSeason":{"type":"object","properties":{"channel":{"const":"iris"},"tax_year":{"type":"integer"},"processing_year":{"type":"integer"},"sandbox":{"type":"object","properties":{"available":{"type":"boolean"},"price_cents":{"type":"integer"},"synthetic_only":{"type":"boolean"}},"required":["available","price_cents","synthetic_only"],"additionalProperties":false},"production":{"type":"object","properties":{"status":{"type":"string"},"live_transmission_enabled":{"type":"boolean"},"expected_irs_opening_month":{"type":"string"},"confirmed_irs_opening_at":{"type":["string","null"]},"payment_method":{"type":"string"}},"required":["status","live_transmission_enabled","expected_irs_opening_month","confirmed_irs_opening_at","payment_method"],"additionalProperties":false},"irs_source_url":{"type":"string"}},"required":["channel","tax_year","processing_year","sandbox","production","irs_source_url"],"additionalProperties":false},"IRISCatalog":{"type":"object","properties":{"channel":{"const":"iris"},"filing_season_url":{"type":"string"},"forms":{"type":"array","items":{"type":"object","properties":{"form":{"type":"string"},"tax_year":{"type":"integer"},"schema_url":{"type":"string"},"sandbox_batch":{"type":"boolean"},"transmission_status":{"type":"string"},"account_credit_pricing":{"enum":["per_record","requires_form_specific_pricing"]}},"required":["form","tax_year","schema_url","sandbox_batch","transmission_status","account_credit_pricing"],"additionalProperties":false}}},"required":["channel","filing_season_url","forms"],"additionalProperties":false},"IRISFormSchema":{"type":"object","properties":{"form":{"type":"string"},"tax_year":{"type":"integer"},"header":{"type":"object"},"record":{"type":"object"},"max_records":{"type":"integer"},"submission_group":{"type":"string"}},"required":["form","tax_year","header","record"],"additionalProperties":false},"SandboxKey":{"type":"object","properties":{"api_key":{"type":"string"},"expires_at":{"type":"string","format":"date-time"},"webhook_secret":{"type":["string","null"]}},"required":["api_key","expires_at","webhook_secret"],"additionalProperties":false},"SandboxWallet":{"type":"object","properties":{"environment":{"const":"sandbox"},"available":{"type":"integer"},"payment_charged":{"const":false}},"required":["environment","available","payment_charged"],"additionalProperties":false},"SandboxTopUp":{"type":"object","properties":{"quantity":{"type":"integer","minimum":1,"maximum":2000}},"required":["quantity"],"additionalProperties":false},"SingleFixtureCatalog":{"type":"object","properties":{"environment":{"const":"sandbox"},"channels":{"type":"object","properties":{"iris":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"forms":{"type":"array","items":{"type":"string"}}},"required":["name","forms"],"additionalProperties":false}}},"required":["iris"],"additionalProperties":false}},"required":["environment","channels"],"additionalProperties":false},"SingleFixtureInput":{"type":"object","properties":{"channel":{"const":"iris"},"form":{"enum":["1099-NEC","1099-MISC","1099-INT","1099-DIV","1099-K","1099-DA","1099-A","1099-B","1099-C","1099-CAP","1099-G","1099-LPS","1099-LS","1099-LTC","1099-OID","1099-PATR","1099-Q","1099-QA","1099-R","1099-S","1099-SA","1099-SB","1098","1098-C","1098-E","1098-F","1098-Q","1098-T","1098-VLI","5498","5498-ESA","5498-QA","5498-SA","5498-TA","1042-S","1097-BTC","3921","3922","8027","8596","8809","8955-SSA","15397","W-2G"]},"scenario":{"enum":["accepted","rejected","pending"]}},"required":["channel","form","scenario"],"additionalProperties":false},"SingleReceipt":{"type":"object","properties":{"receipt_id":{"type":"string"},"acknowledgment_url":{"type":"string"},"environment":{"const":"sandbox"},"status":{"const":"received"},"sent_to_irs":{"const":false},"payment_charged":{"const":false}},"required":["receipt_id","acknowledgment_url","environment","status","sent_to_irs","payment_charged"],"additionalProperties":false},"SingleAcknowledgment":{"type":"object","properties":{"receipt_id":{"type":"string"},"environment":{"const":"sandbox"},"channel":{"enum":["iris","mef"]},"form":{"type":"string"},"status":{"enum":["accepted","rejected","pending"]},"sent_to_irs":{"const":false},"irs_acceptance_verified":{"const":false},"payment_charged":{"const":false},"findings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}}},"required":["receipt_id","environment","channel","form","status","sent_to_irs","irs_acceptance_verified","payment_charged"],"additionalProperties":false},"MeFCatalog":{"type":"object","properties":{"environment":{"const":"sandbox"},"channel":{"const":"mef"},"tax_year":{"const":2026},"groups":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"forms":{"type":"array","items":{"type":"string"}}},"required":["label","forms"],"additionalProperties":false}},"fixtures":{"type":"array","items":{"enum":["complete","missing_information"]}},"production":{"type":"object","properties":{"enabled":{"const":false},"credential_verification_required":{"const":true},"accepted_provider_roles":{"type":"array","items":{"enum":["ero","online_provider"]}}},"required":["enabled","credential_verification_required","accepted_provider_roles"],"additionalProperties":false}},"required":["environment","channel","tax_year","groups","fixtures","production"],"additionalProperties":false},"MeFFixture":{"type":"object","properties":{"tax_year":{"const":2026},"form":{"enum":["1040","1040-NR","1041","2350","4868","9465","1065","1120","1120-S","1120-F","1120-POL","1042","7004","990","990-EZ","990-PF","990-T","4720","5227","5330","8868","8038-CP","940","941","941-X","943","943-X","944","944-X","945","945-X","94x-PIN","720","2290","8849","1045-IND","1045-EST","1139","56","706","709","8892"]},"fixture":{"enum":["complete","missing_information"]}},"required":["tax_year","form","fixture"],"additionalProperties":false},"MeFDraft":{"type":"object","properties":{"draft_id":{"type":"string"},"channel":{"const":"mef"},"environment":{"const":"sandbox"},"form":{"type":"string"},"form_family":{"type":"string"},"tax_year":{"const":2026},"status":{"enum":["prepared","needs_information"]},"inputs":{"type":"object","properties":{"filer_ref":{"type":["string","null"]},"tax_year":{"const":2026},"form":{"type":"string"}},"required":["filer_ref","tax_year","form"],"additionalProperties":false},"findings":{"type":"array","items":{"$ref":"#/components/schemas/Finding"}},"simulation":{"type":"object","properties":{"irs_schema_validated":{"const":false},"return_calculated":{"const":false},"sent_to_irs":{"const":false},"payment_charged":{"const":false}},"required":["irs_schema_validated","return_calculated","sent_to_irs","payment_charged"],"additionalProperties":false}},"required":["draft_id","channel","environment","form","form_family","tax_year","status","inputs","findings","simulation"],"additionalProperties":false},"ProviderApplicationInput":{"type":"object","properties":{"legal_name":{"type":"string","minLength":2,"maxLength":160},"contact_email":{"type":"string","format":"email","maxLength":254},"role":{"enum":["ero","online_provider"]},"efin":{"type":"string","pattern":"^[0-9]{6}$"},"evidence_ref":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_.:-]{3,79}$"}},"required":["legal_name","contact_email","role","efin","evidence_ref"],"additionalProperties":false},"ProviderApplication":{"type":"object","properties":{"id":{"type":"string"},"legal_name":{"type":"string"},"contact_email":{"type":"string"},"role":{"enum":["ero","online_provider"]},"efin_last_four":{"type":"string"},"status":{"enum":["pending","verified","expired","rejected","revoked"]},"submitted_at":{"type":"string"},"verified_until":{"type":["string","null"]},"review_reason":{"type":["string","null"]}},"required":["id","legal_name","contact_email","role","efin_last_four","status","submitted_at","verified_until","review_reason"],"additionalProperties":false},"ProviderApplications":{"type":"object","properties":{"applications":{"type":"array","items":{"$ref":"#/components/schemas/ProviderApplication"}},"review_configured":{"type":"boolean"}},"required":["applications","review_configured"],"additionalProperties":false},"ProviderReview":{"type":"object","properties":{"decision":{"enum":["verified","rejected","revoked"]},"reason":{"type":"string","minLength":12,"maxLength":400},"matched_efin":{"type":"string"},"confirmed_active_role":{"type":"string"},"verified_evidence_ref":{"type":"string"},"matched_legal_name":{"type":"string"}},"required":["decision","reason","matched_efin","confirmed_active_role","verified_evidence_ref","matched_legal_name"],"additionalProperties":false},"ProviderCheckInput":{"type":"object","properties":{"provider_id":{"type":"string","pattern":"^prov_[a-f0-9]{32}$"},"owner_id":{"type":"string","minLength":1,"maxLength":120},"role":{"enum":["ero","online_provider"]},"efin":{"type":"string","pattern":"^[0-9]{6}$"}},"required":["provider_id","owner_id","role","efin"],"additionalProperties":false},"ProviderCheck":{"type":"object","properties":{"provider_id":{"type":"string"},"verified":{"const":true},"verified_until":{"type":"string"}},"required":["provider_id","verified","verified_until"],"additionalProperties":false}}},"tags":[{"name":"Discovery"},{"name":"IRIS batches"},{"name":"Keys, approvals and credits"},{"name":"Single-fixture simulator"},{"name":"Tax Returns preparation"},{"name":"Provider verification"}]}