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

# Request execution or record performance and partner follow-up

Reports require active case membership. OAuth requires the new executions:report scope; existing grants gain no authority. Acknowledgement or dispute comes from the opposite side. Provider release requires a separately authorized settlement adapter credential and all Award holds to clear. Partner receipts and non-execution attestations additionally require x-execution-timestamp and x-execution-signature. The HMAC-SHA256 key is the presented partner bearer credential; sign canonical JSON of caseId, awardHash, idempotencyKey, timestamp and body. Timestamp is Unix milliseconds, within five minutes. A signature proves report provenance; the registered partner provider independently verifies a receipt. Reuse the idempotency key only for the same operation and unchanged request.

Reference

Execution

POST

partial

`/api/cases/{id}/executions`

`recordAwardExecution`

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

Name

Location

Requirement

Schema

`id`

path

Required

{"type":"string"}

`Idempotency-Key`

header

Required

{"type":"string","minLength":8,"maxLength":200}

`x-execution-timestamp`

header

Optional

{"type":"string"}

`x-execution-signature`

header

Optional

{"type":"string"}

## Request body

Required request body.

application/json

```json
{
  "$ref": "#/components/schemas/AwardExecutionCommand",
  "discriminator": {
    "propertyName": "action"
  },
  "oneOf": [
    {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "action",
        "awardHash"
      ],
      "properties": {
        "action": {
          "type": "string",
          "enum": [
            "initialize"
          ]
        },
        "awardHash": {
          "type": "string"
        }
      }
    },
    {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "action",
        "awardHash"
      ],
      "properties": {
        "action": {
          "type": "string",
          "enum": [
            "request_release"
          ]
        },
        "awardHash": {
          "type": "string"
        }
      }
    },
    {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "action",
        "awardHash",
        "description"
      ],
      "properties": {
        "action": {
          "type": "string",
          "enum": [
            "report_performance"
          ]
        },
        "awardHash": {
          "type": "string"
        },
        "description": {
          "type": "string",
          "minLength": 1,
          "maxLength": 4000
        },
        "reference": {
          "type": "string",
          "minLength": 1,
          "maxLength": 500
        }
      }
    },
    {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "action",
        "awardHash",
        "reportId"
      ],
      "properties": {
        "action": {
          "type": "string",
          "enum": [
            "acknowledge"
          ]
        },
        "awardHash": {
          "type": "string"
        },
        "reportId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "reason": {
          "type": "string",
          "minLength": 1,
          "maxLength": 4000
        }
      }
    },
    {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "action",
        "awardHash",
        "reportId"
      ],
      "properties": {
        "action": {
          "type": "string",
          "enum": [
            "dispute"
          ]
        },
        "awardHash": {
          "type": "string"
        },
        "reportId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "reason": {
          "type": "string",
          "minLength": 1,
          "maxLength": 4000
        }
      }
    },
    {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "action",
        "awardHash",
        "reason"
      ],
      "properties": {
        "action": {
          "type": "string",
          "enum": [
            "will_not_execute"
          ]
        },
        "awardHash": {
          "type": "string"
        },
        "reason": {
          "type": "string",
          "minLength": 1,
          "maxLength": 4000
        }
      }
    },
    {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "action",
        "awardHash",
        "reference"
      ],
      "properties": {
        "action": {
          "type": "string",
          "enum": [
            "partner_receipt"
          ]
        },
        "awardHash": {
          "type": "string"
        },
        "reference": {
          "type": "string",
          "minLength": 1,
          "maxLength": 500
        }
      }
    }
  ]
}
```

## Responses

### 201

Recorded execution resource or authorized replay.

application/json

