POSTpartial

File an authorized appeal

Flag-gated preview over the shared remedy operations. Session/case proofs retain existing scope. Partner writes require an explicit appeal:file, appeal:answer, or post_award:request membership grant; existing memberships are not widened. Idempotency-Key shares durable receipts with hosted aliases. Only internal actors decide remedies or confirm provider payment. POST post-award-requests accepts action=respond with requestId and response for the opposite party’s response.

/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

CanonicalSession

AccountOAuth

Account tokens authorize only their approving account and case scope. S256 PKCE is mandatory on the code flow. Explicit reacceptance is required after Rules/disclosure changes.

Parameters

Name	Location	Requirement	Schema
`id`	path	Required	`{"type":"string"}`
`Idempotency-Key`	header	Optional	`{"type":"string"}`

Request body

Required request body.

application/json

{
  "$ref": "#/components/schemas/CanonicalRemedyInput",
  "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
    },
    "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"
    }
  }
}

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"
            },
            "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"
  ],
  "x-code-source": "lib/api/canonical-remedies.ts"
}

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"
            },
            "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"
  ],
  "x-code-source": "lib/api/canonical-remedies.ts"
}

404

Preview disabled or authorized resource unavailable.

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"
    }
  }
}

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.

Use https://peoplescourt.ai with the test credential issued for your integration.

cURL

curl --request POST \
  --url 'https://peoplescourt.ai/api/cases/id_test/appeals' \
  --header 'Authorization: Bearer pk_test_replace_me' \
  --header 'Idempotency-Key: idem_test_12345678' \
  --header 'Content-Type: application/json' \
  --data '{}'

TypeScript SDK

import type { PeopleCourtClient } from "./sdk/typescript/src/index.ts";

// Pass your configured client and this method’s typed arguments.
export async function request(client: PeopleCourtClient,
  ...args: Parameters<PeopleCourtClient["fileAppealPreview"]>) {
  const response = await client.fileAppealPreview(...args);
  return response.data;
}

Python

import requests

response = requests.post(
    "https://peoplescourt.ai/api/cases/id_test/appeals",
    headers={
      "Authorization": "Bearer pk_test_replace_me",
      "Idempotency-Key": "idem_test_12345678",
      "Content-Type": "application/json"
    },
    json={},
    timeout=30,
)
response.raise_for_status()
result = response.json()