GETpartial

Read your own filing's acceptance, fee and opening progress

Account-only, selected by a People's Court account access token with filings:write, the same authority that prepared the draft. Ownership is enforced before anything is read, and a draft owned by another account is not found. Read-only: it reports whether the person has accepted the packet on People's Court, the quoted fee, whether a payment has started, the 30-day payment window after acceptance, and the case once it has opened. It never returns the one-use acceptance link, a payment handle or a Checkout session, and it records nothing. A packet whose Rules, disclosure or price moved before money was admitted reports expired with packet_changed, because acceptance and payment would refuse it. filingPayment is the owner's signed-in continuation page; payment there never records arbitration acceptance.

/api/filings/{id}/statusgetAccountFilingStatus

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.

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

NameLocationRequirementSchema
idpathRequired{"type":"string"}

Responses

200

The owner's current filing progress.

application/json

{
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/AccountFilingStatus",
      "type": "object",
      "additionalProperties": false,
      "description": "One account-owned filing's progress, read by its owner. It carries no capability and states only what People's Court has recorded.",
      "properties": {
        "schemaVersion": {
          "type": "string",
          "const": "account-filing-status-v1"
        },
        "filingId": {
          "type": "string"
        },
        "status": {
          "type": "string",
          "enum": [
            "awaiting_acceptance",
            "accepted",
            "filing_fee_pending",
            "opened",
            "expired"
          ],
          "description": "awaiting_acceptance until the person accepts on People's Court; accepted once they have; filing_fee_pending once the case is reserved and its fee is due; opened once the case exists; expired when the review link or the 30-day payment window closed, or the packet no longer matches the current Rules and price."
        },
        "expiredReason": {
          "type": "string",
          "enum": [
            "review_window_closed",
            "payment_window_closed",
            "packet_changed"
          ]
        },
        "acceptance": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "recorded"
          ],
          "properties": {
            "recorded": {
              "type": "boolean"
            },
            "acceptedAt": {
              "type": "string",
              "format": "date-time"
            }
          }
        },
        "acceptanceLinkExpiresAt": {
          "type": "string",
          "format": "date-time",
          "description": "While unaccepted, when the issued hosted acceptance link stops working. The link itself is never returned here."
        },
        "acceptanceExpiresAt": {
          "type": "string",
          "format": "date-time",
          "description": "For an accepted payable filing, the end of its 30-day payment window."
        },
        "quotedFeeUsd": {
          "type": "string",
          "description": "Exact quoted filing fee in USD at the published schedule's precision."
        },
        "payable": {
          "type": "boolean"
        },
        "paymentAdmitted": {
          "type": "boolean",
          "description": "A Checkout attempt is open. Closing Checkout keeps the draft."
        },
        "caseId": {
          "type": "string",
          "description": "Present only once the case has opened."
        },
        "links": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "casePage": {
              "type": "string"
            },
            "filingPayment": {
              "type": "string",
              "description": "The owner's signed-in page that continues into payment. Present only while an accepted fee is due."
            }
          }
        }
      },
      "required": [
        "schemaVersion",
        "filingId",
        "status",
        "acceptance",
        "quotedFeeUsd",
        "payable",
        "paymentAdmitted",
        "links"
      ]
    },
    "requestId": {
      "type": "string"
    }
  }
}
default

RFC 9457 style problem response.

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": {
    "schemaVersion": "account-filing-status-v1",
    "filingId": "filingId_test",
    "status": "awaiting_acceptance",
    "acceptance": {
      "recorded": false
    },
    "quotedFeeUsd": "quotedFeeUsd_test",
    "payable": false,
    "paymentAdmitted": false,
    "links": {}
  },
  "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.