```json
{
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/AwardExecutionResource",
      "type": "object",
      "required": [
        "id",
        "caseId",
        "awardId",
        "awardHash",
        "mode",
        "status",
        "paymentConfirmed",
        "executedBy",
        "receipt",
        "reports",
        "links"
      ],
      "properties": {
        "provider": {
          "type": "string"
        },
        "providerOperation": {
          "type": "object",
          "required": [
            "id",
            "status",
            "attempts"
          ],
          "properties": {
            "id": {
              "type": "string"
            },
            "status": {
              "enum": [
                "prepared",
                "submitting",
                "unknown",
                "confirmed",
                "needs_action"
              ]
            },
            "attempts": {
              "type": "integer",
              "minimum": 0
            }
          }
        },
        "reconciliation": {
          "type": "object",
          "required": [
            "state",
            "checkedAt",
            "recovery"
          ],
          "properties": {
            "state": {
              "enum": [
                "pending",
                "unknown",
                "confirmed",
                "needs_action",
                "reversed"
              ]
            },
            "checkedAt": {
              "type": [
                "string",
                "null"
              ],
              "format": "date-time"
            },
            "recovery": {
              "type": [
                "object",
                "null"
              ],
              "properties": {
                "reason": {
                  "enum": [
                    "vacated",
                    "superseded",
                    "provider_reversal"
                  ]
                },
                "status": {
                  "enum": [
                    "pending",
                    "reversed",
                    "needs_action"
                  ]
                },
                "detail": {
                  "type": "string"
                },
                "requestedAt": {
                  "type": "string",
                  "format": "date-time"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            }
          }
        },
        "providerReceipts": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "step",
              "id",
              "object",
              "amount",
              "currency",
              "livemode",
              "status"
            ],
            "properties": {
              "step": {
                "enum": [
                  "debit",
                  "transfer",
                  "reverse_transfer",
                  "refund_debit"
                ]
              },
              "id": {
                "type": "string"
              },
              "object": {
                "enum": [
                  "charge",
                  "payment",
                  "transfer",
                  "transfer_reversal",
                  "refund"
                ]
              },
              "amount": {
                "type": "integer",
                "minimum": 1
              },
              "currency": {
                "const": "usd"
              },
              "livemode": {
                "type": "boolean"
              },
              "source": {
                "type": "string"
              },
              "destination": {
                "type": "string"
              },
              "status": {
                "type": "string"
              }
            }
          }
        },
        "id": {
          "type": "string"
        },
        "caseId": {
          "type": "string"
        },
        "awardId": {
          "type": "string"
        },
        "awardHash": {
          "type": "string"
        },
        "mode": {
          "type": "string",
          "enum": [
            "partner_executed",
            "court_escrow",
            "external_provider",
            "decision_only"
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "decision_delivered",
            "execution_pending",
            "overdue",
            "will_not_execute",
            "not_automatically_executed",
            "performance_reported",
            "performance_acknowledged",
            "performance_disputed",
            "not_requested",
            "pending",
            "unknown_outcome",
            "needs_action",
            "blocked",
            "executed",
            "simulated",
            "reversal_pending",
            "reversed",
            "reversal_needs_action"
          ]
        },
        "paymentConfirmed": {
          "type": "boolean"
        },
        "executedBy": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "partner",
            "peoples_court",
            "provider",
            null
          ]
        },
        "receipt": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/ExecutionReceipt",
              "type": "object",
              "additionalProperties": false,
              "required": [
                "adapter",
                "action",
                "txHashes",
                "at"
              ],
              "properties": {
                "adapter": {
                  "type": "string"
                },
                "action": {
                  "type": "string",
                  "enum": [
                    "capture",
                    "void",
                    "capture_partial",
                    "refund",
                    "refuse",
                    "complete",
                    "reject",
                    "distribute",
                    "partner_execute"
                  ]
                },
                "txHashes": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "at": {
                  "type": "string",
                  "format": "date-time"
                },
                "detail": {
                  "type": "string"
                },
                "provenance": {
                  "$ref": "#/components/schemas/ExecutionReceiptProvenance",
                  "type": "string",
                  "enum": [
                    "live",
                    "test",
                    "synthetic"
                  ],
                  "description": "Provider environment recorded by the engine. Missing historical provenance never confirms payment."
                }
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "reports": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ExecutionPerformanceReport",
            "type": "object",
            "additionalProperties": false,
            "required": [
              "id",
              "by",
              "description",
              "reportedAt",
              "responses"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "by": {
                "type": "string",
                "enum": [
                  "claimant",
                  "respondent",
                  "partner"
                ]
              },
              "description": {
                "type": "string"
              },
              "reference": {
                "type": "string"
              },
              "reportedAt": {
                "type": "string",
                "format": "date-time"
              },
              "responses": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ExecutionPerformanceResponse",
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "by",
                    "status",
                    "at"
                  ],
                  "properties": {
                    "by": {
                      "type": "string",
                      "enum": [
                        "claimant",
                        "respondent"
                      ]
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "acknowledged",
                        "disputed"
                      ]
                    },
                    "reason": {
                      "type": "string"
                    },
                    "at": {
                      "type": "string",
                      "format": "date-time"
                    }
                  }
                }
              }
            }
          }
        },
        "attestation": {
          "oneOf": [
            {
              "$ref": "#/components/schemas/ExecutionNonPerformanceAttestation",
              "type": "object",
              "additionalProperties": false,
              "required": [
                "reason",
                "at"
              ],
              "properties": {
                "reason": {
                  "type": "string"
                },
                "at": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "submissionAttempts": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0,
          "description": "Durable adapter invocations, excluding reconciliation reads. Historical counts are null when unavailable. An invocation may stop before provider submission."
        },
        "deliveredAt": {
          "type": "string",
          "format": "date-time"
        },
        "overdueAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "nextReconcileAt": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "reminders": {
          "type": "integer",
          "minimum": 0
        },
        "createdAt": {
          "type": "string",
          "format": "date-time"
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time"
        },
        "links": {
          "type": "object",
          "required": [
            "self",
            "case"
          ],
          "properties": {
            "self": {
              "type": "string"
            },
            "case": {
              "type": "string"
            }
          }
        }
      }
    },
    "requestId": {
      "type": "string"
    }
  }
}
```

