For the complete documentation index, see llms.txt. This page is also available as Markdown.

POSTpartial

File an authorized appeal

File an appeal under the acting party’s authority; partner membership requires appeal:file. The served Award, deadline and fee requirements must permit the filing.

/api/cases/{id}/appealsfileAppealPreview

Authentication and authority

Use one listed account-session, scoped OAuth, or partner credential alternative. Account tokens retain the approving account’s authority. Cookie-authenticated writes require same-origin authorization. Alternatives are OR; schemes in one alternative are AND.

CanonicalPartnerBearer

Partner key issued after partner access is approved. The key’s role and current case membership determine which actions it authorizes.

CanonicalSession

The signed-in account’s session. Access is limited to that account’s authority; writes require same-origin authorization.

AccountOAuth

Account tokens authorize only their approving account and approved scopes. S256 PKCE is mandatory on the code flow. Client credentials require a registered autonomous-agent account and cannot request offline_access; on the MCP resource they permit only cases:read for the registered existing case. Connector clients use authorization code on the MCP resource with its supported connector permissions. Explicit reacceptance is required after Rules or disclosure changes.

Parameters

NameLocationRequirementSchema
idpathRequired{"type":"string"}
Idempotency-KeyheaderOptional{"type":"string"}

Request body

Required request body.

application/json

{
  "$ref": "#/components/schemas/CanonicalRemedyInput",
  "description": "Post-Award requests retain the applicable seven-day period after service despite an appeal waiver or completed execution. Existing appellate material-specific deadlines remain controlling. An exact sourceSupplement target opens only that supplement’s correction window, without renewing the deadline for unrelated original material.",
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "expectedRevision": {
          "type": "integer",
          "minimum": 0
        },
        "notice": {
          "type": "string"
        },
        "claimedErrors": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "outcomeEffect": {
          "type": "string"
        },
        "response": {
          "type": "string"
        },
        "crossErrors": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "requestedDisposition": {
          "type": "string"
        },
        "kind": {
          "type": "string",
          "enum": [
            "correction",
            "additional_award"
          ]
        },
        "request": {
          "type": "string"
        },
        "pleadedReliefIndex": {
          "type": "integer",
          "minimum": 0
        },
        "sourceSupplement": false,
        "correctionTarget": {
          "description": "Required for correction after a Rules 1.0 modification, substitution, or vacatur. Vacatur permits only appellate_text. Unchanged funds instructions retain the original request deadline.",
          "oneOf": [
            {
              "type": "object",
              "required": [
                "kind"
              ],
              "additionalProperties": false,
              "properties": {
                "kind": {
                  "type": "string",
                  "const": "appellate_text"
                }
              }
            },
            {
              "type": "object",
              "required": [
                "kind",
                "index"
              ],
              "additionalProperties": false,
              "properties": {
                "kind": {
                  "type": "string",
                  "const": "funds_instruction"
                },
                "index": {
                  "type": "integer",
                  "minimum": 0
                }
              }
            }
          ]
        },
        "action": {
          "type": "string",
          "enum": [
            "file",
            "respond"
          ]
        },
        "requestId": {
          "type": "string"
        }
      }
    },
    {
      "type": "object",
      "properties": {
        "expectedRevision": {
          "type": "integer",
          "minimum": 0
        },
        "notice": {
          "type": "string"
        },
        "claimedErrors": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "outcomeEffect": {
          "type": "string"
        },
        "response": {
          "type": "string"
        },
        "crossErrors": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "requestedDisposition": {
          "type": "string"
        },
        "kind": {
          "type": "string",
          "const": "correction"
        },
        "request": {
          "type": "string"
        },
        "pleadedReliefIndex": {
          "type": "integer",
          "minimum": 0
        },
        "sourceSupplement": {
          "$ref": "#/components/schemas/PostExecutionSupplementTarget",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "id",
            "sha256"
          ],
          "description": "Exact signed supplement coordinate. A correction request may target only a verified supplement in this case that has no correction successor when the request is filed. Its seven-day period runs from its service. Omit sourceSupplement to target the original Award; unrelated original deadlines are never renewed.",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1
            },
            "sha256": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            }
          }
        },
        "correctionTarget": {
          "description": "Required for correction after a Rules 1.0 modification, substitution, or vacatur. Vacatur permits only appellate_text. Unchanged funds instructions retain the original request deadline.",
          "oneOf": [
            {
              "type": "object",
              "required": [
                "kind"
              ],
              "additionalProperties": false,
              "properties": {
                "kind": {
                  "type": "string",
                  "const": "appellate_text"
                }
              }
            },
            {
              "type": "object",
              "required": [
                "kind",
                "index"
              ],
              "additionalProperties": false,
              "properties": {
                "kind": {
                  "type": "string",
                  "const": "funds_instruction"
                },
                "index": {
                  "type": "integer",
                  "minimum": 0
                }
              }
            }
          ]
        },
        "action": {
          "type": "string",
          "enum": [
            "file",
            "respond"
          ]
        },
        "requestId": {
          "type": "string"
        }
      },
      "required": [
        "sourceSupplement",
        "kind"
      ]
    }
  ]
}

