POSTpartial

Confirm the exact party record digest

Preview controlled by PEOPLES_COURT_API_CANONICAL_ROUTES. Accepts an authorized session or partner bearer; Answer also accepts the existing wallet/invitation proof. A record-summary correction is a distinct party act, so an active case membership must allow restatement:respond, which record:confirm alone never grants. Existing aliases and their application operations remain authoritative. Idempotency-Key reuses the alias journal.

/api/cases/{id}/record-summary/confirmationsconfirmRecordSummaryPreview

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/CanonicalRecordConfirmationInput",
  "type": "object",
  "required": [
    "recordDigest",
    "confirmationStatement"
  ],
  "description": "Exact confirmation of the caller's current party record. Both values come unchanged from the case view's confirm_record requirements or from the record-summary read; the operation refuses any other value.",
  "properties": {
    "recordDigest": {
      "type": "string",
      "description": "Exact digest of the caller's current record."
    },
    "confirmationStatement": {
      "type": "string",
      "description": "Exact confirmation sentence bound to that digest."
    },
    "inventoryDigest": {
      "type": "string",
      "description": "Session callers on the confirmed-request-inventory preparation may also echo the exact displayed request-list digest."
    },
    "party": {
      "type": "string",
      "description": "Optional for a session caller holding authority for both sides; a bearer's party comes from its membership.",
      "enum": [
        "claimant",
        "respondent"
      ]
    },
    "expectedRevision": {
      "type": "integer",
      "minimum": 0
    }
  }
}

Responses

200

Authorized operation result.

application/json