### default

Authorization, validation, or execution conflict.

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": {
    "id": "id_test",
    "caseId": "pcase_test_123",
    "awardId": "awardId_test",
    "awardHash": "awardHash_test",
    "mode": "partner_executed",
    "status": "decision_delivered",
    "paymentConfirmed": false,
    "executedBy": "partner",
    "receipt": {
      "adapter": "adapter_test",
      "action": "capture",
      "txHashes": [
        "txHashes_test"
      ],
      "at": "2026-08-09T12:00:00.000Z"
    },
    "reports": [
      {
        "id": "id_test",
        "by": "claimant",
        "description": "description_test",
        "reportedAt": "2026-08-09T12:00:00.000Z",
        "responses": [
          {
            "by": "claimant",
            "status": "acknowledged",
            "at": "2026-08-09T12:00:00.000Z"
          }
        ]
      }
    ],
    "links": {
      "self": "self_test",
      "case": "case_test"
    }
  },
  "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/executions' \
  --header 'Authorization: Bearer pk_test_replace_me' \
  --header 'Idempotency-Key: idem_test_12345678' \
  --header 'Content-Type: application/json' \
  --data '{
  "action": "initialize",
  "awardHash": "awardHash_test"
}'
```

```ts
const input = {
  "action": "initialize",
  "awardHash": "awardHash_test"
};

const response = await fetch("https://peoplescourt.ai/api/cases/pcase_test_123/executions", {
  method: "POST",
  headers: {
    "Authorization": "Bearer pk_test_replace_me",
    "Idempotency-Key": "idem_test_12345678",
    "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/executions",
    headers={
      "Authorization": "Bearer pk_test_replace_me",
      "Idempotency-Key": "idem_test_12345678",
      "Content-Type": "application/json"
    },
    json={"action": "initialize", "awardHash": "awardHash_test"},
    timeout=30,
)
response.raise_for_status()
result = response.json()
```