Responses

200

Authorized read, response, or recovered result.

application/json

{
  "$ref": "#/components/schemas/CanonicalFileAppealPreviewResponse",
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/CanonicalAppealResult",
      "type": "object",
      "properties": {
        "appeal": {
          "$ref": "#/components/schemas/CanonicalAppeal",
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "disputeId": {
              "type": "string"
            },
            "filedBy": {
              "type": "string",
              "enum": [
                "claimant",
                "respondent"
              ]
            },
            "filedAt": {
              "type": "string"
            },
            "sourceDispositionId": {
              "type": "string"
            },
            "sourceAwardHash": {
              "type": "string"
            },
            "sourceAwardRevision": {
              "type": "integer"
            },
            "sourceRecordHash": {
              "type": "string"
            },
            "feeUsd": {
              "type": "number"
            },
            "feeRecordId": {
              "type": "string"
            },
            "feeStatus": {
              "type": "string",
              "enum": [
                "payable",
                "confirmed"
              ]
            },
            "openingBrief": {
              "type": "object",
              "properties": {
                "notice": {
                  "type": "string"
                },
                "claimedErrors": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "outcomeEffect": {
                  "type": "string"
                },
                "filedAt": {
                  "type": "string"
                }
              }
            },
            "answerBrief": {
              "type": "object",
              "properties": {
                "response": {
                  "type": "string"
                },
                "crossErrors": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "requestedDisposition": {
                  "type": "string"
                },
                "filedAt": {
                  "type": "string"
                }
              }
            },
            "answerDueAt": {
              "type": "string"
            },
            "reservationState": {
              "type": "string",
              "enum": [
                "unpaid",
                "awaiting_docket",
                "unapplied",
                "withdrawn",
                "lapsed"
              ]
            },
            "paymentRecordedAt": {
              "type": "string"
            },
            "operativeBindings": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "awardHash": {
                    "type": "string"
                  },
                  "awardRevision": {
                    "type": "integer"
                  },
                  "boundAt": {
                    "type": "string"
                  },
                  "election": {
                    "type": "string"
                  },
                  "supplementalStatement": {
                    "type": "string"
                  }
                }
              }
            },
            "revisionElection": {
              "type": "object",
              "properties": {
                "awardHash": {
                  "type": "string"
                },
                "awardRevision": {
                  "type": "integer"
                },
                "servedAt": {
                  "type": "string"
                },
                "dueAt": {
                  "type": "string"
                },
                "decidedAt": {
                  "type": "string"
                },
                "choice": {
                  "type": "string"
                }
              }
            },
            "decisionDueAt": {
              "type": "string"
            },
            "extendedDecisionDueAt": {
              "type": "string"
            },
            "briefingClosedAt": {
              "type": "string"
            },
            "briefingCloseReason": {
              "type": "string"
            },
            "paymentReservationExpiresAt": {
              "type": "string"
            },
            "docketedAt": {
              "type": "string"
            },
            "docketNoticeServedAt": {
              "type": "string"
            },
            "reasonedDisposition": {
              "type": "object",
              "properties": {
                "text": {
                  "type": "string"
                },
                "by": {
                  "type": "string"
                },
                "at": {
                  "type": "string"
                }
              }
            },
            "decidedAt": {
              "type": "string"
            },
            "outcome": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "filedBy",
            "filedAt",
            "sourceDispositionId",
            "sourceAwardHash",
            "sourceAwardRevision",
            "sourceRecordHash",
            "feeUsd",
            "feeStatus"
          ]
        },
        "status": {
          "type": "string"
        },
        "feeChallenge": {
          "$ref": "#/components/schemas/CanonicalAppealFeeChallenge",
          "type": "object",
          "properties": {
            "method": {
              "type": "string",
              "const": "fiat_card"
            },
            "feeRecordId": {
              "type": "string"
            },
            "amountUsd": {
              "type": "number"
            },
            "deadlineAt": {
              "type": "string"
            },
            "checkoutEndpoint": {
              "type": "string"
            }
          },
          "required": [
            "method",
            "feeRecordId",
            "amountUsd",
            "checkoutEndpoint"
          ]
        }
      },
      "required": [
        "appeal"
      ]
    },
    "requestId": {
      "type": "string"
    }
  },
  "required": [
    "data",
    "requestId"
  ]
}
201

