POSTlive

Confirm and open a prepared claimant filing

Confirm and open a prepared claimant filing Compatibility alias. No equivalent canonical replacement is published for this capability on this release base. Its compatibility window has not started; keep using this route.

/api/v2/filings/{draftId}/confirmconfirmFilingV2

Authentication and authority

Send one of the allowed bearer credential roles. Alternatives are OR; credentials named within one alternative are AND.

platformOrchestratorBearer

Credential bound to the platform_orchestrator role.

claimantAgentBearer

Credential bound to the claimant_agent role. Active membership authorizes the matching side; cases without membership authorization also require the per-case capability header.

Parameters

Name	Location	Requirement	Schema
`draftId`	path	Required	`{"type":"string"}`
`Idempotency-Key`	header	Required	`{"type":"string","minLength":8,"maxLength":200}`

Request body

Required request body.

application/json

{
  "$ref": "#/components/schemas/FilingConfirmation",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "draftDigest",
    "confirmationStatement",
    "actorId",
    "principalId",
    "confirmationMethod",
    "confirmationReference"
  ],
  "properties": {
    "draftDigest": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "confirmationStatement": {
      "type": "string",
      "minLength": 1,
      "maxLength": 1000
    },
    "actorId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "Must equal the immutable claimant authority agent ID."
    },
    "principalId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "confirmationMethod": {
      "type": "string",
      "const": "protocol_act"
    },
    "confirmationReference": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "acceptance": {
      "$ref": "#/components/schemas/FilingAcceptanceProof",
      "oneOf": [
        {
          "$ref": "#/components/schemas/WalletFilingAcceptance",
          "type": "object",
          "additionalProperties": false,
          "required": [
            "method",
            "termsDigest",
            "walletAddress",
            "signature"
          ],
          "properties": {
            "method": {
              "type": "string",
              "const": "wallet_signature"
            },
            "termsDigest": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            },
            "walletAddress": {
              "type": "string",
              "pattern": "^0x[0-9a-fA-F]{40}$"
            },
            "signature": {
              "type": "string",
              "pattern": "^0x[0-9a-fA-F]{130}$"
            }
          }
        },
        {
          "$ref": "#/components/schemas/StandingFilingAcceptance",
          "type": "object",
          "properties": {
            "method": {
              "type": "string",
              "const": "standing_grant"
            },
            "grantId": {
              "type": "string"
            },
            "termsDigest": {
              "type": "string",
              "pattern": "^[a-f0-9]{64}$"
            }
          },
          "required": [
            "method",
            "grantId",
            "termsDigest"
          ],
          "additionalProperties": false
        }
      ]
    }
  }
}

Responses

201

Versioned data envelope.

application/json

{
  "type": "object",
  "required": [
    "data",
    "requestId"
  ],
  "properties": {
    "data": {},
    "requestId": {
      "type": "string"
    }
  }
}

409

Conflict, including acceptance_required. Hosted acceptance, explicit principal-bound API acceptance, or an exact wallet signature is required for new packets. Standing grants require step 11. Authorized claimant callers receive the packet digest and a new scoped hosted link.

application/problem+json

{
  "anyOf": [
    {
      "$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"
                      }
                    }
                  }
                }
              }
            },
            {}
          ]
        }
      }
    },
    {
      "$ref": "#/components/schemas/FilingAcceptanceRequiredProblem",
      "allOf": [
        {
          "$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"
                      }
                    }
                  }
                },
                {
                  "$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",
          "properties": {
            "code": {
              "type": "string",
              "const": "acceptance_required"
            },
            "details": {
              "$ref": "#/components/schemas/FilingAcceptanceRequiredDetails",
              "type": "object",
              "additionalProperties": false,
              "required": [
                "termsDigest"
              ],
              "properties": {
                "termsDigest": {
                  "type": "string",
                  "pattern": "^[a-f0-9]{64}$"
                },
                "reviewPacket": {
                  "anyOf": [
                    {
                      "$ref": "#/components/schemas/FilingReviewPacket"
                    },
                    {
                      "$ref": "#/components/schemas/AccountFilingReviewPacket"
                    }
                  ]
                },
                "hostedAcceptanceUrl": {
                  "type": "string"
                },
                "acceptanceLinkExpiresAt": {
                  "type": "string",
                  "format": "date-time",
                  "description": "Expiry of the account filing’s current hosted acceptance link."
                }
              }
            }
          }
        }
      ]
    }
  ]
}

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": {},
  "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/v2/filings/draft_test_123/confirm' \
  --header 'Authorization: Bearer pk_test_replace_me' \
  --header 'Idempotency-Key: idem_test_12345678' \
  --header 'Content-Type: application/json' \
  --data '{
  "draftDigest": "draftDigest_test",
  "confirmationStatement": "COPY_EXACT_SERVER_CONFIRMATION_STATEMENT",
  "actorId": "agent_test_123",
  "principalId": "principal_test_123",
  "confirmationMethod": "protocol_act",
  "confirmationReference": "partner_reference_123"
}'

TypeScript / fetch

const response = await fetch("https://peoplescourt.ai/api/v2/filings/draft_test_123/confirm", {
  method: "POST",
  headers: {
    "Authorization": "Bearer pk_test_replace_me",
    "Idempotency-Key": "idem_test_12345678",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "draftDigest": "draftDigest_test",
    "confirmationStatement": "COPY_EXACT_SERVER_CONFIRMATION_STATEMENT",
    "actorId": "agent_test_123",
    "principalId": "principal_test_123",
    "confirmationMethod": "protocol_act",
    "confirmationReference": "partner_reference_123"
  }),
});
if (!response.ok) throw await response.json();
const result = await response.json();

Python

import requests

response = requests.post(
    "https://peoplescourt.ai/api/v2/filings/draft_test_123/confirm",
    headers={
      "Authorization": "Bearer pk_test_replace_me",
      "Idempotency-Key": "idem_test_12345678",
      "Content-Type": "application/json"
    },
    json={"draftDigest": "draftDigest_test", "confirmationStatement": "COPY_EXACT_SERVER_CONFIRMATION_STATEMENT", "actorId": "agent_test_123", "principalId": "principal_test_123", "confirmationMethod": "protocol_act", "confirmationReference": "partner_reference_123"},
    timeout=30,
)
response.raise_for_status()
result = response.json()