{
  "$ref": "#/components/schemas/CanonicalRecordConfirmationEnvelope",
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/CanonicalRecordConfirmationResult",
      "type": "object",
      "required": [
        "preparationVersion"
      ],
      "description": "Committed confirmation. A bearer result also carries the projected record-confirmation fields; a session result carries the confirmed party-scoped record. Only preparationVersion is guaranteed for both credential classes on both preparations.",
      "properties": {
        "preparationVersion": {
          "type": "string"
        },
        "phase": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "confirmedAt": {
          "type": "string",
          "format": "date-time"
        },
        "caseId": {
          "type": "string"
        },
        "party": {
          "type": "string"
        },
        "recordDigest": {
          "type": "string"
        },
        "confirmationStatement": {
          "type": "string"
        },
        "revision": {
          "type": "integer",
          "minimum": 0
        },
        "submissionIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "restatement": {
          "type": "object",
          "properties": {
            "text": {
              "type": "string"
            },
            "generatedAt": {
              "type": "string"
            },
            "status": {
              "type": "string",
              "enum": [
                "pending",
                "confirmed",
                "corrected",
                "lapsed"
              ]
            },
            "respondedAt": {
              "type": "string"
            },
            "correction": {
              "type": "string"
            },
            "revision": {
              "type": "integer"
            },
            "sourceSubmissionIds": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "sourceContentHashes": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "sourceFingerprint": {
              "type": "string"
            },
            "confirmationDueAt": {
              "type": "string"
            },
            "rejectedCorrections": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "text": {
                    "type": "string"
                  },
                  "reason": {
                    "type": "string"
                  },
                  "at": {
                    "type": "string"
                  }
                }
              }
            },
            "requestInventory": {
              "type": "object",
              "properties": {
                "version": {
                  "type": "string"
                },
                "party": {
                  "type": "string",
                  "enum": [
                    "claimant",
                    "respondent"
                  ]
                },
                "sourceFingerprint": {
                  "type": "string"
                },
                "restatementRevision": {
                  "type": "integer"
                },
                "parents": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "parentId": {
                        "type": "string"
                      },
                      "claimId": {
                        "type": "string"
                      },
                      "title": {
                        "type": "string"
                      },
                      "statement": {
                        "type": "string"
                      },
                      "kind": {
                        "type": "string"
                      },
                      "currency": {
                        "type": "string"
                      }
                    }
                  }
                },
                "items": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "itemId": {
                        "type": "string"
                      },
                      "parentId": {
                        "type": "string"
                      },
                      "parentClaimId": {
                        "type": "string"
                      },
                      "kind": {
                        "type": "string"
                      },
                      "fixedText": {
                        "type": "string"
                      },
                      "requestedAmount": {
                        "type": "number"
                      },
                      "currency": {
                        "type": "string"
                      },
                      "canonicalDeclaration": {
                        "type": "string"
                      },
                      "canonicalOrder": {
                        "type": "string"
                      },
                      "severableScopes": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "scopeId": {
                              "type": "string"
                            },
                            "fixedText": {
                              "type": "string"
                            },
                            "source": {
                              "type": "object",
                              "properties": {
                                "sourceId": {
                                  "type": "string"
                                },
                                "sourceContentHash": {
                                  "type": "string"
                                },
                                "firstLine": {
                                  "type": "integer"
                                },
                                "lastLine": {
                                  "type": "integer"
                                },
                                "exactText": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      },
                      "source": {
                        "type": "object",
                        "properties": {
                          "sourceId": {
                            "type": "string"
                          },
                          "sourceContentHash": {
                            "type": "string"
                          },
                          "firstLine": {
                            "type": "integer"
                          },
                          "lastLine": {
                            "type": "integer"
                          },
                          "exactText": {
                            "type": "string"
                          }
                        }
                      },
                      "residual": {
                        "type": "boolean"
                      }
                    }
                  }
                },
                "originalParentCoverage": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "displayText": {
                  "type": "string"
                },
                "displayDigest": {
                  "type": "string"
                },
                "inventoryHash": {
                  "type": "string"
                },
                "status": {
                  "type": "string"
                },
                "respondedAt": {
                  "type": "string"
                }
              }
            },
            "priorRevisions": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/CanonicalPartyRestatementRevision",
                "type": "object",
                "properties": {
                  "text": {
                    "type": "string"
                  },
                  "generatedAt": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string",
                    "enum": [
                      "pending",
                      "confirmed",
                      "corrected",
                      "lapsed"
                    ]
                  },
                  "respondedAt": {
                    "type": "string"
                  },
                  "correction": {
                    "type": "string"
                  },
                  "revision": {
                    "type": "integer"
                  },
                  "sourceSubmissionIds": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "sourceContentHashes": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "sourceFingerprint": {
                    "type": "string"
                  },
                  "confirmationDueAt": {
                    "type": "string"
                  },
                  "rejectedCorrections": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "text": {
                          "type": "string"
                        },
                        "reason": {
                          "type": "string"
                        },
                        "at": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "requestInventory": {
                    "type": "object",
                    "properties": {
                      "version": {
                        "type": "string"
                      },
                      "party": {
                        "type": "string",
                        "enum": [
                          "claimant",
                          "respondent"
                        ]
                      },
                      "sourceFingerprint": {
                        "type": "string"
                      },
                      "restatementRevision": {
                        "type": "integer"
                      },
                      "parents": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "parentId": {
                              "type": "string"
                            },
                            "claimId": {
                              "type": "string"
                            },
                            "title": {
                              "type": "string"
                            },
                            "statement": {
                              "type": "string"
                            },
                            "kind": {
                              "type": "string"
                            },
                            "currency": {
                              "type": "string"
                            }
                          }
                        }
                      },
                      "items": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "itemId": {
                              "type": "string"
                            },
                            "parentId": {
                              "type": "string"
                            },
                            "parentClaimId": {
                              "type": "string"
                            },
                            "kind": {
                              "type": "string"
                            },
                            "fixedText": {
                              "type": "string"
                            },
                            "requestedAmount": {
                              "type": "number"
                            },
                            "currency": {
                              "type": "string"
                            },
                            "canonicalDeclaration": {
                              "type": "string"
                            },
                            "canonicalOrder": {
                              "type": "string"
                            },
                            "severableScopes": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "scopeId": {
                                    "type": "string"
                                  },
                                  "fixedText": {
                                    "type": "string"
                                  },
                                  "source": {
                                    "type": "object",
                                    "properties": {
                                      "sourceId": {
                                        "type": "string"
                                      },
                                      "sourceContentHash": {
                                        "type": "string"
                                      },
                                      "firstLine": {
                                        "type": "integer"
                                      },
                                      "lastLine": {
                                        "type": "integer"
                                      },
                                      "exactText": {
                                        "type": "string"
                                      }
                                    }
                                  }
                                }
                              }
                            },
                            "source": {
                              "type": "object",
                              "properties": {
                                "sourceId": {
                                  "type": "string"
                                },
                                "sourceContentHash": {
                                  "type": "string"
                                },
                                "firstLine": {
                                  "type": "integer"
                                },
                                "lastLine": {
                                  "type": "integer"
                                },
                                "exactText": {
                                  "type": "string"
                                }
                              }
                            },
                            "residual": {
                              "type": "boolean"
                            }
                          }
                        }
                      },
                      "originalParentCoverage": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "displayText": {
                        "type": "string"
                      },
                      "displayDigest": {
                        "type": "string"
                      },
                      "inventoryHash": {
                        "type": "string"
                      },
                      "status": {
                        "type": "string"
                      },
                      "respondedAt": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "requestId": {
      "type": "string"
    }
  }
}