Remedy act recorded.

application/json

{
  "$ref": "#/components/schemas/CanonicalFileAppealPreviewResponse",
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/CanonicalAppealResult",
      "type": "object",
      "properties": {
        "appeal": {
          "$ref": "#/components/schemas/CanonicalAppeal",
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "disputeId": {
              "type": "string"
            },
            "filedBy": {
              "type": "string",
              "enum": [
                "claimant",
                "respondent"
              ]
            },
            "filedAt": {
              "type": "string"
            },
            "sourceDispositionId": {
              "type": "string"
            },
            "sourceAwardHash": {
              "type": "string"
            },
            "sourceAwardRevision": {
              "type": "integer"
            },
            "sourceRecordHash": {
              "type": "string"
            },
            "feeUsd": {
              "type": "number"
            },
            "feeRecordId": {
              "type": "string"
            },
            "feeStatus": {
              "type": "string",
              "enum": [
                "payable",
                "confirmed"
              ]
            },
            "openingBrief": {
              "type": "object",
              "properties": {
                "notice": {
                  "type": "string"
                },
                "claimedErrors": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "outcomeEffect": {
                  "type": "string"
                },
                "filedAt": {
                  "type": "string"
                }
              }
            },
            "answerBrief": {
              "type": "object",
              "properties": {
                "response": {
                  "type": "string"
                },
                "crossErrors": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "requestedDisposition": {
                  "type": "string"
                },
                "filedAt": {
                  "type": "string"
                }
              }
            },
            "answerDueAt": {
              "type": "string"
            },
            "reservationState": {
              "type": "string",
              "enum": [
                "unpaid",
                "awaiting_docket",
                "unapplied",
                "withdrawn",
                "lapsed"
              ]
            },
            "paymentRecordedAt": {
              "type": "string"
            },
            "operativeBindings": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "awardHash": {
                    "type": "string"
                  },
                  "awardRevision": {
                    "type": "integer"
                  },
                  "boundAt": {
                    "type": "string"
                  },
                  "election": {
                    "type": "string"
                  },
                  "supplementalStatement": {
                    "type": "string"
                  }
                }
              }
            },
            "revisionElection": {
              "type": "object",
              "properties": {
                "awardHash": {
                  "type": "string"
                },
                "awardRevision": {
                  "type": "integer"
                },
                "servedAt": {
                  "type": "string"
                },
                "dueAt": {
                  "type": "string"
                },
                "decidedAt": {
                  "type": "string"
                },
                "choice": {
                  "type": "string"
                }
              }
            },
            "decisionDueAt": {
              "type": "string"
            },
            "extendedDecisionDueAt": {
              "type": "string"
            },
            "briefingClosedAt": {
              "type": "string"
            },
            "briefingCloseReason": {
              "type": "string"
            },
            "paymentReservationExpiresAt": {
              "type": "string"
            },
            "docketedAt": {
              "type": "string"
            },
            "docketNoticeServedAt": {
              "type": "string"
            },
            "reasonedDisposition": {
              "type": "object",
              "properties": {
                "text": {
                  "type": "string"
                },
                "by": {
                  "type": "string"
                },
                "at": {
                  "type": "string"
                }
              }
            },
            "decidedAt": {
              "type": "string"
            },
            "outcome": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "filedBy",
            "filedAt",
            "sourceDispositionId",
            "sourceAwardHash",
            "sourceAwardRevision",
            "sourceRecordHash",
            "feeUsd",
            "feeStatus"
          ]
        },
        "status": {
          "type": "string"
        },
        "feeChallenge": {
          "$ref": "#/components/schemas/CanonicalAppealFeeChallenge",
          "type": "object",
          "properties": {
            "method": {
              "type": "string",
              "const": "fiat_card"
            },
            "feeRecordId": {
              "type": "string"
            },
            "amountUsd": {
              "type": "number"
            },
            "deadlineAt": {
              "type": "string"
            },
            "checkoutEndpoint": {
              "type": "string"
            }
          },
          "required": [
            "method",
            "feeRecordId",
            "amountUsd",
            "checkoutEndpoint"
          ]
        }
      },
      "required": [
        "appeal"
      ]
    },
    "requestId": {
      "type": "string"
    }
  },
  "required": [
    "data",
    "requestId"
  ]
}
404

