document_params

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/notarize/main/json-schema/notarize-document-params-schema.json",
  "title": "document_params",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/notarize-proof-business-api-specification-openapi.yml#/components/schemas/document_params",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 5000,
      "description": "Plain language name given to the document. If this parameter is not provided, Proof will automatically assign a name using the end of the page path of the resource URL."
    },
    "document_url_version": {
      "type": "string",
      "description": "Optional param to test v2 document urls.",
      "enum": [
        "v1",
        "v2"
      ]
    },
    "requirement": {
      "type": "string",
      "maxLength": 5000,
      "description": "Completion requirement for the document. Accepted values can be `notarization`, `esign`, `identity_confirmation` **([identity confirmation feature](https://dev.proof.com/docs/enterprise-features))**, `readonly`, and `non_essential`. Completion requirement for the document.  If the value is set to `non_essential`, the document will be hidden from signers before the notary meeting and values for  `customer_can_annotate` and `witness_required` will be ignored and set to false. `identity_confirmation` is used to support signing of PS Form 1583 for signers without a US SSN. Note: if `identity_confirmation` is set as the document requirement, ensure that all documents requiring notarization in the transaction also use `identity confirmation` as the requirement to avoid requiring KBA on the transaction. [Read more](https://dev.proof.com/docs/document-requirements) about document requirements."
    },
    "notarization_required": {
      "type": "boolean",
      "description": ""
    },
    "witness_required": {
      "type": "boolean",
      "description": "Boolean flag indicating whether an additional witness must be present for this document's signing. A witness is a third person, in addition to the signer and the notary, who must be physically located with the signer."
    },
    "identity_confirmation_required": {
      "type": "boolean"
    },
    "customer_can_annotate": {
      "type": "boolean",
      "description": "Boolean flag indicating whether a signer can add their own annotations onto the document. Defaults to false, limiting the signer to only filling out designated fields setup on the document or as directed by a notary."
    },
    "pdf_bookmarked": {
      "type": "boolean",
      "description": "Boolean flag indicating whether the document is a bookmarked PDF. If passed true, the document will be split by bookmark into multiple documents."
    },
    "tracking_id": {
      "type": "string",
      "maxLength": 5000,
      "description": "External tracking identifier such as a UUID string that can be useful for mapping documents back to your own system."
    }
  }
}