{
  "components": {
    "parameters": {
      "IdempotencyKey": {
        "description": "Required for every state-changing /api/v1 operation. Scoped to the live tenant/connection principal and request fingerprint.",
        "in": "header",
        "name": "Idempotency-Key",
        "required": true,
        "schema": {
          "maxLength": 256,
          "minLength": 1,
          "type": "string"
        }
      }
    },
    "responses": {
      "BadRequest": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ApiV1ErrorEnvelope"
            }
          }
        },
        "description": "Invalid request"
      },
      "CapacityRequired": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ApiV1ErrorEnvelope"
            }
          }
        },
        "description": "An operation that consumes service or W-9 capacity requires a sufficient purchased balance; code is service_capacity_required or w9_capacity_required"
      },
      "Conflict": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ApiV1ErrorEnvelope"
            }
          }
        },
        "description": "Current resource state conflicts"
      },
      "Forbidden": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ApiV1ErrorEnvelope"
            }
          }
        },
        "description": "Insufficient scope or tenant/filer policy denial"
      },
      "InternalError": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ApiV1ErrorEnvelope"
            }
          }
        },
        "description": "Internal error with redacted details"
      },
      "InvalidToken": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ApiV1ErrorEnvelope"
            }
          }
        },
        "description": "Missing, invalid, expired, revoked, stale, or wrong-audience OAuth token"
      },
      "NotFound": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ApiV1ErrorEnvelope"
            }
          }
        },
        "description": "The requested resource was not found"
      },
      "PreconditionFailed": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ApiV1ErrorEnvelope"
            }
          }
        },
        "description": "Expected version, price, or policy changed"
      },
      "RateLimited": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ApiV1ErrorEnvelope"
            }
          }
        },
        "description": "Request or weighted-unit ceiling reached",
        "headers": {
          "Retry-After": {
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          }
        }
      },
      "ServiceUnavailable": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ApiV1ErrorEnvelope"
            }
          }
        },
        "description": "Authorization policy or a required dependency cannot be determined safely"
      },
      "ValidationFailed": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ApiV1ErrorEnvelope"
            }
          }
        },
        "description": "Business validation failed"
      }
    },
    "schemas": {
      "AgentFilingReference": {
        "additionalProperties": false,
        "properties": {
          "review_id": {
            "$ref": "#/components/schemas/Uuid"
          }
        },
        "required": [
          "review_id"
        ],
        "type": "object"
      },
      "ApiDashboardCounts": {
        "additionalProperties": false,
        "properties": {
          "active_recipient_count": {
            "minimum": 0,
            "type": "integer"
          },
          "filer_count": {
            "minimum": 0,
            "type": "integer"
          },
          "orders_completed_count": {
            "minimum": 0,
            "type": "integer"
          },
          "orders_needs_attention_count": {
            "minimum": 0,
            "type": "integer"
          },
          "orders_processing_count": {
            "minimum": 0,
            "type": "integer"
          },
          "orders_total_count": {
            "minimum": 0,
            "type": "integer"
          },
          "release_ready_recipient_count": {
            "minimum": 0,
            "type": "integer"
          },
          "released_recipient_count": {
            "minimum": 0,
            "type": "integer"
          },
          "tin_match_needed_count": {
            "minimum": 0,
            "type": "integer"
          },
          "tin_match_pending_count": {
            "minimum": 0,
            "type": "integer"
          },
          "unvalidated_recipient_count": {
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "filer_count",
          "active_recipient_count",
          "release_ready_recipient_count",
          "unvalidated_recipient_count",
          "released_recipient_count",
          "tin_match_needed_count",
          "tin_match_pending_count",
          "orders_total_count",
          "orders_needs_attention_count",
          "orders_processing_count",
          "orders_completed_count"
        ],
        "type": "object"
      },
      "ApiDashboardRequest": {
        "additionalProperties": false,
        "properties": {
          "tax_year": {
            "enum": [
              2022,
              2023,
              2024,
              2025,
              2026
            ],
            "type": "integer"
          }
        },
        "required": [
          "tax_year"
        ],
        "type": "object"
      },
      "ApiDashboardSummary": {
        "additionalProperties": false,
        "properties": {
          "freshness": {
            "enum": [
              "fresh",
              "stale",
              "building"
            ],
            "type": "string"
          },
          "generated_at": {
            "type": "string"
          },
          "last_materialized_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "next_actions": {
            "items": {
              "additionalProperties": false,
              "properties": {
                "count": {
                  "minimum": 0,
                  "type": "integer"
                },
                "href": {
                  "type": "string"
                },
                "kind": {
                  "enum": [
                    "create_filer",
                    "add_recipients",
                    "review_recipients",
                    "preview_pdfs",
                    "release_order",
                    "review_order",
                    "view_orders"
                  ],
                  "type": "string"
                },
                "label": {
                  "type": "string"
                },
                "severity": {
                  "enum": [
                    "info",
                    "warning",
                    "danger",
                    "success"
                  ],
                  "type": "string"
                }
              },
              "required": [
                "kind",
                "label",
                "href",
                "count",
                "severity"
              ],
              "type": "object"
            },
            "maxItems": 100,
            "type": "array"
          },
          "summary": {
            "$ref": "#/components/schemas/ApiDashboardCounts"
          },
          "tax_year": {
            "anyOf": [
              {
                "enum": [
                  2022,
                  2023,
                  2024,
                  2025,
                  2026
                ],
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "tax_year",
          "generated_at",
          "freshness",
          "last_materialized_at",
          "summary",
          "next_actions"
        ],
        "type": "object"
      },
      "ApiFilingReadiness": {
        "additionalProperties": false,
        "properties": {
          "evidence": {
            "oneOf": [
              {
                "additionalProperties": false,
                "properties": {
                  "archived": {
                    "type": "boolean"
                  },
                  "candidates_read": {
                    "minimum": 0,
                    "type": "integer"
                  },
                  "count_notes": {
                    "type": "string"
                  },
                  "counts": {
                    "anyOf": [
                      {
                        "additionalProperties": false,
                        "properties": {
                          "active_recipients": {
                            "minimum": 0,
                            "type": "integer"
                          },
                          "active_released_recipients": {
                            "minimum": 0,
                            "type": "integer"
                          },
                          "non_archived_recipients": {
                            "minimum": 0,
                            "type": "integer"
                          },
                          "release_ready_recipients": {
                            "minimum": 0,
                            "type": "integer"
                          },
                          "unvalidated_recipients": {
                            "minimum": 0,
                            "type": "integer"
                          }
                        },
                        "required": [
                          "non_archived_recipients",
                          "unvalidated_recipients",
                          "active_recipients",
                          "active_released_recipients",
                          "release_ready_recipients"
                        ],
                        "type": "object"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "eligibility_notes": {
                    "type": "string"
                  },
                  "examples": {
                    "items": {
                      "$ref": "#/components/schemas/ApiRecipientIssueEvidence"
                    },
                    "maxItems": 5,
                    "type": "array"
                  },
                  "examples_exhaustive": {
                    "const": false
                  },
                  "filer_id": {
                    "$ref": "#/components/schemas/Uuid"
                  },
                  "filer_status": {
                    "enum": [
                      "available",
                      "disabled",
                      "archived"
                    ],
                    "type": "string"
                  },
                  "index_has_more": {
                    "type": "boolean"
                  },
                  "name": {
                    "type": "string"
                  },
                  "recipient_operations_in_progress": {
                    "type": "boolean"
                  },
                  "sample_limit": {
                    "const": 5
                  },
                  "sample_notes": {
                    "type": "string"
                  },
                  "scope": {
                    "const": "filer"
                  },
                  "state": {
                    "enum": [
                      "observed",
                      "updating",
                      "unavailable"
                    ],
                    "type": "string"
                  },
                  "tax_year": {
                    "anyOf": [
                      {
                        "enum": [
                          2022,
                          2023,
                          2024,
                          2025,
                          2026
                        ],
                        "type": "integer"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "tin_matching": {
                    "additionalProperties": false,
                    "properties": {
                      "advice": {
                        "enum": [
                          "offer_matching",
                          "wait_for_results",
                          "review_results",
                          "already_matched",
                          "no_pending_filings",
                          "unknown"
                        ],
                        "type": "string"
                      },
                      "attention_required_observed": {
                        "minimum": 0,
                        "type": "integer"
                      },
                      "checked_pending_recipients": {
                        "minimum": 0,
                        "type": "integer"
                      },
                      "coverage": {
                        "enum": [
                          "complete",
                          "partial",
                          "unavailable"
                        ],
                        "type": "string"
                      },
                      "matched_recipients_observed": {
                        "minimum": 0,
                        "type": "integer"
                      },
                      "notes": {
                        "type": "string"
                      },
                      "pending_results_observed": {
                        "minimum": 0,
                        "type": "integer"
                      },
                      "unchecked_recipients_observed": {
                        "minimum": 0,
                        "type": "integer"
                      }
                    },
                    "required": [
                      "advice",
                      "coverage",
                      "checked_pending_recipients",
                      "unchecked_recipients_observed",
                      "matched_recipients_observed",
                      "pending_results_observed",
                      "attention_required_observed",
                      "notes"
                    ],
                    "type": "object"
                  },
                  "total_validation_issues": {
                    "type": "null"
                  }
                },
                "required": [
                  "scope",
                  "state",
                  "filer_id",
                  "name",
                  "tax_year",
                  "filer_status",
                  "archived",
                  "recipient_operations_in_progress",
                  "counts",
                  "total_validation_issues",
                  "tin_matching",
                  "count_notes",
                  "examples",
                  "sample_limit",
                  "candidates_read",
                  "index_has_more",
                  "examples_exhaustive",
                  "sample_notes",
                  "eligibility_notes"
                ],
                "type": "object"
              },
              {
                "additionalProperties": false,
                "properties": {
                  "counts": {
                    "anyOf": [
                      {
                        "$ref": "#/components/schemas/ApiDashboardCounts"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "dashboard_freshness": {
                    "enum": [
                      "fresh",
                      "stale",
                      "building"
                    ],
                    "type": "string"
                  },
                  "filers": {
                    "items": {
                      "additionalProperties": false,
                      "properties": {
                        "dashboard_status": {
                          "enum": [
                            "needs_attention",
                            "workflow_processing",
                            "services_processing",
                            "tin_matching_processing",
                            "tin_matching_complete",
                            "pending_customer_action",
                            "ready_to_release",
                            "no_services_requested",
                            "services_complete",
                            "no_recipients"
                          ],
                          "type": "string"
                        },
                        "filer_id": {
                          "$ref": "#/components/schemas/Uuid"
                        },
                        "generated_at": {
                          "type": "string"
                        },
                        "name": {
                          "type": "string"
                        },
                        "release_ready_recipients": {
                          "minimum": 0,
                          "type": "integer"
                        },
                        "unvalidated_recipients": {
                          "minimum": 0,
                          "type": "integer"
                        }
                      },
                      "required": [
                        "filer_id",
                        "name",
                        "dashboard_status",
                        "unvalidated_recipients",
                        "release_ready_recipients",
                        "generated_at"
                      ],
                      "type": "object"
                    },
                    "maxItems": 5,
                    "type": "array"
                  },
                  "filers_exhaustive": {
                    "const": false
                  },
                  "generated_at": {
                    "type": "string"
                  },
                  "index_has_more": {
                    "type": "boolean"
                  },
                  "last_materialized_at": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "notes": {
                    "type": "string"
                  },
                  "sample_limit": {
                    "const": 5
                  },
                  "scope": {
                    "const": "account_year"
                  },
                  "state": {
                    "enum": [
                      "observed",
                      "updating",
                      "unavailable"
                    ],
                    "type": "string"
                  },
                  "tax_year": {
                    "enum": [
                      2022,
                      2023,
                      2024,
                      2025,
                      2026
                    ],
                    "type": "integer"
                  },
                  "total_validation_issues": {
                    "type": "null"
                  }
                },
                "required": [
                  "scope",
                  "tax_year",
                  "state",
                  "dashboard_freshness",
                  "generated_at",
                  "last_materialized_at",
                  "counts",
                  "total_validation_issues",
                  "filers",
                  "sample_limit",
                  "filers_exhaustive",
                  "index_has_more",
                  "notes"
                ],
                "type": "object"
              }
            ]
          },
          "links": {
            "items": {
              "$ref": "#/components/schemas/ApiInquiryLink"
            },
            "maxItems": 6,
            "type": "array"
          }
        },
        "required": [
          "evidence",
          "links"
        ],
        "type": "object"
      },
      "ApiHelpTopic": {
        "additionalProperties": false,
        "properties": {
          "content": {
            "type": "string"
          },
          "href": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "next_topic_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "previous_topic_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "topic_id": {
            "type": "string"
          }
        },
        "required": [
          "topic_id",
          "content"
        ],
        "type": "object"
      },
      "ApiHelpTopicRequest": {
        "additionalProperties": false,
        "properties": {
          "topic_id": {
            "maxLength": 200,
            "minLength": 1,
            "pattern": "^[A-Za-z0-9_.:-]+$",
            "type": "string"
          }
        },
        "required": [
          "topic_id"
        ],
        "type": "object"
      },
      "ApiHelpTopics": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "additionalProperties": false,
              "properties": {
                "id": {
                  "type": "string"
                },
                "purpose": {
                  "type": "string"
                },
                "score": {
                  "description": "Relative search relevance for this query, not a confidence probability; present for search results.",
                  "minimum": 0,
                  "type": "number"
                },
                "title": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "title",
                "purpose"
              ],
              "type": "object"
            },
            "maxItems": 100,
            "type": "array"
          },
          "limit_reached": {
            "type": "boolean"
          },
          "total_matches": {
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "items"
        ],
        "type": "object"
      },
      "ApiInquiryLink": {
        "additionalProperties": false,
        "properties": {
          "href": {
            "type": "string"
          },
          "label": {
            "type": "string"
          }
        },
        "required": [
          "label",
          "href"
        ],
        "type": "object"
      },
      "ApiPaymentMethodPresence": {
        "additionalProperties": false,
        "properties": {
          "default_configured": {
            "type": "boolean"
          },
          "methods": {
            "items": {
              "additionalProperties": false,
              "properties": {
                "kind": {
                  "enum": [
                    "credit_card",
                    "bank_account_ach"
                  ],
                  "type": "string"
                },
                "selected_default": {
                  "type": "boolean"
                },
                "status": {
                  "enum": [
                    "active",
                    "archived"
                  ],
                  "type": "string"
                }
              },
              "required": [
                "kind",
                "status",
                "selected_default"
              ],
              "type": "object"
            },
            "maxItems": 50,
            "type": "array"
          },
          "partial": {
            "type": "boolean"
          }
        },
        "required": [
          "methods",
          "partial",
          "default_configured"
        ],
        "type": "object"
      },
      "ApiRecipientIssueEvidence": {
        "additionalProperties": false,
        "properties": {
          "archived": {
            "type": "boolean"
          },
          "details_truncated": {
            "type": "boolean"
          },
          "examples_exhaustive": {
            "const": false
          },
          "field_filter": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "field_limit": {
            "minimum": 0,
            "type": "integer"
          },
          "fields": {
            "items": {
              "additionalProperties": false,
              "properties": {
                "field": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "label": {
                  "type": "string"
                },
                "sampled_issue_count": {
                  "minimum": 0,
                  "type": "integer"
                }
              },
              "required": [
                "field",
                "label",
                "sampled_issue_count"
              ],
              "type": "object"
            },
            "maxItems": 8,
            "type": "array"
          },
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "forms": {
            "items": {
              "additionalProperties": false,
              "properties": {
                "error_count": {
                  "minimum": 0,
                  "type": "integer"
                },
                "form_id": {
                  "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_h",
                    "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",
                    "3921",
                    "3922",
                    "5498",
                    "5498_esa",
                    "5498_qa",
                    "5498_sa",
                    "5498_ta",
                    "15397",
                    "8027",
                    "8596",
                    "8809",
                    "8955_ssa",
                    "w_2g"
                  ],
                  "type": "string"
                },
                "has_errors": {
                  "type": "boolean"
                },
                "tax_year": {
                  "enum": [
                    2022,
                    2023,
                    2024,
                    2025,
                    2026
                  ],
                  "type": "integer"
                }
              },
              "required": [
                "form_id",
                "tax_year",
                "has_errors",
                "error_count"
              ],
              "type": "object"
            },
            "maxItems": 5,
            "type": "array"
          },
          "inspected_issue_entries": {
            "minimum": 0,
            "type": "integer"
          },
          "inspection_limit": {
            "minimum": 0,
            "type": "integer"
          },
          "is_validated": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "notes": {
            "type": "string"
          },
          "recipient_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "recipient_validation_issue_count": {
            "minimum": 0,
            "type": "integer"
          },
          "released": {
            "type": "boolean"
          },
          "status": {
            "enum": [
              "active",
              "disabled",
              "archived"
            ],
            "type": "string"
          }
        },
        "required": [
          "filer_id",
          "recipient_id",
          "name",
          "status",
          "archived",
          "released",
          "is_validated",
          "recipient_validation_issue_count",
          "forms",
          "fields",
          "field_filter",
          "inspected_issue_entries",
          "field_limit",
          "inspection_limit",
          "details_truncated",
          "examples_exhaustive",
          "notes"
        ],
        "type": "object"
      },
      "ApiRecipientIssues": {
        "additionalProperties": false,
        "properties": {
          "evidence": {
            "$ref": "#/components/schemas/ApiRecipientIssueEvidence"
          },
          "links": {
            "items": {
              "$ref": "#/components/schemas/ApiInquiryLink"
            },
            "maxItems": 1,
            "type": "array"
          }
        },
        "required": [
          "evidence",
          "links"
        ],
        "type": "object"
      },
      "ApiSearchHit": {
        "additionalProperties": false,
        "properties": {
          "domain": {
            "enum": [
              "filers",
              "recipients",
              "orders",
              "file_submissions",
              "w9_issuers",
              "w9_requests",
              "w9_imports",
              "delivery_artifacts",
              "order_deliverables",
              "import_services"
            ],
            "type": "string"
          },
          "entity_id": {
            "type": "string"
          },
          "excerpt": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "filer_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "is_archived": {
            "type": "boolean"
          },
          "order_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "service_code": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/ApiSearchServiceCode"
              },
              {
                "type": "null"
              }
            ]
          },
          "title": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "updated_at": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "domain",
          "entity_id",
          "filer_id",
          "order_id",
          "service_code",
          "title",
          "excerpt",
          "is_archived",
          "updated_at"
        ],
        "type": "object"
      },
      "ApiSearchRequest": {
        "additionalProperties": false,
        "properties": {
          "archive_scope": {
            "anyOf": [
              {
                "default": "active",
                "enum": [
                  "active",
                  "archived",
                  "all"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "domains": {
            "anyOf": [
              {
                "items": {
                  "enum": [
                    "filers",
                    "recipients",
                    "orders",
                    "file_submissions",
                    "w9_issuers",
                    "w9_requests",
                    "w9_imports",
                    "delivery_artifacts",
                    "order_deliverables",
                    "import_services"
                  ],
                  "type": "string"
                },
                "maxItems": 10,
                "minItems": 1,
                "type": "array",
                "uniqueItems": true
              },
              {
                "type": "null"
              }
            ]
          },
          "filer_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "filing_year": {
            "anyOf": [
              {
                "enum": [
                  2022,
                  2023,
                  2024,
                  2025,
                  2026
                ],
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "limit": {
            "anyOf": [
              {
                "default": 50,
                "maximum": 100,
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "q": {
            "maxLength": 256,
            "minLength": 1,
            "type": "string"
          }
        },
        "required": [
          "q"
        ],
        "type": "object"
      },
      "ApiSearchResponse": {
        "additionalProperties": false,
        "properties": {
          "domains": {
            "items": {
              "enum": [
                "filers",
                "recipients",
                "orders",
                "file_submissions",
                "w9_issuers",
                "w9_requests",
                "w9_imports",
                "delivery_artifacts",
                "order_deliverables",
                "import_services"
              ],
              "type": "string"
            },
            "maxItems": 10,
            "type": "array"
          },
          "filtered_window": {
            "type": "boolean"
          },
          "hits": {
            "items": {
              "$ref": "#/components/schemas/ApiSearchHit"
            },
            "maxItems": 100,
            "type": "array"
          },
          "limit": {
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "partial": {
            "type": "boolean"
          }
        },
        "required": [
          "hits",
          "domains",
          "partial",
          "limit",
          "filtered_window"
        ],
        "type": "object"
      },
      "ApiSearchServiceCode": {
        "enum": [
          "efile",
          "e_delivery",
          "state_efile",
          "print_mail",
          "tin_matching",
          "irs_spec_file",
          "excel_processing",
          "professional_services",
          "w9_collection"
        ],
        "type": "string"
      },
      "ApiV1DocumentCapabilityResponse": {
        "additionalProperties": false,
        "properties": {
          "artifact_id": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "artifact_option_id": {
            "enum": [
              "state_accepted",
              "iris_xml_candidate",
              "pub1220_candidate"
            ],
            "type": "string"
          },
          "download_url": {
            "anyOf": [
              {
                "description": "Short-lived artifact-scoped capability; never a raw storage key.",
                "format": "uri",
                "maxLength": 4096,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "execution_mode": {
            "enum": [
              "cached",
              "immediate",
              "scheduled",
              "not_generated",
              "supplemental_required"
            ],
            "type": "string"
          },
          "expires_at": {
            "anyOf": [
              {
                "format": "date-time",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "form_id": {
            "maxLength": 64,
            "type": "string"
          },
          "message": {
            "anyOf": [
              {
                "maxLength": 1024,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "order_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "record_scope": {
            "enum": [
              "qualified_records",
              "all_state_records",
              "withholding_only"
            ],
            "type": "string"
          },
          "service_code": {
            "$ref": "#/components/schemas/OrderServiceCode"
          },
          "state_code": {
            "pattern": "^[A-Z]{2}$",
            "type": "string"
          },
          "state_output": {
            "$ref": "#/components/schemas/OrderDeliverableStateOutput"
          },
          "status": {
            "enum": [
              "not_requested",
              "queued",
              "processing",
              "ready",
              "expired",
              "failed"
            ],
            "type": "string"
          }
        },
        "required": [
          "order_id",
          "service_code",
          "form_id",
          "state_code",
          "status",
          "execution_mode",
          "record_scope",
          "artifact_option_id",
          "state_output"
        ],
        "type": "object"
      },
      "ApiV1Error": {
        "additionalProperties": false,
        "properties": {
          "code": {
            "enum": [
              "invalid_request",
              "invalid_token",
              "insufficient_scope",
              "forbidden",
              "not_found",
              "conflict",
              "precondition_failed",
              "validation_failed",
              "rate_limited",
              "internal_error",
              "service_unavailable"
            ],
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        },
        "required": [
          "code",
          "message"
        ],
        "type": "object"
      },
      "ApiV1ErrorEnvelope": {
        "additionalProperties": false,
        "properties": {
          "error": {
            "$ref": "#/components/schemas/ApiV1Error"
          },
          "meta": {
            "$ref": "#/components/schemas/ApiV1Meta"
          }
        },
        "required": [
          "error",
          "meta"
        ],
        "type": "object"
      },
      "ApiV1Filer": {
        "additionalProperties": false,
        "description": "Filer read view. Fields marked readOnly are not request controls. List/get-many and mutations mask Tax IDs; a point get may return a full identifier only with tax_ids.read. Invalid imported filers remain readable but require repair before downstream work.",
        "properties": {
          "address1": {
            "type": [
              "string",
              "null"
            ]
          },
          "address2": {
            "type": [
              "string",
              "null"
            ]
          },
          "address_line1": {
            "type": [
              "string",
              "null"
            ]
          },
          "address_line2": {
            "type": [
              "string",
              "null"
            ]
          },
          "app_revision": {
            "type": "string"
          },
          "arch_bucket": {
            "description": "Archive compatibility indicator. Use is_archived for application logic.",
            "type": "string"
          },
          "can_edit_released_details": {
            "description": "Always false. Released-recipient history locks filer details, including migrated filers. Retained for response compatibility; never a request control.",
            "type": "boolean"
          },
          "chapter3_status_code": {
            "type": [
              "string",
              "null"
            ]
          },
          "chapter4_status_code": {
            "type": [
              "string",
              "null"
            ]
          },
          "city": {
            "type": [
              "string",
              "null"
            ]
          },
          "code": {
            "type": [
              "string",
              "null"
            ]
          },
          "contact_name": {
            "type": [
              "string",
              "null"
            ]
          },
          "country": {
            "type": [
              "string",
              "null"
            ]
          },
          "country_code": {
            "type": [
              "string",
              "null"
            ]
          },
          "created_at": {
            "type": "string"
          },
          "data_app": {
            "additionalProperties": false,
            "properties": {
              "data": {},
              "schema_rev": {
                "type": "integer"
              },
              "updated_at": {
                "type": "string"
              }
            },
            "required": [
              "schema_rev",
              "updated_at"
            ],
            "type": "object"
          },
          "department_title": {
            "type": [
              "string",
              "null"
            ]
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "ein_type_ind": {
            "type": [
              "string",
              "null"
            ]
          },
          "email": {
            "type": [
              "string",
              "null"
            ]
          },
          "entity_type_cd": {
            "type": [
              "string",
              "null"
            ]
          },
          "filer_contact_email": {
            "type": [
              "string",
              "null"
            ]
          },
          "filer_contact_first_name": {
            "type": [
              "string",
              "null"
            ]
          },
          "filer_contact_last_name": {
            "type": [
              "string",
              "null"
            ]
          },
          "filer_contact_phone": {
            "type": [
              "string",
              "null"
            ]
          },
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "filer_program": {
            "type": "string"
          },
          "filing_year": {
            "type": [
              "integer",
              "null"
            ]
          },
          "filing_year_text": {
            "type": [
              "string",
              "null"
            ]
          },
          "fire_revision": {
            "type": "string"
          },
          "foreign_city_state_zip": {
            "type": [
              "string",
              "null"
            ]
          },
          "foreign_entity": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "foreign_postal_cd": {
            "type": [
              "string",
              "null"
            ]
          },
          "foreign_tax_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "from_import": {
            "readOnly": true,
            "type": "boolean"
          },
          "giin": {
            "type": [
              "string",
              "null"
            ]
          },
          "has_recipients": {
            "description": "Whether this filer has recipients, when included by the read operation.",
            "type": "boolean"
          },
          "has_released_recipients": {
            "type": "boolean"
          },
          "immutable": {
            "readOnly": true,
            "type": "boolean"
          },
          "immutable_reason": {
            "readOnly": true,
            "type": "string"
          },
          "import_entity_type_cd": {
            "readOnly": true,
            "type": "string"
          },
          "import_entity_type_reason": {
            "readOnly": true,
            "type": "string"
          },
          "import_entity_type_source": {
            "readOnly": true,
            "type": "string"
          },
          "import_run_id": {
            "readOnly": true,
            "type": "string"
          },
          "import_source": {
            "readOnly": true,
            "type": "string"
          },
          "import_validation_issue_count": {
            "minimum": 0,
            "readOnly": true,
            "type": "integer"
          },
          "import_validation_issues": {
            "items": {
              "additionalProperties": false,
              "properties": {
                "code": {
                  "type": "string"
                },
                "field": {
                  "type": "string"
                },
                "message": {
                  "type": "string"
                },
                "origin": {
                  "enum": [
                    "import"
                  ],
                  "type": "string"
                }
              },
              "required": [
                "code",
                "message",
                "origin"
              ],
              "type": "object"
            },
            "readOnly": true,
            "type": "array"
          },
          "import_validation_status": {
            "enum": [
              "valid",
              "invalid"
            ],
            "readOnly": true,
            "type": "string"
          },
          "imported_at": {
            "readOnly": true,
            "type": "string"
          },
          "iris_revision": {
            "type": "string"
          },
          "is_archived": {
            "type": "boolean"
          },
          "is_tin_matched": {
            "type": "boolean"
          },
          "issuer_country_code": {
            "type": [
              "string",
              "null"
            ]
          },
          "last_filing_year_ind": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "last_tin_match_result": {
            "type": "string"
          },
          "last_year_filing": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "name": {
            "type": "string"
          },
          "name1": {
            "type": [
              "string",
              "null"
            ]
          },
          "name2": {
            "type": [
              "string",
              "null"
            ]
          },
          "notes": {
            "type": [
              "string",
              "null"
            ]
          },
          "person_first_nm": {
            "type": [
              "string",
              "null"
            ]
          },
          "person_last_nm": {
            "type": [
              "string",
              "null"
            ]
          },
          "person_middle_nm": {
            "type": [
              "string",
              "null"
            ]
          },
          "person_suffix_nm": {
            "type": [
              "string",
              "null"
            ]
          },
          "phone": {
            "type": [
              "string",
              "null"
            ]
          },
          "postal_code": {
            "type": [
              "string",
              "null"
            ]
          },
          "pro_rata_basis_rep_ind": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "province_code": {
            "type": [
              "string",
              "null"
            ]
          },
          "recipient_contact_email": {
            "type": [
              "string",
              "null"
            ]
          },
          "recipient_contact_name": {
            "type": [
              "string",
              "null"
            ]
          },
          "recipient_filing": {
            "additionalProperties": false,
            "description": "Historical filing provenance. This metadata alone does not authorize a correction.",
            "properties": {
              "accepted_amendment_count": {
                "maximum": 65535,
                "minimum": 0,
                "type": "integer"
              },
              "external_predecessor_sha256": {
                "type": "string"
              },
              "scope": {
                "type": "string"
              },
              "source_filing_state": {
                "enum": [
                  "unfiled",
                  "fire_released"
                ],
                "type": "string"
              },
              "source_group_sha256": {
                "type": "string"
              },
              "source_is_corrected": {
                "type": "boolean"
              }
            },
            "readOnly": true,
            "required": [
              "scope",
              "source_filing_state",
              "source_group_sha256",
              "source_is_corrected"
            ],
            "type": "object"
          },
          "recipient_ops_lock_expires_at": {
            "type": [
              "string",
              "null"
            ]
          },
          "recipient_ops_lock_reason": {
            "type": [
              "string",
              "null"
            ]
          },
          "recipient_ops_lock_run_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "recipient_ops_lock_started_at": {
            "type": [
              "string",
              "null"
            ]
          },
          "recipient_ops_locked": {
            "type": "boolean"
          },
          "second_name_line_t_agent": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "source_correction_system": {
            "readOnly": true,
            "type": "string"
          },
          "source_digest": {
            "readOnly": true,
            "type": "string"
          },
          "source_external_id": {
            "readOnly": true,
            "type": "string"
          },
          "source_external_ref": {
            "readOnly": true,
            "type": "string"
          },
          "source_filing_system": {
            "readOnly": true,
            "type": "string"
          },
          "source_platform": {
            "readOnly": true,
            "type": "string"
          },
          "state": {
            "type": [
              "string",
              "null"
            ]
          },
          "status": {
            "type": "string"
          },
          "target_filing_system": {
            "readOnly": true,
            "type": "string"
          },
          "tax_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "telephone_number_and_extension": {
            "type": [
              "string",
              "null"
            ]
          },
          "tin": {
            "type": [
              "string",
              "null"
            ]
          },
          "tin_kind": {
            "type": [
              "string",
              "null"
            ]
          },
          "tin_last4": {
            "type": [
              "string",
              "null"
            ]
          },
          "transition_correction_policy": {
            "readOnly": true,
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          },
          "version": {
            "type": "integer"
          },
          "withholding_ind": {
            "type": [
              "string",
              "null"
            ]
          },
          "zip_code": {
            "type": [
              "string",
              "null"
            ]
          },
          "zip_or_post_code": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "address1",
          "address2",
          "address_line1",
          "address_line2",
          "arch_bucket",
          "can_edit_released_details",
          "chapter3_status_code",
          "chapter4_status_code",
          "city",
          "code",
          "contact_name",
          "country",
          "country_code",
          "created_at",
          "department_title",
          "description",
          "ein_type_ind",
          "email",
          "entity_type_cd",
          "filer_contact_email",
          "filer_contact_first_name",
          "filer_contact_last_name",
          "filer_contact_phone",
          "filer_id",
          "filer_program",
          "filing_year",
          "filing_year_text",
          "foreign_city_state_zip",
          "foreign_entity",
          "foreign_postal_cd",
          "foreign_tax_id",
          "from_import",
          "giin",
          "has_released_recipients",
          "immutable",
          "import_validation_issue_count",
          "import_validation_issues",
          "import_validation_status",
          "is_archived",
          "is_tin_matched",
          "issuer_country_code",
          "last_filing_year_ind",
          "last_year_filing",
          "name",
          "name1",
          "name2",
          "notes",
          "person_first_nm",
          "person_last_nm",
          "person_middle_nm",
          "person_suffix_nm",
          "phone",
          "postal_code",
          "pro_rata_basis_rep_ind",
          "province_code",
          "recipient_contact_email",
          "recipient_contact_name",
          "recipient_ops_lock_expires_at",
          "recipient_ops_lock_reason",
          "recipient_ops_lock_run_id",
          "recipient_ops_lock_started_at",
          "recipient_ops_locked",
          "second_name_line_t_agent",
          "state",
          "status",
          "tax_id",
          "telephone_number_and_extension",
          "tin",
          "tin_kind",
          "tin_last4",
          "updated_at",
          "version",
          "withholding_ind",
          "zip_code",
          "zip_or_post_code"
        ],
        "type": "object"
      },
      "ApiV1FilerGetManyRequest": {
        "additionalProperties": false,
        "properties": {
          "filer_ids": {
            "items": {
              "$ref": "#/components/schemas/Uuid"
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array",
            "uniqueItems": true
          }
        },
        "required": [
          "filer_ids"
        ],
        "type": "object"
      },
      "ApiV1FilerGetManyResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1Filer"
            },
            "maxItems": 100,
            "type": "array"
          },
          "missing": {
            "items": {
              "$ref": "#/components/schemas/Uuid"
            },
            "maxItems": 100,
            "type": "array"
          }
        },
        "required": [
          "items",
          "missing"
        ],
        "type": "object"
      },
      "ApiV1FilerGetRequest": {
        "additionalProperties": false,
        "properties": {
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          }
        },
        "required": [
          "filer_id"
        ],
        "type": "object"
      },
      "ApiV1FilerListResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1Filer"
            },
            "maxItems": 100,
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "maxLength": 4096,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "total_count": {
            "anyOf": [
              {
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "items"
        ],
        "type": "object"
      },
      "ApiV1FilerUpsertRequest": {
        "additionalProperties": false,
        "description": "Stable third-party filer mutation. Supplying a full Tax ID requires tax_ids.write; mutation responses never echo it.",
        "properties": {
          "address1": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "address2": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "address_line1": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "address_line2": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "chapter3_status_code": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "chapter4_status_code": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "city": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "code": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "contact_name": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "country": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "country_code": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "department_title": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "description": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "ein_type_ind": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "email": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "entity_type_cd": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "expected_version": {
            "anyOf": [
              {
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "filer_contact_email": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "filer_contact_first_name": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "filer_contact_last_name": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "filer_contact_phone": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "filer_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "filer_program": {
            "enum": [
              "app_1099_class",
              "app_1042s"
            ],
            "type": "string"
          },
          "filing_year": {
            "anyOf": [
              {
                "enum": [
                  2022,
                  2023,
                  2024,
                  2025,
                  2026
                ],
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "filing_year_text": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "foreign_city_state_zip": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "foreign_entity": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          },
          "foreign_tax_id": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "form_profiles": {
            "anyOf": [
              {
                "additionalProperties": {
                  "$ref": "#/components/schemas/FilerFormProfileInput"
                },
                "maxProperties": 100,
                "type": "object"
              },
              {
                "type": "null"
              }
            ]
          },
          "giin": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "last_filing_year_ind": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          },
          "last_year_filing": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          },
          "name": {
            "maxLength": 256,
            "minLength": 1,
            "type": "string"
          },
          "name1": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "name2": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "notes": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_first_nm": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_last_nm": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_middle_nm": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_suffix_nm": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "phone": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "postal_code": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "pro_rata_basis_rep_ind": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          },
          "province_code": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "recipient_contact_email": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "recipient_contact_name": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "second_name_line_t_agent": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          },
          "state": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "tax_id": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "telephone_number_and_extension": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "tin": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "tin_kind": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "tin_last4": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "withholding_ind": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "zip_code": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "zip_or_post_code": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "name",
          "filer_program"
        ],
        "type": "object"
      },
      "ApiV1ImportConfigureMappingRequest": {
        "additionalProperties": false,
        "properties": {
          "default_form_id": {
            "anyOf": [
              {
                "maxLength": 64,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "default_schema_rev": {
            "anyOf": [
              {
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "default_tax_year": {
            "anyOf": [
              {
                "enum": [
                  2022,
                  2023,
                  2024,
                  2025,
                  2026
                ],
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "expected_version": {
            "anyOf": [
              {
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "mapping": {
            "type": "object"
          },
          "submission_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "target_filer_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "submission_id",
          "mapping"
        ],
        "type": "object"
      },
      "ApiV1ImportCreateRequest": {
        "additionalProperties": false,
        "properties": {
          "content_type": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string"
          },
          "default_form_id": {
            "anyOf": [
              {
                "maxLength": 64,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "default_schema_rev": {
            "anyOf": [
              {
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "default_tax_year": {
            "anyOf": [
              {
                "enum": [
                  2022,
                  2023,
                  2024,
                  2025,
                  2026
                ],
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "file_name": {
            "maxLength": 180,
            "minLength": 1,
            "type": "string"
          },
          "filer_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "mapping": {
            "anyOf": [
              {
                "type": "object"
              },
              {
                "type": "null"
              }
            ]
          },
          "notify_email": {
            "anyOf": [
              {
                "format": "email",
                "maxLength": 254,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "provider": {
            "enum": [
              "spreadsheet",
              "custom_spreadsheet",
              "generic_spreadsheet"
            ],
            "type": "string"
          },
          "rows_per_chunk": {
            "anyOf": [
              {
                "maximum": 2000,
                "minimum": 100,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "sha256": {
            "anyOf": [
              {
                "pattern": "^[a-f0-9]{64}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "size_bytes": {
            "maximum": 26214400,
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "provider",
          "file_name",
          "content_type",
          "size_bytes"
        ],
        "type": "object"
      },
      "ApiV1ImportCreateResponse": {
        "additionalProperties": false,
        "properties": {
          "submission": {
            "$ref": "#/components/schemas/ApiV1ImportSubmission"
          },
          "upload_headers": {
            "additionalProperties": {
              "type": "string"
            },
            "type": "object"
          },
          "upload_method": {
            "const": "PUT"
          },
          "upload_url": {
            "format": "uri",
            "type": "string"
          }
        },
        "required": [
          "submission",
          "upload_url",
          "upload_method",
          "upload_headers"
        ],
        "type": "object"
      },
      "ApiV1ImportDeleteRequest": {
        "additionalProperties": false,
        "properties": {
          "expected_version": {
            "anyOf": [
              {
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "submission_id": {
            "$ref": "#/components/schemas/Uuid"
          }
        },
        "required": [
          "submission_id"
        ],
        "type": "object"
      },
      "ApiV1ImportGetManyRequest": {
        "additionalProperties": false,
        "properties": {
          "submission_ids": {
            "items": {
              "$ref": "#/components/schemas/Uuid"
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array",
            "uniqueItems": true
          }
        },
        "required": [
          "submission_ids"
        ],
        "type": "object"
      },
      "ApiV1ImportGetManyResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1ImportSubmission"
            },
            "maxItems": 100,
            "type": "array"
          },
          "missing": {
            "items": {
              "$ref": "#/components/schemas/Uuid"
            },
            "maxItems": 100,
            "type": "array"
          }
        },
        "required": [
          "items",
          "missing"
        ],
        "type": "object"
      },
      "ApiV1ImportGetRequest": {
        "additionalProperties": false,
        "properties": {
          "submission_id": {
            "$ref": "#/components/schemas/Uuid"
          }
        },
        "required": [
          "submission_id"
        ],
        "type": "object"
      },
      "ApiV1ImportInspectRequest": {
        "additionalProperties": false,
        "properties": {
          "preview_rows": {
            "anyOf": [
              {
                "maximum": 100,
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "submission_id": {
            "$ref": "#/components/schemas/Uuid"
          }
        },
        "required": [
          "submission_id"
        ],
        "type": "object"
      },
      "ApiV1ImportInspectResponse": {
        "additionalProperties": true,
        "properties": {
          "content_type": {
            "type": "string"
          },
          "detected_import_kind": {
            "description": "Determined from uploaded file contents. Native Publication 1220 uses pub1220.",
            "enum": [
              "unknown",
              "standard_template",
              "inline_filer_template",
              "pub1220",
              "advanced_mapping"
            ],
            "type": "string"
          },
          "file_name": {
            "type": "string"
          },
          "filer_id": {
            "format": "uuid",
            "type": [
              "string",
              "null"
            ]
          },
          "has_more": {
            "type": "boolean"
          },
          "provider": {
            "enum": [
              "spreadsheet",
              "custom_spreadsheet",
              "generic_spreadsheet",
              "quickbooks_online",
              "xero",
              "bill",
              "zoho_books",
              "freshbooks",
              "business_central"
            ],
            "type": "string"
          },
          "submission_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "target_scope": {
            "enum": [
              "single_filer",
              "multi_filer"
            ],
            "type": "string"
          },
          "total_rows": {
            "minimum": 0,
            "type": "integer"
          },
          "total_rows_exact": {
            "type": "boolean"
          },
          "version": {
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "submission_id",
          "version",
          "provider",
          "detected_import_kind",
          "target_scope",
          "file_name",
          "content_type",
          "total_rows",
          "total_rows_exact",
          "has_more"
        ],
        "type": "object"
      },
      "ApiV1ImportListResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1ImportSubmission"
            },
            "maxItems": 100,
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "maxLength": 4096,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "total_count": {
            "anyOf": [
              {
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "items"
        ],
        "type": "object"
      },
      "ApiV1ImportRow": {
        "additionalProperties": true,
        "properties": {
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "error_count": {
            "minimum": 0,
            "type": "integer"
          },
          "has_errors": {
            "type": "boolean"
          },
          "row_id": {
            "type": "string"
          },
          "row_number": {
            "minimum": 1,
            "type": "integer"
          },
          "status": {
            "type": "string"
          },
          "submission_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          },
          "version": {
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "submission_id",
          "row_id",
          "row_number",
          "status",
          "version",
          "has_errors",
          "error_count",
          "created_at",
          "updated_at"
        ],
        "type": "object"
      },
      "ApiV1ImportRowsListResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1ImportRow"
            },
            "maxItems": 100,
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "maxLength": 4096,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "total_count": {
            "anyOf": [
              {
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "items"
        ],
        "type": "object"
      },
      "ApiV1ImportStartRequest": {
        "additionalProperties": false,
        "properties": {
          "expected_version": {
            "anyOf": [
              {
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "submission_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "target_filer_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "submission_id"
        ],
        "type": "object"
      },
      "ApiV1ImportSubmission": {
        "additionalProperties": false,
        "properties": {
          "chunk_checksums": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array"
          },
          "completed_at": {
            "anyOf": [
              {
                "format": "date-time",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "content_type": {
            "maxLength": 128,
            "type": "string"
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "additionalProperties": true,
            "type": "object"
          },
          "created_by_user_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "default_form_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "default_schema_rev": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "default_tax_year": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "detected_import_kind": {
            "description": "Determined from uploaded file contents. Native Publication 1220 uses pub1220.",
            "enum": [
              "unknown",
              "standard_template",
              "inline_filer_template",
              "pub1220",
              "advanced_mapping"
            ],
            "type": "string"
          },
          "file_name": {
            "maxLength": 180,
            "type": "string"
          },
          "filer_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "final_checksum_sha256": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "imported_count": {
            "minimum": 0,
            "type": "integer"
          },
          "last_error": {
            "anyOf": [
              {
                "maxLength": 2000,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "mapping": {
            "anyOf": [
              {
                "type": "object"
              },
              {
                "type": "null"
              }
            ]
          },
          "next_row_number": {
            "minimum": 1,
            "type": "integer"
          },
          "notification_sent_at": {
            "anyOf": [
              {
                "format": "date-time",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "notify_email": {
            "anyOf": [
              {
                "format": "email",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "provider": {
            "enum": [
              "spreadsheet",
              "custom_spreadsheet",
              "generic_spreadsheet",
              "quickbooks_online",
              "xero",
              "bill",
              "zoho_books",
              "freshbooks",
              "business_central"
            ],
            "type": "string"
          },
          "pub1220_corrections_skipped": {
            "minimum": 0,
            "type": "integer"
          },
          "pub1220_counts_complete": {
            "type": "boolean"
          },
          "pub1220_mode": {
            "enum": [
              "general_information",
              "with_details"
            ],
            "type": "string"
          },
          "rolling_checksum_sha256": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "row_count_processed": {
            "minimum": 0,
            "type": "integer"
          },
          "row_count_total": {
            "minimum": 0,
            "type": "integer"
          },
          "rows_per_chunk": {
            "minimum": 1,
            "type": "integer"
          },
          "sha256": {
            "anyOf": [
              {
                "pattern": "^[a-f0-9]{64}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "size_bytes": {
            "minimum": 0,
            "type": "integer"
          },
          "skip_reason_counts": {
            "anyOf": [
              {
                "additionalProperties": {
                  "type": "integer"
                },
                "type": "object"
              },
              {
                "type": "null"
              }
            ]
          },
          "skipped_count": {
            "minimum": 0,
            "type": "integer"
          },
          "status": {
            "type": "string"
          },
          "submission_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "target_scope": {
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          },
          "validation_issue_count": {
            "minimum": 0,
            "type": "integer"
          },
          "version": {
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "submission_id",
          "provider",
          "detected_import_kind",
          "target_scope",
          "status",
          "version",
          "file_name",
          "content_type",
          "size_bytes",
          "rows_per_chunk",
          "next_row_number",
          "row_count_total",
          "row_count_processed",
          "imported_count",
          "skipped_count",
          "validation_issue_count",
          "created_by",
          "created_at",
          "updated_at"
        ],
        "type": "object"
      },
      "ApiV1Meta": {
        "additionalProperties": false,
        "properties": {
          "api_version": {
            "const": "v1"
          },
          "request_id": {
            "maxLength": 256,
            "minLength": 1,
            "type": "string"
          }
        },
        "required": [
          "api_version",
          "request_id"
        ],
        "type": "object"
      },
      "ApiV1OrderDeliverableDetail": {
        "additionalProperties": false,
        "properties": {
          "groups": {
            "items": {
              "$ref": "#/components/schemas/ApiV1OrderDeliverableGroup"
            },
            "type": "array"
          },
          "order": {
            "$ref": "#/components/schemas/ApiV1OrderDeliverableSummary"
          },
          "transmitter_defaults": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/OrderDeliverableTransmitterDefaults"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "order",
          "groups"
        ],
        "type": "object"
      },
      "ApiV1OrderDeliverableGetManyRequest": {
        "additionalProperties": false,
        "properties": {
          "order_ids": {
            "items": {
              "$ref": "#/components/schemas/Uuid"
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array",
            "uniqueItems": true
          },
          "service_code": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/OrderServiceCode"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "order_ids"
        ],
        "type": "object"
      },
      "ApiV1OrderDeliverableGetManyResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1OrderDeliverableDetail"
            },
            "maxItems": 100,
            "type": "array"
          },
          "missing": {
            "items": {
              "$ref": "#/components/schemas/Uuid"
            },
            "maxItems": 100,
            "type": "array"
          }
        },
        "required": [
          "items",
          "missing"
        ],
        "type": "object"
      },
      "ApiV1OrderDeliverableGetRequest": {
        "additionalProperties": false,
        "properties": {
          "order_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "service_code": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/OrderServiceCode"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "order_id"
        ],
        "type": "object"
      },
      "ApiV1OrderDeliverableGroup": {
        "additionalProperties": false,
        "properties": {
          "artifact_id": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "artifact_option_id": {
            "anyOf": [
              {
                "enum": [
                  "state_accepted",
                  "iris_xml_candidate",
                  "pub1220_candidate"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "documentation": {
            "$ref": "#/components/schemas/OrderDeliverableStateDocumentation"
          },
          "expires_at": {
            "anyOf": [
              {
                "format": "date-time",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "file_record_scope": {
            "anyOf": [
              {
                "enum": [
                  "qualified_records",
                  "all_state_records",
                  "withholding_only"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "file_status": {
            "enum": [
              "not_requested",
              "queued",
              "processing",
              "ready",
              "expired",
              "failed"
            ],
            "type": "string"
          },
          "form_id": {
            "maxLength": 64,
            "minLength": 1,
            "type": "string"
          },
          "last_error": {
            "anyOf": [
              {
                "maxLength": 2048,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "materialization_status": {
            "enum": [
              "snapshot_pending",
              "materializing",
              "ready",
              "failed",
              "canceled"
            ],
            "type": "string"
          },
          "order_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "recipient_count": {
            "minimum": 0,
            "type": "integer"
          },
          "record_count": {
            "minimum": 0,
            "type": "integer"
          },
          "service_code": {
            "$ref": "#/components/schemas/OrderServiceCode"
          },
          "state_code": {
            "pattern": "^[A-Z]{2}$",
            "type": "string"
          },
          "state_metrics": {
            "$ref": "#/components/schemas/OrderDeliverableStateMetrics"
          },
          "state_output": {
            "$ref": "#/components/schemas/OrderDeliverableStateOutput"
          },
          "tax_year": {
            "enum": [
              2022,
              2023,
              2024,
              2025,
              2026
            ],
            "type": "integer"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "order_id",
          "service_code",
          "form_id",
          "state_code",
          "tax_year",
          "recipient_count",
          "record_count",
          "materialization_status",
          "file_status",
          "state_metrics",
          "state_output",
          "documentation",
          "updated_at"
        ],
        "type": "object"
      },
      "ApiV1OrderDeliverableListResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1OrderDeliverableSummary"
            },
            "maxItems": 100,
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "maxLength": 4096,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "total_count": {
            "anyOf": [
              {
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "items"
        ],
        "type": "object"
      },
      "ApiV1OrderDeliverableRequestFileRequest": {
        "additionalProperties": false,
        "properties": {
          "artifact_option_id": {
            "enum": [
              "state_accepted",
              "iris_xml_candidate",
              "pub1220_candidate"
            ],
            "type": "string"
          },
          "documentation_acknowledged": {
            "default": false,
            "type": "boolean"
          },
          "form_id": {
            "maxLength": 64,
            "minLength": 1,
            "type": "string"
          },
          "order_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "record_scope": {
            "anyOf": [
              {
                "enum": [
                  "qualified_records",
                  "all_state_records",
                  "withholding_only"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "service_code": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/OrderServiceCode"
              },
              {
                "type": "null"
              }
            ]
          },
          "state_code": {
            "pattern": "^[A-Z]{2}$",
            "type": "string"
          },
          "state_supplemental_values": {
            "items": {
              "$ref": "#/components/schemas/OrderDeliverableStateSupplementalValue"
            },
            "maxItems": 20,
            "type": "array"
          },
          "transmitter_details": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/OrderDeliverableTransmitterDetails"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "order_id",
          "form_id",
          "state_code"
        ],
        "type": "object"
      },
      "ApiV1OrderDeliverableSummary": {
        "additionalProperties": false,
        "properties": {
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "filer_name": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "group_count": {
            "minimum": 0,
            "type": "integer"
          },
          "last_error": {
            "anyOf": [
              {
                "maxLength": 2048,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "materialization_status": {
            "enum": [
              "snapshot_pending",
              "materializing",
              "ready",
              "failed",
              "canceled"
            ],
            "type": "string"
          },
          "order_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "public_order_ref": {
            "anyOf": [
              {
                "maxLength": 128,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "recipient_count": {
            "minimum": 0,
            "type": "integer"
          },
          "record_count": {
            "minimum": 0,
            "type": "integer"
          },
          "service_code": {
            "$ref": "#/components/schemas/OrderServiceCode"
          },
          "service_name": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string"
          },
          "tax_year": {
            "enum": [
              2022,
              2023,
              2024,
              2025,
              2026
            ],
            "type": "integer"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "order_id",
          "service_code",
          "service_name",
          "filer_id",
          "tax_year",
          "materialization_status",
          "group_count",
          "recipient_count",
          "record_count",
          "created_at",
          "updated_at"
        ],
        "type": "object"
      },
      "ApiV1OrderDetail": {
        "additionalProperties": false,
        "properties": {
          "invoice": {
            "additionalProperties": true,
            "type": "object"
          },
          "order": {
            "$ref": "#/components/schemas/ApiV1OrderSummary"
          },
          "order_confirmation": {
            "additionalProperties": true,
            "type": "object"
          },
          "services": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array"
          }
        },
        "required": [
          "order",
          "services",
          "order_confirmation",
          "invoice"
        ],
        "type": "object"
      },
      "ApiV1OrderGetManyRequest": {
        "additionalProperties": false,
        "properties": {
          "order_ids": {
            "items": {
              "$ref": "#/components/schemas/Uuid"
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array",
            "uniqueItems": true
          }
        },
        "required": [
          "order_ids"
        ],
        "type": "object"
      },
      "ApiV1OrderGetManyResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1OrderDetail"
            },
            "maxItems": 100,
            "type": "array"
          },
          "missing": {
            "items": {
              "$ref": "#/components/schemas/Uuid"
            },
            "maxItems": 100,
            "type": "array"
          }
        },
        "required": [
          "items",
          "missing"
        ],
        "type": "object"
      },
      "ApiV1OrderGetRequest": {
        "additionalProperties": false,
        "properties": {
          "order_id": {
            "$ref": "#/components/schemas/Uuid"
          }
        },
        "required": [
          "order_id"
        ],
        "type": "object"
      },
      "ApiV1OrderListResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1OrderSummary"
            },
            "maxItems": 100,
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "maxLength": 4096,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "total_count": {
            "anyOf": [
              {
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "items"
        ],
        "type": "object"
      },
      "ApiV1OrderPreviewRequest": {
        "additionalProperties": false,
        "properties": {
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "funding_alias": {
            "maxLength": 64,
            "minLength": 1,
            "type": "string"
          },
          "service_codes": {
            "$ref": "#/components/schemas/OrderServiceCodes"
          },
          "tax_year": {
            "anyOf": [
              {
                "enum": [
                  2022,
                  2023,
                  2024,
                  2025,
                  2026
                ],
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "filer_id",
          "service_codes",
          "funding_alias"
        ],
        "type": "object"
      },
      "ApiV1OrderPreviewResponse": {
        "properties": {
          "blocked_released_recipients": {
            "minimum": 0,
            "type": "integer"
          },
          "blocked_tin_matched_recipients": {
            "minimum": 0,
            "type": "integer"
          },
          "blocked_unvalidated_recipients": {
            "minimum": 0,
            "type": "integer"
          },
          "currency": {
            "const": "USD"
          },
          "eligible_recipients": {
            "minimum": 0,
            "type": "integer"
          },
          "estimated_payment_due_minor": {
            "minimum": 0,
            "type": "integer"
          },
          "expected_total_minor": {
            "minimum": 0,
            "type": "integer"
          },
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "funding_kind": {
            "enum": [
              "deposit",
              "terms",
              "vaulted_instrument"
            ],
            "type": "string"
          },
          "policy_version": {
            "minimum": 1,
            "type": "integer"
          },
          "pricing_basis": {
            "$ref": "#/components/schemas/OrderPricingBasis"
          },
          "services": {
            "items": {
              "type": "object"
            },
            "type": "array"
          },
          "tax_year": {
            "type": [
              "integer",
              "null"
            ]
          }
        },
        "required": [
          "filer_id",
          "currency",
          "expected_total_minor",
          "policy_version",
          "funding_kind",
          "services"
        ],
        "type": "object"
      },
      "ApiV1OrderSubmitRequest": {
        "additionalProperties": false,
        "properties": {
          "expected_policy_version": {
            "minimum": 1,
            "type": "integer"
          },
          "expected_total_minor": {
            "minimum": 0,
            "type": "integer"
          },
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "funding_alias": {
            "maxLength": 64,
            "minLength": 1,
            "type": "string"
          },
          "order_signature_crypto": {
            "maxLength": 16384,
            "minLength": 1,
            "type": "string"
          },
          "service_codes": {
            "$ref": "#/components/schemas/OrderServiceCodes"
          },
          "tax_year": {
            "anyOf": [
              {
                "enum": [
                  2022,
                  2023,
                  2024,
                  2025,
                  2026
                ],
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "terms_accepted": {
            "const": true
          },
          "terms_version": {
            "maxLength": 64,
            "minLength": 1,
            "type": "string"
          }
        },
        "required": [
          "filer_id",
          "service_codes",
          "funding_alias",
          "expected_total_minor",
          "expected_policy_version",
          "terms_version",
          "terms_accepted",
          "order_signature_crypto"
        ],
        "type": "object"
      },
      "ApiV1OrderSubmitResponse": {
        "additionalProperties": false,
        "properties": {
          "funding_kind": {
            "enum": [
              "deposit",
              "terms",
              "vaulted_instrument"
            ],
            "type": "string"
          },
          "order": {
            "$ref": "#/components/schemas/ApiV1OrderDetail"
          },
          "payment_status": {
            "type": "string"
          },
          "policy_version": {
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "order",
          "payment_status",
          "funding_kind",
          "policy_version"
        ],
        "type": "object"
      },
      "ApiV1OrderSummary": {
        "additionalProperties": false,
        "properties": {
          "balance_due_minor": {
            "minimum": 0,
            "type": "integer"
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "currency": {
            "const": "USD"
          },
          "customer_deposit_applied_minor": {
            "minimum": 0,
            "type": "integer"
          },
          "customer_deposit_reserved_minor": {
            "minimum": 0,
            "type": "integer"
          },
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "from_import": {
            "type": "boolean"
          },
          "fulfillment_status": {
            "type": "string"
          },
          "hold": {
            "additionalProperties": true,
            "type": "object"
          },
          "import_run_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "import_source": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "imported_at": {
            "anyOf": [
              {
                "format": "date-time",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "last_error": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "order_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "payment_due_minor": {
            "minimum": 0,
            "type": "integer"
          },
          "payment_status": {
            "type": "string"
          },
          "public_order_ref": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "snapshot_chunk_completed": {
            "minimum": 0,
            "type": "integer"
          },
          "snapshot_chunk_total": {
            "minimum": 0,
            "type": "integer"
          },
          "snapshot_copied_recipients": {
            "minimum": 0,
            "type": "integer"
          },
          "snapshot_status": {
            "type": "string"
          },
          "snapshot_total_recipients": {
            "minimum": 0,
            "type": "integer"
          },
          "source_digest": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "source_external_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "source_external_ref": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "source_filing_system": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "source_platform": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "status": {
            "type": "string"
          },
          "tax_year": {
            "anyOf": [
              {
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "tenant_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "total_minor": {
            "minimum": 0,
            "type": "integer"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          },
          "version": {
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "tenant_id",
          "order_id",
          "filer_id",
          "status",
          "fulfillment_status",
          "snapshot_status",
          "payment_status",
          "hold",
          "currency",
          "total_minor",
          "balance_due_minor",
          "customer_deposit_reserved_minor",
          "customer_deposit_applied_minor",
          "payment_due_minor",
          "snapshot_total_recipients",
          "snapshot_copied_recipients",
          "snapshot_chunk_total",
          "snapshot_chunk_completed",
          "created_at",
          "updated_at",
          "version",
          "from_import"
        ],
        "type": "object"
      },
      "ApiV1PdfPrintJobsResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "additionalProperties": false,
              "properties": {
                "delivery_kind": {
                  "enum": [
                    "pdf",
                    "zip",
                    "manifest",
                    null
                  ],
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "download_url": {
                  "format": "uri",
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "export_id": {
                  "$ref": "#/components/schemas/Uuid"
                },
                "filer_id": {
                  "$ref": "#/components/schemas/Uuid"
                },
                "form_id": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "job_id": {
                  "$ref": "#/components/schemas/Uuid"
                },
                "recipient_form_count": {
                  "type": "integer"
                },
                "status": {
                  "anyOf": [
                    {
                      "enum": [
                        "queued",
                        "processing",
                        "merging",
                        "completed",
                        "failed"
                      ],
                      "type": "string"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "tax_year": {
                  "enum": [
                    2022,
                    2023,
                    2024,
                    2025,
                    2026
                  ],
                  "type": "integer"
                }
              },
              "required": [
                "job_id",
                "export_id",
                "filer_id",
                "tax_year",
                "form_id",
                "recipient_form_count",
                "status",
                "delivery_kind",
                "download_url"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "missing": {
            "items": {
              "$ref": "#/components/schemas/Uuid"
            },
            "type": "array"
          }
        },
        "required": [
          "items",
          "missing"
        ],
        "type": "object"
      },
      "ApiV1Recipient": {
        "additionalProperties": false,
        "description": "Recipient read view with annual form values. Mutation responses never echo a full Tax ID. Optional fields omitted by serialization are distinct from nullable values.",
        "properties": {
          "address_line1": {
            "description": "Common projection maintained by the backend from canonical APP form data on writes. Read-only as a business value: supplying this field to recipient upsert does not change it. Use data_app.forms for authoritative IRS field values. Existing historical records are not rewritten by reads; Tax ID redaction still applies.",
            "type": "string"
          },
          "address_line2": {
            "description": "Common projection maintained by the backend from canonical APP form data on writes. Read-only as a business value: supplying this field to recipient upsert does not change it. Use data_app.forms for authoritative IRS field values. Existing historical records are not rewritten by reads; Tax ID redaction still applies.",
            "type": "string"
          },
          "app_revision": {
            "type": "string"
          },
          "arch_bucket": {
            "type": "string"
          },
          "city": {
            "description": "Common projection maintained by the backend from canonical APP form data on writes. Read-only as a business value: supplying this field to recipient upsert does not change it. Use data_app.forms for authoritative IRS field values. Existing historical records are not rewritten by reads; Tax ID redaction still applies.",
            "type": "string"
          },
          "company_name": {
            "description": "Common projection maintained by the backend from canonical APP form data on writes. Read-only as a business value: supplying this field to recipient upsert does not change it. Use data_app.forms for authoritative IRS field values. Existing historical records are not rewritten by reads; Tax ID redaction still applies.",
            "type": "string"
          },
          "correction_type": {
            "type": "string"
          },
          "country": {
            "description": "Common projection maintained by the backend from canonical APP form data on writes. Read-only as a business value: supplying this field to recipient upsert does not change it. Use data_app.forms for authoritative IRS field values. Existing historical records are not rewritten by reads; Tax ID redaction still applies.",
            "type": "string"
          },
          "created_at": {
            "type": "string"
          },
          "data_app": {
            "additionalProperties": false,
            "properties": {
              "forms": {
                "items": {
                  "additionalProperties": false,
                  "properties": {
                    "app_revision": {
                      "type": "integer"
                    },
                    "correction_code": {
                      "type": "string"
                    },
                    "correction_type": {
                      "type": "string"
                    },
                    "data": {
                      "description": "Form values under the exact annual APP contract returned by the form catalog."
                    },
                    "data_ref": {
                      "type": "string"
                    },
                    "data_sha256": {
                      "type": "string"
                    },
                    "error_count": {
                      "type": "integer"
                    },
                    "filer_revision": {
                      "type": "integer"
                    },
                    "fire_revision": {
                      "type": "integer"
                    },
                    "fire_translation_contract_id": {
                      "type": "string"
                    },
                    "form_id": {
                      "type": "string"
                    },
                    "has_errors": {
                      "type": "boolean"
                    },
                    "iris_revision": {
                      "type": "integer"
                    },
                    "iris_translation_contract_id": {
                      "type": "string"
                    },
                    "is_corrected": {
                      "type": "boolean"
                    },
                    "schema_rev": {
                      "type": "integer"
                    },
                    "status": {
                      "type": "string"
                    },
                    "tax_year": {
                      "type": "integer"
                    },
                    "unique_record_id": {
                      "type": "string"
                    },
                    "updated_at": {
                      "type": "string"
                    },
                    "validation_issues": {
                      "items": {
                        "additionalProperties": false,
                        "properties": {
                          "code": {
                            "type": "string"
                          },
                          "field": {
                            "type": "string"
                          },
                          "message": {
                            "type": "string"
                          },
                          "origin": {
                            "type": "string"
                          }
                        },
                        "required": [
                          "code",
                          "message"
                        ],
                        "type": "object"
                      },
                      "type": "array"
                    }
                  },
                  "required": [
                    "app_revision",
                    "correction_code",
                    "error_count",
                    "form_id",
                    "has_errors",
                    "iris_revision",
                    "iris_translation_contract_id",
                    "schema_rev",
                    "status",
                    "tax_year",
                    "updated_at"
                  ],
                  "type": "object"
                },
                "type": "array"
              }
            },
            "required": [],
            "type": "object"
          },
          "display_name": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "filing_outcome": {
            "additionalProperties": false,
            "description": "Latest recorded IRS filing outcome and response summary. Absent until an outcome has been recorded. Provider acceptance and required customer action are distinct.",
            "properties": {
              "attempt_started_at": {
                "type": "string"
              },
              "bucket_id": {
                "type": "string"
              },
              "decision_digest": {
                "type": "string"
              },
              "evidence_digest": {
                "type": "string"
              },
              "filing_kind": {
                "enum": [
                  "original",
                  "correction"
                ],
                "type": "string"
              },
              "generation": {
                "type": "integer"
              },
              "item_id": {
                "type": "string"
              },
              "observed_at": {
                "type": "string"
              },
              "order_id": {
                "$ref": "#/components/schemas/Uuid"
              },
              "received_at": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "record_id": {
                "type": "integer"
              },
              "record_priority": {
                "type": "integer"
              },
              "recovery_case_id": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "response_generation": {
                "type": "integer"
              },
              "retry_source_run_id": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "run_id": {
                "type": "string"
              },
              "submission_id": {
                "type": "string"
              },
              "submitted_at": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "summary": {
                "additionalProperties": false,
                "properties": {
                  "acceptance": {
                    "enum": [
                      "accepted",
                      "rejected",
                      "processing",
                      "undetermined"
                    ],
                    "type": "string"
                  },
                  "conditions": {
                    "items": {
                      "enum": [
                        "attention_required",
                        "correction_required",
                        "rejected",
                        "review_required",
                        "technical_pending",
                        "terminal"
                      ],
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "contract_digest": {
                    "type": "string"
                  },
                  "contract_version": {
                    "description": "Historical outcomes retain their recorded response-policy version; this is independent of the APP form revision.",
                    "enum": [
                      "iris_response_contract_v1",
                      "iris_response_contract_v2"
                    ],
                    "type": "string"
                  },
                  "inherited_rejection": {
                    "type": "boolean"
                  },
                  "issue_count": {
                    "minimum": 0,
                    "type": "integer"
                  },
                  "next_action": {
                    "enum": [
                      "none",
                      "correct",
                      "repair_rejected",
                      "review",
                      "technical_handling",
                      "new_original"
                    ],
                    "type": "string"
                  },
                  "terminal_reason": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "unmatched_issue_count": {
                    "minimum": 0,
                    "type": "integer"
                  }
                },
                "readOnly": true,
                "required": [
                  "acceptance",
                  "conditions",
                  "contract_digest",
                  "contract_version",
                  "inherited_rejection",
                  "issue_count",
                  "next_action",
                  "terminal_reason",
                  "unmatched_issue_count"
                ],
                "type": "object"
              },
              "transmission_id": {
                "type": "string"
              }
            },
            "readOnly": true,
            "required": [
              "attempt_started_at",
              "bucket_id",
              "decision_digest",
              "evidence_digest",
              "filing_kind",
              "generation",
              "item_id",
              "observed_at",
              "order_id",
              "received_at",
              "record_id",
              "record_priority",
              "recovery_case_id",
              "response_generation",
              "retry_source_run_id",
              "run_id",
              "submission_id",
              "submitted_at",
              "summary",
              "transmission_id"
            ],
            "type": "object"
          },
          "fire_revision": {
            "type": "string"
          },
          "first_name": {
            "description": "Common projection maintained by the backend from canonical APP form data on writes. Read-only as a business value: supplying this field to recipient upsert does not change it. Use data_app.forms for authoritative IRS field values. Existing historical records are not rewritten by reads; Tax ID redaction still applies.",
            "type": "string"
          },
          "from_import": {
            "readOnly": true,
            "type": "boolean"
          },
          "immutable": {
            "readOnly": true,
            "type": "boolean"
          },
          "immutable_reason": {
            "readOnly": true,
            "type": "string"
          },
          "import_entity_type_cd": {
            "readOnly": true,
            "type": "string"
          },
          "import_entity_type_reason": {
            "readOnly": true,
            "type": "string"
          },
          "import_entity_type_source": {
            "readOnly": true,
            "type": "string"
          },
          "import_run_id": {
            "readOnly": true,
            "type": "string"
          },
          "import_source": {
            "readOnly": true,
            "type": "string"
          },
          "imported_at": {
            "readOnly": true,
            "type": "string"
          },
          "iris_repair_submission": {
            "anyOf": [
              {
                "additionalProperties": false,
                "properties": {
                  "case_ids": {
                    "items": {
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "generation": {
                    "type": "integer"
                  },
                  "request_sha256": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "source_run_id": {
                    "type": "string"
                  },
                  "source_version": {
                    "type": "integer"
                  },
                  "submitted_at": {
                    "type": "string"
                  }
                },
                "readOnly": true,
                "required": [
                  "case_ids",
                  "generation",
                  "request_sha256",
                  "source_run_id",
                  "source_version",
                  "submitted_at"
                ],
                "type": "object"
              },
              {
                "type": "null"
              }
            ],
            "description": "Recorded authorization to repair rejected filing records. Null when no repair has been submitted; this is not IRS acceptance.",
            "readOnly": true
          },
          "iris_revision": {
            "type": "string"
          },
          "is_archived": {
            "type": "boolean"
          },
          "is_btin_validated": {
            "type": "boolean"
          },
          "is_corrected": {
            "type": "boolean"
          },
          "is_released": {
            "type": "boolean"
          },
          "is_tin_match_pending": {
            "type": "boolean"
          },
          "is_tin_matched": {
            "type": "boolean"
          },
          "is_validated": {
            "type": "boolean"
          },
          "last_name": {
            "description": "Common projection maintained by the backend from canonical APP form data on writes. Read-only as a business value: supplying this field to recipient upsert does not change it. Use data_app.forms for authoritative IRS field values. Existing historical records are not rewritten by reads; Tax ID redaction still applies.",
            "type": "string"
          },
          "last_tin_match_result": {
            "type": "string"
          },
          "middle_name": {
            "description": "Common projection maintained by the backend from canonical APP form data on writes. Read-only as a business value: supplying this field to recipient upsert does not change it. Use data_app.forms for authoritative IRS field values. Existing historical records are not rewritten by reads; Tax ID redaction still applies.",
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "postal_code": {
            "description": "Common projection maintained by the backend from canonical APP form data on writes. Read-only as a business value: supplying this field to recipient upsert does not change it. Use data_app.forms for authoritative IRS field values. Existing historical records are not rewritten by reads; Tax ID redaction still applies.",
            "type": "string"
          },
          "recipient_filing": {
            "additionalProperties": false,
            "description": "Historical filing provenance. This metadata alone does not authorize a correction.",
            "properties": {
              "accepted_amendment_count": {
                "maximum": 65535,
                "minimum": 0,
                "type": "integer"
              },
              "external_predecessor_sha256": {
                "type": "string"
              },
              "scope": {
                "type": "string"
              },
              "source_filing_state": {
                "enum": [
                  "unfiled",
                  "fire_released"
                ],
                "type": "string"
              },
              "source_group_sha256": {
                "type": "string"
              },
              "source_is_corrected": {
                "type": "boolean"
              }
            },
            "readOnly": true,
            "required": [
              "scope",
              "source_filing_state",
              "source_group_sha256",
              "source_is_corrected"
            ],
            "type": "object"
          },
          "recipient_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "source_correction_system": {
            "readOnly": true,
            "type": "string"
          },
          "source_digest": {
            "readOnly": true,
            "type": "string"
          },
          "source_external_id": {
            "readOnly": true,
            "type": "string"
          },
          "source_external_ref": {
            "readOnly": true,
            "type": "string"
          },
          "source_filing_system": {
            "readOnly": true,
            "type": "string"
          },
          "source_platform": {
            "readOnly": true,
            "type": "string"
          },
          "state": {
            "description": "Common projection maintained by the backend from canonical APP form data on writes. Read-only as a business value: supplying this field to recipient upsert does not change it. Use data_app.forms for authoritative IRS field values. Existing historical records are not rewritten by reads; Tax ID redaction still applies.",
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "target_filing_system": {
            "readOnly": true,
            "type": "string"
          },
          "tin": {
            "description": "Common projection maintained by the backend from canonical APP form data on writes. Read-only as a business value: supplying this field to recipient upsert does not change it. Use data_app.forms for authoritative IRS field values. Existing historical records are not rewritten by reads; Tax ID redaction still applies.",
            "type": "string"
          },
          "tin_kind": {
            "type": "string"
          },
          "tin_last4": {
            "type": "string"
          },
          "transition_correction_policy": {
            "readOnly": true,
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          },
          "validation_issue_count": {
            "type": "integer"
          },
          "validation_issues": {
            "items": {
              "additionalProperties": false,
              "properties": {
                "code": {
                  "type": "string"
                },
                "field": {
                  "type": "string"
                },
                "message": {
                  "type": "string"
                },
                "origin": {
                  "type": "string"
                }
              },
              "required": [
                "code",
                "message"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "version": {
            "type": "integer"
          }
        },
        "required": [
          "arch_bucket",
          "correction_type",
          "created_at",
          "data_app",
          "display_name",
          "filer_id",
          "from_import",
          "immutable",
          "iris_repair_submission",
          "is_archived",
          "is_btin_validated",
          "is_corrected",
          "is_released",
          "is_tin_match_pending",
          "is_tin_matched",
          "is_validated",
          "recipient_id",
          "status",
          "updated_at",
          "validation_issue_count",
          "version"
        ],
        "type": "object"
      },
      "ApiV1RecipientDedupeApplyRequest": {
        "additionalProperties": false,
        "properties": {
          "chunk_size": {
            "anyOf": [
              {
                "maximum": 100,
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "delete_recipients": {
            "items": {
              "$ref": "#/components/schemas/RecipientDeleteTargetInput"
            },
            "maxItems": 100,
            "type": "array"
          },
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "survivor": {
            "additionalProperties": false,
            "description": "Save one canonical APP form. Common identity and mailing-address fields are backend-maintained projections, not independent inputs. Supply IRS values in forms[0].data using its exact form_id/tax_year/schema_rev contract. Full Tax ID writes require tax_ids.write and are never echoed.",
            "properties": {
              "address_line1": {
                "anyOf": [
                  {
                    "maxLength": 160,
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "Backend-maintained common projection of the selected primary-party mailing street field in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
              },
              "address_line2": {
                "anyOf": [
                  {
                    "maxLength": 160,
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "Backend-maintained common projection of the selected primary-party second mailing address line in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
              },
              "city": {
                "anyOf": [
                  {
                    "maxLength": 80,
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "Backend-maintained common projection of the selected primary-party mailing city in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
              },
              "company_name": {
                "anyOf": [
                  {
                    "maxLength": 256,
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "Backend-maintained common projection of Name1, or the annual contract's primary-party business-name field in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
              },
              "country": {
                "anyOf": [
                  {
                    "maxLength": 80,
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "Backend-maintained common projection of US for the domestic mailing address choice, or CountryCode for the foreign choice, or the corresponding primary-party field in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
              },
              "display_name": {
                "description": "Operator display label, independently editable; does not replace the IRS filing name in forms[0].data.",
                "maxLength": 256,
                "minLength": 1,
                "type": "string"
              },
              "email": {
                "anyOf": [
                  {
                    "format": "email",
                    "maxLength": 254,
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "Operational recipient delivery/contact email. Independently editable; not a projection of an IRS form field."
              },
              "expected_version": {
                "anyOf": [
                  {
                    "minimum": 1,
                    "type": "integer"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "filer_id": {
                "$ref": "#/components/schemas/Uuid"
              },
              "first_name": {
                "anyOf": [
                  {
                    "maxLength": 160,
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "Backend-maintained common projection of PersonFirstNm, or the annual contract's primary-party first-name field in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
              },
              "forms": {
                "items": {
                  "$ref": "#/components/schemas/RecipientFormInput"
                },
                "maxItems": 1,
                "minItems": 1,
                "type": "array"
              },
              "last_name": {
                "anyOf": [
                  {
                    "maxLength": 160,
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "Backend-maintained common projection of PersonLastNm, or the annual contract's primary-party last-name field in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
              },
              "middle_name": {
                "anyOf": [
                  {
                    "maxLength": 160,
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "Backend-maintained common projection of PersonMiddleNm, or the annual contract's primary-party middle-name field in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
              },
              "phone": {
                "anyOf": [
                  {
                    "maxLength": 32,
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "Operational contact phone. Independently editable; not a projection of an IRS form field."
              },
              "postal_code": {
                "anyOf": [
                  {
                    "maxLength": 32,
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "Backend-maintained common projection of ZipCode for a domestic address or ForeignPostalCd for a foreign address, or the corresponding primary-party field in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
              },
              "recipient_id": {
                "anyOf": [
                  {
                    "$ref": "#/components/schemas/Uuid"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "state": {
                "anyOf": [
                  {
                    "maxLength": 80,
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "Backend-maintained common projection of State for a domestic address or ProvinceCode for a foreign address, or the corresponding primary-party field in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
              },
              "tin": {
                "anyOf": [
                  {
                    "maxLength": 32,
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ],
                "description": "Backend-maintained common projection of TaxID, or the annual contract's primary-party TIN field (the common copy is digits-only) in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
              }
            },
            "required": [
              "filer_id",
              "display_name",
              "forms"
            ],
            "type": "object"
          }
        },
        "required": [
          "filer_id",
          "survivor"
        ],
        "type": "object"
      },
      "ApiV1RecipientDedupeApplyResponse": {
        "additionalProperties": false,
        "properties": {
          "chunk_count": {
            "minimum": 0,
            "type": "integer"
          },
          "deleted_recipient_ids": {
            "items": {
              "$ref": "#/components/schemas/Uuid"
            },
            "type": "array"
          },
          "survivor": {
            "$ref": "#/components/schemas/ApiV1Recipient"
          }
        },
        "required": [
          "survivor",
          "deleted_recipient_ids",
          "chunk_count"
        ],
        "type": "object"
      },
      "ApiV1RecipientDedupeGroup": {
        "additionalProperties": false,
        "properties": {
          "form_id": {
            "type": "string"
          },
          "recipient_count": {
            "minimum": 2,
            "type": "integer"
          },
          "recipient_ids": {
            "items": {
              "$ref": "#/components/schemas/Uuid"
            },
            "type": "array"
          },
          "recipient_ids_truncated": {
            "type": "boolean"
          },
          "tin": {
            "description": "Always masked.",
            "type": "string"
          }
        },
        "required": [
          "tin",
          "form_id",
          "recipient_ids",
          "recipient_count",
          "recipient_ids_truncated"
        ],
        "type": "object"
      },
      "ApiV1RecipientDedupeGroupsResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1RecipientDedupeGroup"
            },
            "maxItems": 100,
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "maxLength": 4096,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "total_count": {
            "anyOf": [
              {
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "items"
        ],
        "type": "object"
      },
      "ApiV1RecipientDeleteRequest": {
        "additionalProperties": false,
        "properties": {
          "expected_version": {
            "minimum": 1,
            "type": "integer"
          },
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "recipient_id": {
            "$ref": "#/components/schemas/Uuid"
          }
        },
        "required": [
          "filer_id",
          "recipient_id",
          "expected_version"
        ],
        "type": "object"
      },
      "ApiV1RecipientDeleteResponse": {
        "additionalProperties": false,
        "properties": {
          "recipient_id": {
            "$ref": "#/components/schemas/Uuid"
          }
        },
        "required": [
          "recipient_id"
        ],
        "type": "object"
      },
      "ApiV1RecipientGetManyRequest": {
        "additionalProperties": false,
        "properties": {
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "recipient_ids": {
            "items": {
              "$ref": "#/components/schemas/Uuid"
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array",
            "uniqueItems": true
          }
        },
        "required": [
          "filer_id",
          "recipient_ids"
        ],
        "type": "object"
      },
      "ApiV1RecipientGetManyResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1Recipient"
            },
            "maxItems": 100,
            "type": "array"
          },
          "missing": {
            "items": {
              "$ref": "#/components/schemas/Uuid"
            },
            "maxItems": 100,
            "type": "array"
          }
        },
        "required": [
          "items",
          "missing"
        ],
        "type": "object"
      },
      "ApiV1RecipientGetRequest": {
        "additionalProperties": false,
        "properties": {
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "recipient_id": {
            "$ref": "#/components/schemas/Uuid"
          }
        },
        "required": [
          "filer_id",
          "recipient_id"
        ],
        "type": "object"
      },
      "ApiV1RecipientHistory": {
        "additionalProperties": false,
        "properties": {
          "actor_id": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "actor_type": {
            "type": "string"
          },
          "event_at": {
            "format": "date-time",
            "type": "string"
          },
          "event_family": {
            "type": "string"
          },
          "event_type": {
            "type": "string"
          },
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "history_id": {
            "type": "string"
          },
          "line_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "order_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "payload": {
            "additionalProperties": true,
            "type": "object"
          },
          "provider": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "recipient_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "recipient_record_state": {
            "enum": [
              "active",
              "archived",
              "deleted",
              "orphaned"
            ],
            "type": "string"
          },
          "service_code": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "status": {
            "type": "string"
          }
        },
        "required": [
          "history_id",
          "filer_id",
          "recipient_id",
          "event_type",
          "event_family",
          "event_at",
          "actor_type",
          "status",
          "recipient_record_state",
          "payload"
        ],
        "type": "object"
      },
      "ApiV1RecipientHistoryListResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1RecipientHistory"
            },
            "maxItems": 100,
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "maxLength": 4096,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "total_count": {
            "anyOf": [
              {
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "items"
        ],
        "type": "object"
      },
      "ApiV1RecipientListResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1Recipient"
            },
            "maxItems": 100,
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "maxLength": 4096,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "total_count": {
            "anyOf": [
              {
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "items"
        ],
        "type": "object"
      },
      "ApiV1RecipientPrintResponse": {
        "oneOf": [
          {
            "additionalProperties": false,
            "properties": {
              "execution_mode": {
                "const": "immediate"
              },
              "expires_at_epoch": {
                "type": "integer"
              },
              "filer_id": {
                "$ref": "#/components/schemas/Uuid"
              },
              "form_id": {
                "type": "string"
              },
              "page_count": {
                "type": "integer"
              },
              "recipient_id": {
                "$ref": "#/components/schemas/Uuid"
              },
              "schema_rev": {
                "type": "integer"
              },
              "statement_count": {
                "type": "integer"
              },
              "tax_year": {
                "enum": [
                  2022,
                  2023,
                  2024,
                  2025,
                  2026
                ],
                "type": "integer"
              },
              "transaction_count": {
                "type": "integer"
              },
              "url": {
                "format": "uri",
                "type": "string"
              }
            },
            "required": [
              "execution_mode",
              "filer_id",
              "recipient_id",
              "form_id",
              "tax_year",
              "schema_rev",
              "transaction_count",
              "statement_count",
              "page_count",
              "url",
              "expires_at_epoch"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "already_scheduled": {
                "type": "boolean"
              },
              "chunk_size": {
                "type": "integer"
              },
              "download_url": {
                "format": "uri",
                "type": "string"
              },
              "execution_mode": {
                "const": "scheduled"
              },
              "export_id": {
                "$ref": "#/components/schemas/Uuid"
              },
              "filer_id": {
                "$ref": "#/components/schemas/Uuid"
              },
              "form_id": {
                "type": "string"
              },
              "mode": {
                "enum": [
                  "all",
                  "corrected",
                  "uncorrected"
                ],
                "type": "string"
              },
              "recipient_form_count": {
                "type": "integer"
              },
              "status": {
                "enum": [
                  "queued",
                  "processing",
                  "merging",
                  "completed",
                  "failed"
                ],
                "type": "string"
              },
              "tax_year": {
                "enum": [
                  2022,
                  2023,
                  2024,
                  2025,
                  2026
                ],
                "type": "integer"
              }
            },
            "required": [
              "execution_mode",
              "export_id",
              "status",
              "filer_id",
              "tax_year",
              "mode",
              "recipient_form_count",
              "chunk_size",
              "already_scheduled"
            ],
            "type": "object"
          }
        ]
      },
      "ApiV1RecipientUpsertRequest": {
        "additionalProperties": false,
        "description": "Save one canonical APP form. Common identity and mailing-address fields are backend-maintained projections, not independent inputs. Supply IRS values in forms[0].data using its exact form_id/tax_year/schema_rev contract. Full Tax ID writes require tax_ids.write and are never echoed.",
        "properties": {
          "address_line1": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Backend-maintained common projection of the selected primary-party mailing street field in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
          },
          "address_line2": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Backend-maintained common projection of the selected primary-party second mailing address line in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
          },
          "city": {
            "anyOf": [
              {
                "maxLength": 80,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Backend-maintained common projection of the selected primary-party mailing city in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
          },
          "company_name": {
            "anyOf": [
              {
                "maxLength": 256,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Backend-maintained common projection of Name1, or the annual contract's primary-party business-name field in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
          },
          "country": {
            "anyOf": [
              {
                "maxLength": 80,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Backend-maintained common projection of US for the domestic mailing address choice, or CountryCode for the foreign choice, or the corresponding primary-party field in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
          },
          "display_name": {
            "description": "Operator display label, independently editable; does not replace the IRS filing name in forms[0].data.",
            "maxLength": 256,
            "minLength": 1,
            "type": "string"
          },
          "email": {
            "anyOf": [
              {
                "format": "email",
                "maxLength": 254,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Operational recipient delivery/contact email. Independently editable; not a projection of an IRS form field."
          },
          "expected_version": {
            "anyOf": [
              {
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "first_name": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Backend-maintained common projection of PersonFirstNm, or the annual contract's primary-party first-name field in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
          },
          "forms": {
            "items": {
              "$ref": "#/components/schemas/RecipientFormInput"
            },
            "maxItems": 1,
            "minItems": 1,
            "type": "array"
          },
          "last_name": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Backend-maintained common projection of PersonLastNm, or the annual contract's primary-party last-name field in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
          },
          "middle_name": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Backend-maintained common projection of PersonMiddleNm, or the annual contract's primary-party middle-name field in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
          },
          "phone": {
            "anyOf": [
              {
                "maxLength": 32,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Operational contact phone. Independently editable; not a projection of an IRS form field."
          },
          "postal_code": {
            "anyOf": [
              {
                "maxLength": 32,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Backend-maintained common projection of ZipCode for a domestic address or ForeignPostalCd for a foreign address, or the corresponding primary-party field in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
          },
          "recipient_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "state": {
            "anyOf": [
              {
                "maxLength": 80,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Backend-maintained common projection of State for a domestic address or ProvinceCode for a foreign address, or the corresponding primary-party field in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
          },
          "tin": {
            "anyOf": [
              {
                "maxLength": 32,
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "description": "Backend-maintained common projection of TaxID, or the annual contract's primary-party TIN field (the common copy is digits-only) in forms[0].data. Incoming values are disregarded for persistence; omit this legacy input. Normal JSON/envelope constraints still apply. Missing or blank optional APP values clear the projection; a separate common value never fills an APP field."
          }
        },
        "required": [
          "filer_id",
          "display_name",
          "forms"
        ],
        "type": "object"
      },
      "ApiV1SuccessEnvelope": {
        "additionalProperties": false,
        "properties": {
          "data": {},
          "meta": {
            "$ref": "#/components/schemas/ApiV1Meta"
          }
        },
        "required": [
          "data",
          "meta"
        ],
        "type": "object"
      },
      "ApiV1W9ConvertResponse": {
        "additionalProperties": false,
        "properties": {
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "form_id": {
            "type": "string"
          },
          "recipient_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "request": {
            "$ref": "#/components/schemas/ApiV1W9Request"
          },
          "schema_rev": {
            "minimum": 1,
            "type": "integer"
          },
          "status": {
            "const": "converted"
          },
          "tax_year": {
            "type": "integer"
          }
        },
        "required": [
          "status",
          "request",
          "filer_id",
          "recipient_id"
        ],
        "type": "object"
      },
      "ApiV1W9DispatchResponse": {
        "additionalProperties": false,
        "properties": {
          "dispatched": {
            "items": {
              "$ref": "#/components/schemas/ApiV1W9Request"
            },
            "type": "array"
          },
          "run": {
            "additionalProperties": true,
            "type": "object"
          }
        },
        "required": [
          "run",
          "dispatched"
        ],
        "type": "object"
      },
      "ApiV1W9ImportCreateRequest": {
        "additionalProperties": false,
        "properties": {
          "dispatch_immediately": {
            "default": false,
            "type": "boolean"
          },
          "file_name": {
            "maxLength": 80,
            "minLength": 1,
            "type": "string"
          },
          "issuer_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "rows": {
            "items": {
              "$ref": "#/components/schemas/W9ImportRowInput"
            },
            "maxItems": 1000,
            "minItems": 1,
            "type": "array"
          }
        },
        "required": [
          "file_name",
          "rows"
        ],
        "type": "object"
      },
      "ApiV1W9ImportCreateUploadRequest": {
        "additionalProperties": false,
        "properties": {
          "content_type": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string"
          },
          "dispatch_immediately": {
            "default": false,
            "type": "boolean"
          },
          "file_name": {
            "maxLength": 180,
            "minLength": 1,
            "type": "string"
          },
          "issuer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "notify_email": {
            "anyOf": [
              {
                "format": "email",
                "maxLength": 254,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "rows_per_chunk": {
            "anyOf": [
              {
                "maximum": 1000,
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "sha256": {
            "anyOf": [
              {
                "pattern": "^[a-f0-9]{64}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "size_bytes": {
            "maximum": 26214400,
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "file_name",
          "content_type",
          "size_bytes",
          "issuer_id"
        ],
        "type": "object"
      },
      "ApiV1W9ImportCreateUploadResponse": {
        "additionalProperties": false,
        "properties": {
          "submission": {
            "$ref": "#/components/schemas/ApiV1W9ImportSubmission"
          },
          "upload_headers": {
            "additionalProperties": {
              "type": "string"
            },
            "type": "object"
          },
          "upload_method": {
            "const": "PUT"
          },
          "upload_url": {
            "format": "uri",
            "type": "string"
          }
        },
        "required": [
          "submission",
          "upload_url",
          "upload_method",
          "upload_headers"
        ],
        "type": "object"
      },
      "ApiV1W9ImportInspectRequest": {
        "additionalProperties": false,
        "properties": {
          "preview_rows": {
            "anyOf": [
              {
                "maximum": 100,
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "submission_id": {
            "$ref": "#/components/schemas/Uuid"
          }
        },
        "required": [
          "submission_id"
        ],
        "type": "object"
      },
      "ApiV1W9ImportInspectResponse": {
        "additionalProperties": true,
        "properties": {
          "content_type": {
            "type": "string"
          },
          "file_name": {
            "type": "string"
          },
          "has_more": {
            "type": "boolean"
          },
          "submission_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "total_rows": {
            "minimum": 0,
            "type": "integer"
          },
          "total_rows_exact": {
            "type": "boolean"
          }
        },
        "required": [
          "submission_id",
          "file_name",
          "content_type",
          "total_rows",
          "total_rows_exact",
          "has_more"
        ],
        "type": "object"
      },
      "ApiV1W9ImportListResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1W9ImportSubmission"
            },
            "maxItems": 100,
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "maxLength": 4096,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "total_count": {
            "anyOf": [
              {
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "items"
        ],
        "type": "object"
      },
      "ApiV1W9ImportRow": {
        "additionalProperties": true,
        "properties": {
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "email": {
            "format": "email",
            "type": "string"
          },
          "row_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "row_number": {
            "minimum": 1,
            "type": "integer"
          },
          "status": {
            "type": "string"
          },
          "submission_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "tin_last4": {
            "type": [
              "string",
              "null"
            ]
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "submission_id",
          "row_id",
          "row_number",
          "status",
          "email",
          "created_at",
          "updated_at"
        ],
        "type": "object"
      },
      "ApiV1W9ImportRowsListResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1W9ImportRow"
            },
            "maxItems": 100,
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "maxLength": 4096,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "total_count": {
            "anyOf": [
              {
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "items"
        ],
        "type": "object"
      },
      "ApiV1W9ImportStartRequest": {
        "additionalProperties": false,
        "properties": {
          "expected_version": {
            "anyOf": [
              {
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "submission_id": {
            "$ref": "#/components/schemas/Uuid"
          }
        },
        "required": [
          "submission_id"
        ],
        "type": "object"
      },
      "ApiV1W9ImportSubmission": {
        "additionalProperties": false,
        "properties": {
          "content_type": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "additionalProperties": true,
            "type": "object"
          },
          "created_by_user_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "dispatch_requested": {
            "type": "boolean"
          },
          "dispatched_count": {
            "minimum": 0,
            "type": "integer"
          },
          "file_name": {
            "type": "string"
          },
          "issuer_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "notify_email": {
            "anyOf": [
              {
                "format": "email",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "request_count_created": {
            "minimum": 0,
            "type": "integer"
          },
          "row_count_processed": {
            "minimum": 0,
            "type": "integer"
          },
          "row_count_total": {
            "minimum": 0,
            "type": "integer"
          },
          "rows_per_chunk": {
            "minimum": 1,
            "type": "integer"
          },
          "size_bytes": {
            "anyOf": [
              {
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "skipped_count": {
            "minimum": 0,
            "type": "integer"
          },
          "source_stage_completed": {
            "type": "boolean"
          },
          "status": {
            "type": "string"
          },
          "submission_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          },
          "version": {
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "submission_id",
          "status",
          "file_name",
          "row_count_total",
          "request_count_created",
          "dispatch_requested",
          "row_count_processed",
          "dispatched_count",
          "skipped_count",
          "source_stage_completed",
          "rows_per_chunk",
          "version",
          "created_by",
          "created_at",
          "updated_at"
        ],
        "type": "object"
      },
      "ApiV1W9Issuer": {
        "additionalProperties": false,
        "properties": {
          "address_line1": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "address_line2": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "arch_bucket": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "city": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "contact_email": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "contact_name": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "country": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "dba_name": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "display_name": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "entity_type_cd": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "is_archived": {
            "type": "boolean"
          },
          "issuer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "legal_name": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "name1": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "name2": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_first_nm": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_last_nm": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_middle_nm": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_suffix_nm": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "phone": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "postal_code": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "source_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "source_type": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "state": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "status": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          },
          "version": {
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "issuer_id",
          "status",
          "is_archived",
          "arch_bucket",
          "source_type",
          "display_name",
          "legal_name",
          "version",
          "created_at",
          "updated_at"
        ],
        "type": "object"
      },
      "ApiV1W9IssuerGetManyRequest": {
        "additionalProperties": false,
        "properties": {
          "issuer_ids": {
            "items": {
              "$ref": "#/components/schemas/Uuid"
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array",
            "uniqueItems": true
          }
        },
        "required": [
          "issuer_ids"
        ],
        "type": "object"
      },
      "ApiV1W9IssuerGetManyResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1W9Issuer"
            },
            "maxItems": 100,
            "type": "array"
          },
          "missing": {
            "items": {
              "$ref": "#/components/schemas/Uuid"
            },
            "maxItems": 100,
            "type": "array"
          }
        },
        "required": [
          "items",
          "missing"
        ],
        "type": "object"
      },
      "ApiV1W9IssuerListResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1W9Issuer"
            },
            "maxItems": 100,
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "maxLength": 4096,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "total_count": {
            "anyOf": [
              {
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "items"
        ],
        "type": "object"
      },
      "ApiV1W9IssuerUpsertRequest": {
        "additionalProperties": false,
        "properties": {
          "address_line1": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "address_line2": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "city": {
            "anyOf": [
              {
                "maxLength": 80,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "contact_email": {
            "anyOf": [
              {
                "format": "email",
                "maxLength": 254,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "contact_name": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "country": {
            "anyOf": [
              {
                "maxLength": 80,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "dba_name": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "display_name": {
            "maxLength": 160,
            "minLength": 1,
            "type": "string"
          },
          "entity_type_cd": {
            "anyOf": [
              {
                "enum": [
                  "B",
                  "I"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "expected_version": {
            "anyOf": [
              {
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "issuer_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "legal_name": {
            "maxLength": 160,
            "minLength": 1,
            "type": "string"
          },
          "name1": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "name2": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_first_nm": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_last_nm": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_middle_nm": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_suffix_nm": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "phone": {
            "anyOf": [
              {
                "maxLength": 32,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "postal_code": {
            "anyOf": [
              {
                "maxLength": 80,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "source_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "source_type": {
            "anyOf": [
              {
                "enum": [
                  "customer_account",
                  "filer",
                  "manual"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "state": {
            "anyOf": [
              {
                "maxLength": 80,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "status": {
            "anyOf": [
              {
                "enum": [
                  "active",
                  "archived"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "display_name",
          "legal_name"
        ],
        "type": "object"
      },
      "ApiV1W9RecipientMatches": {
        "additionalProperties": true,
        "properties": {
          "items": {
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array"
          },
          "request_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "truncated": {
            "type": "boolean"
          }
        },
        "required": [
          "request_id",
          "items",
          "truncated"
        ],
        "type": "object"
      },
      "ApiV1W9RecipientMatchesGetManyRequest": {
        "additionalProperties": false,
        "properties": {
          "request_ids": {
            "items": {
              "$ref": "#/components/schemas/Uuid"
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array",
            "uniqueItems": true
          }
        },
        "required": [
          "request_ids"
        ],
        "type": "object"
      },
      "ApiV1W9RecipientMatchesGetManyResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1W9RecipientMatches"
            },
            "maxItems": 100,
            "type": "array"
          },
          "missing": {
            "items": {
              "$ref": "#/components/schemas/Uuid"
            },
            "maxItems": 100,
            "type": "array"
          }
        },
        "required": [
          "items",
          "missing"
        ],
        "type": "object"
      },
      "ApiV1W9ReconfirmationGetManyRequest": {
        "additionalProperties": false,
        "properties": {
          "targets": {
            "items": {
              "$ref": "#/components/schemas/W9RecipientTargetInput"
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array"
          }
        },
        "required": [
          "targets"
        ],
        "type": "object"
      },
      "ApiV1W9ReconfirmationGetManyResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1W9ReconfirmationLink"
            },
            "maxItems": 100,
            "type": "array"
          },
          "missing": {
            "items": {
              "$ref": "#/components/schemas/W9RecipientTargetInput"
            },
            "maxItems": 100,
            "type": "array"
          }
        },
        "required": [
          "items",
          "missing"
        ],
        "type": "object"
      },
      "ApiV1W9ReconfirmationLink": {
        "additionalProperties": true,
        "properties": {
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "recipient_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          },
          "version": {
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "filer_id",
          "recipient_id",
          "version",
          "created_at",
          "updated_at"
        ],
        "type": "object"
      },
      "ApiV1W9ReconfirmationResponse": {
        "additionalProperties": false,
        "properties": {
          "link": {
            "$ref": "#/components/schemas/ApiV1W9ReconfirmationLink"
          },
          "request": {
            "$ref": "#/components/schemas/ApiV1W9Request"
          }
        },
        "required": [
          "request",
          "link"
        ],
        "type": "object"
      },
      "ApiV1W9ReconfirmationUpsertRequest": {
        "additionalProperties": false,
        "properties": {
          "expected_recipient_version": {
            "minimum": 1,
            "type": "integer"
          },
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "recipient_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "send_immediately": {
            "default": false,
            "type": "boolean"
          }
        },
        "required": [
          "filer_id",
          "recipient_id",
          "expected_recipient_version"
        ],
        "type": "object"
      },
      "ApiV1W9Request": {
        "additionalProperties": false,
        "properties": {
          "account_ref": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "business_name": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "canceled_at": {
            "anyOf": [
              {
                "format": "date-time",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "converted_at": {
            "anyOf": [
              {
                "format": "date-time",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "converted_filer_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "converted_recipient_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "dispatched_at": {
            "anyOf": [
              {
                "format": "date-time",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "email": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "entity_type_cd": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "issuer_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "issuer_snapshot": {
            "anyOf": [
              {
                "additionalProperties": true,
                "type": "object"
              },
              {
                "type": "null"
              }
            ]
          },
          "opened_at": {
            "anyOf": [
              {
                "format": "date-time",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_first_nm": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_last_nm": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_middle_nm": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_suffix_nm": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "prior_request_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "purpose": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "recipient_name": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "reconfirmation_apply_status": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "reconfirmation_data": {
            "anyOf": [
              {
                "additionalProperties": true,
                "description": "Tax identifier is masked according to route scope.",
                "type": "object"
              },
              {
                "type": "null"
              }
            ]
          },
          "reconfirmation_review_reason": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "request_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "source_recipient_version": {
            "anyOf": [
              {
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "status": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "submitted_at": {
            "anyOf": [
              {
                "format": "date-time",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "submitted_data": {
            "anyOf": [
              {
                "additionalProperties": true,
                "description": "Tax identifier is masked according to route scope.",
                "type": "object"
              },
              {
                "type": "null"
              }
            ]
          },
          "target_filer_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "target_recipient_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "tax_classification": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "tin_last4": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "tin_type": {
            "anyOf": [
              {
                "maxLength": 512,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          },
          "version": {
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "request_id",
          "status",
          "purpose",
          "email",
          "version",
          "created_at",
          "updated_at"
        ],
        "type": "object"
      },
      "ApiV1W9RequestCancelRequest": {
        "additionalProperties": false,
        "properties": {
          "expected_version": {
            "anyOf": [
              {
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "request_id": {
            "$ref": "#/components/schemas/Uuid"
          }
        },
        "required": [
          "request_id"
        ],
        "type": "object"
      },
      "ApiV1W9RequestConvertRequest": {
        "additionalProperties": false,
        "properties": {
          "expected_version": {
            "anyOf": [
              {
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "filer_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "form_id": {
            "anyOf": [
              {
                "maxLength": 32,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "request_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "schema_rev": {
            "anyOf": [
              {
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "tax_year": {
            "anyOf": [
              {
                "enum": [
                  2022,
                  2023,
                  2024,
                  2025,
                  2026
                ],
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "request_id"
        ],
        "type": "object"
      },
      "ApiV1W9RequestDispatchRequest": {
        "additionalProperties": false,
        "properties": {
          "request_ids": {
            "anyOf": [
              {
                "items": {
                  "$ref": "#/components/schemas/Uuid"
                },
                "maxItems": 100,
                "minItems": 1,
                "type": "array",
                "uniqueItems": true
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [],
        "type": "object"
      },
      "ApiV1W9RequestGetManyRequest": {
        "additionalProperties": false,
        "properties": {
          "request_ids": {
            "items": {
              "$ref": "#/components/schemas/Uuid"
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array",
            "uniqueItems": true
          }
        },
        "required": [
          "request_ids"
        ],
        "type": "object"
      },
      "ApiV1W9RequestGetManyResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1W9Request"
            },
            "maxItems": 100,
            "type": "array"
          },
          "missing": {
            "items": {
              "$ref": "#/components/schemas/Uuid"
            },
            "maxItems": 100,
            "type": "array"
          }
        },
        "required": [
          "items",
          "missing"
        ],
        "type": "object"
      },
      "ApiV1W9RequestListResponse": {
        "additionalProperties": false,
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ApiV1W9Request"
            },
            "maxItems": 100,
            "type": "array"
          },
          "next_cursor": {
            "anyOf": [
              {
                "maxLength": 4096,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "total_count": {
            "anyOf": [
              {
                "minimum": 0,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "items"
        ],
        "type": "object"
      },
      "ApiV1W9RequestUpsertRequest": {
        "additionalProperties": false,
        "properties": {
          "account_ref": {
            "anyOf": [
              {
                "maxLength": 80,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "business_name": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "email": {
            "format": "email",
            "maxLength": 254,
            "minLength": 3,
            "type": "string"
          },
          "entity_type_cd": {
            "anyOf": [
              {
                "enum": [
                  "B",
                  "I"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "expected_version": {
            "anyOf": [
              {
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "issuer_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_first_nm": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_last_nm": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_middle_nm": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_suffix_nm": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "recipient_name": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "request_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "send_immediately": {
            "default": false,
            "type": "boolean"
          }
        },
        "required": [
          "email"
        ],
        "type": "object"
      },
      "CreateRecipientPrintRequest": {
        "additionalProperties": false,
        "properties": {
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "form_id": {
            "type": "string"
          },
          "recipient_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "schema_rev": {
            "minimum": 1,
            "type": "integer"
          },
          "tax_year": {
            "enum": [
              2022,
              2023,
              2024,
              2025,
              2026
            ],
            "type": "integer"
          }
        },
        "required": [
          "filer_id",
          "recipient_id",
          "form_id",
          "tax_year",
          "schema_rev"
        ],
        "type": "object"
      },
      "FilerFormProfileInput": {
        "additionalProperties": false,
        "properties": {
          "data": {
            "anyOf": [
              {
                "description": "Form-family APP payload validated against the selected schema revision.",
                "type": "object"
              },
              {
                "type": "null"
              }
            ]
          },
          "data_ref": {
            "anyOf": [
              {
                "maxLength": 2048,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "data_sha256": {
            "anyOf": [
              {
                "pattern": "^[a-f0-9]{64}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "schema_rev": {
            "minimum": 1,
            "type": "integer"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "schema_rev",
          "updated_at"
        ],
        "type": "object"
      },
      "FilingReadinessRequest": {
        "additionalProperties": false,
        "anyOf": [
          {
            "properties": {
              "filer_id": {
                "$ref": "#/components/schemas/Uuid"
              }
            },
            "required": [
              "filer_id"
            ]
          },
          {
            "properties": {
              "tax_year": {
                "enum": [
                  2022,
                  2023,
                  2024,
                  2025,
                  2026
                ],
                "type": "integer"
              }
            },
            "required": [
              "tax_year"
            ]
          }
        ],
        "properties": {
          "filer_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "tax_year": {
            "anyOf": [
              {
                "enum": [
                  2022,
                  2023,
                  2024,
                  2025,
                  2026
                ],
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [],
        "type": "object"
      },
      "GetManyScheduledPdfPrintJobsRequest": {
        "additionalProperties": false,
        "properties": {
          "include_download_urls": {
            "default": true,
            "type": "boolean"
          },
          "job_ids": {
            "items": {
              "$ref": "#/components/schemas/Uuid"
            },
            "maxItems": 100,
            "minItems": 1,
            "type": "array"
          }
        },
        "required": [
          "job_ids"
        ],
        "type": "object"
      },
      "McpCheckoutReceipt": {
        "additionalProperties": false,
        "properties": {
          "checkout_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "delivery": {
            "enum": [
              "sending",
              "sent",
              "failed",
              "uncertain"
            ],
            "type": "string"
          },
          "expires_at": {
            "type": "integer"
          },
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "retry_after": {
            "minimum": 0,
            "type": "integer"
          },
          "tax_year": {
            "enum": [
              2022,
              2023,
              2024,
              2025,
              2026
            ],
            "type": "integer"
          },
          "workflow": {
            "enum": [
              "efile",
              "tin_matching"
            ],
            "type": "string"
          }
        },
        "required": [
          "checkout_id",
          "filer_id",
          "tax_year",
          "delivery",
          "expires_at",
          "retry_after",
          "workflow"
        ],
        "type": "object"
      },
      "McpCheckoutReference": {
        "additionalProperties": false,
        "properties": {
          "checkout_id": {
            "$ref": "#/components/schemas/Uuid"
          }
        },
        "required": [
          "checkout_id"
        ],
        "type": "object"
      },
      "OrderDeliverableArtifactOption": {
        "additionalProperties": false,
        "properties": {
          "candidate": {
            "type": "boolean"
          },
          "description": {
            "minLength": 1,
            "type": "string"
          },
          "label": {
            "minLength": 1,
            "type": "string"
          },
          "option_id": {
            "enum": [
              "state_accepted",
              "iris_xml_candidate",
              "pub1220_candidate"
            ],
            "type": "string"
          },
          "requires_documentation_acknowledgement": {
            "type": "boolean"
          }
        },
        "required": [
          "option_id",
          "label",
          "description",
          "candidate",
          "requires_documentation_acknowledgement"
        ],
        "type": "object"
      },
      "OrderDeliverableStateDocumentation": {
        "additionalProperties": false,
        "properties": {
          "available": {
            "type": "boolean"
          },
          "official_sources": {
            "items": {
              "$ref": "#/components/schemas/OrderDeliverableStateGuideSource"
            },
            "type": "array"
          },
          "reviewed_at": {
            "anyOf": [
              {
                "format": "date",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "sections": {
            "items": {
              "$ref": "#/components/schemas/OrderDeliverableStateGuideSection"
            },
            "type": "array"
          },
          "state_code": {
            "pattern": "^[A-Z]{2}$",
            "type": "string"
          },
          "state_name": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string"
          },
          "summary": {
            "anyOf": [
              {
                "minLength": 1,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "tax_year": {
            "enum": [
              2022,
              2023,
              2024,
              2025,
              2026
            ],
            "type": "integer"
          },
          "title": {
            "maxLength": 512,
            "minLength": 1,
            "type": "string"
          },
          "unavailable_reason": {
            "anyOf": [
              {
                "minLength": 1,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "available",
          "title",
          "state_code",
          "state_name",
          "tax_year",
          "sections",
          "official_sources"
        ],
        "type": "object"
      },
      "OrderDeliverableStateGuideSection": {
        "additionalProperties": false,
        "properties": {
          "bullets": {
            "items": {
              "minLength": 1,
              "type": "string"
            },
            "type": "array"
          },
          "heading": {
            "maxLength": 512,
            "minLength": 1,
            "type": "string"
          },
          "paragraphs": {
            "items": {
              "minLength": 1,
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "heading",
          "paragraphs",
          "bullets"
        ],
        "type": "object"
      },
      "OrderDeliverableStateGuideSource": {
        "additionalProperties": false,
        "properties": {
          "title": {
            "maxLength": 512,
            "minLength": 1,
            "type": "string"
          },
          "url": {
            "format": "uri",
            "pattern": "^https://",
            "type": "string"
          }
        },
        "required": [
          "title",
          "url"
        ],
        "type": "object"
      },
      "OrderDeliverableStateMetrics": {
        "additionalProperties": false,
        "properties": {
          "local_withholding_recipient_count": {
            "minimum": 0,
            "type": "integer"
          },
          "local_withholding_total_cents": {
            "minimum": 0,
            "type": "integer"
          },
          "missing_state_account_recipient_count": {
            "minimum": 0,
            "type": "integer"
          },
          "state_income_recipient_count": {
            "minimum": 0,
            "type": "integer"
          },
          "state_income_total_cents": {
            "minimum": 0,
            "type": "integer"
          },
          "state_withholding_recipient_count": {
            "minimum": 0,
            "type": "integer"
          },
          "state_withholding_total_cents": {
            "minimum": 0,
            "type": "integer"
          },
          "withholding_missing_state_account_recipient_count": {
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "state_withholding_recipient_count",
          "state_withholding_total_cents",
          "local_withholding_recipient_count",
          "local_withholding_total_cents",
          "state_income_recipient_count",
          "state_income_total_cents",
          "missing_state_account_recipient_count",
          "withholding_missing_state_account_recipient_count"
        ],
        "type": "object"
      },
      "OrderDeliverableStateOutput": {
        "additionalProperties": false,
        "properties": {
          "actionable": {
            "type": "boolean"
          },
          "allowed_record_scopes": {
            "items": {
              "enum": [
                "qualified_records",
                "all_state_records",
                "withholding_only"
              ],
              "type": "string"
            },
            "type": "array",
            "uniqueItems": true
          },
          "artifact_options": {
            "items": {
              "$ref": "#/components/schemas/OrderDeliverableArtifactOption"
            },
            "type": "array"
          },
          "cfsf_status": {
            "enum": [
              "not_applicable",
              "not_selected",
              "planned",
              "included_in_attempt",
              "accepted",
              "failed"
            ],
            "type": "string"
          },
          "decision": {
            "enum": [
              "generated",
              "not_required",
              "manual_review_required",
              "unsupported_format",
              "blocked_by_missing_data"
            ],
            "type": "string"
          },
          "default_record_scope": {
            "anyOf": [
              {
                "enum": [
                  "qualified_records",
                  "all_state_records",
                  "withholding_only"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "format": {
            "enum": [
              "pub1187",
              "pub1220",
              "pub1220_variant",
              "pub1220_zip",
              "duplicate_irs_pub1220",
              "csv",
              "xml",
              "fixed_text",
              "portal_manual",
              "manual_verify",
              "unsupported"
            ],
            "type": "string"
          },
          "format_label": {
            "maxLength": 256,
            "type": "string"
          },
          "generation_capability": {
            "enum": [
              "generated",
              "manual",
              "unsupported",
              "no_artifact"
            ],
            "type": "string"
          },
          "obligation": {
            "enum": [
              "direct_required",
              "direct_optional",
              "satisfied_by_cfsf",
              "not_required",
              "required_missing_information",
              "required_manual",
              "required_unsupported"
            ],
            "type": "string"
          },
          "package_profile": {
            "enum": [
              "no_artifact",
              "single_form_artifact",
              "hawaii_n196",
              "enc3",
              "rev1667",
              "wht434"
            ],
            "type": "string"
          },
          "qualified_recipient_count": {
            "minimum": 0,
            "type": "integer"
          },
          "qualified_recipient_digest": {
            "anyOf": [
              {
                "pattern": "^[a-f0-9]{64}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "reason": {
            "anyOf": [
              {
                "maxLength": 2048,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "reason_code": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string"
          },
          "renderer_revision": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string"
          },
          "rule_catalog_digest": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string"
          },
          "rule_id": {
            "maxLength": 256,
            "minLength": 1,
            "type": "string"
          },
          "rule_revision": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string"
          },
          "source_evidence_sha256": {
            "items": {
              "pattern": "^[a-f0-9]{64}$",
              "type": "string"
            },
            "type": "array",
            "uniqueItems": true
          },
          "source_ref": {
            "maxLength": 4096,
            "type": "string"
          },
          "spec_url": {
            "maxLength": 4096,
            "type": "string"
          },
          "supplemental_fields": {
            "items": {
              "$ref": "#/components/schemas/OrderDeliverableStateSupplementalField"
            },
            "maxItems": 20,
            "type": "array"
          },
          "trigger": {
            "maxLength": 256,
            "type": "string"
          }
        },
        "required": [
          "decision",
          "obligation",
          "generation_capability",
          "cfsf_status",
          "actionable",
          "rule_id",
          "rule_revision",
          "rule_catalog_digest",
          "renderer_revision",
          "package_profile",
          "source_evidence_sha256",
          "reason_code",
          "qualified_recipient_count",
          "format",
          "trigger",
          "format_label",
          "spec_url",
          "source_ref"
        ],
        "type": "object"
      },
      "OrderDeliverableStateSupplementalField": {
        "additionalProperties": false,
        "properties": {
          "field_id": {
            "maxLength": 64,
            "minLength": 1,
            "type": "string"
          },
          "help_text": {
            "maxLength": 1024,
            "type": "string"
          },
          "label": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string"
          },
          "max_len": {
            "maximum": 128,
            "minimum": 1,
            "type": "integer"
          },
          "redacted": {
            "type": "boolean"
          },
          "required": {
            "type": "boolean"
          },
          "scope": {
            "maxLength": 64,
            "minLength": 1,
            "type": "string"
          },
          "validation_rule": {
            "maxLength": 64,
            "minLength": 1,
            "type": "string"
          },
          "write_target": {
            "maxLength": 128,
            "minLength": 1,
            "type": "string"
          }
        },
        "required": [
          "field_id",
          "label",
          "help_text",
          "required",
          "validation_rule",
          "max_len",
          "redacted",
          "scope",
          "write_target"
        ],
        "type": "object"
      },
      "OrderDeliverableStateSupplementalValue": {
        "additionalProperties": false,
        "properties": {
          "field_id": {
            "maxLength": 64,
            "minLength": 1,
            "type": "string"
          },
          "value": {
            "maxLength": 128,
            "type": "string"
          }
        },
        "required": [
          "field_id",
          "value"
        ],
        "type": "object"
      },
      "OrderDeliverableTransmitterDefaults": {
        "additionalProperties": false,
        "description": "Confirmed submitter details are validated against the selected saved output option before generation and on worker resume. Publication 1220 permits 80 characters each for legal_name and company_name (two 40-position lines), 40 for mailing_address and city, 40 for the combined contact_first_name plus space plus contact_last_name, and 50 for contact_email; text must be printable ASCII. The telephone permits 1-15 digits with formatting punctuation; a U.S. ZIP code must contain 5 or 9 digits; foreign postal text is preserved within 9 ASCII characters. Values are never silently truncated. These export constraints do not restrict canonical APP records or IRIS XML to Publication 1220 widths.",
        "properties": {
          "city": {
            "type": "string"
          },
          "company_name": {
            "type": "string"
          },
          "contact_email": {
            "type": "string"
          },
          "contact_first_name": {
            "type": "string"
          },
          "contact_last_name": {
            "type": "string"
          },
          "contact_phone": {
            "type": "string"
          },
          "foreign_entity": {
            "type": "boolean"
          },
          "legal_name": {
            "type": "string"
          },
          "mailing_address": {
            "type": "string"
          },
          "postal_code": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "tin_last_four": {
            "pattern": "^[0-9]{0,4}$",
            "type": "string"
          },
          "tin_submitted_type_cd": {
            "enum": [
              "BUSINESS_TIN",
              "INDIVIDUAL_TIN"
            ],
            "type": "string"
          }
        },
        "required": [
          "city",
          "company_name",
          "contact_email",
          "contact_first_name",
          "contact_last_name",
          "contact_phone",
          "foreign_entity",
          "legal_name",
          "mailing_address",
          "postal_code",
          "state",
          "tin_last_four",
          "tin_submitted_type_cd"
        ],
        "type": "object"
      },
      "OrderDeliverableTransmitterDetails": {
        "additionalProperties": false,
        "description": "Confirmed submitter details are validated against the selected saved output option before generation and on worker resume. Publication 1220 permits 80 characters each for legal_name and company_name (two 40-position lines), 40 for mailing_address and city, 40 for the combined contact_first_name plus space plus contact_last_name, and 50 for contact_email; text must be printable ASCII. The telephone permits 1-15 digits with formatting punctuation; a U.S. ZIP code must contain 5 or 9 digits; foreign postal text is preserved within 9 ASCII characters. Values are never silently truncated. These export constraints do not restrict canonical APP records or IRIS XML to Publication 1220 widths.",
        "properties": {
          "city": {
            "maxLength": 120,
            "minLength": 1,
            "type": "string"
          },
          "company_name": {
            "maxLength": 80,
            "minLength": 1,
            "type": "string"
          },
          "contact_email": {
            "maxLength": 254,
            "minLength": 1,
            "type": "string"
          },
          "contact_first_name": {
            "maxLength": 80,
            "minLength": 1,
            "type": "string"
          },
          "contact_last_name": {
            "maxLength": 80,
            "minLength": 1,
            "type": "string"
          },
          "contact_phone": {
            "maxLength": 32,
            "minLength": 1,
            "type": "string"
          },
          "foreign_entity": {
            "type": "boolean"
          },
          "legal_name": {
            "maxLength": 80,
            "minLength": 1,
            "type": "string"
          },
          "mailing_address": {
            "maxLength": 160,
            "minLength": 1,
            "type": "string"
          },
          "override_tin": {
            "anyOf": [
              {
                "pattern": "^[0-9]{9}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "postal_code": {
            "maxLength": 12,
            "minLength": 1,
            "type": "string"
          },
          "state": {
            "maxLength": 2,
            "minLength": 1,
            "pattern": "^[A-Z]{2}$",
            "type": "string"
          },
          "tin_submitted_type_cd": {
            "enum": [
              "BUSINESS_TIN",
              "INDIVIDUAL_TIN"
            ],
            "type": "string"
          },
          "transmitter_control_code": {
            "description": "Five uppercase alphanumeric characters are required for IRIS XML, Publication 1220 and Publication 1187. Other output formats may use an empty string. This structural check is not IRS enrollment verification.",
            "pattern": "^([A-Z0-9]{5})?$",
            "type": "string"
          },
          "use_frozen_filer_tin": {
            "type": "boolean"
          }
        },
        "required": [
          "use_frozen_filer_tin",
          "tin_submitted_type_cd",
          "transmitter_control_code",
          "foreign_entity",
          "legal_name",
          "company_name",
          "mailing_address",
          "city",
          "state",
          "postal_code",
          "contact_first_name",
          "contact_last_name",
          "contact_phone",
          "contact_email"
        ],
        "type": "object"
      },
      "OrderPricingBasis": {
        "additionalProperties": false,
        "properties": {
          "mode": {
            "enum": [
              "per_order",
              "cumulative_tax_year"
            ],
            "type": "string"
          },
          "starting_recipient_count": {
            "minimum": 0,
            "type": "integer"
          },
          "tax_year": {
            "type": "integer"
          }
        },
        "required": [
          "mode",
          "tax_year",
          "starting_recipient_count"
        ],
        "type": "object"
      },
      "OrderServiceCode": {
        "enum": [
          "efile",
          "e_delivery",
          "state_efile",
          "print_mail",
          "irs_spec_file"
        ],
        "type": "string"
      },
      "OrderServiceCodes": {
        "description": "Must include efile and e_delivery. State E-File is not currently available: new state_efile requests return HTTP 400 invalid_request with message 'State E-File is not currently available.'. State Reporting File (irs_spec_file) remains available. Historical response identities are unchanged.",
        "items": {
          "enum": [
            "efile",
            "e_delivery",
            "print_mail",
            "irs_spec_file"
          ],
          "type": "string"
        },
        "maxItems": 4,
        "minItems": 2,
        "type": "array",
        "uniqueItems": true
      },
      "PlatformCatalogFieldExposure": {
        "additionalProperties": false,
        "properties": {
          "api_readable": {
            "type": "boolean"
          },
          "api_writable": {
            "type": "boolean"
          },
          "import_accepted": {
            "type": "boolean"
          },
          "operator_editable": {
            "type": "boolean"
          },
          "operator_visible": {
            "type": "boolean"
          },
          "print_included": {
            "type": "boolean"
          },
          "server_derived": {
            "type": "boolean"
          }
        },
        "required": [
          "operator_visible",
          "operator_editable",
          "api_readable",
          "api_writable",
          "import_accepted",
          "print_included",
          "server_derived"
        ],
        "type": "object"
      },
      "PlatformCatalogFieldSpec": {
        "additionalProperties": false,
        "description": "Field metadata belongs to the exact annual contract. Metadata identifiers and declared rules must be consumed from that contract; they are not a fixed cross-year vocabulary.",
        "properties": {
          "amount_semantics": {
            "type": "string"
          },
          "annual_change_reason": {
            "type": "string"
          },
          "applicability_rule_id": {
            "type": "string"
          },
          "box_ref": {
            "type": "string"
          },
          "cardinality": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "display_label": {
            "type": "string"
          },
          "display_order": {
            "type": "integer"
          },
          "exposure": {
            "$ref": "#/components/schemas/PlatformCatalogFieldExposure"
          },
          "field_id": {
            "type": "string"
          },
          "group_id": {
            "type": "string"
          },
          "help_text": {
            "type": "string"
          },
          "import_aliases": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "input_kind": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "max_len": {
            "type": "integer"
          },
          "normalizers": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "output_scope": {
            "type": "string"
          },
          "repeat_group_id": {
            "type": "string"
          },
          "repeat_group_max_items": {
            "type": "integer"
          },
          "repeated": {
            "type": "boolean"
          },
          "required": {
            "type": "boolean"
          },
          "section": {
            "type": "string"
          },
          "source_provenance": {
            "type": "string"
          },
          "special_handling": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "storage_type": {
            "type": "string"
          },
          "unique_items": {
            "type": "boolean"
          },
          "validators": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "field_id",
          "label",
          "help_text",
          "group_id",
          "display_order",
          "cardinality",
          "unique_items",
          "storage_type",
          "required",
          "repeated",
          "max_len",
          "validators",
          "normalizers",
          "import_aliases",
          "exposure",
          "input_kind",
          "section",
          "special_handling",
          "source_provenance",
          "output_scope"
        ],
        "type": "object"
      },
      "PlatformCatalogPresentationGroup": {
        "additionalProperties": false,
        "properties": {
          "columns": {
            "type": "integer"
          },
          "description": {
            "type": "string"
          },
          "field_ids": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "group_id": {
            "type": "string"
          },
          "title": {
            "type": "string"
          }
        },
        "required": [
          "group_id",
          "title",
          "description",
          "columns",
          "field_ids"
        ],
        "type": "object"
      },
      "PlatformFilerClassCatalogRow": {
        "additionalProperties": false,
        "properties": {
          "class_code": {
            "type": "string"
          },
          "class_label": {
            "type": "string"
          },
          "filer_class": {
            "type": "string"
          },
          "schema_family": {
            "type": "string"
          }
        },
        "required": [
          "filer_class",
          "schema_family",
          "class_code",
          "class_label"
        ],
        "type": "object"
      },
      "PlatformFilerFieldCatalogRow": {
        "additionalProperties": false,
        "properties": {
          "class_code": {
            "type": "string"
          },
          "class_label": {
            "type": "string"
          },
          "field_ids": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "fields": {
            "items": {
              "$ref": "#/components/schemas/PlatformCatalogFieldSpec"
            },
            "type": "array"
          },
          "filer_class": {
            "type": "string"
          },
          "schema_family": {
            "type": "string"
          },
          "schema_release": {
            "type": "string"
          },
          "schema_rev": {
            "type": "integer"
          },
          "tax_year": {
            "type": "integer"
          }
        },
        "required": [
          "filer_class",
          "schema_family",
          "class_code",
          "class_label",
          "tax_year",
          "schema_rev",
          "schema_release",
          "field_ids",
          "fields"
        ],
        "type": "object"
      },
      "PlatformFormFieldCatalogResponse": {
        "additionalProperties": false,
        "properties": {
          "catalog_view": {
            "enum": [
              "inventory",
              "filer",
              "recipient"
            ],
            "type": "string"
          },
          "filer_classes": {
            "items": {
              "$ref": "#/components/schemas/PlatformFilerClassCatalogRow"
            },
            "type": "array"
          },
          "filer_fields": {
            "items": {
              "$ref": "#/components/schemas/PlatformFilerFieldCatalogRow"
            },
            "type": "array"
          },
          "recipient_fields": {
            "items": {
              "$ref": "#/components/schemas/PlatformRecipientFieldCatalogRow"
            },
            "type": "array"
          },
          "schema_family": {
            "type": "string"
          },
          "validator_catalog": {
            "items": {
              "$ref": "#/components/schemas/PlatformValidatorCatalogRow"
            },
            "type": "array"
          }
        },
        "required": [
          "catalog_view",
          "schema_family",
          "filer_classes",
          "filer_fields",
          "recipient_fields",
          "validator_catalog"
        ],
        "type": "object"
      },
      "PlatformRecipientFieldCatalogRow": {
        "additionalProperties": false,
        "properties": {
          "app_support": {
            "type": "string"
          },
          "class_code": {
            "type": "string"
          },
          "class_label": {
            "type": "string"
          },
          "common_field_ids": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "correction_supported": {
            "type": "boolean"
          },
          "editing_supported": {
            "type": "boolean"
          },
          "field_ids": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "fields": {
            "items": {
              "$ref": "#/components/schemas/PlatformCatalogFieldSpec"
            },
            "type": "array"
          },
          "filer_class": {
            "type": "string"
          },
          "fire_fileable": {
            "type": "boolean"
          },
          "fire_target_release": {
            "type": "string"
          },
          "fire_target_schema_rev": {
            "type": "integer"
          },
          "fire_translation_contract_id": {
            "type": "string"
          },
          "fire_unavailable_reason": {
            "type": "string"
          },
          "form_field_ids": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "form_id": {
            "type": "string"
          },
          "form_label": {
            "type": "string"
          },
          "import_supported": {
            "type": "boolean"
          },
          "iris_fileable": {
            "type": "boolean"
          },
          "iris_target_release": {
            "type": "string"
          },
          "iris_target_schema_rev": {
            "type": "integer"
          },
          "iris_translation_contract_id": {
            "type": "string"
          },
          "iris_unavailable_reason": {
            "type": "string"
          },
          "presentation_groups": {
            "items": {
              "$ref": "#/components/schemas/PlatformCatalogPresentationGroup"
            },
            "type": "array"
          },
          "print_supported": {
            "type": "boolean"
          },
          "schema_family": {
            "type": "string"
          },
          "schema_release": {
            "type": "string"
          },
          "schema_rev": {
            "type": "integer"
          },
          "support_reason": {
            "type": "string"
          },
          "tax_year": {
            "type": "integer"
          }
        },
        "required": [
          "filer_class",
          "schema_family",
          "class_code",
          "class_label",
          "form_id",
          "form_label",
          "tax_year",
          "schema_rev",
          "schema_release",
          "app_support",
          "editing_supported",
          "import_supported",
          "print_supported",
          "correction_supported",
          "iris_fileable",
          "fire_fileable",
          "support_reason",
          "field_ids",
          "common_field_ids",
          "form_field_ids",
          "fields",
          "presentation_groups"
        ],
        "type": "object"
      },
      "PlatformValidatorCatalogRow": {
        "additionalProperties": false,
        "properties": {
          "description": {
            "type": "string"
          },
          "input_kind": {
            "type": "string"
          },
          "validator_id": {
            "type": "string"
          }
        },
        "required": [
          "validator_id",
          "input_kind",
          "description"
        ],
        "type": "object"
      },
      "PrepareAgentFiling": {
        "additionalProperties": false,
        "properties": {
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "filer_version": {
            "minimum": 1,
            "type": "integer"
          },
          "recipients": {
            "description": "Distinct original recipients and their current versions.",
            "items": {
              "additionalProperties": false,
              "properties": {
                "recipient_id": {
                  "$ref": "#/components/schemas/Uuid"
                },
                "version": {
                  "minimum": 1,
                  "type": "integer"
                }
              },
              "required": [
                "recipient_id",
                "version"
              ],
              "type": "object"
            },
            "maxItems": 10,
            "minItems": 1,
            "type": "array"
          },
          "services": {
            "additionalProperties": false,
            "properties": {
              "irs_spec_file": {
                "type": "boolean"
              },
              "print_mail": {
                "type": "boolean"
              },
              "state_efile": {
                "const": false,
                "description": "Direct State E-File is unavailable.",
                "type": "boolean"
              }
            },
            "required": [
              "state_efile",
              "print_mail",
              "irs_spec_file"
            ],
            "type": "object"
          },
          "tuple": {
            "additionalProperties": false,
            "properties": {
              "form_id": {
                "description": "Exact form identifier from the annual catalog.",
                "type": "string"
              },
              "schema_release": {
                "description": "Exact release returned for this form/year/revision.",
                "type": "string"
              },
              "schema_rev": {
                "const": 3,
                "type": "integer"
              },
              "tax_year": {
                "enum": [
                  2022,
                  2023,
                  2024,
                  2025,
                  2026
                ],
                "type": "integer"
              }
            },
            "required": [
              "form_id",
              "tax_year",
              "schema_rev",
              "schema_release"
            ],
            "type": "object"
          }
        },
        "required": [
          "filer_id",
          "filer_version",
          "tuple",
          "recipients",
          "services"
        ],
        "type": "object"
      },
      "PreparedAgentFiling": {
        "additionalProperties": false,
        "properties": {
          "expires_at": {
            "description": "Unix seconds.",
            "type": "integer"
          },
          "order_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "review_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "review_url": {
            "description": "Open in the browser for the originating user's review and explicit checkout.",
            "format": "uri",
            "type": "string"
          }
        },
        "required": [
          "review_id",
          "review_url",
          "expires_at",
          "order_id"
        ],
        "type": "object"
      },
      "RecipientDeleteTargetInput": {
        "additionalProperties": false,
        "properties": {
          "expected_version": {
            "minimum": 1,
            "type": "integer"
          },
          "recipient_id": {
            "$ref": "#/components/schemas/Uuid"
          }
        },
        "required": [
          "recipient_id",
          "expected_version"
        ],
        "type": "object"
      },
      "RecipientFormInput": {
        "additionalProperties": false,
        "properties": {
          "app_revision": {
            "anyOf": [
              {
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "correction_code": {
            "anyOf": [
              {
                "maxLength": 32,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "correction_type": {
            "anyOf": [
              {
                "maxLength": 64,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "data": {
            "anyOf": [
              {
                "description": "APP form payload validated against form_id, tax_year, and schema_rev.",
                "type": "object"
              },
              {
                "type": "null"
              }
            ]
          },
          "data_ref": {
            "anyOf": [
              {
                "maxLength": 2048,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "data_sha256": {
            "anyOf": [
              {
                "pattern": "^[a-f0-9]{64}$",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "filer_revision": {
            "anyOf": [
              {
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "fire_revision": {
            "anyOf": [
              {
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "form_id": {
            "maxLength": 64,
            "minLength": 1,
            "type": "string"
          },
          "form_profiles": {
            "anyOf": [
              {
                "type": "object"
              },
              {
                "type": "null"
              }
            ]
          },
          "iris_revision": {
            "anyOf": [
              {
                "minimum": 1,
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          },
          "is_corrected": {
            "anyOf": [
              {
                "type": "boolean"
              },
              {
                "type": "null"
              }
            ]
          },
          "schema_rev": {
            "minimum": 1,
            "type": "integer"
          },
          "tax_year": {
            "enum": [
              2022,
              2023,
              2024,
              2025,
              2026
            ],
            "type": "integer"
          },
          "unique_record_id": {
            "anyOf": [
              {
                "maxLength": 128,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "form_id",
          "tax_year",
          "schema_rev"
        ],
        "type": "object"
      },
      "RecipientIssuesRequest": {
        "additionalProperties": false,
        "properties": {
          "field": {
            "anyOf": [
              {
                "description": "Exact APP field ID from the saved annual form contract.",
                "maxLength": 100,
                "minLength": 1,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "form_id": {
            "anyOf": [
              {
                "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_h",
                  "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",
                  "3921",
                  "3922",
                  "5498",
                  "5498_esa",
                  "5498_qa",
                  "5498_sa",
                  "5498_ta",
                  "15397",
                  "8027",
                  "8596",
                  "8809",
                  "8955_ssa",
                  "w_2g"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "recipient_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "tax_year": {
            "anyOf": [
              {
                "enum": [
                  2022,
                  2023,
                  2024,
                  2025,
                  2026
                ],
                "type": "integer"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "filer_id",
          "recipient_id"
        ],
        "type": "object"
      },
      "RequestMcpCheckout": {
        "additionalProperties": false,
        "properties": {
          "action": {
            "default": "request",
            "enum": [
              "request",
              "remind"
            ],
            "type": "string"
          },
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "tax_year": {
            "enum": [
              2022,
              2023,
              2024,
              2025,
              2026
            ],
            "type": "integer"
          },
          "workflow": {
            "default": "efile",
            "description": "Separate human checkout intent. Filing checkout never offers TIN Matching as an add-on. Use tin_matching for a distinct optional order before filing.",
            "enum": [
              "efile",
              "tin_matching"
            ],
            "type": "string"
          }
        },
        "required": [
          "filer_id",
          "tax_year"
        ],
        "type": "object"
      },
      "SchedulePdfPrintJobRequest": {
        "additionalProperties": false,
        "properties": {
          "chunk_size": {
            "maximum": 5000,
            "minimum": 100,
            "type": [
              "integer",
              "null"
            ]
          },
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "form_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "mode": {
            "enum": [
              "all",
              "corrected",
              "uncorrected"
            ],
            "type": "string"
          },
          "tax_year": {
            "enum": [
              2022,
              2023,
              2024,
              2025,
              2026
            ],
            "type": "integer"
          }
        },
        "required": [
          "filer_id",
          "tax_year",
          "mode"
        ],
        "type": "object"
      },
      "SchedulePdfPrintJobResponse": {
        "additionalProperties": false,
        "properties": {
          "already_scheduled": {
            "type": "boolean"
          },
          "chunk_size": {
            "type": "integer"
          },
          "download_url": {
            "format": "uri",
            "type": "string"
          },
          "execution_mode": {
            "enum": [
              "immediate",
              "scheduled"
            ],
            "type": "string"
          },
          "export_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "form_id": {
            "type": "string"
          },
          "mode": {
            "enum": [
              "all",
              "corrected",
              "uncorrected"
            ],
            "type": "string"
          },
          "recipient_form_count": {
            "type": "integer"
          },
          "status": {
            "enum": [
              "queued",
              "processing",
              "merging",
              "completed",
              "failed"
            ],
            "type": "string"
          },
          "tax_year": {
            "enum": [
              2022,
              2023,
              2024,
              2025,
              2026
            ],
            "type": "integer"
          }
        },
        "required": [
          "execution_mode",
          "export_id",
          "status",
          "filer_id",
          "tax_year",
          "mode",
          "recipient_form_count",
          "chunk_size",
          "already_scheduled"
        ],
        "type": "object"
      },
      "Uuid": {
        "format": "uuid",
        "type": "string"
      },
      "W9ImportRowInput": {
        "additionalProperties": false,
        "properties": {
          "account_ref": {
            "anyOf": [
              {
                "maxLength": 80,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "business_name": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "email": {
            "format": "email",
            "maxLength": 254,
            "minLength": 3,
            "type": "string"
          },
          "entity_type_cd": {
            "anyOf": [
              {
                "enum": [
                  "B",
                  "I"
                ],
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "issuer_id": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_first_nm": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_last_nm": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_middle_nm": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "person_suffix_nm": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "recipient_name": {
            "anyOf": [
              {
                "maxLength": 160,
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "email"
        ],
        "type": "object"
      },
      "W9RecipientTargetInput": {
        "additionalProperties": false,
        "properties": {
          "filer_id": {
            "$ref": "#/components/schemas/Uuid"
          },
          "recipient_id": {
            "$ref": "#/components/schemas/Uuid"
          }
        },
        "required": [
          "filer_id",
          "recipient_id"
        ],
        "type": "object"
      }
    },
    "securitySchemes": {
      "OAuth2": {
        "description": "RS256 RFC 9068 access tokens. Interactive EFM session JWTs are rejected.",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://app.efilemagic.com/oauth/authorize",
            "scopes": {
              "deliverables.read": "Authorize deliverables.read operations",
              "deliverables.request": "Authorize deliverables.request operations",
              "documents.read": "Authorize documents.read operations",
              "filers.read": "Authorize filers.read operations",
              "filers.write": "Authorize filers.write operations",
              "forms.read": "Authorize forms.read operations",
              "imports.delete": "Authorize imports.delete operations",
              "imports.read": "Authorize imports.read operations",
              "imports.write": "Authorize imports.write operations",
              "offline_access": "Authorize offline_access operations",
              "orders.preview": "Authorize orders.preview operations",
              "orders.read": "Authorize orders.read operations",
              "orders.submit": "Authorize orders.submit operations",
              "payment_methods.read": "Authorize payment_methods.read operations",
              "recipients.delete": "Authorize recipients.delete operations",
              "recipients.read": "Authorize recipients.read operations",
              "recipients.write": "Authorize recipients.write operations",
              "tax_ids.read": "Authorize tax_ids.read operations",
              "tax_ids.write": "Authorize tax_ids.write operations",
              "w9.cancel": "Authorize w9.cancel operations",
              "w9.dispatch": "Authorize w9.dispatch operations",
              "w9.read": "Authorize w9.read operations",
              "w9.write": "Authorize w9.write operations"
            },
            "tokenUrl": "https://api.efilemagic.com/oauth/token"
          },
          "clientCredentials": {
            "scopes": {
              "deliverables.read": "Authorize deliverables.read operations",
              "deliverables.request": "Authorize deliverables.request operations",
              "documents.read": "Authorize documents.read operations",
              "filers.read": "Authorize filers.read operations",
              "filers.write": "Authorize filers.write operations",
              "forms.read": "Authorize forms.read operations",
              "imports.delete": "Authorize imports.delete operations",
              "imports.read": "Authorize imports.read operations",
              "imports.write": "Authorize imports.write operations",
              "offline_access": "Authorize offline_access operations",
              "orders.preview": "Authorize orders.preview operations",
              "orders.read": "Authorize orders.read operations",
              "orders.submit": "Authorize orders.submit operations",
              "payment_methods.read": "Authorize payment_methods.read operations",
              "recipients.delete": "Authorize recipients.delete operations",
              "recipients.read": "Authorize recipients.read operations",
              "recipients.write": "Authorize recipients.write operations",
              "tax_ids.read": "Authorize tax_ids.read operations",
              "tax_ids.write": "Authorize tax_ids.write operations",
              "w9.cancel": "Authorize w9.cancel operations",
              "w9.dispatch": "Authorize w9.dispatch operations",
              "w9.read": "Authorize w9.read operations",
              "w9.write": "Authorize w9.write operations"
            },
            "tokenUrl": "https://api.efilemagic.com/oauth/token"
          }
        },
        "type": "oauth2"
      }
    }
  },
  "info": {
    "description": "Stable OAuth-protected inbound API containing only the versioned third-party filing resource surface. Interactive application, staff, login, public capability, and accounting-provider authorization routes are excluded.",
    "title": "E-File Magic Third-Party Filing API",
    "version": "1.0.0"
  },
  "openapi": "3.1.0",
  "paths": {
    "/api/v1/dashboard/summary": {
      "post": {
        "description": "Reads the existing tax-year dashboard projection. Requires filers.read, recipients.read, orders.read and access to all filers; restricted grants must use filer readiness instead. Counts and generated_at/freshness retain ordinary dashboard semantics and can lag current writes. This read does not validate, submit or purchase anything.",
        "operationId": "api_v1_dashboard_summary",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiDashboardRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiDashboardSummary"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "filers.read",
              "recipients.read",
              "orders.read"
            ]
          }
        ],
        "summary": "Read the account dashboard summary",
        "tags": [
          "Filing readiness"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "filers.read",
          "recipients.read",
          "orders.read"
        ],
        "x-efm-weighted-units": 2
      }
    },
    "/api/v1/filers/get": {
      "post": {
        "operationId": "api_v1_filer_get",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1FilerGetRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1Filer"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "filers.read"
            ]
          }
        ],
        "summary": "POST /api/v1/filers/get",
        "tags": [
          "Filers"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "filers.read"
        ],
        "x-efm-weighted-units": 1
      }
    },
    "/api/v1/filers/get_many": {
      "post": {
        "operationId": "api_v1_filer_get_many",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1FilerGetManyRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1FilerGetManyResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "filers.read"
            ]
          }
        ],
        "summary": "POST /api/v1/filers/get_many",
        "tags": [
          "Filers"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "filers.read"
        ],
        "x-efm-weighted-units": 1
      }
    },
    "/api/v1/filers/list": {
      "get": {
        "operationId": "api_v1_filer_list",
        "parameters": [
          {
            "in": "query",
            "name": "q",
            "required": false,
            "schema": {
              "maxLength": 256,
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "is_archived",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "in": "query",
            "name": "filing_year",
            "required": false,
            "schema": {
              "enum": [
                2022,
                2023,
                2024,
                2025,
                2026
              ],
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "sort_by",
            "required": false,
            "schema": {
              "enum": [
                "updated_at",
                "relevance"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "sort_order",
            "required": false,
            "schema": {
              "enum": [
                "asc",
                "desc"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "maxLength": 2048,
              "minLength": 1,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1FilerListResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "filers.read"
            ]
          }
        ],
        "summary": "GET /api/v1/filers/list",
        "tags": [
          "Filers"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "filers.read"
        ],
        "x-efm-weighted-units": 1
      }
    },
    "/api/v1/filers/upsert": {
      "post": {
        "operationId": "api_v1_filer_upsert",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1FilerUpsertRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1Filer"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "filers.write"
            ]
          }
        ],
        "summary": "POST /api/v1/filers/upsert",
        "tags": [
          "Filers"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "filers.write"
        ],
        "x-efm-weighted-units": 5
      }
    },
    "/api/v1/filing-reviews/get": {
      "post": {
        "description": "Retrieve the existing review under the same current delegated agent authority. Changed or expired authority or selection requires fresh preparation. This read returns the review link and expiry without submitting a filing or collecting payment.",
        "operationId": "api_v1_filing_review_get",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AgentFilingReference"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/PreparedAgentFiling"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "orders.read"
            ]
          }
        ],
        "summary": "Retrieve a prepared filing review",
        "tags": [
          "Orders"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "orders.read"
        ],
        "x-efm-weighted-units": 1
      }
    },
    "/api/v1/filing-reviews/prepare": {
      "post": {
        "description": "Requires current delegated agent authorization. Freeze 1–10 distinct original recipients, their current versions, the exact annual form tuple and requested services for the originating user's review. Reuse the same Idempotency-Key after an uncertain response. Returns a browser review link and expiry; preparation does not approve, pay for or submit the filing.",
        "operationId": "api_v1_filing_review_prepare",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PrepareAgentFiling"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/PreparedAgentFiling"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "orders.preview",
              "recipients.read",
              "forms.read",
              "filers.read"
            ]
          }
        ],
        "summary": "Prepare a filing for human review",
        "tags": [
          "Orders"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "orders.preview",
          "recipients.read",
          "forms.read",
          "filers.read"
        ],
        "x-efm-weighted-units": 15
      }
    },
    "/api/v1/filings/readiness": {
      "post": {
        "description": "Shares the built-in agent's bounded readiness read. Supply filer_id, or tax_year for an account overview. Account overview additionally requires orders.read and access to all filers. Per-filer counts distinguish updating/unavailable from zero. Up to five recipient or filer examples are hints, not exhaustive error totals. The per-filer tin_matching field uses two bounded existing sparse-index pages and strongly reread metadata for at most 100 candidates; observed counts are not full-filer totals. Offer optional matching only for offer_matching, track wait_for_results, and review adverse results for review_results. Partial/unknown coverage never proves all matched. This reads saved backend validation and metrics; it does not run agent validation, authorize filing or certify IRS acceptance. IDs and application links support follow-up reads.",
        "operationId": "api_v1_filing_readiness",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/FilingReadinessRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiFilingReadiness"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "filers.read",
              "recipients.read",
              "forms.read"
            ]
          }
        ],
        "summary": "Read saved filing readiness",
        "tags": [
          "Filing readiness"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "filers.read",
          "recipients.read",
          "forms.read"
        ],
        "x-efm-weighted-units": 10
      }
    },
    "/api/v1/forms/catalog": {
      "get": {
        "description": "Start with view=inventory, then request the exact filer or recipient contract using its filer_class, tax_year and schema_rev, plus form_id for recipient view. Only the selectors for that view are accepted. Read availability, fields, validation and presentation metadata from the returned annual tuple; do not infer support from another year.",
        "operationId": "api_v1_form_field_catalog",
        "parameters": [
          {
            "in": "query",
            "name": "view",
            "required": true,
            "schema": {
              "description": "inventory takes only view. filer also requires filer_class, tax_year and schema_rev. recipient additionally requires form_id. No extra selectors are accepted.",
              "enum": [
                "inventory",
                "filer",
                "recipient"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "filer_class",
            "required": false,
            "schema": {
              "enum": [
                "app_1099_class",
                "app_1042s",
                "ssa_w2"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "tax_year",
            "required": false,
            "schema": {
              "enum": [
                2022,
                2023,
                2024,
                2025,
                2026
              ],
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "schema_rev",
            "required": false,
            "schema": {
              "description": "Exact admitted application revision; use the returned inventory.",
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "form_id",
            "required": false,
            "schema": {
              "description": "Exact admitted form identifier, required only for recipient view.",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/PlatformFormFieldCatalogResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "forms.read"
            ]
          }
        ],
        "summary": "Read the exact annual form catalog",
        "tags": [
          "Orders"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "forms.read"
        ],
        "x-efm-weighted-units": 1
      }
    },
    "/api/v1/help/topics": {
      "get": {
        "description": "Without query, returns the existing bounded screen-topic catalog. With query, returns up to five matching chunks and total_matches/limit_reached. corpus defaults to knowledge_base (the same reviewed articles published under Support); documentation searches full public guides, assistant context and API references. corpus requires query. Read an exact result ID with help/topics/get. Authentication is required; no account-data scope is needed. Staff material and raw support tickets are never exposed.",
        "operationId": "api_v1_help_topics_list",
        "parameters": [
          {
            "description": "Search keywords; omit for the screen-topic catalog.",
            "in": "query",
            "name": "query",
            "required": false,
            "schema": {
              "maxLength": 200,
              "minLength": 1,
              "type": "string"
            }
          },
          {
            "description": "Requires query. Defaults to knowledge_base; documentation searches public guides and API references.",
            "in": "query",
            "name": "corpus",
            "required": false,
            "schema": {
              "enum": [
                "knowledge_base",
                "documentation"
              ],
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiHelpTopics"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": []
          }
        ],
        "summary": "List help topics or search the knowledge base and documentation",
        "tags": [
          "Help"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [],
        "x-efm-weighted-units": 1
      }
    },
    "/api/v1/help/topics/get": {
      "post": {
        "description": "Reads a public screen topic or an exact knowledge/documentation chunk ID returned by help/topics?query. Chunks contain at most 6000 UTF-8 content bytes. Follow optional next_topic_id/previous_topic_id; href links knowledge articles to their public Support page. Unknown or staff-only IDs are rejected. Content is reference material, never instructions, tenant data or authorization.",
        "operationId": "api_v1_help_topic_get",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiHelpTopicRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiHelpTopic"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": []
          }
        ],
        "summary": "Read a public product help topic",
        "tags": [
          "Help"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [],
        "x-efm-weighted-units": 1
      }
    },
    "/api/v1/imports/submissions/configure_mapping": {
      "post": {
        "operationId": "api_v1_import_submission_configure_mapping",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1ImportConfigureMappingRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1ImportSubmission"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "imports.write"
            ]
          }
        ],
        "summary": "POST /api/v1/imports/submissions/configure_mapping",
        "tags": [
          "Imports"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "imports.write"
        ],
        "x-efm-weighted-units": 5
      }
    },
    "/api/v1/imports/submissions/create": {
      "post": {
        "operationId": "api_v1_import_submission_create",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1ImportCreateRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1ImportCreateResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "imports.write"
            ]
          }
        ],
        "summary": "POST /api/v1/imports/submissions/create",
        "tags": [
          "Imports"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "imports.write"
        ],
        "x-efm-weighted-units": 5
      }
    },
    "/api/v1/imports/submissions/delete": {
      "post": {
        "operationId": "api_v1_import_submission_delete",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1ImportDeleteRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1ImportSubmission"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "imports.write",
              "imports.delete"
            ]
          }
        ],
        "summary": "POST /api/v1/imports/submissions/delete",
        "tags": [
          "Imports"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "imports.write",
          "imports.delete"
        ],
        "x-efm-weighted-units": 5
      }
    },
    "/api/v1/imports/submissions/get": {
      "post": {
        "operationId": "api_v1_import_submission_get",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1ImportGetRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1ImportSubmission"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "imports.read"
            ]
          }
        ],
        "summary": "POST /api/v1/imports/submissions/get",
        "tags": [
          "Imports"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "imports.read"
        ],
        "x-efm-weighted-units": 2
      }
    },
    "/api/v1/imports/submissions/get_many": {
      "post": {
        "operationId": "api_v1_import_submission_get_many",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1ImportGetManyRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1ImportGetManyResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "imports.read"
            ]
          }
        ],
        "summary": "POST /api/v1/imports/submissions/get_many",
        "tags": [
          "Imports"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "imports.read"
        ],
        "x-efm-weighted-units": 2
      }
    },
    "/api/v1/imports/submissions/inspect": {
      "post": {
        "operationId": "api_v1_import_submission_inspect",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1ImportInspectRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1ImportInspectResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "imports.read",
              "tax_ids.read"
            ]
          }
        ],
        "summary": "POST /api/v1/imports/submissions/inspect",
        "tags": [
          "Imports"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "imports.read",
          "tax_ids.read"
        ],
        "x-efm-weighted-units": 2
      }
    },
    "/api/v1/imports/submissions/list": {
      "get": {
        "operationId": "api_v1_import_submission_list",
        "parameters": [
          {
            "in": "query",
            "name": "q",
            "required": false,
            "schema": {
              "maxLength": 256,
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "filer_id",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/Uuid"
            }
          },
          {
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": [
                "upload_pending",
                "queued",
                "processing",
                "completed",
                "failed"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "sort_by",
            "required": false,
            "schema": {
              "enum": [
                "created_at",
                "relevance"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "sort_order",
            "required": false,
            "schema": {
              "enum": [
                "asc",
                "desc"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "maxLength": 2048,
              "minLength": 1,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1ImportListResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "imports.read"
            ]
          }
        ],
        "summary": "GET /api/v1/imports/submissions/list",
        "tags": [
          "Imports"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "imports.read"
        ],
        "x-efm-weighted-units": 2
      }
    },
    "/api/v1/imports/submissions/rows/list": {
      "get": {
        "operationId": "api_v1_import_submission_rows_list",
        "parameters": [
          {
            "in": "query",
            "name": "submission_id",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Uuid"
            }
          },
          {
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": [
                "staged",
                "validated",
                "pushed",
                "failed",
                "dead_letter"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1ImportRowsListResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "imports.read",
              "tax_ids.read"
            ]
          }
        ],
        "summary": "GET /api/v1/imports/submissions/rows/list",
        "tags": [
          "Imports"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "imports.read",
          "tax_ids.read"
        ],
        "x-efm-weighted-units": 2
      }
    },
    "/api/v1/imports/submissions/start": {
      "post": {
        "operationId": "api_v1_import_submission_start",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1ImportStartRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1ImportSubmission"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "imports.write"
            ]
          }
        ],
        "summary": "POST /api/v1/imports/submissions/start",
        "tags": [
          "Imports"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "imports.write"
        ],
        "x-efm-weighted-units": 25
      }
    },
    "/api/v1/orders/checkout/get": {
      "post": {
        "description": "Returns delivery/expiry for one email request under the same delegated user and connection. For submitted filings use orders/list, orders/get or orders/get_many. This endpoint does not expose the human's email token or submit an order.",
        "operationId": "api_v1_checkout_get",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/McpCheckoutReference"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/McpCheckoutReceipt"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "orders.read"
            ]
          }
        ],
        "summary": "Read checkout email delivery status",
        "tags": [
          "Orders"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "orders.read"
        ],
        "x-efm-weighted-units": 1
      }
    },
    "/api/v1/orders/checkout/request": {
      "post": {
        "description": "Requests an email to the verified human who authorized this MCP connection. Specify a filer, year and workflow (efile by default, or tin_matching for a separate Bulk TIN Matching order), never a recipient selection. Read filing readiness first; only offer optional matching when tin_matching.advice=offer_matching. Pending/resolved matches are not new matching purchases. The human optionally downloads PDFs, chooses services and uses ordinary payment/terms/submission. No MCP form-count ceiling. The response contains delivery metadata only, never a bearer token or checkout URL. Requests deduplicate for the same connection/human/filer/year/workflow/day; action=remind explicitly resends after five minutes, at most three sends per link, invalidating older links. Email abuse quotas are separate from form volume. Use the same Idempotency-Key to recover an uncertain request. Opening the email never submits or charges.",
        "operationId": "api_v1_checkout_request",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RequestMcpCheckout"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/McpCheckoutReceipt"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "orders.preview",
              "filers.read"
            ]
          }
        ],
        "summary": "Email the human a filer checkout link",
        "tags": [
          "Orders"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "orders.preview",
          "filers.read"
        ],
        "x-efm-weighted-units": 5
      }
    },
    "/api/v1/orders/deliverables/get": {
      "post": {
        "operationId": "api_v1_order_deliverable_get",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1OrderDeliverableGetRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1OrderDeliverableDetail"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "deliverables.read"
            ]
          }
        ],
        "summary": "POST /api/v1/orders/deliverables/get",
        "tags": [
          "Deliverables"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "deliverables.read"
        ],
        "x-efm-weighted-units": 1
      }
    },
    "/api/v1/orders/deliverables/get_many": {
      "post": {
        "operationId": "api_v1_order_deliverable_get_many",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1OrderDeliverableGetManyRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1OrderDeliverableGetManyResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "deliverables.read"
            ]
          }
        ],
        "summary": "POST /api/v1/orders/deliverables/get_many",
        "tags": [
          "Deliverables"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "deliverables.read"
        ],
        "x-efm-weighted-units": 1
      }
    },
    "/api/v1/orders/deliverables/list": {
      "get": {
        "operationId": "api_v1_order_deliverable_list",
        "parameters": [
          {
            "in": "query",
            "name": "filer_id",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/Uuid"
            }
          },
          {
            "in": "query",
            "name": "q",
            "required": false,
            "schema": {
              "maxLength": 256,
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "service_code",
            "required": false,
            "schema": {
              "enum": [
                "efile",
                "e_delivery",
                "state_efile",
                "print_mail",
                "irs_spec_file"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": [
                "snapshot_pending",
                "materializing",
                "ready",
                "failed",
                "canceled"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "sort_by",
            "required": false,
            "schema": {
              "enum": [
                "updated_at",
                "relevance"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "sort_order",
            "required": false,
            "schema": {
              "enum": [
                "asc",
                "desc"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "maxLength": 2048,
              "minLength": 1,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1OrderDeliverableListResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "deliverables.read"
            ]
          }
        ],
        "summary": "GET /api/v1/orders/deliverables/list",
        "tags": [
          "Deliverables"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "deliverables.read"
        ],
        "x-efm-weighted-units": 1
      }
    },
    "/api/v1/orders/deliverables/request_file": {
      "post": {
        "operationId": "api_v1_order_deliverable_request_file",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1OrderDeliverableRequestFileRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1DocumentCapabilityResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "deliverables.request",
              "documents.read"
            ]
          }
        ],
        "summary": "POST /api/v1/orders/deliverables/request_file",
        "tags": [
          "Deliverables"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "deliverables.request",
          "documents.read"
        ],
        "x-efm-weighted-units": 25
      }
    },
    "/api/v1/orders/get": {
      "post": {
        "operationId": "api_v1_order_get",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1OrderGetRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1OrderDetail"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "orders.read"
            ]
          }
        ],
        "summary": "POST /api/v1/orders/get",
        "tags": [
          "Orders"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "orders.read"
        ],
        "x-efm-weighted-units": 1
      }
    },
    "/api/v1/orders/get_many": {
      "post": {
        "operationId": "api_v1_order_get_many",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1OrderGetManyRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1OrderGetManyResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "orders.read"
            ]
          }
        ],
        "summary": "POST /api/v1/orders/get_many",
        "tags": [
          "Orders"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "orders.read"
        ],
        "x-efm-weighted-units": 1
      }
    },
    "/api/v1/orders/list": {
      "get": {
        "operationId": "api_v1_order_list",
        "parameters": [
          {
            "in": "query",
            "name": "q",
            "required": false,
            "schema": {
              "maxLength": 256,
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "filer_id",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/Uuid"
            }
          },
          {
            "in": "query",
            "name": "snapshot_status",
            "required": false,
            "schema": {
              "enum": [
                "not_started",
                "queued",
                "processing",
                "completed",
                "failed"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "sort_by",
            "required": false,
            "schema": {
              "enum": [
                "updated_at",
                "relevance"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "sort_order",
            "required": false,
            "schema": {
              "enum": [
                "asc",
                "desc"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "maxLength": 2048,
              "minLength": 1,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1OrderListResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "orders.read"
            ]
          }
        ],
        "summary": "GET /api/v1/orders/list",
        "tags": [
          "Orders"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "orders.read"
        ],
        "x-efm-weighted-units": 1
      }
    },
    "/api/v1/orders/preview": {
      "post": {
        "operationId": "api_v1_order_preview",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1OrderPreviewRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1OrderPreviewResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "orders.preview"
            ]
          }
        ],
        "summary": "POST /api/v1/orders/preview",
        "tags": [
          "Orders"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "orders.preview"
        ],
        "x-efm-weighted-units": 10
      }
    },
    "/api/v1/orders/submit": {
      "post": {
        "description": "Submit a billable order after reviewing its services, funding, current price and account limits. Retry an uncertain 500 or 503 response with the exact request and the same Idempotency-Key so the existing payment attempt and order can be recovered. Do not start a replacement operation while its outcome is uncertain. A 409 or 412 requires review and a fresh preview before further submission.",
        "operationId": "api_v1_order_submit",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1OrderSubmitRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1OrderSubmitResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "orders.submit"
            ]
          }
        ],
        "summary": "POST /api/v1/orders/submit",
        "tags": [
          "Orders"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "orders.submit"
        ],
        "x-efm-weighted-units": 100
      }
    },
    "/api/v1/payment-methods/presence": {
      "get": {
        "description": "Requires explicit payment_methods.read, current filer-management permission and access to all filers. Uses the same bounded account read as the built-in agent. Returns only kind, lifecycle status, default marker and partial flag for at most 50 methods. Never returns IDs, numbers, tokens, addresses or provider credentials, and cannot charge or change a payment method. Existing grants do not acquire this new permission automatically.",
        "operationId": "api_v1_payment_methods_presence",
        "parameters": [],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiPaymentMethodPresence"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "payment_methods.read"
            ]
          }
        ],
        "summary": "Check saved payment-method status",
        "tags": [
          "Payment methods"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "payment_methods.read"
        ],
        "x-efm-weighted-units": 2
      }
    },
    "/api/v1/pdfs/print_jobs/get_many": {
      "post": {
        "description": "Batch-read up to 100 print jobs under the current account and allowed filers. Preserves request order and reports missing IDs. Downloads are minted only for completed artifacts when include_download_urls is true (default). No raw storage paths or recipient authentication challenges are returned.",
        "operationId": "api_v1_pdf_print_jobs_get_many",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/GetManyScheduledPdfPrintJobsRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1PdfPrintJobsResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "recipients.read",
              "forms.read",
              "documents.read",
              "tax_ids.read"
            ]
          }
        ],
        "summary": "Read scheduled PDF previews",
        "tags": [
          "Orders"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "recipients.read",
          "forms.read",
          "documents.read",
          "tax_ids.read"
        ],
        "x-efm-weighted-units": 5
      }
    },
    "/api/v1/pdfs/print_jobs/schedule": {
      "post": {
        "description": "Uses the same validated print request and scheduler as the app. The backend chooses immediate generation up to 100 forms or scheduled generation above 100 using authoritative counts. Form and correction filters remain optional/explicit. Immediate output returns download_url; scheduled output returns export_id (also job_id) for print_jobs/get_many. Requires documents.read and tax_ids.read. Agent requests do not send PDF-ready emails; poll the existing job endpoint. Never split the filer into repeated direct-print calls to bypass scheduling. Reuse the same Idempotency-Key after uncertainty; do not automatically repeat with a fresh key.",
        "operationId": "api_v1_pdf_print_jobs_schedule",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SchedulePdfPrintJobRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/SchedulePdfPrintJobResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "recipients.read",
              "forms.read",
              "documents.read",
              "tax_ids.read"
            ]
          }
        ],
        "summary": "Generate PDFs for a filer",
        "tags": [
          "Orders"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "recipients.read",
          "forms.read",
          "documents.read",
          "tax_ids.read"
        ],
        "x-efm-weighted-units": 25
      }
    },
    "/api/v1/recipients/dedupe/apply": {
      "post": {
        "operationId": "api_v1_recipient_dedupe_apply",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1RecipientDedupeApplyRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1RecipientDedupeApplyResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "recipients.write",
              "recipients.delete"
            ]
          }
        ],
        "summary": "POST /api/v1/recipients/dedupe/apply",
        "tags": [
          "Recipients"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "recipients.write",
          "recipients.delete"
        ],
        "x-efm-weighted-units": 10
      }
    },
    "/api/v1/recipients/dedupe/groups": {
      "get": {
        "operationId": "api_v1_recipient_dedupe_groups",
        "parameters": [
          {
            "in": "query",
            "name": "filer_id",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Uuid"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "maxLength": 2048,
              "minLength": 1,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1RecipientDedupeGroupsResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "recipients.read"
            ]
          }
        ],
        "summary": "GET /api/v1/recipients/dedupe/groups",
        "tags": [
          "Recipients"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "recipients.read"
        ],
        "x-efm-weighted-units": 3
      }
    },
    "/api/v1/recipients/delete": {
      "post": {
        "operationId": "api_v1_recipient_delete",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1RecipientDeleteRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1RecipientDeleteResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "recipients.write",
              "recipients.delete"
            ]
          }
        ],
        "summary": "POST /api/v1/recipients/delete",
        "tags": [
          "Recipients"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "recipients.write",
          "recipients.delete"
        ],
        "x-efm-weighted-units": 5
      }
    },
    "/api/v1/recipients/get": {
      "post": {
        "operationId": "api_v1_recipient_get",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1RecipientGetRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1Recipient"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "recipients.read"
            ]
          }
        ],
        "summary": "POST /api/v1/recipients/get",
        "tags": [
          "Recipients"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "recipients.read"
        ],
        "x-efm-weighted-units": 1
      }
    },
    "/api/v1/recipients/get_many": {
      "post": {
        "operationId": "api_v1_recipient_get_many",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1RecipientGetManyRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1RecipientGetManyResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "recipients.read"
            ]
          }
        ],
        "summary": "POST /api/v1/recipients/get_many",
        "tags": [
          "Recipients"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "recipients.read"
        ],
        "x-efm-weighted-units": 1
      }
    },
    "/api/v1/recipients/history/list": {
      "get": {
        "operationId": "api_v1_recipient_history_list",
        "parameters": [
          {
            "in": "query",
            "name": "filer_id",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Uuid"
            }
          },
          {
            "in": "query",
            "name": "recipient_id",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Uuid"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "maxLength": 2048,
              "minLength": 1,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1RecipientHistoryListResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "recipients.read",
              "forms.read"
            ]
          }
        ],
        "summary": "GET /api/v1/recipients/history/list",
        "tags": [
          "Recipients"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "recipients.read",
          "forms.read"
        ],
        "x-efm-weighted-units": 2
      }
    },
    "/api/v1/recipients/issues": {
      "post": {
        "description": "Shares the built-in agent's focused saved-issue projection. Optional tax_year/form_id select saved forms; field is an exact annual APP field ID. At most five forms, eight field groups and 64 issue entries are inspected. Returns safe field labels/counts and a record link; excludes private values and raw diagnostic messages. Empty/truncated examples do not prove validity. No validation is performed by the agent.",
        "operationId": "api_v1_recipient_issues",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RecipientIssuesRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiRecipientIssues"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "recipients.read",
              "forms.read"
            ]
          }
        ],
        "summary": "Read saved recipient validation issues",
        "tags": [
          "Recipients"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "recipients.read",
          "forms.read"
        ],
        "x-efm-weighted-units": 2
      }
    },
    "/api/v1/recipients/list": {
      "get": {
        "operationId": "api_v1_recipient_list",
        "parameters": [
          {
            "in": "query",
            "name": "filer_id",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Uuid"
            }
          },
          {
            "in": "query",
            "name": "q",
            "required": false,
            "schema": {
              "maxLength": 256,
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "is_archived",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "in": "query",
            "name": "state_filter",
            "required": false,
            "schema": {
              "enum": [
                "all",
                "unvalidated",
                "corrected"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "form_id",
            "required": false,
            "schema": {
              "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_h",
                "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",
                "3921",
                "3922",
                "5498",
                "5498_esa",
                "5498_qa",
                "5498_sa",
                "5498_ta",
                "15397",
                "8027",
                "8596",
                "8809",
                "8955_ssa",
                "w_2g"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "sort_by",
            "required": false,
            "schema": {
              "enum": [
                "created_at",
                "name",
                "relevance"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "sort_order",
            "required": false,
            "schema": {
              "enum": [
                "asc",
                "desc"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "maxLength": 2048,
              "minLength": 1,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1RecipientListResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "recipients.read"
            ]
          }
        ],
        "summary": "GET /api/v1/recipients/list",
        "tags": [
          "Recipients"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "recipients.read"
        ],
        "x-efm-weighted-units": 1
      }
    },
    "/api/v1/recipients/print": {
      "post": {
        "description": "Uses ordinary annual-template and grouped-statement printing. Requires documents.read and tax_ids.read because the PDF may contain Tax IDs. Immediate results contain a short-lived URL; scheduled results return export_id (also job_id) for pdfs/print_jobs/get_many. No email is sent. Idempotency uses non-replayable secret handling: an uncertain result must not be retried with a fresh key automatically. Missing templates return an error without changing form support.",
        "operationId": "api_v1_recipient_print",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateRecipientPrintRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1RecipientPrintResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "recipients.read",
              "forms.read",
              "documents.read",
              "tax_ids.read"
            ]
          }
        ],
        "summary": "Preview a saved recipient form as PDF",
        "tags": [
          "Recipients"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "recipients.read",
          "forms.read",
          "documents.read",
          "tax_ids.read"
        ],
        "x-efm-weighted-units": 25
      }
    },
    "/api/v1/recipients/upsert": {
      "post": {
        "operationId": "api_v1_recipient_upsert",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1RecipientUpsertRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1Recipient"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "recipients.write"
            ]
          }
        ],
        "summary": "POST /api/v1/recipients/upsert",
        "tags": [
          "Recipients"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "recipients.write"
        ],
        "x-efm-weighted-units": 5
      }
    },
    "/api/v1/search": {
      "post": {
        "description": "Uses the same tenant Search V2 service as global search. Omit domains to search only granted domains, or request explicit domains; ungranted domains fail before querying. Each domain requires its normal read scope. Staff and retired print-export domains are excluded. Filer restrictions filter every hit, including cached results; domains without a filer owner are unavailable to restricted connections. Results are a bounded ranked window, not a full directory. A filtered window always reports partial=true; no hidden-hit counts, ranking scores, budgets or protected metadata are returned. Search indexing may lag successful saves. Use record IDs with normal get/get_many tools. Order-deliverable hits also include typed order_id and service_code selectors because their search entity_id is composite.",
        "operationId": "api_v1_search",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiSearchRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiSearchResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "deliverables.read"
            ]
          },
          {
            "OAuth2": [
              "filers.read"
            ]
          },
          {
            "OAuth2": [
              "imports.read"
            ]
          },
          {
            "OAuth2": [
              "orders.read"
            ]
          },
          {
            "OAuth2": [
              "recipients.read"
            ]
          },
          {
            "OAuth2": [
              "w9.read"
            ]
          }
        ],
        "summary": "Search authorized account records",
        "tags": [
          "Search"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [],
        "x-efm-weighted-units": 5
      }
    },
    "/api/v1/w9/imports/create": {
      "post": {
        "operationId": "api_v1_w9_import_create",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1W9ImportCreateRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1W9ImportSubmission"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "w9.write"
            ]
          }
        ],
        "summary": "POST /api/v1/w9/imports/create",
        "tags": [
          "W-9"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "w9.write"
        ],
        "x-efm-weighted-units": 5
      }
    },
    "/api/v1/w9/imports/create_upload": {
      "post": {
        "operationId": "api_v1_w9_import_create_upload",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1W9ImportCreateUploadRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1W9ImportCreateUploadResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "w9.write"
            ]
          }
        ],
        "summary": "POST /api/v1/w9/imports/create_upload",
        "tags": [
          "W-9"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "w9.write"
        ],
        "x-efm-weighted-units": 5
      }
    },
    "/api/v1/w9/imports/inspect": {
      "post": {
        "operationId": "api_v1_w9_import_inspect",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1W9ImportInspectRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1W9ImportInspectResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "w9.read"
            ]
          }
        ],
        "summary": "POST /api/v1/w9/imports/inspect",
        "tags": [
          "W-9"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "w9.read"
        ],
        "x-efm-weighted-units": 2
      }
    },
    "/api/v1/w9/imports/list": {
      "get": {
        "operationId": "api_v1_w9_import_list",
        "parameters": [
          {
            "in": "query",
            "name": "q",
            "required": false,
            "schema": {
              "maxLength": 256,
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": [
                "upload_pending",
                "queued",
                "processing",
                "processed",
                "failed"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "sort_by",
            "required": false,
            "schema": {
              "enum": [
                "created_at",
                "relevance"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "sort_order",
            "required": false,
            "schema": {
              "enum": [
                "asc",
                "desc"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "maxLength": 2048,
              "minLength": 1,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1W9ImportListResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "w9.read"
            ]
          }
        ],
        "summary": "GET /api/v1/w9/imports/list",
        "tags": [
          "W-9"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "w9.read"
        ],
        "x-efm-weighted-units": 2
      }
    },
    "/api/v1/w9/imports/rows/list": {
      "get": {
        "operationId": "api_v1_w9_import_rows_list",
        "parameters": [
          {
            "in": "query",
            "name": "submission_id",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Uuid"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1W9ImportRowsListResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "w9.read"
            ]
          }
        ],
        "summary": "GET /api/v1/w9/imports/rows/list",
        "tags": [
          "W-9"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "w9.read"
        ],
        "x-efm-weighted-units": 2
      }
    },
    "/api/v1/w9/imports/start": {
      "post": {
        "operationId": "api_v1_w9_import_start",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1W9ImportStartRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1W9ImportSubmission"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "w9.write"
            ]
          }
        ],
        "summary": "POST /api/v1/w9/imports/start",
        "tags": [
          "W-9"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "w9.write"
        ],
        "x-efm-weighted-units": 5
      }
    },
    "/api/v1/w9/issuers/get_many": {
      "post": {
        "operationId": "api_v1_w9_issuer_get_many",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1W9IssuerGetManyRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1W9IssuerGetManyResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "w9.read"
            ]
          }
        ],
        "summary": "POST /api/v1/w9/issuers/get_many",
        "tags": [
          "W-9"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "w9.read"
        ],
        "x-efm-weighted-units": 2
      }
    },
    "/api/v1/w9/issuers/list": {
      "get": {
        "operationId": "api_v1_w9_issuer_list",
        "parameters": [
          {
            "in": "query",
            "name": "q",
            "required": false,
            "schema": {
              "maxLength": 256,
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "is_archived",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "in": "query",
            "name": "sort_by",
            "required": false,
            "schema": {
              "enum": [
                "updated_at",
                "relevance"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "sort_order",
            "required": false,
            "schema": {
              "enum": [
                "asc",
                "desc"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "maxLength": 2048,
              "minLength": 1,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1W9IssuerListResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "w9.read"
            ]
          }
        ],
        "summary": "GET /api/v1/w9/issuers/list",
        "tags": [
          "W-9"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "w9.read"
        ],
        "x-efm-weighted-units": 2
      }
    },
    "/api/v1/w9/issuers/upsert": {
      "post": {
        "operationId": "api_v1_w9_issuer_upsert",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1W9IssuerUpsertRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1W9Issuer"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "w9.write"
            ]
          }
        ],
        "summary": "POST /api/v1/w9/issuers/upsert",
        "tags": [
          "W-9"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "w9.write"
        ],
        "x-efm-weighted-units": 5
      }
    },
    "/api/v1/w9/recipient_matches/get_many": {
      "post": {
        "operationId": "api_v1_w9_recipient_matches_get_many",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1W9RecipientMatchesGetManyRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1W9RecipientMatchesGetManyResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "w9.read"
            ]
          }
        ],
        "summary": "POST /api/v1/w9/recipient_matches/get_many",
        "tags": [
          "W-9"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "w9.read"
        ],
        "x-efm-weighted-units": 2
      }
    },
    "/api/v1/w9/reconfirmations/get_many": {
      "post": {
        "operationId": "api_v1_w9_reconfirmation_get_many",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1W9ReconfirmationGetManyRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1W9ReconfirmationGetManyResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "w9.read"
            ]
          }
        ],
        "summary": "POST /api/v1/w9/reconfirmations/get_many",
        "tags": [
          "W-9"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "w9.read"
        ],
        "x-efm-weighted-units": 2
      }
    },
    "/api/v1/w9/reconfirmations/upsert": {
      "post": {
        "operationId": "api_v1_w9_reconfirmation_upsert",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1W9ReconfirmationUpsertRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1W9ReconfirmationResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "w9.write",
              "recipients.write"
            ]
          }
        ],
        "summary": "POST /api/v1/w9/reconfirmations/upsert",
        "tags": [
          "W-9"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "w9.write",
          "recipients.write"
        ],
        "x-efm-weighted-units": 5
      }
    },
    "/api/v1/w9/requests/cancel": {
      "post": {
        "operationId": "api_v1_w9_request_cancel",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1W9RequestCancelRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1W9Request"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "w9.write",
              "w9.cancel"
            ]
          }
        ],
        "summary": "POST /api/v1/w9/requests/cancel",
        "tags": [
          "W-9"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "w9.write",
          "w9.cancel"
        ],
        "x-efm-weighted-units": 5
      }
    },
    "/api/v1/w9/requests/convert": {
      "post": {
        "operationId": "api_v1_w9_request_convert",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1W9RequestConvertRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1W9ConvertResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "w9.write",
              "recipients.write"
            ]
          }
        ],
        "summary": "POST /api/v1/w9/requests/convert",
        "tags": [
          "W-9"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "w9.write",
          "recipients.write"
        ],
        "x-efm-weighted-units": 5
      }
    },
    "/api/v1/w9/requests/dispatch": {
      "post": {
        "operationId": "api_v1_w9_request_dispatch",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1W9RequestDispatchRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1W9DispatchResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "w9.write",
              "w9.dispatch"
            ]
          }
        ],
        "summary": "POST /api/v1/w9/requests/dispatch",
        "tags": [
          "W-9"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "w9.write",
          "w9.dispatch"
        ],
        "x-efm-weighted-units": 5
      }
    },
    "/api/v1/w9/requests/get_many": {
      "post": {
        "operationId": "api_v1_w9_request_get_many",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1W9RequestGetManyRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1W9RequestGetManyResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "w9.read"
            ]
          }
        ],
        "summary": "POST /api/v1/w9/requests/get_many",
        "tags": [
          "W-9"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "w9.read"
        ],
        "x-efm-weighted-units": 2
      }
    },
    "/api/v1/w9/requests/list": {
      "get": {
        "operationId": "api_v1_w9_request_list",
        "parameters": [
          {
            "in": "query",
            "name": "q",
            "required": false,
            "schema": {
              "maxLength": 256,
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": [
                "pending_dispatch",
                "sent",
                "opened",
                "otp_verified",
                "submitted",
                "converted",
                "canceled",
                "expired",
                "email_failed"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "issuer_id",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/Uuid"
            }
          },
          {
            "in": "query",
            "name": "dispatch_eligible",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "in": "query",
            "name": "sort_by",
            "required": false,
            "schema": {
              "enum": [
                "updated_at",
                "relevance"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "sort_order",
            "required": false,
            "schema": {
              "enum": [
                "asc",
                "desc"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "maxLength": 2048,
              "minLength": 1,
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1W9RequestListResponse"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "w9.read"
            ]
          }
        ],
        "summary": "GET /api/v1/w9/requests/list",
        "tags": [
          "W-9"
        ],
        "x-efm-idempotency-required": false,
        "x-efm-required-scopes": [
          "w9.read"
        ],
        "x-efm-weighted-units": 2
      }
    },
    "/api/v1/w9/requests/upsert": {
      "post": {
        "operationId": "api_v1_w9_request_upsert",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ApiV1W9RequestUpsertRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ApiV1SuccessEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/ApiV1W9Request"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/InvalidToken"
          },
          "402": {
            "$ref": "#/components/responses/CapacityRequired"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "412": {
            "$ref": "#/components/responses/PreconditionFailed"
          },
          "422": {
            "$ref": "#/components/responses/ValidationFailed"
          },
          "429": {
            "$ref": "#/components/responses/RateLimited"
          },
          "500": {
            "$ref": "#/components/responses/InternalError"
          },
          "503": {
            "$ref": "#/components/responses/ServiceUnavailable"
          }
        },
        "security": [
          {
            "OAuth2": [
              "w9.write"
            ]
          }
        ],
        "summary": "POST /api/v1/w9/requests/upsert",
        "tags": [
          "W-9"
        ],
        "x-efm-idempotency-required": true,
        "x-efm-required-scopes": [
          "w9.write"
        ],
        "x-efm-weighted-units": 5
      }
    }
  },
  "security": [
    {
      "OAuth2": []
    }
  ],
  "servers": [
    {
      "description": "Production (replace with the environment-specific resource origin)",
      "url": "https://api.efilemagic.com"
    }
  ],
  "tags": [
    {
      "name": "Filers"
    },
    {
      "name": "Recipients"
    },
    {
      "name": "Imports"
    },
    {
      "name": "W-9"
    },
    {
      "name": "Orders"
    },
    {
      "name": "Deliverables"
    }
  ]
}