The resource is unavailable or the caller lacks access.

default

Stable problem code and requestId.

application/problem+json

{
  "$ref": "#/components/schemas/Problem",
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "requestId"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "details": {
      "description": "Account-readiness refusals include a value-free checklist and exact account-page link. Other error codes may provide different details.",
      "anyOf": [
        {
          "$ref": "#/components/schemas/AccountReadinessDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "ready",
            "accountSetupUrl",
            "missing"
          ],
          "properties": {
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {
          "$ref": "#/components/schemas/LegalDocumentsRequiredDetails",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "legalDocumentsUrl"
          ],
          "properties": {
            "legalDocumentsUrl": {
              "type": "string",
              "format": "uri",
              "description": "Absolute account-page URL where the person reviews and accepts the current Terms and Privacy Notice. Uses the configured public application origin. After accepting the documents, retry the original operation."
            },
            "ready": {
              "type": "boolean"
            },
            "accountSetupUrl": {
              "type": "string",
              "format": "uri"
            },
            "missing": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AccountReadinessRequirement",
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "code",
                  "label",
                  "section",
                  "accountUrl"
                ],
                "properties": {
                  "code": {
                    "type": "string"
                  },
                  "label": {
                    "type": "string"
                  },
                  "section": {
                    "type": "string",
                    "enum": [
                      "email",
                      "identity",
                      "legal_documents"
                    ]
                  },
                  "accountUrl": {
                    "type": "string",
                    "format": "uri"
                  }
                }
              }
            }
          }
        },
        {}
      ]
    }
  }
}

Example response

Successful response

{
  "data": {
    "appeal": {
      "id": "id_test",
      "filedBy": "claimant",
      "filedAt": "filedAt_test",
      "sourceDispositionId": "sourceDispositionId_test",
      "sourceAwardHash": "sourceAwardHash_test",
      "sourceAwardRevision": 1,
      "sourceRecordHash": "sourceRecordHash_test",
      "feeUsd": 0.9,
      "feeStatus": "payable"
    }
  },
  "requestId": "requestId_test"
}

Errors

Read the response status and stable error code. See errors and rate limits for recovery. Refresh the resource before resolving a state or digest conflict.

Idempotency and retries

  • For throttling, honor Retry-After when present. Back off on retryable server failures.
  • Send a unique Idempotency-Key. An exact retry returns the stored result; reusing the key with a different request fails.
  • The request is accepted only when its credential, authority, case state, and resource preconditions are satisfied.