> For the complete documentation index, see [llms.txt](https://peoplescourt.ai/llms.txt). This page is also available as Markdown.

# Withdraw a claim where pinned Rules permit

Available when canonical API access is enabled. The shared operation rechecks current authority and pinned Rules. Confined to an authorized claimant and the existing unilateral-withdrawal predicate.

Reference

Party procedure

POST

partial

`/api/cases/{id}/withdrawals`

`withdrawClaimPreview`

## 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.

`CanonicalSession`

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

`CanonicalPartnerBearer`

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

`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

Name

Location

Requirement

Schema

`id`

path

Required

{"type":"string"}

`Idempotency-Key`

Reuse for an identical retry to recover the same result. Changed input conflicts.

header

Optional

{"type":"string"}

## Request body

Required request body.

application/json

```json
{
  "$ref": "#/components/schemas/TerminationRequestInput",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "action",
    "expectedRevision"
  ],
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "request",
        "cancel_request"
      ]
    },
    "expectedRevision": {
      "type": "integer",
      "minimum": 0
    },
    "requestId": {
      "type": "string",
      "description": "Required when action is cancel_request."
    },
    "adoption": {
      "$ref": "#/components/schemas/RulesAdoptionAssent",
      "type": "object",
      "additionalProperties": false,
      "required": [
        "version",
        "hash",
        "statementVersion"
      ],
      "properties": {
        "version": {
          "type": "string"
        },
        "hash": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "statementVersion": {
          "type": "string",
          "const": "rule_1_3_adoption_v1"
        }
      }
    },
    "externalProtocolReference": {
      "type": "string",
      "pattern": "^[A-Za-z0-9._:-]{1,200}$",
      "description": "Required when action is request; identifies the agent protocol act without exposing settlement terms."
    }
  }
}
```

## Responses

### 201

Authorized operation result.

application/json

```json
{
  "$ref": "#/components/schemas/CanonicalWithdrawClaimPreviewResponse",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "caseId",
        "caseStatus",
        "revision",
        "termination"
      ],
      "properties": {
        "caseId": {
          "type": "string"
        },
        "caseStatus": {
          "type": "string"
        },
        "revision": {
          "type": "integer",
          "minimum": 0
        },
        "termination": {
          "$ref": "#/components/schemas/CanonicalTermination",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "id",
            "kind",
            "status",
            "initiatedBySide",
            "initiatedAt",
            "confirmations",
            "fundsEffect"
          ],
          "properties": {
            "schemaVersion": {
              "type": "string",
              "const": "pre-award-termination-v1"
            },
            "id": {
              "type": "string"
            },
            "kind": {
              "type": "string",
              "enum": [
                "claimant_withdrawal",
                "party_agreement"
              ]
            },
            "status": {
              "type": "string",
              "enum": [
                "pending",
                "completed",
                "cancelled",
                "superseded"
              ]
            },
            "initiatedBySide": {
              "type": "string",
              "enum": [
                "claimant",
                "respondent"
              ]
            },
            "initiatedAt": {
              "type": "string",
              "format": "date-time"
            },
            "confirmations": {
              "type": "array",
              "maxItems": 2,
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "side",
                  "confirmedAt"
                ],
                "properties": {
                  "side": {
                    "type": "string",
                    "enum": [
                      "claimant",
                      "respondent"
                    ]
                  },
                  "confirmedAt": {
                    "type": "string",
                    "format": "date-time"
                  }
                }
              }
            },
            "completedAt": {
              "type": "string",
              "format": "date-time"
            },
            "cancelledAt": {
              "type": "string",
              "format": "date-time"
            },
            "fundsEffect": {
              "type": "string",
              "const": "none"
            },
            "adoptsRulesVersion": {
              "type": "string"
            },
            "adoptsRulesHash": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            }
          }
        },
        "deadlinesContinue": {
          "type": "boolean"
        }
      }
    },
    "requestId": {
      "type": "string"
    }
  },
  "required": [
    "data",
    "requestId"
  ]
}
```

### 404

The resource is unavailable or the caller lacks access.

### default

RFC 9457 style problem response.

application/problem+json

```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

```json
{
  "data": {
    "caseId": "pcase_test_123",
    "caseStatus": "caseStatus_test",
    "revision": 1,
    "termination": {
      "id": "id_test",
      "kind": "claimant_withdrawal",
      "status": "pending",
      "initiatedBySide": "claimant",
      "initiatedAt": "2026-08-09T12:00:00.000Z",
      "confirmations": [
        {
          "side": "claimant",
          "confirmedAt": "2026-08-09T12:00:00.000Z"
        }
      ],
      "fundsEffect": "none"
    }
  },
  "requestId": "requestId_test"
}
```

## Errors

Read the response status and stable error code. See [errors](https://peoplescourt.ai/docs/api/errors.md) and [rate limits](https://peoplescourt.ai/docs/api/rate-limits.md) 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.

## Request examples

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

```sh
curl --request POST \
  --url 'https://peoplescourt.ai/api/cases/pcase_test_123/withdrawals' \
  --header 'Cookie: arb_session=COPY_ACCOUNT_SESSION' \
  --header 'Origin: https://peoplescourt.ai' \
  --header 'Content-Type: application/json' \
  --data '{
  "action": "request",
  "expectedRevision": 1
}'
```

```ts
const input = {
  "action": "request",
  "expectedRevision": 1
};

const response = await fetch("https://peoplescourt.ai/api/cases/pcase_test_123/withdrawals", {
  method: "POST",
  headers: {
    "Cookie": "arb_session=COPY_ACCOUNT_SESSION",
    "Origin": "https://peoplescourt.ai",
    "Content-Type": "application/json"
  },
  body: JSON.stringify(input),
});
if (!response.ok) throw await response.json();
const result = await response.json();
```

```python
import requests

response = requests.post(
    "https://peoplescourt.ai/api/cases/pcase_test_123/withdrawals",
    headers={
      "Cookie": "arb_session=COPY_ACCOUNT_SESSION",
      "Origin": "https://peoplescourt.ai",
      "Content-Type": "application/json"
    },
    json={"action": "request", "expectedRevision": 1},
    timeout=30,
)
response.raise_for_status()
result = response.json()
```