201

Answer or invitation created through the shared partner operation.

application/json

{
  "$ref": "#/components/schemas/CanonicalRecordConfirmationEnvelope",
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {
      "$ref": "#/components/schemas/CanonicalRecordConfirmationResult",
      "type": "object",
      "required": [
        "preparationVersion"
      ],
      "description": "Committed confirmation. A bearer result also carries the projected record-confirmation fields; a session result carries the confirmed party-scoped record. Only preparationVersion is guaranteed for both credential classes on both preparations.",
      "properties": {
        "preparationVersion": {
          "type": "string"
        },
        "phase": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "confirmedAt": {
          "type": "string",
          "format": "date-time"
        },
        "caseId": {
          "type": "string"
        },
        "party": {
          "type": "string"
        },
        "recordDigest": {
          "type": "string"
        },
        "confirmationStatement": {
          "type": "string"
        },
        "revision": {
          "type": "integer",
          "minimum": 0
        },
        "submissionIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "restatement": {
          "type": "object",
          "properties": {
            "text": {
              "type": "string"
            },
            "generatedAt": {
              "type": "string"
            },
            "status": {
              "type": "string",
              "enum": [
                "pending",
                "confirmed",
                "corrected",
                "lapsed"
              ]
            },
            "respondedAt": {
              "type": "string"
            },
            "correction": {
              "type": "string"
            },
            "revision": {
              "type": "integer"
            },
            "sourceSubmissionIds": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "sourceContentHashes": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "sourceFingerprint": {
              "type": "string"
            },
            "confirmationDueAt": {
              "type": "string"
            },
            "rejectedCorrections": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "text": {
                    "type": "string"
                  },
                  "reason": {
                    "type": "string"
                  },
                  "at": {
                    "type": "string"
                  }
                }
              }
            },
            "requestInventory": {
              "type": "object",
              "properties": {
                "version": {
                  "type": "string"
                },
                "party": {
                  "type": "string",
                  "enum": [
                    "claimant",
                    "respondent"
                  ]
                },
                "sourceFingerprint": {
                  "type": "string"
                },
                "restatementRevision": {
                  "type": "integer"
                },
                "parents": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "parentId": {
                        "type": "string"
                      },
                      "claimId": {
                        "type": "string"
                      },
                      "title": {
                        "type": "string"
                      },
                      "statement": {
                        "type": "string"
                      },
                      "kind": {
                        "type": "string"
                      },
                      "currency": {
                        "type": "string"
                      }
                    }
                  }
                },
                "items": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "itemId": {
                        "type": "string"
                      },
                      "parentId": {
                        "type": "string"
                      },
                      "parentClaimId": {
                        "type": "string"
                      },
                      "kind": {
                        "type": "string"
                      },
                      "fixedText": {
                        "type": "string"
                      },
                      "requestedAmount": {
                        "type": "number"
                      },
                      "currency": {
                        "type": "string"
                      },
                      "canonicalDeclaration": {
                        "type": "string"
                      },
                      "canonicalOrder": {
                        "type": "string"
                      },
                      "severableScopes": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "scopeId": {
                              "type": "string"
                            },
                            "fixedText": {
                              "type": "string"
                            },
                            "source": {
                              "type": "object",
                              "properties": {
                                "sourceId": {
                                  "type": "string"
                                },
                                "sourceContentHash": {
                                  "type": "string"
                                },
                                "firstLine": {
                                  "type": "integer"
                                },
                                "lastLine": {
                                  "type": "integer"
                                },
                                "exactText": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        }
                      },
                      "source": {
                        "type": "object",
                        "properties": {
                          "sourceId": {
                            "type": "string"
                          },
                          "sourceContentHash": {
                            "type": "string"
                          },
                          "firstLine": {
                            "type": "integer"
                          },
                          "lastLine": {
                            "type": "integer"
                          },
                          "exactText": {
                            "type": "string"
                          }
                        }
                      },
                      "residual": {
                        "type": "boolean"
                      }
                    }
                  }
                },
                "originalParentCoverage": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "displayText": {
                  "type": "string"
                },
                "displayDigest": {
                  "type": "string"
                },
                "inventoryHash": {
                  "type": "string"
                },
                "status": {
                  "type": "string"
                },
                "respondedAt": {
                  "type": "string"
                }
              }
            },
            "priorRevisions": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/CanonicalPartyRestatementRevision",
                "type": "object",
                "properties": {
                  "text": {
                    "type": "string"
                  },
                  "generatedAt": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string",
                    "enum": [
                      "pending",
                      "confirmed",
                      "corrected",
                      "lapsed"
                    ]
                  },
                  "respondedAt": {
                    "type": "string"
                  },
                  "correction": {
                    "type": "string"
                  },
                  "revision": {
                    "type": "integer"
                  },
                  "sourceSubmissionIds": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "sourceContentHashes": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "sourceFingerprint": {
                    "type": "string"
                  },
                  "confirmationDueAt": {
                    "type": "string"
                  },
                  "rejectedCorrections": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "text": {
                          "type": "string"
                        },
                        "reason": {
                          "type": "string"
                        },
                        "at": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "requestInventory": {
                    "type": "object",
                    "properties": {
                      "version": {
                        "type": "string"
                      },
                      "party": {
                        "type": "string",
                        "enum": [
                          "claimant",
                          "respondent"
                        ]
                      },
                      "sourceFingerprint": {
                        "type": "string"
                      },
                      "restatementRevision": {
                        "type": "integer"
                      },
                      "parents": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "parentId": {
                              "type": "string"
                            },
                            "claimId": {
                              "type": "string"
                            },
                            "title": {
                              "type": "string"
                            },
                            "statement": {
                              "type": "string"
                            },
                            "kind": {
                              "type": "string"
                            },
                            "currency": {
                              "type": "string"
                            }
                          }
                        }
                      },
                      "items": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "itemId": {
                              "type": "string"
                            },
                            "parentId": {
                              "type": "string"
                            },
                            "parentClaimId": {
                              "type": "string"
                            },
                            "kind": {
                              "type": "string"
                            },
                            "fixedText": {
                              "type": "string"
                            },
                            "requestedAmount": {
                              "type": "number"
                            },
                            "currency": {
                              "type": "string"
                            },
                            "canonicalDeclaration": {
                              "type": "string"
                            },
                            "canonicalOrder": {
                              "type": "string"
                            },
                            "severableScopes": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "scopeId": {
                                    "type": "string"
                                  },
                                  "fixedText": {
                                    "type": "string"
                                  },
                                  "source": {
                                    "type": "object",
                                    "properties": {
                                      "sourceId": {
                                        "type": "string"
                                      },
                                      "sourceContentHash": {
                                        "type": "string"
                                      },
                                      "firstLine": {
                                        "type": "integer"
                                      },
                                      "lastLine": {
                                        "type": "integer"
                                      },
                                      "exactText": {
                                        "type": "string"
                                      }
                                    }
                                  }
                                }
                              }
                            },
                            "source": {
                              "type": "object",
                              "properties": {
                                "sourceId": {
                                  "type": "string"
                                },
                                "sourceContentHash": {
                                  "type": "string"
                                },
                                "firstLine": {
                                  "type": "integer"
                                },
                                "lastLine": {
                                  "type": "integer"
                                },
                                "exactText": {
                                  "type": "string"
                                }
                              }
                            },
                            "residual": {
                              "type": "boolean"
                            }
                          }
                        }
                      },
                      "originalParentCoverage": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "displayText": {
                        "type": "string"
                      },
                      "displayDigest": {
                        "type": "string"
                      },
                      "inventoryHash": {
                        "type": "string"
                      },
                      "status": {
                        "type": "string"
                      },
                      "respondedAt": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "requestId": {
      "type": "string"
    }
  }
}

404

Preview disabled or resource unavailable.

default

Stable problem code and requestId; no protected state disclosed.

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": {
    "preparationVersion": "preparationVersion_test"
  },
  "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/record-summary/confirmations' \
  --header 'Authorization: Bearer pk_test_replace_me' \
  --header 'Idempotency-Key: idem_test_12345678' \
  --header 'Content-Type: application/json' \
  --data '{
  "recordDigest": "recordDigest_test",
  "confirmationStatement": "COPY_EXACT_SERVER_CONFIRMATION_STATEMENT"
}'

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["confirmRecordSummaryPreview"]>) {
  const response = await client.confirmRecordSummaryPreview(...args);
  return response.data;
}

Python

import requests

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