{
  "openapi": "3.1.0",
  "info": {
    "title": "Esign Comply API",
    "version": "2026-11-21",
    "summary": "Record signing ceremonies built in your own interface, and seal evidence that can be verified independently.",
    "description": "The path stays /v1. Breaking changes ship only under a new dated Esign-Comply-Version; additive changes ship without one, so clients ignore fields and enumeration values they do not know. API keys are secret and server-only. Browsers hold only the short-lived session client token returned by POST /sessions. Operations marked x-status: planned are not part of the current API. Conventions: https://esigncomply.com/docs/api. Errors: https://esigncomply.com/docs/api/errors. Index for AI tools: https://esigncomply.com/llms.txt.",
    "termsOfService": "https://esigncomply.com/legal",
    "contact": {
      "name": "Esign Comply support",
      "url": "https://esigncomply.com/support"
    }
  },
  "externalDocs": {
    "url": "https://esigncomply.com/docs/api",
    "description": "API reference"
  },
  "servers": [
    {
      "url": "https://esigncomply.com/v1",
      "description": "US region"
    },
    {
      "url": "https://api.eu.esigncomply.com/v1",
      "description": "EU region"
    }
  ],
  "tags": [
    {
      "name": "Documents",
      "description": "Documents and immutable document versions."
    },
    {
      "name": "Profiles",
      "description": "Ceremony profiles: named, versioned rule sets."
    },
    {
      "name": "Jurisdictions",
      "description": "The pack catalogue and the dry run."
    },
    {
      "name": "Sessions",
      "description": "Ceremonies in progress: events, verifications, completion."
    },
    {
      "name": "Records",
      "description": "Sealed records, evidence report, evidence package, receipt, annotations."
    },
    {
      "name": "Signers",
      "description": "Records and status per signer, consent withdrawal, erasure."
    },
    {
      "name": "Certificates",
      "description": "The on-request Contemporaneous Record Statement."
    },
    {
      "name": "Supplements",
      "description": "Customer-supplied material: text, JSON and files, sealed on receipt."
    },
    {
      "name": "Guidance",
      "description": "Notices, releases, update prompts, adoption and rollback."
    },
    {
      "name": "Verification",
      "description": "Receipt verification, the public log and the public keys."
    },
    {
      "name": "Webhooks",
      "description": "Webhook endpoints and deliveries."
    },
    {
      "name": "Account",
      "description": "Domains, API keys, usage, conformance runs, prompts."
    },
    {
      "name": "Agent",
      "description": "The account API for AI agents: account state, API keys, the domain and going live, with an agent token."
    }
  ],
  "security": [
    {
      "secretKey": []
    }
  ],
  "paths": {
    "/documents": {
      "post": {
        "operationId": "createDocument",
        "tags": [
          "Documents"
        ],
        "summary": "Create a document",
        "description": "Secret key with full_access or recording_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/documents",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "name",
                  "type"
                ],
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "Display name, for example Terms of Service."
                  },
                  "type": {
                    "type": "string",
                    "description": "terms, privacy_notice, nda, contract, consent, policy_ack or custom."
                  },
                  "metadata": {
                    "type": "object",
                    "description": "Your key-value pairs."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A Document object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Document"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access"
        ]
      },
      "get": {
        "operationId": "listDocuments",
        "tags": [
          "Documents"
        ],
        "summary": "List documents",
        "description": "Secret key with full_access or recording_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/documents",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "Items per page, 1 to 100. Default 20.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "after",
            "in": "query",
            "required": false,
            "description": "Return items after this object ID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "before",
            "in": "query",
            "required": false,
            "description": "Return items before this object ID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "type",
            "in": "query",
            "required": false,
            "description": "Filter by document type.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of Document objects.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/List"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Document"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access",
          "read_only"
        ]
      }
    },
    "/documents/{id}": {
      "get": {
        "operationId": "getDocument",
        "tags": [
          "Documents"
        ],
        "summary": "Retrieve a document",
        "description": "Secret key with full_access or recording_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/documents",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A Document object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Document"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access",
          "read_only"
        ]
      },
      "patch": {
        "operationId": "updateDocument",
        "tags": [
          "Documents"
        ],
        "summary": "Update a document's name, metadata or archived flag",
        "description": "Secret key with full_access or recording_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/documents",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "New display name."
                  },
                  "metadata": {
                    "type": "object",
                    "description": "Replaces the metadata."
                  },
                  "archived": {
                    "type": "boolean",
                    "description": "Archive or restore the document."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A Document object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Document"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access"
        ]
      }
    },
    "/documents/{id}/versions": {
      "post": {
        "operationId": "publishDocumentVersion",
        "tags": [
          "Documents"
        ],
        "summary": "Publish an immutable document version",
        "description": "Secret key with full_access or recording_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/documents",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "version_label",
                  "content"
                ],
                "properties": {
                  "version_label": {
                    "type": "string",
                    "description": "Label of the version, for example 2026-11-21. One version per label and language."
                  },
                  "language": {
                    "type": "string",
                    "description": "Language code. Default en."
                  },
                  "effective_at": {
                    "type": "string",
                    "format": "date-time",
                    "description": "When the version takes effect. Default now."
                  },
                  "content": {
                    "type": "object",
                    "description": "{ format: \"markdown\" | \"html\" | \"text\", text } or { format: \"pdf\", data_base64 }."
                  },
                  "material_change": {
                    "type": "boolean",
                    "description": "Marks earlier acceptances as outstanding."
                  },
                  "summary_of_changes": {
                    "type": "string",
                    "description": "Shown to signers on re-acceptance."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A DocumentVersion object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DocumentVersion"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access"
        ]
      },
      "get": {
        "operationId": "listDocumentVersions",
        "tags": [
          "Documents"
        ],
        "summary": "List the versions of a document",
        "description": "Secret key with full_access or recording_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/documents",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of DocumentVersion objects.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/List"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/DocumentVersion"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access",
          "read_only"
        ]
      }
    },
    "/documents/{id}/versions/{version_id}": {
      "get": {
        "operationId": "getDocumentVersion",
        "tags": [
          "Documents"
        ],
        "summary": "Retrieve a version",
        "description": "Secret key with full_access or recording_access or read_only permission. version_id may be \"current\".",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/documents",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "version_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "locale",
            "in": "query",
            "required": false,
            "description": "With version_id \"current\": prefer the translation for this locale.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A DocumentVersion object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DocumentVersion"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access",
          "read_only"
        ]
      }
    },
    "/documents/{id}/versions/{version_id}/content": {
      "get": {
        "operationId": "getDocumentVersionContent",
        "tags": [
          "Documents"
        ],
        "summary": "Fetch the canonical content to render",
        "description": "Session client token for its own session, or a secret key with full_access or recording_access or read_only permission. A client token reads only the versions pinned on its own session.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/documents",
          "description": "Documentation"
        },
        "security": [
          {
            "clientToken": []
          },
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "version_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A DocumentVersionContent object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DocumentVersionContent"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "either",
        "x-permissions": [
          "full_access",
          "recording_access",
          "read_only"
        ]
      }
    },
    "/profiles": {
      "post": {
        "operationId": "createProfile",
        "tags": [
          "Profiles"
        ],
        "summary": "Create a ceremony profile",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/profiles",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "name"
                ],
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "Profile name."
                  },
                  "jurisdictions": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Pack codes to enable, for example [\"US-FED\", \"US-CA\"]. Default [\"US-FED\"]."
                  },
                  "jurisdiction_mode": {
                    "type": "string",
                    "enum": [
                      "auto",
                      "strictest",
                      "explicit"
                    ],
                    "description": "How enabled packs are applied to a session. Default auto."
                  },
                  "on_unknown_region": {
                    "type": "string",
                    "enum": [
                      "strictest",
                      "base_only",
                      "reject"
                    ],
                    "description": "What to do when a U.S. signer has no signer.region. Default strictest."
                  },
                  "governing_law": {
                    "type": "string",
                    "description": "Pack code or ISO 3166 code named as governing law in the documents."
                  },
                  "allow_session_packs": {
                    "type": "boolean",
                    "description": "Whether a session may add a pack the profile does not enable."
                  },
                  "strict_jurisdictions": {
                    "type": "boolean",
                    "description": "Return 422 jurisdiction_not_enabled instead of a warning."
                  },
                  "signer_class": {
                    "type": "string",
                    "description": "consumer, business or employee."
                  },
                  "document_type": {
                    "type": "string",
                    "description": "Document type this profile is meant for."
                  },
                  "purpose": {
                    "type": "string",
                    "description": "Default context.purpose."
                  },
                  "method": {
                    "type": "string",
                    "enum": [
                      "click",
                      "checkbox",
                      "typed",
                      "drawn",
                      "passkey"
                    ],
                    "description": "Signature method. Default checkbox."
                  },
                  "assurance_level": {
                    "type": "string",
                    "enum": [
                      "L1",
                      "L2",
                      "L3"
                    ],
                    "description": "Default L1."
                  },
                  "failure_mode": {
                    "type": "string",
                    "enum": [
                      "fail_closed",
                      "fail_open_deferred"
                    ],
                    "description": "Default fail_closed."
                  },
                  "consumer_econsent": {
                    "type": "boolean",
                    "description": "Require the ESIGN consumer consent steps for consumer signers."
                  },
                  "capture_mode": {
                    "type": "string",
                    "enum": [
                      "standard",
                      "eu_minimal"
                    ],
                    "description": "Default standard."
                  },
                  "receipts_enabled": {
                    "type": "boolean",
                    "description": "Send the signer receipt email. Default true."
                  },
                  "change_note": {
                    "type": "string",
                    "description": "Note stored with the new profile version."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A Profile object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Profile"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      },
      "get": {
        "operationId": "listProfiles",
        "tags": [
          "Profiles"
        ],
        "summary": "List profiles",
        "description": "Secret key with full_access or recording_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/profiles",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of Profile objects.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/List"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Profile"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access",
          "read_only"
        ]
      }
    },
    "/profiles/{id}": {
      "get": {
        "operationId": "getProfile",
        "tags": [
          "Profiles"
        ],
        "summary": "Retrieve a profile with its pending conditions and versions",
        "description": "Secret key with full_access or recording_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/profiles",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A Profile object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Profile"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access",
          "read_only"
        ]
      },
      "post": {
        "operationId": "updateProfile",
        "tags": [
          "Profiles"
        ],
        "summary": "Update a profile (writes a new profile version)",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/profiles",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "Profile name."
                  },
                  "jurisdictions": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Pack codes to enable, for example [\"US-FED\", \"US-CA\"]. Default [\"US-FED\"]."
                  },
                  "jurisdiction_mode": {
                    "type": "string",
                    "enum": [
                      "auto",
                      "strictest",
                      "explicit"
                    ],
                    "description": "How enabled packs are applied to a session. Default auto."
                  },
                  "on_unknown_region": {
                    "type": "string",
                    "enum": [
                      "strictest",
                      "base_only",
                      "reject"
                    ],
                    "description": "What to do when a U.S. signer has no signer.region. Default strictest."
                  },
                  "governing_law": {
                    "type": "string",
                    "description": "Pack code or ISO 3166 code named as governing law in the documents."
                  },
                  "allow_session_packs": {
                    "type": "boolean",
                    "description": "Whether a session may add a pack the profile does not enable."
                  },
                  "strict_jurisdictions": {
                    "type": "boolean",
                    "description": "Return 422 jurisdiction_not_enabled instead of a warning."
                  },
                  "signer_class": {
                    "type": "string",
                    "description": "consumer, business or employee."
                  },
                  "document_type": {
                    "type": "string",
                    "description": "Document type this profile is meant for."
                  },
                  "purpose": {
                    "type": "string",
                    "description": "Default context.purpose."
                  },
                  "method": {
                    "type": "string",
                    "enum": [
                      "click",
                      "checkbox",
                      "typed",
                      "drawn",
                      "passkey"
                    ],
                    "description": "Signature method. Default checkbox."
                  },
                  "assurance_level": {
                    "type": "string",
                    "enum": [
                      "L1",
                      "L2",
                      "L3"
                    ],
                    "description": "Default L1."
                  },
                  "failure_mode": {
                    "type": "string",
                    "enum": [
                      "fail_closed",
                      "fail_open_deferred"
                    ],
                    "description": "Default fail_closed."
                  },
                  "consumer_econsent": {
                    "type": "boolean",
                    "description": "Require the ESIGN consumer consent steps for consumer signers."
                  },
                  "capture_mode": {
                    "type": "string",
                    "enum": [
                      "standard",
                      "eu_minimal"
                    ],
                    "description": "Default standard."
                  },
                  "receipts_enabled": {
                    "type": "boolean",
                    "description": "Send the signer receipt email. Default true."
                  },
                  "change_note": {
                    "type": "string",
                    "description": "Note stored with the new profile version."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A Profile object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Profile"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      },
      "patch": {
        "operationId": "patchProfile",
        "tags": [
          "Profiles"
        ],
        "summary": "Update a profile (same as POST)",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/profiles",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "Profile name."
                  },
                  "jurisdictions": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Pack codes to enable, for example [\"US-FED\", \"US-CA\"]. Default [\"US-FED\"]."
                  },
                  "jurisdiction_mode": {
                    "type": "string",
                    "enum": [
                      "auto",
                      "strictest",
                      "explicit"
                    ],
                    "description": "How enabled packs are applied to a session. Default auto."
                  },
                  "on_unknown_region": {
                    "type": "string",
                    "enum": [
                      "strictest",
                      "base_only",
                      "reject"
                    ],
                    "description": "What to do when a U.S. signer has no signer.region. Default strictest."
                  },
                  "governing_law": {
                    "type": "string",
                    "description": "Pack code or ISO 3166 code named as governing law in the documents."
                  },
                  "allow_session_packs": {
                    "type": "boolean",
                    "description": "Whether a session may add a pack the profile does not enable."
                  },
                  "strict_jurisdictions": {
                    "type": "boolean",
                    "description": "Return 422 jurisdiction_not_enabled instead of a warning."
                  },
                  "signer_class": {
                    "type": "string",
                    "description": "consumer, business or employee."
                  },
                  "document_type": {
                    "type": "string",
                    "description": "Document type this profile is meant for."
                  },
                  "purpose": {
                    "type": "string",
                    "description": "Default context.purpose."
                  },
                  "method": {
                    "type": "string",
                    "enum": [
                      "click",
                      "checkbox",
                      "typed",
                      "drawn",
                      "passkey"
                    ],
                    "description": "Signature method. Default checkbox."
                  },
                  "assurance_level": {
                    "type": "string",
                    "enum": [
                      "L1",
                      "L2",
                      "L3"
                    ],
                    "description": "Default L1."
                  },
                  "failure_mode": {
                    "type": "string",
                    "enum": [
                      "fail_closed",
                      "fail_open_deferred"
                    ],
                    "description": "Default fail_closed."
                  },
                  "consumer_econsent": {
                    "type": "boolean",
                    "description": "Require the ESIGN consumer consent steps for consumer signers."
                  },
                  "capture_mode": {
                    "type": "string",
                    "enum": [
                      "standard",
                      "eu_minimal"
                    ],
                    "description": "Default standard."
                  },
                  "receipts_enabled": {
                    "type": "boolean",
                    "description": "Send the signer receipt email. Default true."
                  },
                  "change_note": {
                    "type": "string",
                    "description": "Note stored with the new profile version."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A Profile object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Profile"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/profiles/{id}/guidance": {
      "get": {
        "operationId": "getProfileGuidance",
        "tags": [
          "Guidance"
        ],
        "summary": "Record conditions, obligations, recommendations and reports that apply to a profile",
        "description": "Secret key with full_access or recording_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/guidance",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A ProfileGuidance object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProfileGuidance"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access",
          "read_only"
        ]
      }
    },
    "/profiles/{id}/adopt": {
      "post": {
        "operationId": "adoptProfile",
        "tags": [
          "Guidance"
        ],
        "summary": "Adopt pending record conditions (advise to enforce)",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/guidance",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "note": {
                    "type": "string",
                    "description": "Note stored with the adoption."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A Profile object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Profile"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/profiles/{id}/rollback": {
      "post": {
        "operationId": "rollbackProfile",
        "tags": [
          "Guidance"
        ],
        "summary": "Return to the previous baseline (within 90 days of an adoption)",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/guidance",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A Profile object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Profile"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/jurisdictions": {
      "get": {
        "operationId": "listJurisdictions",
        "tags": [
          "Jurisdictions"
        ],
        "summary": "The catalogue of jurisdiction packs",
        "description": "Public. A secret key is accepted and not required.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/jurisdictions",
          "description": "Documentation"
        },
        "security": [
          {},
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "expand",
            "in": "query",
            "required": false,
            "description": "\"rules\" to include each pack's rules.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of JurisdictionPack objects.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/List"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/JurisdictionPack"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "optional"
      }
    },
    "/jurisdictions/{code}": {
      "get": {
        "operationId": "getJurisdiction",
        "tags": [
          "Jurisdictions"
        ],
        "summary": "One pack: rules, parts, fixed strings, exclusions, retention floors, fact keys",
        "description": "Public. A secret key is accepted and not required.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/jurisdictions",
          "description": "Documentation"
        },
        "security": [
          {},
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "code",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "version",
            "in": "query",
            "required": false,
            "description": "A dated pack version. Default: the latest.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A JurisdictionPack object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JurisdictionPack"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "optional"
      }
    },
    "/jurisdictions/{code}/versions": {
      "get": {
        "operationId": "listJurisdictionVersions",
        "tags": [
          "Jurisdictions"
        ],
        "summary": "Version history of a pack",
        "description": "Public. A secret key is accepted and not required.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/jurisdictions",
          "description": "Documentation"
        },
        "security": [
          {},
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "code",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of JurisdictionPackVersion objects.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/List"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/JurisdictionPackVersion"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "optional"
      }
    },
    "/jurisdictions/resolve": {
      "post": {
        "operationId": "resolveJurisdictions",
        "tags": [
          "Jurisdictions"
        ],
        "summary": "Dry run: the packs, rules, steps and strings a session would apply",
        "description": "Secret key with full_access or recording_access or read_only permission. Creates nothing and is not metered.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/jurisdictions",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "profile"
                ],
                "properties": {
                  "profile": {
                    "type": "string",
                    "description": "Profile ID."
                  },
                  "signer": {
                    "type": "object",
                    "description": "{ class, country, region, locality }."
                  },
                  "jurisdictions": {
                    "type": "object",
                    "description": "{ mode, packs, governing_law }: per-session overrides."
                  },
                  "documents": {
                    "type": "array",
                    "items": {},
                    "description": "[{ document, version }]."
                  },
                  "context": {
                    "type": "object",
                    "description": "{ purpose, facts, locale }."
                  },
                  "baseline": {
                    "type": "string",
                    "enum": [
                      "current",
                      "latest"
                    ],
                    "description": "Evaluate against the profile's baseline, or with every condition of the latest release enforced."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A JurisdictionResolution object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JurisdictionResolution"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access",
          "read_only"
        ]
      }
    },
    "/sessions": {
      "post": {
        "operationId": "createSession",
        "tags": [
          "Sessions"
        ],
        "summary": "Start a ceremony for one signer and a bundle of document versions",
        "description": "Secret key with full_access or recording_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/sessions",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "profile",
                  "signer",
                  "documents"
                ],
                "properties": {
                  "profile": {
                    "type": "string",
                    "description": "Profile ID."
                  },
                  "signer": {
                    "type": "object",
                    "description": "{ external_id (required), email, name, phone, class, country, region, locality, actor_type }. Asserted by you."
                  },
                  "documents": {
                    "type": "array",
                    "items": {},
                    "description": "[{ document, version }], 1 to 10 entries. version is a version ID or \"current\"."
                  },
                  "jurisdictions": {
                    "type": "object",
                    "description": "{ mode, packs, governing_law }: overrides for this session."
                  },
                  "context": {
                    "type": "object",
                    "description": "{ url, locale, purpose, facts, notes, extra }. url is required in live mode and must be within the registered domain."
                  },
                  "metadata": {
                    "type": "object",
                    "description": "Your key-value pairs, 50 keys at most."
                  },
                  "expires_in": {
                    "type": "integer",
                    "description": "Session lifetime in seconds, 60 to 86400. Default 1800."
                  },
                  "capture_mode": {
                    "type": "string",
                    "enum": [
                      "direct",
                      "server_only"
                    ],
                    "description": "Default direct: events come from the signer's browser."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A Session object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Session"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access"
        ]
      }
    },
    "/sessions/{id}": {
      "get": {
        "operationId": "getSession",
        "tags": [
          "Sessions"
        ],
        "summary": "Read session state and remaining steps",
        "description": "Session client token for its own session, or a secret key with full_access or recording_access or read_only permission. A client token gets a reduced view of its own session.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/sessions",
          "description": "Documentation"
        },
        "security": [
          {
            "clientToken": []
          },
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A Session object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Session"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "either",
        "x-permissions": [
          "full_access",
          "recording_access",
          "read_only"
        ]
      }
    },
    "/sessions/{id}/events": {
      "post": {
        "operationId": "appendSessionEvent",
        "tags": [
          "Sessions"
        ],
        "summary": "Append one ceremony event",
        "description": "Session client token for its own session, or a secret key with full_access or recording_access permission. Called by the browser SDK with the client token. A secret key may send events only for a session created with capture_mode server_only.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/sessions",
          "description": "Documentation"
        },
        "security": [
          {
            "clientToken": []
          },
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "type"
                ],
                "properties": {
                  "type": {
                    "type": "string",
                    "description": "Event type, for example client.attached, document.presented, notice.captured, intent.captured."
                  },
                  "version_id": {
                    "type": "string",
                    "description": "Required for document.presented."
                  },
                  "client_time": {
                    "type": "string",
                    "description": "Time reported by the browser. Reported, not verified."
                  },
                  "data": {
                    "type": "object",
                    "description": "Measurements for the event, 256 KB at most."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A Event object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Event"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "either",
        "x-permissions": [
          "full_access",
          "recording_access"
        ]
      }
    },
    "/sessions/{id}/access-sample": {
      "get": {
        "operationId": "getAccessSample",
        "tags": [
          "Sessions"
        ],
        "summary": "Sample document for the access demonstration (consumer e-consent)",
        "description": "Session client token (esc_ct_...), sent by the browser SDK.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/sessions",
          "description": "Documentation"
        },
        "security": [
          {
            "clientToken": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A AccessSample object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccessSample"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "client"
      }
    },
    "/sessions/{id}/verifications": {
      "post": {
        "operationId": "startVerification",
        "tags": [
          "Sessions"
        ],
        "summary": "Send a one-time code or link, or start a passkey challenge",
        "description": "Session client token (esc_ct_...), sent by the browser SDK.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/sessions",
          "description": "Documentation"
        },
        "security": [
          {
            "clientToken": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "method"
                ],
                "properties": {
                  "method": {
                    "type": "string",
                    "enum": [
                      "email_otp",
                      "email_link",
                      "sms_otp",
                      "passkey"
                    ],
                    "description": "Verification method. The destination comes from the session's signer."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A Verification object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Verification"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "client"
      }
    },
    "/sessions/{id}/verifications/{ver_id}/confirm": {
      "post": {
        "operationId": "confirmVerification",
        "tags": [
          "Sessions"
        ],
        "summary": "Confirm the code or the passkey response",
        "description": "Session client token (esc_ct_...), sent by the browser SDK.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/sessions",
          "description": "Documentation"
        },
        "security": [
          {
            "clientToken": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "ver_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "code": {
                    "type": "string",
                    "description": "The 6-digit code the signer received."
                  },
                  "token": {
                    "type": "string",
                    "description": "The token of an email link."
                  },
                  "attestation": {
                    "type": "object",
                    "description": "WebAuthn registration response (passkey, register phase)."
                  },
                  "assertion": {
                    "type": "object",
                    "description": "WebAuthn authentication response (passkey, authenticate phase)."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A Verification object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Verification"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "client"
      }
    },
    "/sessions/{id}/complete": {
      "post": {
        "operationId": "completeSession",
        "tags": [
          "Sessions"
        ],
        "summary": "Apply the signing act. Returns the record and its receipt",
        "description": "Session client token for its own session, or a secret key with full_access or recording_access permission. The response goes to the browser. Confirm the record on your server before granting access.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/sessions",
          "description": "Documentation"
        },
        "security": [
          {
            "clientToken": []
          },
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "signature": {
                    "type": "object",
                    "description": "{ method, label_text, button_text, typed_name }."
                  },
                  "client_time": {
                    "type": "string",
                    "description": "Time reported by the browser. Reported, not verified."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A Record object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Record"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "either",
        "x-permissions": [
          "full_access",
          "recording_access"
        ]
      }
    },
    "/sessions/{id}/cancel": {
      "post": {
        "operationId": "cancelSession",
        "tags": [
          "Sessions"
        ],
        "summary": "Cancel a session",
        "description": "Session client token for its own session, or a secret key with full_access or recording_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/sessions",
          "description": "Documentation"
        },
        "security": [
          {
            "clientToken": []
          },
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A Session object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Session"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "either",
        "x-permissions": [
          "full_access",
          "recording_access"
        ]
      }
    },
    "/records": {
      "get": {
        "operationId": "listRecords",
        "tags": [
          "Records"
        ],
        "summary": "Search records",
        "description": "Secret key with full_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/records",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "Items per page, 1 to 100. Default 20.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "after",
            "in": "query",
            "required": false,
            "description": "Return items after this object ID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "before",
            "in": "query",
            "required": false,
            "description": "Return items before this object ID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "signer_external_id",
            "in": "query",
            "required": false,
            "description": "Filter by signer.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "email",
            "in": "query",
            "required": false,
            "description": "Filter by signer email.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "document_id",
            "in": "query",
            "required": false,
            "description": "Filter by document.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "version_id",
            "in": "query",
            "required": false,
            "description": "Filter by document version.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "created_after",
            "in": "query",
            "required": false,
            "description": "RFC 3339 timestamp.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "created_before",
            "in": "query",
            "required": false,
            "description": "RFC 3339 timestamp.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "pending_seal, recorded, timestamped, anchored, disputed or voided.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of Record objects.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/List"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Record"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "read_only"
        ]
      }
    },
    "/records/{id}": {
      "get": {
        "operationId": "getRecord",
        "tags": [
          "Records"
        ],
        "summary": "Retrieve a record",
        "description": "Secret key with full_access or recording_access or read_only permission. A recording_access key gets the status view used for server confirmation; full_access and read_only keys get the full record.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/records",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A Record object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Record"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access",
          "read_only"
        ]
      }
    },
    "/records/{id}/report": {
      "get": {
        "operationId": "getRecordReport",
        "tags": [
          "Records"
        ],
        "summary": "Evidence report (PDF)",
        "description": "Secret key with full_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/records",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "Evidence report (PDF).",
            "content": {
              "application/pdf": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "read_only"
        ]
      }
    },
    "/records/{id}/evidence": {
      "get": {
        "operationId": "getRecordEvidence",
        "tags": [
          "Records"
        ],
        "summary": "Evidence package (ZIP): a signed download URL, or the archive with inline=true",
        "description": "Secret key with full_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/records",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "inline",
            "in": "query",
            "required": false,
            "description": "\"true\" returns the archive itself when it is under 4 MB.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "supplements",
            "in": "query",
            "required": false,
            "description": "\"false\" leaves out the customer-supplied folder.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A EvidencePackage object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EvidencePackage"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "read_only"
        ]
      }
    },
    "/records/{id}/receipt": {
      "get": {
        "operationId": "getRecordReceipt",
        "tags": [
          "Records"
        ],
        "summary": "Signed receipt (JWS)",
        "description": "Secret key with full_access or recording_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/records",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A Receipt object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Receipt"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access",
          "read_only"
        ]
      }
    },
    "/records/{id}/annotations": {
      "post": {
        "operationId": "createRecordAnnotation",
        "tags": [
          "Records"
        ],
        "summary": "Add an annotation: superseded, legal_hold, legal_hold_released, note, paper_copy_requested",
        "description": "Secret key with full_access permission. notice.sent and cancellation.requested are accepted here and stored as supplements.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/records",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "type"
                ],
                "properties": {
                  "type": {
                    "type": "string",
                    "description": "Annotation type."
                  },
                  "data": {
                    "type": "object",
                    "description": "Details of the annotation."
                  },
                  "note": {
                    "type": "string",
                    "description": "Free text, 4,000 characters at most."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A Annotation object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Annotation"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/records/{id}/certificates": {
      "post": {
        "operationId": "createRecordCertificate",
        "tags": [
          "Certificates"
        ],
        "summary": "Issue an on-request certificate for one record",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/certificates",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "type"
                ],
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": [
                      "contemporaneous_record",
                      "contemporaneous_record_set",
                      "custodian_certification"
                    ],
                    "description": "Certificate type."
                  },
                  "wording": {
                    "type": "string",
                    "description": "\"auto\" (the packs applied on the record) or a pack code naming the forum variant."
                  },
                  "reference": {
                    "type": "string",
                    "description": "Requester reference, 120 characters at most. Printed as asserted."
                  },
                  "include": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Optional sections: \"supplements\", \"network\"."
                  },
                  "share": {
                    "type": "object",
                    "description": "{ expires_in } in seconds, 90 days at most: creates a share link."
                  },
                  "confirm_charge": {
                    "type": "boolean",
                    "description": "Required when a charge would result. Without it the API returns 402 certificate_charge_unconfirmed with a quote."
                  },
                  "reissue_of": {
                    "type": "string",
                    "description": "ID of an earlier certificate to re-issue."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A Certificate object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Certificate"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/records/deferred": {
      "post": {
        "operationId": "submitDeferredRecord",
        "tags": [
          "Records"
        ],
        "summary": "Submit a deferred acceptance under fail_open_deferred",
        "description": "Secret key with full_access or recording_access permission. The record is sealed with capture_mode deferred and every ceremony field is tagged asserted.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/records",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "profile",
                  "signer",
                  "documents",
                  "signed_at"
                ],
                "properties": {
                  "profile": {
                    "type": "string",
                    "description": "Profile ID with failure_mode fail_open_deferred."
                  },
                  "signer": {
                    "type": "object",
                    "description": "{ external_id, email, name, class, country, region }."
                  },
                  "documents": {
                    "type": "array",
                    "items": {},
                    "description": "[{ document, version }] naming the exact version that was shown."
                  },
                  "signed_at": {
                    "type": "string",
                    "format": "date-time",
                    "description": "When you say the act happened. Asserted."
                  },
                  "signature": {
                    "type": "object",
                    "description": "{ method, label_text, button_text }."
                  },
                  "reason": {
                    "type": "string",
                    "description": "Why the direct channel was not available."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A Record object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Record"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access"
        ]
      }
    },
    "/records/import": {
      "post": {
        "operationId": "importRecords",
        "tags": [
          "Records"
        ],
        "summary": "Import historical acceptances, marked asserted",
        "description": "Secret key with full_access permission. Planned. P2: historical import is not part of the current API.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/records",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A Record object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Record"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ],
        "x-status": "planned"
      }
    },
    "/signers/{external_id}/records": {
      "get": {
        "operationId": "listSignerRecords",
        "tags": [
          "Signers"
        ],
        "summary": "All records for one signer",
        "description": "Secret key with full_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/signers",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "external_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "Items per page, 1 to 100. Default 20.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "after",
            "in": "query",
            "required": false,
            "description": "Return items after this object ID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "before",
            "in": "query",
            "required": false,
            "description": "Return items before this object ID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of Record objects.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/List"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Record"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "read_only"
        ]
      }
    },
    "/signers/{external_id}/status": {
      "get": {
        "operationId": "getSignerStatus",
        "tags": [
          "Signers"
        ],
        "summary": "For each document: latest version accepted, and whether the current version is outstanding",
        "description": "Secret key with full_access or recording_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/signers",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "external_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "documents",
            "in": "query",
            "required": false,
            "description": "Comma-separated document IDs to check.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "locale",
            "in": "query",
            "required": false,
            "description": "Locale used to resolve the current version.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A SignerStatus object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SignerStatus"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access",
          "read_only"
        ]
      }
    },
    "/signers/{external_id}/consents/withdraw": {
      "post": {
        "operationId": "withdrawSignerConsent",
        "tags": [
          "Signers"
        ],
        "summary": "Record withdrawal of consent to electronic records",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/signers",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "external_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "record_id": {
                    "type": "string",
                    "description": "The record the withdrawal relates to."
                  },
                  "scope": {
                    "type": "string",
                    "description": "What the withdrawal covers."
                  },
                  "note": {
                    "type": "string",
                    "description": "Free text."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A ConsentWithdrawal object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConsentWithdrawal"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/signers/{external_id}/erasure-requests": {
      "post": {
        "operationId": "requestSignerErasure",
        "tags": [
          "Signers"
        ],
        "summary": "Start a data-subject erasure or restriction",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/signers",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "external_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "scope": {
                    "type": "string",
                    "enum": [
                      "erasure",
                      "restriction"
                    ],
                    "description": "Default erasure."
                  },
                  "basis": {
                    "type": "string",
                    "description": "The basis or reference for the request."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A ErasureRequest object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErasureRequest"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/certificates": {
      "post": {
        "operationId": "createCertificate",
        "tags": [
          "Certificates"
        ],
        "summary": "Issue a certificate over a set of records selected by filter",
        "description": "Secret key with full_access permission. Asynchronous: the certificate.issued webhook carries the ID when it is ready. Charged as one certificate per 100 records or part of 100.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/certificates",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "type",
                  "filter"
                ],
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": [
                      "contemporaneous_record",
                      "contemporaneous_record_set",
                      "custodian_certification"
                    ],
                    "description": "Certificate type."
                  },
                  "wording": {
                    "type": "string",
                    "description": "\"auto\" (the packs applied on the record) or a pack code naming the forum variant."
                  },
                  "reference": {
                    "type": "string",
                    "description": "Requester reference, 120 characters at most. Printed as asserted."
                  },
                  "include": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Optional sections: \"supplements\", \"network\"."
                  },
                  "share": {
                    "type": "object",
                    "description": "{ expires_in } in seconds, 90 days at most: creates a share link."
                  },
                  "confirm_charge": {
                    "type": "boolean",
                    "description": "Required when a charge would result. Without it the API returns 402 certificate_charge_unconfirmed with a quote."
                  },
                  "reissue_of": {
                    "type": "string",
                    "description": "ID of an earlier certificate to re-issue."
                  },
                  "filter": {
                    "type": "object",
                    "description": "One of record_ids, signer_external_id, document_id or version_id, optionally bounded by created_after and created_before."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "A Certificate object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Certificate"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      },
      "get": {
        "operationId": "listCertificates",
        "tags": [
          "Certificates"
        ],
        "summary": "List certificates",
        "description": "Secret key with full_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/certificates",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "Items per page, 1 to 100. Default 20.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "after",
            "in": "query",
            "required": false,
            "description": "Return items after this object ID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "before",
            "in": "query",
            "required": false,
            "description": "Return items before this object ID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of Certificate objects.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/List"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Certificate"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "read_only"
        ]
      }
    },
    "/certificates/quote": {
      "post": {
        "operationId": "quoteCertificate",
        "tags": [
          "Certificates"
        ],
        "summary": "The charge a certificate request would incur. Issues nothing",
        "description": "Secret key with full_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/certificates",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "description": "Certificate type."
                  },
                  "record_id": {
                    "type": "string",
                    "description": "For a single-record certificate."
                  },
                  "filter": {
                    "type": "object",
                    "description": "For a set certificate."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A CertificateQuote object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CertificateQuote"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "read_only"
        ]
      }
    },
    "/certificates/{id}": {
      "get": {
        "operationId": "getCertificate",
        "tags": [
          "Certificates"
        ],
        "summary": "Retrieve a certificate as JSON",
        "description": "Secret key with full_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/certificates",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A Certificate object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Certificate"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "read_only"
        ]
      }
    },
    "/certificates/{id}/pdf": {
      "get": {
        "operationId": "getCertificatePdf",
        "tags": [
          "Certificates"
        ],
        "summary": "Download a certificate as PDF",
        "description": "Secret key with full_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/certificates",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "Download a certificate as PDF.",
            "content": {
              "application/pdf": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "read_only"
        ]
      }
    },
    "/certificates/{id}/share": {
      "post": {
        "operationId": "createCertificateShare",
        "tags": [
          "Certificates"
        ],
        "summary": "Create a time-limited share link",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/certificates",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "expires_in": {
                    "type": "integer",
                    "description": "Seconds, 60 to 7,776,000 (90 days). Default 30 days."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A CertificateShare object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CertificateShare"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      },
      "delete": {
        "operationId": "revokeCertificateShare",
        "tags": [
          "Certificates"
        ],
        "summary": "Revoke the share links of a certificate",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/certificates",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A CertificateShare object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CertificateShare"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/receipts/{receipt_token}/certificates": {
      "post": {
        "operationId": "createSignerCertificate",
        "tags": [
          "Certificates"
        ],
        "summary": "Signer requests a certificate for the signer's own record",
        "description": "No credential needed. Planned. v1.1 (P1): signer-requested certificates. Off unless the customer enables them; the customer is charged, never the signer.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/certificates",
          "description": "Documentation"
        },
        "security": [],
        "parameters": [
          {
            "name": "receipt_token",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A Certificate object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Certificate"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "none",
        "x-status": "planned"
      }
    },
    "/supplements": {
      "post": {
        "operationId": "createSupplement",
        "tags": [
          "Supplements"
        ],
        "summary": "Send customer-supplied material: text, JSON, files",
        "description": "Secret key with full_access or recording_access permission. At least one of text, data or files is required. Nothing else is. Sealed on receipt and labelled customer-supplied; Esign Comply does not verify it.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/supplements",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "subject": {
                    "type": "object",
                    "description": "Exactly one of { record }, { session }, { signer }, { document_version } or { domain }. Omitted means the domain."
                  },
                  "type": {
                    "type": "string",
                    "description": "A type from GET /supplement-types, or custom.<slug>. Unknown types are accepted."
                  },
                  "occurred_at": {
                    "type": "string",
                    "format": "date-time",
                    "description": "When you say the thing happened. Asserted."
                  },
                  "rule_ids": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Rule IDs the material relates to, for example NY-05."
                  },
                  "text": {
                    "type": "string",
                    "description": "UTF-8 text, 20,000 characters at most."
                  },
                  "data": {
                    "description": "Any JSON value, 256 KB at most."
                  },
                  "files": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Up to 10 file IDs from POST /files."
                  },
                  "labels": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Up to 20 labels."
                  },
                  "supersedes": {
                    "type": "string",
                    "description": "ID of a supplement this one corrects."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A Supplement object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Supplement"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access"
        ]
      },
      "get": {
        "operationId": "listSupplements",
        "tags": [
          "Supplements"
        ],
        "summary": "List supplements",
        "description": "Secret key with full_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/supplements",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "Items per page, 1 to 100. Default 20.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "after",
            "in": "query",
            "required": false,
            "description": "Return items after this object ID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "before",
            "in": "query",
            "required": false,
            "description": "Return items before this object ID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "subject",
            "in": "query",
            "required": false,
            "description": "Subject ID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "type",
            "in": "query",
            "required": false,
            "description": "Supplement type.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "rule_id",
            "in": "query",
            "required": false,
            "description": "Rule ID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "label",
            "in": "query",
            "required": false,
            "description": "Label.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "received_after",
            "in": "query",
            "required": false,
            "description": "RFC 3339 timestamp.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "received_before",
            "in": "query",
            "required": false,
            "description": "RFC 3339 timestamp.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of Supplement objects.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/List"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Supplement"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "read_only"
        ]
      }
    },
    "/supplements/{id}": {
      "get": {
        "operationId": "getSupplement",
        "tags": [
          "Supplements"
        ],
        "summary": "Retrieve a supplement",
        "description": "Secret key with full_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/supplements",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A Supplement object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Supplement"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "read_only"
        ]
      },
      "delete": {
        "operationId": "withdrawSupplement",
        "tags": [
          "Supplements"
        ],
        "summary": "Withdraw a supplement",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/supplements",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A Supplement object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Supplement"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/supplements/{id}/content": {
      "get": {
        "operationId": "getSupplementContent",
        "tags": [
          "Supplements"
        ],
        "summary": "Text, data and file download links as stored",
        "description": "Secret key with full_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/supplements",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A SupplementContent object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SupplementContent"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "read_only"
        ]
      }
    },
    "/supplement-types": {
      "get": {
        "operationId": "listSupplementTypes",
        "tags": [
          "Supplements"
        ],
        "summary": "Catalogue of recognised supplement types with suggested fields",
        "description": "No credential needed.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/supplements",
          "description": "Documentation"
        },
        "security": [],
        "responses": {
          "200": {
            "description": "A list of SupplementType objects.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/List"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/SupplementType"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "none"
      }
    },
    "/files": {
      "post": {
        "operationId": "createFile",
        "tags": [
          "Supplements"
        ],
        "summary": "Start a file upload: returns the file ID and an upload URL",
        "description": "Secret key with full_access or recording_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/supplements",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "name",
                  "size",
                  "sha256"
                ],
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "File name."
                  },
                  "size": {
                    "type": "integer",
                    "description": "Size in bytes."
                  },
                  "content_type": {
                    "type": "string",
                    "description": "MIME type."
                  },
                  "sha256": {
                    "type": "string",
                    "description": "SHA-256 of the exact bytes you will upload."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A File object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/File"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access"
        ]
      }
    },
    "/files/{id}": {
      "get": {
        "operationId": "getFile",
        "tags": [
          "Supplements"
        ],
        "summary": "Read the status of an uploaded file",
        "description": "Secret key with full_access or recording_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/supplements",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A File object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/File"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access"
        ]
      }
    },
    "/guidance/notices": {
      "get": {
        "operationId": "listGuidanceNotices",
        "tags": [
          "Guidance"
        ],
        "summary": "List guidance notices",
        "description": "Public fields without a key. With a secret key: the notices that target the domain, with acknowledgment state.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/guidance",
          "description": "Documentation"
        },
        "security": [
          {},
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "jurisdiction",
            "in": "query",
            "required": false,
            "description": "Pack, country, subdivision or locality code.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "class",
            "in": "query",
            "required": false,
            "description": "record_change, obligation, recommendation or information.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "severity",
            "in": "query",
            "required": false,
            "description": "action_required, recommended or info.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "kind",
            "in": "query",
            "required": false,
            "description": "Notice kind.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "topic",
            "in": "query",
            "required": false,
            "description": "Topic.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "since",
            "in": "query",
            "required": false,
            "description": "RFC 3339 timestamp.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "affecting_profile",
            "in": "query",
            "required": false,
            "description": "Profile ID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of GuidanceNotice objects.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/List"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/GuidanceNotice"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "optional"
      }
    },
    "/guidance/notices/{id}": {
      "get": {
        "operationId": "getGuidanceNotice",
        "tags": [
          "Guidance"
        ],
        "summary": "Retrieve a notice",
        "description": "Public fields without a key.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/guidance",
          "description": "Documentation"
        },
        "security": [
          {},
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A GuidanceNotice object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GuidanceNotice"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "optional"
      }
    },
    "/guidance/notices/{id}/acknowledge": {
      "post": {
        "operationId": "acknowledgeGuidanceNotice",
        "tags": [
          "Guidance"
        ],
        "summary": "Mark a notice read, applied or not applicable",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/guidance",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "state"
                ],
                "properties": {
                  "state": {
                    "type": "string",
                    "enum": [
                      "read",
                      "applied",
                      "not_applicable"
                    ],
                    "description": "Acknowledgment state. Never gates recording."
                  },
                  "note": {
                    "type": "string",
                    "description": "Free text."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A GuidanceAcknowledgment object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GuidanceAcknowledgment"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/guidance/releases": {
      "get": {
        "operationId": "listGuidanceReleases",
        "tags": [
          "Guidance"
        ],
        "summary": "List guidance releases",
        "description": "Public.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/guidance",
          "description": "Documentation"
        },
        "security": [
          {},
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of GuidanceRelease objects.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/List"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/GuidanceRelease"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "optional"
      }
    },
    "/guidance/releases/{id}": {
      "get": {
        "operationId": "getGuidanceRelease",
        "tags": [
          "Guidance"
        ],
        "summary": "A release and its changelog",
        "description": "Public.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/guidance",
          "description": "Documentation"
        },
        "security": [
          {},
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A GuidanceRelease object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GuidanceRelease"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "optional"
      }
    },
    "/guidance/updates/{update_prompt_id}": {
      "get": {
        "operationId": "getGuidanceUpdate",
        "tags": [
          "Guidance"
        ],
        "summary": "An update prompt (JSON, or Markdown with Accept: text/markdown)",
        "description": "Secret key with full_access or recording_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/guidance",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "update_prompt_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A GuidanceUpdate object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GuidanceUpdate"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access",
          "read_only"
        ]
      }
    },
    "/domains/{id}/watched-jurisdictions": {
      "get": {
        "operationId": "getWatchedJurisdictions",
        "tags": [
          "Guidance"
        ],
        "summary": "Read the watched jurisdictions of a domain",
        "description": "Secret key with full_access or recording_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/guidance",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A WatchedJurisdictions object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WatchedJurisdictions"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access",
          "read_only"
        ]
      },
      "put": {
        "operationId": "setWatchedJurisdictions",
        "tags": [
          "Guidance"
        ],
        "summary": "Set the watched jurisdictions of a domain",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/guidance",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "jurisdictions"
                ],
                "properties": {
                  "jurisdictions": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Up to 100 codes: a pack code, an ISO 3166-1 country, an ISO 3166-2 subdivision, or a locality such as US-NY/NYC."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A WatchedJurisdictions object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WatchedJurisdictions"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/verify": {
      "post": {
        "operationId": "verify",
        "tags": [
          "Verification"
        ],
        "summary": "Check a signed receipt. Returns proof status only",
        "description": "The holder of the full signed receipt needs no key. With a secret key, a record_id of the key's own domain is also accepted. A record ID or hash alone reveals nothing: not existence, not metadata.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/verification",
          "description": "Documentation"
        },
        "security": [
          {},
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "receipt": {
                    "type": "string",
                    "description": "The full signed receipt (compact JWS)."
                  },
                  "record_id": {
                    "type": "string",
                    "description": "With a secret key of the same domain only."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A VerificationResult object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VerificationResult"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "optional"
      }
    },
    "/log/checkpoint": {
      "get": {
        "operationId": "getLogCheckpoint",
        "tags": [
          "Verification"
        ],
        "summary": "Latest signed Merkle checkpoint",
        "description": "No credential needed.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/verification",
          "description": "Documentation"
        },
        "security": [],
        "parameters": [
          {
            "name": "environment",
            "in": "query",
            "required": false,
            "description": "\"test\" reads the test log. Default live.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "tree_size",
            "in": "query",
            "required": false,
            "description": "Read an earlier checkpoint.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A Checkpoint object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Checkpoint"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "none"
      }
    },
    "/log/proof": {
      "get": {
        "operationId": "getLogProof",
        "tags": [
          "Verification"
        ],
        "summary": "Inclusion or consistency proof (RFC 6962)",
        "description": "No credential needed.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/verification",
          "description": "Documentation"
        },
        "security": [],
        "parameters": [
          {
            "name": "leaf_index",
            "in": "query",
            "required": false,
            "description": "Inclusion proof: index of the leaf.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "tree_size",
            "in": "query",
            "required": false,
            "description": "Inclusion proof: tree size. Default: the latest.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "first",
            "in": "query",
            "required": false,
            "description": "Consistency proof: the earlier tree size.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "second",
            "in": "query",
            "required": false,
            "description": "Consistency proof: the later tree size.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "environment",
            "in": "query",
            "required": false,
            "description": "\"test\" reads the test log.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "A LogProof object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogProof"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "none"
      }
    },
    "/domains": {
      "post": {
        "operationId": "registerDomain",
        "tags": [
          "Account"
        ],
        "summary": "Register the domain for this subscription",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/account",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "domain"
                ],
                "properties": {
                  "domain": {
                    "type": "string",
                    "description": "A host or URL. The registrable domain is computed from it and covers every subdomain."
                  },
                  "region": {
                    "type": "string",
                    "enum": [
                      "us",
                      "eu"
                    ],
                    "description": "Data region. Fixed after registration."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A Domain object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Domain"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      },
      "get": {
        "operationId": "listDomains",
        "tags": [
          "Account"
        ],
        "summary": "The domain of the calling key",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/account",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of Domain objects.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/List"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Domain"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/domains/{id}": {
      "get": {
        "operationId": "getDomain",
        "tags": [
          "Account"
        ],
        "summary": "Retrieve a domain and its verification instructions",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/account",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A Domain object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Domain"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      },
      "patch": {
        "operationId": "updateDomain",
        "tags": [
          "Account"
        ],
        "summary": "Set the certificate spend limit or the test origins",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/account",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "certificate_spend_limit": {
                    "type": "integer",
                    "description": "Monthly limit in cents, 0 to 500000."
                  },
                  "test_origins": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Up to 25 preview hosts where test keys may run."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A Domain object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Domain"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/domains/{id}/verify": {
      "post": {
        "operationId": "verifyDomain",
        "tags": [
          "Account"
        ],
        "summary": "Run a verification check now",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/account",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A Domain object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Domain"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/api-keys": {
      "post": {
        "operationId": "createApiKey",
        "tags": [
          "Account"
        ],
        "summary": "Create an API key. The secret is returned once",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/account",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "name"
                ],
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "Key name."
                  },
                  "permission": {
                    "type": "string",
                    "enum": [
                      "full_access",
                      "recording_access",
                      "read_only"
                    ],
                    "description": "Default recording_access."
                  },
                  "mode": {
                    "type": "string",
                    "enum": [
                      "test",
                      "live"
                    ],
                    "description": "Default: the mode of the calling key."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A ApiKey object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiKey"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      },
      "get": {
        "operationId": "listApiKeys",
        "tags": [
          "Account"
        ],
        "summary": "List API keys (prefix only, never the secret)",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/account",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of ApiKey objects.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/List"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/ApiKey"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/api-keys/{id}": {
      "delete": {
        "operationId": "revokeApiKey",
        "tags": [
          "Account"
        ],
        "summary": "Revoke an API key",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/account",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A ApiKey object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiKey"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/webhooks": {
      "post": {
        "operationId": "createWebhookEndpoint",
        "tags": [
          "Webhooks"
        ],
        "summary": "Create a webhook endpoint. The signing secret is returned once",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/account",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "url"
                ],
                "properties": {
                  "url": {
                    "type": "string",
                    "description": "HTTPS URL. http://localhost is accepted in test mode."
                  },
                  "events": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Event types, or [\"*\"] for all. Default [\"*\"]."
                  },
                  "description": {
                    "type": "string",
                    "description": "Free text."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A WebhookEndpoint object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpoint"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      },
      "get": {
        "operationId": "listWebhookEndpoints",
        "tags": [
          "Webhooks"
        ],
        "summary": "List webhook endpoints",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/account",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of WebhookEndpoint objects.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/List"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/WebhookEndpoint"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/webhooks/{id}": {
      "patch": {
        "operationId": "updateWebhookEndpoint",
        "tags": [
          "Webhooks"
        ],
        "summary": "Update a webhook endpoint",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/account",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string",
                    "description": "New URL."
                  },
                  "events": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "New event list."
                  },
                  "description": {
                    "type": "string",
                    "description": "Free text."
                  },
                  "status": {
                    "type": "string",
                    "enum": [
                      "enabled",
                      "disabled"
                    ],
                    "description": "Enable or disable the endpoint."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A WebhookEndpoint object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpoint"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      },
      "delete": {
        "operationId": "deleteWebhookEndpoint",
        "tags": [
          "Webhooks"
        ],
        "summary": "Delete a webhook endpoint",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/account",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A WebhookEndpoint object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookEndpoint"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/webhooks/{id}/test": {
      "post": {
        "operationId": "testWebhookEndpoint",
        "tags": [
          "Webhooks"
        ],
        "summary": "Send a signed test event to an endpoint now",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/webhooks",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A WebhookTest object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookTest"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/webhooks/deliveries": {
      "get": {
        "operationId": "listWebhookDeliveries",
        "tags": [
          "Webhooks"
        ],
        "summary": "Delivery history with response codes",
        "description": "Secret key with full_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/account",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "Items per page, 1 to 100. Default 20.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "endpoint",
            "in": "query",
            "required": false,
            "description": "Endpoint ID.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Delivery status.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "since",
            "in": "query",
            "required": false,
            "description": "RFC 3339 timestamp.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "include",
            "in": "query",
            "required": false,
            "description": "\"payload\" to include each delivery body.",
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of WebhookDelivery objects.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/List"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/WebhookDelivery"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/usage": {
      "get": {
        "operationId": "getUsage",
        "tags": [
          "Account"
        ],
        "summary": "Events used, quota, period end, certificate allowance and spend, supplement storage",
        "description": "Secret key with full_access or recording_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/account",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A Usage object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Usage"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access",
          "read_only"
        ]
      }
    },
    "/agent": {
      "get": {
        "operationId": "getAgentAccount",
        "tags": [
          "Agent"
        ],
        "summary": "The account state and the next step",
        "description": "Agent token (esc_agent_...), sent as a Bearer token. It acts as the member who created it, with that member's role. Not an API key. The one call a locked account still answers.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/agent",
          "description": "Documentation"
        },
        "security": [
          {
            "agentToken": []
          }
        ],
        "responses": {
          "200": {
            "description": "A AgentAccount object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentAccount"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "agent"
      }
    },
    "/agent/api-keys": {
      "post": {
        "operationId": "createAgentApiKey",
        "tags": [
          "Agent"
        ],
        "summary": "Create a test key or a live key. The key is returned once",
        "description": "Agent token (esc_agent_...), sent as a Bearer token. It acts as the member who created it, with that member's role. Not an API key.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/agent",
          "description": "Documentation"
        },
        "security": [
          {
            "agentToken": []
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "mode": {
                    "type": "string",
                    "enum": [
                      "test",
                      "live"
                    ],
                    "description": "Default test. A live key needs a verified domain, saved organization details and recorded agreements."
                  },
                  "name": {
                    "type": "string",
                    "description": "Up to 80 characters."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A ApiKey object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiKey"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "agent"
      }
    },
    "/agent/domain": {
      "get": {
        "operationId": "getAgentDomain",
        "tags": [
          "Agent"
        ],
        "summary": "The domain and the DNS record that verifies it",
        "description": "Agent token (esc_agent_...), sent as a Bearer token. It acts as the member who created it, with that member's role. Not an API key.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/agent",
          "description": "Documentation"
        },
        "security": [
          {
            "agentToken": []
          }
        ],
        "responses": {
          "200": {
            "description": "A Domain object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Domain"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "agent"
      },
      "put": {
        "operationId": "registerAgentDomain",
        "tags": [
          "Agent"
        ],
        "summary": "Register the domain",
        "description": "Agent token (esc_agent_...), sent as a Bearer token. It acts as the member who created it, with that member's role. Not an API key.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/agent",
          "description": "Documentation"
        },
        "security": [
          {
            "agentToken": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "domain"
                ],
                "properties": {
                  "domain": {
                    "type": "string",
                    "description": "A host or a URL, for example app.example.com."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A Domain object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Domain"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "agent"
      }
    },
    "/agent/domain/verify": {
      "post": {
        "operationId": "verifyAgentDomain",
        "tags": [
          "Agent"
        ],
        "summary": "Look for the verification record now",
        "description": "Agent token (esc_agent_...), sent as a Bearer token. It acts as the member who created it, with that member's role. Not an API key. The response is the domain object with `verified` (boolean) and `check` (the outcome of this check).",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/agent",
          "description": "Documentation"
        },
        "security": [
          {
            "agentToken": []
          }
        ],
        "responses": {
          "200": {
            "description": "A Domain object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Domain"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "agent"
      }
    },
    "/agent/go-live": {
      "post": {
        "operationId": "agentGoLive",
        "tags": [
          "Agent"
        ],
        "summary": "Save the organization's details and create the live key on the Free plan",
        "description": "Agent token (esc_agent_...), sent as a Bearer token. It acts as the member who created it, with that member's role. Not an API key. 201 when a live key was created, 200 when the account already holds one.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/agent",
          "description": "Documentation"
        },
        "security": [
          {
            "agentToken": []
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "organization": {
                    "type": "object",
                    "description": "legal_name, country, line1, city and billing_email are required; line2, region, postal_code, state and tax_id are optional. Leave the object out when the details are on file."
                  },
                  "key_name": {
                    "type": "string",
                    "description": "Name of the live key. Default Production."
                  },
                  "new_key": {
                    "type": "boolean",
                    "description": "true creates another live key on an account that already has one."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A GoLive object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GoLive"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "agent"
      }
    },
    "/conformance/runs": {
      "post": {
        "operationId": "createConformanceRun",
        "tags": [
          "Account"
        ],
        "summary": "Run the conformance checker over recent sessions",
        "description": "Secret key with full_access or recording_access permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/account",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "session_ids": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Up to 200 sessions to evaluate."
                  },
                  "since": {
                    "type": "string",
                    "format": "date-time",
                    "description": "Evaluate sessions created after this time."
                  },
                  "url": {
                    "type": "string",
                    "description": "Only sessions declared on this page URL."
                  },
                  "limit": {
                    "type": "integer",
                    "description": "Number of sessions to evaluate, 1 to 500."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "A ConformanceRun object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConformanceRun"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access"
        ]
      },
      "get": {
        "operationId": "listConformanceRuns",
        "tags": [
          "Account"
        ],
        "summary": "List conformance runs",
        "description": "Secret key with full_access or recording_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/account",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A list of ConformanceRun objects.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/List"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/ConformanceRun"
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access",
          "read_only"
        ]
      }
    },
    "/conformance/runs/{id}": {
      "get": {
        "operationId": "getConformanceRun",
        "tags": [
          "Account"
        ],
        "summary": "Retrieve a conformance run and its findings",
        "description": "Secret key with full_access or recording_access or read_only permission.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/account",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "responses": {
          "200": {
            "description": "A ConformanceRun object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConformanceRun"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access",
          "recording_access",
          "read_only"
        ]
      }
    },
    "/prompts/generate": {
      "post": {
        "operationId": "generatePrompt",
        "tags": [
          "Account"
        ],
        "summary": "Generate the integration prompt from wizard selections",
        "description": "Secret key with full_access permission. The prompt never contains a key. It carries a prompt ID and a content hash.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/account",
          "description": "Documentation"
        },
        "security": [
          {
            "secretKey": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/IdempotencyKey"
          },
          {
            "$ref": "#/components/parameters/ApiVersion"
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "jurisdictions": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Pack codes."
                  },
                  "jurisdiction_mode": {
                    "type": "string",
                    "enum": [
                      "auto",
                      "strictest",
                      "explicit"
                    ],
                    "description": "Same meaning as on a profile."
                  },
                  "on_unknown_region": {
                    "type": "string",
                    "enum": [
                      "strictest",
                      "base_only",
                      "reject"
                    ],
                    "description": "Same meaning as on a profile."
                  },
                  "governing_law": {
                    "type": "string",
                    "description": "Pack code or ISO 3166 code."
                  }
                },
                "additionalProperties": true
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A Prompt object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Prompt"
                }
              }
            }
          },
          "default": {
            "description": "Error. See the error envelope.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "x-key": "secret",
        "x-permissions": [
          "full_access"
        ]
      }
    },
    "/.well-known/jwks.json": {
      "servers": [
        {
          "url": "https://esigncomply.com",
          "description": "Site root"
        }
      ],
      "get": {
        "operationId": "getJwks",
        "tags": [
          "Verification"
        ],
        "summary": "Public sealing keys, current and retired",
        "description": "No credential needed. Served from the site root, not under /v1.",
        "externalDocs": {
          "url": "https://esigncomply.com/docs/api/verification",
          "description": "Documentation"
        },
        "security": [],
        "responses": {
          "200": {
            "description": "A JSON Web Key Set.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Jwks"
                }
              }
            }
          }
        },
        "x-key": "none"
      }
    }
  },
  "components": {
    "securitySchemes": {
      "secretKey": {
        "type": "http",
        "scheme": "bearer",
        "description": "Secret API key: esc_test_us_..., esc_live_us_..., esc_test_eu_..., esc_live_eu_.... Server only. Each key has one permission (full_access, recording_access, read_only) and is bound to one domain and one region."
      },
      "clientToken": {
        "type": "http",
        "scheme": "bearer",
        "description": "Session client token: esc_ct_.... Returned by POST /sessions, short-lived, scoped to one session. The only credential a browser holds."
      },
      "agentToken": {
        "type": "http",
        "scheme": "bearer",
        "description": "Agent token: esc_agent_.... Created by a signed-in person under Agent access in the dashboard. Accepted by the /agent endpoints only. It acts as that person with their role, expires, and can be revoked."
      }
    },
    "parameters": {
      "IdempotencyKey": {
        "name": "Idempotency-Key",
        "in": "header",
        "required": false,
        "description": "Up to 255 characters. Kept for 24 hours. The same key and body return the original response; a different body returns 409 idempotency_conflict.",
        "schema": {
          "type": "string",
          "maxLength": 255
        }
      },
      "ApiVersion": {
        "name": "Esign-Comply-Version",
        "in": "header",
        "required": false,
        "description": "Dated API version for this request. Default: the version the key is pinned to. Current: 2026-11-21.",
        "schema": {
          "type": "string",
          "examples": [
            "2026-11-21"
          ]
        }
      }
    },
    "headers": {
      "X-Request-Id": {
        "description": "Carried by every response. Repeated as error.request_id.",
        "schema": {
          "type": "string"
        }
      },
      "RateLimit-Limit": {
        "description": "Requests allowed in the window.",
        "schema": {
          "type": "integer"
        }
      },
      "RateLimit-Remaining": {
        "description": "Requests left in the window.",
        "schema": {
          "type": "integer"
        }
      },
      "RateLimit-Reset": {
        "description": "Seconds until the window resets.",
        "schema": {
          "type": "integer"
        }
      },
      "Retry-After": {
        "description": "Seconds to wait before retrying.",
        "schema": {
          "type": "integer"
        }
      },
      "Idempotent-Replayed": {
        "description": "true when the response is a replay for an Idempotency-Key.",
        "schema": {
          "type": "string"
        }
      }
    },
    "schemas": {
      "Error": {
        "type": "object",
        "title": "Error",
        "description": "The error envelope. Branch on error.type first, then on error.code. New codes may be added; treat an unknown code as its type.",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "object",
            "required": [
              "type",
              "code",
              "message",
              "doc_url",
              "request_id"
            ],
            "additionalProperties": true,
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "invalid_request_error",
                  "authentication_error",
                  "permission_error",
                  "conflict_error",
                  "ceremony_error",
                  "conformance_error",
                  "quota_error",
                  "billing_error",
                  "rate_limit_error",
                  "api_error"
                ],
                "description": "The class of error. Closed within an API version."
              },
              "code": {
                "type": "string",
                "description": "Stable machine value.",
                "examples": [
                  "invalid_request",
                  "jurisdiction_unknown",
                  "missing_api_key",
                  "invalid_api_key",
                  "client_token_expired",
                  "domain_not_verified",
                  "domain_mismatch",
                  "insufficient_permission",
                  "plan_feature_unavailable",
                  "signer_certificates_disabled",
                  "not_found",
                  "subject_not_found",
                  "idempotency_conflict",
                  "step_out_of_order",
                  "session_not_active",
                  "domain_already_registered",
                  "record_not_timestamped",
                  "baseline_unchanged",
                  "rollback_unavailable",
                  "region_mismatch",
                  "steps_incomplete",
                  "conformance_failed",
                  "render_mismatch",
                  "document_type_excluded",
                  "verification_failed",
                  "version_not_published",
                  "jurisdiction_not_enabled",
                  "signer_region_required",
                  "jurisdiction_fact_required",
                  "certificate_set_too_large",
                  "certificate_field_unavailable",
                  "file_type_refused",
                  "file_hash_mismatch",
                  "file_too_large",
                  "quota_exhausted",
                  "quota_exceeded",
                  "certificate_charge_unconfirmed",
                  "certificate_spend_limit_reached",
                  "payment_method_required",
                  "storage_limit_reached",
                  "rate_limit_exceeded",
                  "test_quota_exceeded",
                  "internal_error",
                  "service_unavailable",
                  "certificate_verification_failed"
                ]
              },
              "message": {
                "type": "string",
                "description": "What happened, why, and the fix. Do not parse it."
              },
              "param": {
                "type": "string",
                "description": "Present when one request field caused the error."
              },
              "missing_steps": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "On steps_incomplete and step_out_of_order."
              },
              "rule": {
                "type": "string",
                "description": "Rule ID that produced the error, for example CR-08."
              },
              "findings": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Finding"
                },
                "description": "On conformance_failed and render_mismatch."
              },
              "quote": {
                "$ref": "#/components/schemas/CertificateQuote"
              },
              "doc_url": {
                "type": "string",
                "format": "uri",
                "description": "Link to the code on the errors page."
              },
              "request_id": {
                "type": "string",
                "description": "The same value as the X-Request-Id header."
              }
            }
          }
        }
      },
      "List": {
        "type": "object",
        "title": "List",
        "description": "The list envelope of every list endpoint.",
        "properties": {
          "object": {
            "type": "string",
            "description": "Always \"list\"."
          },
          "data": {
            "type": "array",
            "items": {}
          },
          "has_more": {
            "type": "boolean"
          }
        },
        "additionalProperties": true
      },
      "Finding": {
        "type": "object",
        "title": "Finding",
        "description": "One conformance result. Findings describe measurable design facts. They are not a statement that a flow is lawful or enforceable.",
        "properties": {
          "rule": {
            "type": "string",
            "description": "Rule ID, CR-01 to CR-28."
          },
          "status": {
            "type": "string",
            "description": "pass, warn or block."
          },
          "state": {
            "type": "string",
            "description": "enforce can refuse a live record; advise is measured and stored only."
          },
          "message": {
            "type": "string"
          },
          "fix": {
            "type": "string"
          },
          "measurement": {
            "type": "object"
          },
          "maps_to": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "event_type": {
            "type": "string"
          },
          "version_id": {
            "type": "string"
          }
        },
        "additionalProperties": true
      },
      "Document": {
        "type": "object",
        "title": "Document",
        "description": "A named agreement.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "metadata": {
            "type": "object"
          },
          "archived": {
            "type": "boolean"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "current_version": {
            "type": "string"
          },
          "warnings": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": true
      },
      "DocumentVersion": {
        "type": "object",
        "title": "DocumentVersion",
        "description": "An immutable snapshot of a document's content.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "document_id": {
            "type": "string"
          },
          "livemode": {
            "type": "boolean"
          },
          "version_label": {
            "type": "string"
          },
          "language": {
            "type": "string"
          },
          "format": {
            "type": "string"
          },
          "content_hash": {
            "type": "string",
            "description": "SHA-256 of the exact stored bytes."
          },
          "render_hash": {
            "type": "string",
            "description": "SHA-256 of the normalized visible text; what the browser SDK compares."
          },
          "size": {
            "type": "integer"
          },
          "material_change": {
            "type": "boolean"
          },
          "summary_of_changes": {
            "type": "string"
          },
          "effective_at": {
            "type": "string",
            "format": "date-time"
          },
          "published_at": {
            "type": "string",
            "format": "date-time"
          },
          "warnings": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": true
      },
      "DocumentVersionContent": {
        "type": "object",
        "title": "DocumentVersionContent",
        "description": "The canonical content to render. Inject html unmodified so the page text matches render_hash.",
        "properties": {
          "object": {
            "type": "string"
          },
          "version_id": {
            "type": "string"
          },
          "document_id": {
            "type": "string"
          },
          "format": {
            "type": "string"
          },
          "language": {
            "type": "string"
          },
          "content_hash": {
            "type": "string"
          },
          "render_hash": {
            "type": "string"
          },
          "text": {
            "type": "string"
          },
          "html": {
            "type": "string"
          },
          "data_base64": {
            "type": "string"
          },
          "content_type": {
            "type": "string"
          }
        },
        "additionalProperties": true
      },
      "Profile": {
        "type": "object",
        "title": "Profile",
        "description": "A versioned ceremony profile.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "version": {
            "type": "integer"
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "jurisdictions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "jurisdiction_mode": {
            "type": "string"
          },
          "on_unknown_region": {
            "type": "string"
          },
          "governing_law": {
            "type": "string"
          },
          "allow_session_packs": {
            "type": "boolean"
          },
          "strict_jurisdictions": {
            "type": "boolean"
          },
          "signer_class": {
            "type": "string"
          },
          "document_type": {
            "type": "string"
          },
          "purpose": {
            "type": "string"
          },
          "method": {
            "type": "string"
          },
          "assurance_level": {
            "type": "string"
          },
          "failure_mode": {
            "type": "string"
          },
          "consumer_econsent": {
            "type": "boolean"
          },
          "capture_mode": {
            "type": "string"
          },
          "receipts_enabled": {
            "type": "boolean"
          },
          "baseline": {
            "type": "string"
          },
          "prompt_id": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "pending_conditions": {
            "type": "array",
            "items": {}
          },
          "versions": {
            "type": "array",
            "items": {}
          },
          "warnings": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": true
      },
      "ProfileGuidance": {
        "type": "object",
        "title": "ProfileGuidance",
        "description": "Everything that applies to a profile now.",
        "properties": {
          "object": {
            "type": "string"
          },
          "record_conditions": {
            "type": "array",
            "items": {}
          },
          "obligations": {
            "type": "array",
            "items": {}
          },
          "recommendations": {
            "type": "array",
            "items": {}
          },
          "reports": {
            "type": "array",
            "items": {}
          },
          "required_strings": {
            "type": "array",
            "items": {}
          },
          "baseline": {
            "type": "object"
          }
        },
        "additionalProperties": true
      },
      "JurisdictionPack": {
        "type": "object",
        "title": "JurisdictionPack",
        "description": "A versioned rule pack. It records which rules Esign Comply applied; it is not a statement that a flow meets the law of a jurisdiction.",
        "properties": {
          "object": {
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "parent": {
            "type": "string"
          },
          "version": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "effective_at": {
            "type": "string",
            "format": "date-time"
          },
          "reviewed_at": {
            "type": "string",
            "format": "date-time",
            "description": "Counsel review date. null means research draft."
          },
          "content_hash": {
            "type": "string"
          },
          "coverage": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "not_covered": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "rules": {
            "type": "array",
            "items": {}
          },
          "exclusions": {
            "type": "array",
            "items": {}
          },
          "retention_floors": {
            "type": "array",
            "items": {}
          },
          "fixed_strings": {
            "type": "array",
            "items": {}
          },
          "fact_keys": {
            "type": "array",
            "items": {}
          },
          "guidance_release": {
            "type": "string"
          }
        },
        "additionalProperties": true
      },
      "JurisdictionPackVersion": {
        "type": "object",
        "title": "JurisdictionPackVersion",
        "description": "One entry of a pack's version history.",
        "properties": {
          "object": {
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "version": {
            "type": "string"
          },
          "effective_at": {
            "type": "string",
            "format": "date-time"
          },
          "reviewed_at": {
            "type": "string",
            "format": "date-time"
          },
          "review_state": {
            "type": "string"
          },
          "content_hash": {
            "type": "string"
          },
          "guidance_release": {
            "type": "string"
          },
          "published_at": {
            "type": "string",
            "format": "date-time"
          },
          "changelog": {
            "type": "string"
          },
          "rule_count": {
            "type": "integer"
          }
        },
        "additionalProperties": true
      },
      "JurisdictionResolution": {
        "type": "object",
        "title": "JurisdictionResolution",
        "description": "What a session would apply.",
        "properties": {
          "object": {
            "type": "string"
          },
          "mode": {
            "type": "string"
          },
          "applied_jurisdictions": {
            "type": "array",
            "items": {}
          },
          "rule_set_version": {
            "type": "string"
          },
          "rules_fired": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "required_steps": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "required_strings": {
            "type": "array",
            "items": {}
          },
          "retention_floor": {
            "type": "object"
          },
          "exclusions": {
            "type": "array",
            "items": {}
          },
          "obligations": {
            "type": "array",
            "items": {}
          },
          "recommendations": {
            "type": "array",
            "items": {}
          },
          "reports": {
            "type": "array",
            "items": {}
          },
          "advisories": {
            "type": "array",
            "items": {}
          },
          "warnings": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "guidance_release": {
            "type": "string"
          },
          "would_fail": {
            "type": "object"
          }
        },
        "additionalProperties": true
      },
      "Session": {
        "type": "object",
        "title": "Session",
        "description": "One ceremony in progress for one signer over one bundle of document versions.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "description": "created, in_progress, awaiting_verification, ready, completed, expired or cancelled."
          },
          "livemode": {
            "type": "boolean"
          },
          "client_token": {
            "type": "string",
            "description": "esc_ct_... Returned at creation only. The one credential that may reach the browser."
          },
          "expires_at": {
            "type": "string",
            "format": "date-time"
          },
          "profile": {
            "type": "object"
          },
          "assurance_level": {
            "type": "string"
          },
          "signature_method": {
            "type": "string"
          },
          "capture_mode": {
            "type": "string"
          },
          "minimal_capture": {
            "type": "boolean"
          },
          "required_steps": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The authoritative list for this session."
          },
          "completed_steps": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "remaining_steps": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "documents": {
            "type": "array",
            "items": {}
          },
          "applied_jurisdictions": {
            "type": "array",
            "items": {}
          },
          "jurisdiction_mode": {
            "type": "string"
          },
          "rule_set_version": {
            "type": "string"
          },
          "rules_fired": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "required_strings": {
            "type": "array",
            "items": {}
          },
          "retention_floor": {
            "type": "object"
          },
          "guidance_release": {
            "type": "string"
          },
          "advisories": {
            "type": "array",
            "items": {}
          },
          "warnings": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "record_id": {
            "type": "string"
          },
          "api_url": {
            "type": "string"
          }
        },
        "additionalProperties": true
      },
      "Event": {
        "type": "object",
        "title": "Event",
        "description": "One recorded ceremony step.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "tag": {
            "type": "string",
            "description": "observed or asserted."
          },
          "server_time": {
            "type": "string",
            "format": "date-time"
          },
          "sequence": {
            "type": "integer"
          },
          "conformance": {
            "type": "object",
            "description": "{ status, rules_version, findings[] }."
          },
          "remaining_steps": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "session_status": {
            "type": "string"
          }
        },
        "additionalProperties": true
      },
      "AccessSample": {
        "type": "object",
        "title": "AccessSample",
        "description": "The sample document that carries the access code.",
        "properties": {
          "object": {
            "type": "string"
          },
          "session_id": {
            "type": "string"
          },
          "format": {
            "type": "string"
          },
          "instruction": {
            "type": "string"
          },
          "html": {
            "type": "string"
          }
        },
        "additionalProperties": true
      },
      "Verification": {
        "type": "object",
        "title": "Verification",
        "description": "A one-time-code or passkey check inside a session.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "method": {
            "type": "string"
          },
          "destination": {
            "type": "string",
            "description": "Masked destination."
          },
          "status": {
            "type": "string"
          },
          "expires_at": {
            "type": "string",
            "format": "date-time"
          },
          "attempts_remaining": {
            "type": "integer"
          },
          "sends_remaining": {
            "type": "integer"
          },
          "delivered": {
            "type": "boolean"
          },
          "code": {
            "type": "string",
            "description": "Test mode only, when the message was not delivered."
          },
          "phase": {
            "type": "string",
            "description": "Passkey: register or authenticate."
          },
          "options": {
            "type": "object",
            "description": "Passkey: WebAuthn options."
          },
          "remaining_steps": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": true
      },
      "Record": {
        "type": "object",
        "title": "Record",
        "description": "The sealed outcome of a completed session. Each field is observed by Esign Comply or asserted by the customer.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "livemode": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "description": "pending_seal, recorded, timestamped, anchored, disputed or voided."
          },
          "signed_at": {
            "type": "string",
            "format": "date-time",
            "description": "Server receipt time of the final event."
          },
          "signature_level": {
            "type": "string",
            "description": "simple or not_applicable for the base product."
          },
          "assurance_level": {
            "type": "string"
          },
          "capture_mode": {
            "type": "string"
          },
          "signer": {
            "type": "object"
          },
          "documents": {
            "type": "array",
            "items": {}
          },
          "record_hash": {
            "type": "string"
          },
          "receipt": {
            "type": "string",
            "description": "Compact JWS. null while pending_seal."
          },
          "verify_url": {
            "type": "string"
          },
          "seal": {
            "type": "object"
          },
          "organization": {
            "type": "object"
          },
          "domain": {
            "type": "string"
          },
          "profile": {
            "type": "object"
          },
          "jurisdictions": {
            "type": "object"
          },
          "events": {
            "type": "array",
            "items": {}
          },
          "notice": {
            "type": "object"
          },
          "signature": {
            "type": "object"
          },
          "context": {
            "type": "object"
          },
          "metadata": {
            "type": "object"
          },
          "conformance": {
            "type": "object",
            "description": "Advisory. Stored beside the record and outside the sealed hash."
          },
          "advisories": {
            "type": "array",
            "items": {}
          },
          "copy_delivery": {
            "type": "object"
          },
          "annotations": {
            "type": "array",
            "items": {}
          },
          "supplements": {
            "type": "array",
            "items": {}
          },
          "certificates": {
            "type": "array",
            "items": {}
          },
          "guidance_release": {
            "type": "string"
          },
          "api_version": {
            "type": "string"
          },
          "quota_locked": {
            "type": "boolean"
          }
        },
        "additionalProperties": true
      },
      "Receipt": {
        "type": "object",
        "title": "Receipt",
        "description": "The signed receipt of a record.",
        "properties": {
          "object": {
            "type": "string"
          },
          "record_id": {
            "type": "string"
          },
          "receipt": {
            "type": "string",
            "description": "Compact JWS, ES256."
          },
          "kid": {
            "type": "string"
          },
          "payload": {
            "type": "object",
            "description": "{ iss, rid, dom, hash, iat, lvl, asr, seq, prev, live }."
          }
        },
        "additionalProperties": true
      },
      "EvidencePackage": {
        "type": "object",
        "title": "EvidencePackage",
        "description": "A signed download URL for the evidence package.",
        "properties": {
          "object": {
            "type": "string"
          },
          "record_id": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "expires_in": {
            "type": "integer"
          },
          "size": {
            "type": "integer"
          },
          "files": {
            "type": "array",
            "items": {}
          },
          "format": {
            "type": "string"
          }
        },
        "additionalProperties": true
      },
      "Annotation": {
        "type": "object",
        "title": "Annotation",
        "description": "A later fact attached to a record, with its own ledger entry.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "record_id": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "actor": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "data": {
            "type": "object"
          },
          "ledger_seq": {
            "type": "integer"
          }
        },
        "additionalProperties": true
      },
      "SignerStatus": {
        "type": "object",
        "title": "SignerStatus",
        "description": "Per document: the latest version accepted and whether the current version is outstanding.",
        "properties": {
          "object": {
            "type": "string"
          },
          "signer": {
            "type": "object",
            "description": "{ external_id, known, erased }."
          },
          "documents": {
            "type": "array",
            "items": {},
            "description": "One entry per document, with the latest version accepted and whether the current version is outstanding."
          },
          "outstanding": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "IDs of the documents whose current version is outstanding."
          }
        },
        "additionalProperties": true
      },
      "ConsentWithdrawal": {
        "type": "object",
        "title": "ConsentWithdrawal",
        "description": "A recorded withdrawal of consent to electronic records. Prospective only.",
        "properties": {
          "object": {
            "type": "string"
          },
          "signer": {
            "type": "string",
            "description": "The signer's external ID."
          },
          "record_id": {
            "type": "string"
          },
          "annotation_id": {
            "type": "string"
          },
          "recorded_at": {
            "type": "string",
            "format": "date-time"
          }
        },
        "additionalProperties": true
      },
      "ErasureRequest": {
        "type": "object",
        "title": "ErasureRequest",
        "description": "An erasure or restriction request for one signer.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "signer": {
            "type": "string",
            "description": "The signer's external ID."
          },
          "scope": {
            "type": "string"
          },
          "status": {
            "type": "string"
          }
        },
        "additionalProperties": true
      },
      "Certificate": {
        "type": "object",
        "title": "Certificate",
        "description": "An on-request certificate. Printed title: \"Contemporaneous Record Statement\".",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "description": "processing, requested, issued or failed."
          },
          "livemode": {
            "type": "boolean"
          },
          "record_ids": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "record_count": {
            "type": "integer"
          },
          "issued_at": {
            "type": "string",
            "format": "date-time"
          },
          "requested_by": {
            "type": "object"
          },
          "reference": {
            "type": "string"
          },
          "wording": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "capture_mode": {
            "type": "string"
          },
          "chronology": {
            "type": "object"
          },
          "intervals_ms": {
            "type": "object"
          },
          "verification": {
            "type": "object"
          },
          "certificate_hash": {
            "type": "string"
          },
          "seal": {
            "type": "object",
            "description": "{ receipt, ledger, ledger_seq, timestamp_token }. ledger is the certificate's full ledger entry, which the offline verifier recomputes."
          },
          "pdf_url": {
            "type": "string"
          },
          "json_url": {
            "type": "string"
          },
          "share": {
            "type": "object",
            "description": "The active share link { id, expires_at, opens, last_opened_at }, or null. Its url is included only in the response of the request that created the link."
          },
          "share_url": {
            "type": "string",
            "description": "Same value as share.url. Only in the response that created the link."
          },
          "share_expires_at": {
            "type": "string",
            "format": "date-time",
            "description": "Same value as share.expires_at. Only in the response that created the link."
          },
          "billing": {
            "type": "object",
            "description": "{ charge_class, units, unit_amount, amount, currency, allowance, month_to_date, spend_limit, confirmed_by }."
          }
        },
        "additionalProperties": true
      },
      "CertificateQuote": {
        "type": "object",
        "title": "CertificateQuote",
        "description": "The charge a certificate request would incur. Amounts are integers in the smallest currency unit.",
        "properties": {
          "object": {
            "type": "string"
          },
          "units": {
            "type": "integer"
          },
          "unit_amount": {
            "type": "integer"
          },
          "amount": {
            "type": "integer"
          },
          "currency": {
            "type": "string"
          },
          "allowance_remaining": {
            "type": "integer"
          },
          "month_to_date": {
            "type": "integer"
          },
          "spend_limit": {
            "type": "integer"
          },
          "charge_class": {
            "type": "string"
          },
          "units_included": {
            "type": "integer"
          },
          "units_charged": {
            "type": "integer"
          },
          "requires_confirmation": {
            "type": "boolean"
          },
          "record_count": {
            "type": "integer"
          }
        },
        "additionalProperties": true
      },
      "CertificateShare": {
        "type": "object",
        "title": "CertificateShare",
        "description": "A time-limited share link to an issued certificate.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "certificate_id": {
            "type": "string"
          },
          "share_url": {
            "type": "string"
          },
          "share_expires_at": {
            "type": "string",
            "format": "date-time"
          },
          "revoked": {
            "type": "integer"
          }
        },
        "additionalProperties": true
      },
      "Supplement": {
        "type": "object",
        "title": "Supplement",
        "description": "Customer-supplied material. Sealed on receipt, labelled customer-supplied, not verified by Esign Comply.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "livemode": {
            "type": "boolean"
          },
          "subject": {
            "type": "object"
          },
          "type": {
            "type": "string"
          },
          "type_recognized": {
            "type": "boolean"
          },
          "provenance": {
            "type": "string",
            "description": "Always \"customer_supplied\"."
          },
          "occurred_at": {
            "type": "string",
            "format": "date-time",
            "description": "Asserted by the customer."
          },
          "received_at": {
            "type": "string",
            "format": "date-time",
            "description": "Esign Comply server time."
          },
          "content_hash": {
            "type": "string"
          },
          "files": {
            "type": "array",
            "items": {}
          },
          "seal": {
            "type": "object"
          },
          "rule_ids": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "labels": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "supersedes": {
            "type": "string"
          },
          "withdrawn": {
            "type": "boolean"
          },
          "warnings": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": true
      },
      "SupplementContent": {
        "type": "object",
        "title": "SupplementContent",
        "description": "Text, data and file download links as stored.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "provenance": {
            "type": "string"
          },
          "note": {
            "type": "string"
          },
          "content_hash": {
            "type": "string"
          },
          "withdrawn": {
            "type": "boolean"
          },
          "text": {
            "type": "string"
          },
          "data": {},
          "files": {
            "type": "array",
            "items": {},
            "description": "Each with a short-lived download_url."
          }
        },
        "additionalProperties": true
      },
      "SupplementType": {
        "type": "object",
        "title": "SupplementType",
        "description": "A recognised supplement type with suggested data fields.",
        "properties": {
          "object": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "use": {
            "type": "string"
          },
          "suggested_fields": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": true
      },
      "File": {
        "type": "object",
        "title": "File",
        "description": "One uploaded file referenced by a supplement.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "livemode": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "content_type": {
            "type": "string"
          },
          "size": {
            "type": "integer"
          },
          "sha256": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "reject_reason": {
            "type": "string"
          },
          "supplement": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "upload_url": {
            "type": "string"
          },
          "upload_method": {
            "type": "string"
          },
          "upload_expires_in": {
            "type": "integer"
          },
          "resumable_url": {
            "type": "string"
          }
        },
        "additionalProperties": true
      },
      "GuidanceNotice": {
        "type": "object",
        "title": "GuidanceNotice",
        "description": "A dated message about a legal or product change.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "release": {
            "type": "string"
          },
          "published_at": {
            "type": "string",
            "format": "date-time"
          },
          "kind": {
            "type": "string"
          },
          "class": {
            "type": "string"
          },
          "severity": {
            "type": "string"
          },
          "jurisdictions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "topics": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "title": {
            "type": "string"
          },
          "summary": {
            "type": "string"
          },
          "effective_at": {
            "type": "string",
            "format": "date-time"
          },
          "what_changes": {
            "type": "object",
            "description": "{ esign_comply_record, your_obligations, recommendations }: always three parts."
          },
          "affected_rules": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "affected_profiles": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "requires_code_change": {
            "type": "string",
            "description": "no, only_to_follow_the_rule or to_adopt_a_record_condition."
          },
          "update_prompt": {
            "type": "string"
          },
          "review": {
            "type": "object"
          },
          "sources": {
            "type": "array",
            "items": {}
          },
          "supersedes": {
            "type": "string"
          },
          "acknowledgment": {
            "type": "object"
          }
        },
        "additionalProperties": true
      },
      "GuidanceAcknowledgment": {
        "type": "object",
        "title": "GuidanceAcknowledgment",
        "description": "The acknowledgment state of a notice for the domain.",
        "properties": {
          "object": {
            "type": "string"
          },
          "notice_id": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "note": {
            "type": "string"
          }
        },
        "additionalProperties": true
      },
      "GuidanceRelease": {
        "type": "object",
        "title": "GuidanceRelease",
        "description": "One dated publication of packs, obligations, recommendations, strings and notices.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "content_hash": {
            "type": "string"
          },
          "signature": {
            "type": "string"
          },
          "kid": {
            "type": "string"
          },
          "published_at": {
            "type": "string",
            "format": "date-time"
          },
          "changelog": {}
        },
        "additionalProperties": true
      },
      "GuidanceUpdate": {
        "type": "object",
        "title": "GuidanceUpdate",
        "description": "An update prompt: a short reviewed block that describes only the change.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "notice": {
            "type": "string"
          },
          "release": {
            "type": "string"
          },
          "markdown": {
            "type": "string"
          }
        },
        "additionalProperties": true
      },
      "WatchedJurisdictions": {
        "type": "object",
        "title": "WatchedJurisdictions",
        "description": "Jurisdiction codes a domain watches without enabling a pack.",
        "properties": {
          "object": {
            "type": "string"
          },
          "domain_id": {
            "type": "string"
          },
          "jurisdictions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": true
      },
      "VerificationResult": {
        "type": "object",
        "title": "VerificationResult",
        "description": "Whether a record matches its seal. It does not establish who signed or whether any agreement is valid or enforceable.",
        "properties": {
          "object": {
            "type": "string"
          },
          "valid": {
            "type": "boolean"
          },
          "reason": {
            "type": "string",
            "description": "When not valid: receipt_signature_invalid, receipt_not_on_file or not_verifiable."
          },
          "livemode": {
            "type": "boolean"
          },
          "attestation": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "checks": {
            "type": "object",
            "description": "{ receipt_signature, record_hash, ledger_entry, timestamp_token, inclusion_proof, consistency_proof }."
          },
          "checked_at": {
            "type": "string",
            "format": "date-time"
          },
          "note": {
            "type": "string"
          }
        },
        "additionalProperties": true
      },
      "Checkpoint": {
        "type": "object",
        "title": "Checkpoint",
        "description": "A signed Merkle checkpoint. Hashes only: no personal data and no record-level entries.",
        "properties": {
          "object": {
            "type": "string"
          },
          "environment": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "tree_size": {
            "type": "integer"
          },
          "root": {
            "type": "string"
          },
          "prev_root": {
            "type": "string"
          },
          "checkpoint": {
            "type": "string",
            "description": "Compact JWS, typ esc-checkpoint+jwt."
          },
          "kid": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          }
        },
        "additionalProperties": true
      },
      "LogProof": {
        "type": "object",
        "title": "LogProof",
        "description": "An inclusion proof (leaf_index, tree_size, audit_path, root) or a consistency proof (first, second, proof, first_root, second_root).",
        "properties": {
          "object": {
            "type": "string",
            "description": "inclusion_proof or consistency_proof."
          },
          "environment": {
            "type": "string"
          },
          "leaf_index": {
            "type": "integer"
          },
          "tree_size": {
            "type": "integer"
          },
          "audit_path": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "root": {
            "type": "string"
          },
          "first": {
            "type": "integer"
          },
          "second": {
            "type": "integer"
          },
          "proof": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "first_root": {
            "type": "string"
          },
          "second_root": {
            "type": "string"
          }
        },
        "additionalProperties": true
      },
      "Jwks": {
        "type": "object",
        "title": "Jwks",
        "description": "Public sealing keys, current and retired. No key is ever removed.",
        "properties": {
          "keys": {
            "type": "array",
            "items": {}
          }
        },
        "additionalProperties": true
      },
      "Domain": {
        "type": "object",
        "title": "Domain",
        "description": "The registered domain of a subscription.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "domain": {
            "type": "string",
            "description": "The registrable domain. Covers every subdomain."
          },
          "entered_host": {
            "type": "string"
          },
          "region": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "description": "not_started, pending, verified, failed or lapsed."
          },
          "verification": {
            "type": "object",
            "description": "DNS: { method, type, name, host, value }. File: { method, url, content }."
          },
          "registered_at": {
            "type": "string",
            "format": "date-time"
          },
          "verified_at": {
            "type": "string",
            "format": "date-time"
          },
          "last_checked_at": {
            "type": "string",
            "format": "date-time"
          },
          "lapsed_at": {
            "type": "string",
            "format": "date-time"
          },
          "test_origins": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "api_url": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          }
        },
        "additionalProperties": true
      },
      "ApiKey": {
        "type": "object",
        "title": "ApiKey",
        "description": "A secret server credential. The secret is returned once, at creation.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "livemode": {
            "type": "boolean"
          },
          "permission": {
            "type": "string"
          },
          "prefix": {
            "type": "string"
          },
          "api_version": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "last_used_at": {
            "type": "string",
            "format": "date-time"
          },
          "revoked_at": {
            "type": "string",
            "format": "date-time"
          },
          "key": {
            "type": "string",
            "description": "The secret key. Present only in the creation response."
          },
          "revoked": {
            "type": "boolean"
          }
        },
        "additionalProperties": true
      },
      "WebhookEndpoint": {
        "type": "object",
        "title": "WebhookEndpoint",
        "description": "A URL subscribed to events.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "livemode": {
            "type": "boolean"
          },
          "url": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "events": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "status": {
            "type": "string"
          },
          "api_version": {
            "type": "string"
          },
          "failing_since": {
            "type": "string",
            "format": "date-time"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "secret": {
            "type": "string",
            "description": "whsec_... Present only in the creation response."
          },
          "deleted": {
            "type": "boolean"
          }
        },
        "additionalProperties": true
      },
      "WebhookDelivery": {
        "type": "object",
        "title": "WebhookDelivery",
        "description": "One delivery attempt record.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "endpoint_id": {
            "type": "string"
          },
          "webhook_id": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "attempts": {
            "type": "integer"
          },
          "response_status": {
            "type": "integer"
          },
          "response_excerpt": {
            "type": "string"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "delivered_at": {
            "type": "string",
            "format": "date-time"
          },
          "last_attempt_at": {
            "type": "string",
            "format": "date-time"
          },
          "payload": {
            "type": "object"
          }
        },
        "additionalProperties": true
      },
      "WebhookTest": {
        "type": "object",
        "title": "WebhookTest",
        "description": "The result of a test delivery.",
        "properties": {
          "object": {
            "type": "string"
          },
          "endpoint_id": {
            "type": "string"
          },
          "webhook_id": {
            "type": "string"
          },
          "delivered": {
            "type": "boolean"
          },
          "response_status": {
            "type": "integer"
          },
          "response_excerpt": {
            "type": "string"
          }
        },
        "additionalProperties": true
      },
      "WebhookEvent": {
        "type": "object",
        "title": "WebhookEvent",
        "description": "The body of a webhook delivery. Signed with HMAC-SHA256 over id.timestamp.body (Standard Webhooks).",
        "properties": {
          "object": {
            "type": "string",
            "description": "Always \"event\"."
          },
          "id": {
            "type": "string",
            "description": "Also the webhook-id header."
          },
          "type": {
            "type": "string"
          },
          "api_version": {
            "type": "string"
          },
          "livemode": {
            "type": "boolean"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "data": {
            "type": "object"
          }
        },
        "additionalProperties": true
      },
      "Usage": {
        "type": "object",
        "title": "Usage",
        "description": "Usage against the plan: live events in the allowance period (a UTC calendar month on Free, the subscription year on paid plans), test events, certificates, verifications and supplement storage.",
        "properties": {
          "object": {
            "type": "string"
          },
          "plan": {
            "type": "string",
            "description": "sandbox, starter, unlimited or enterprise. sandbox is the id of the Free plan."
          },
          "plan_name": {
            "type": "string",
            "description": "The name a person reads, for example \"Free\"."
          },
          "subscription_status": {
            "type": "string"
          },
          "period": {
            "type": "object",
            "description": "{ start, end } of the subscription period."
          },
          "events": {
            "type": "object",
            "description": "Live signature events: used (a true count, can be higher than allowance), quota, allowance, remaining, period (month or year), period_start, resets_at (null while locked), open_sessions, level (ok, notice_50, notice_80, notice_90, limit_reached), locked (boolean), locked_since (datetime or null), event_packs, event_packs_enabled."
          },
          "test_events": {
            "type": "object",
            "description": "{ used_this_month, quota_per_month }."
          },
          "certificates": {
            "type": "object",
            "description": "{ included, used, remaining, charged_units, resets_at, charged_month_to_date, spend_limit, unit_amount, live_available }."
          },
          "verifications": {
            "type": "object"
          },
          "supplements": {
            "type": "object"
          }
        },
        "additionalProperties": true
      },
      "AgentAccount": {
        "type": "object",
        "title": "AgentAccount",
        "description": "The account as an agent token sees it: where setup stands and the next step.",
        "properties": {
          "object": {
            "type": "string",
            "description": "Always \"agent_account\"."
          },
          "token": {
            "type": "object",
            "description": "{ id, name, expires_at } of the token in use. Never the token itself."
          },
          "acts_as": {
            "type": "object",
            "description": "{ email, role, second_factor_enrolled } of the member the token acts as."
          },
          "organization": {
            "type": "object",
            "description": "{ id, name, legal_name, country, details_complete }."
          },
          "domain": {
            "$ref": "#/components/schemas/Domain"
          },
          "plan": {
            "type": "object",
            "description": "{ id, name, status, live_events, live_events_period, test_events_per_month }."
          },
          "usage": {
            "$ref": "#/components/schemas/Usage"
          },
          "locked": {
            "type": "object",
            "description": "null, or the lock when the plan's limit was reached: { locked, since, plan, plan_name, domain, limit, used, period, upgrade_url, message }. No reset date: a lock does not lift on its own."
          },
          "live": {
            "type": "object",
            "description": "{ ready, live, live_keys, test_keys, agreements_accepted, blockers, allowance, domain_verified, needs_person }."
          },
          "onboarding": {
            "type": "object",
            "description": "{ key_created, first_test_record, domain_verified, live }."
          },
          "next_step": {
            "type": "object",
            "description": "{ id, done, what, api, browser }: the first step that is not done, or the upgrade when the account is locked."
          },
          "steps": {
            "type": "array",
            "items": {},
            "description": "Every step in order, each { id, done, what, api, browser }."
          },
          "human_only": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The steps that stay with the account owner."
          },
          "api_url": {
            "type": "string",
            "description": "The base URL of the API for this domain."
          },
          "dashboard_url": {
            "type": "string"
          },
          "agent_login_url": {
            "type": "string"
          },
          "guide_url": {
            "type": "string"
          }
        },
        "additionalProperties": true
      },
      "GoLive": {
        "type": "object",
        "title": "GoLive",
        "description": "The result of going live on the Free plan.",
        "properties": {
          "object": {
            "type": "string",
            "description": "Always \"go_live\"."
          },
          "live": {
            "type": "boolean"
          },
          "created": {
            "type": "boolean",
            "description": "true when this call created the live key."
          },
          "api_key": {
            "type": "object",
            "description": "The live key, with the secret in `key`, once. null when no key was created."
          },
          "status": {
            "type": "object",
            "description": "{ plan, plan_name, free, domain, organization, agreements, live_keys, ready, live, blockers, next_step, allowance }."
          }
        },
        "additionalProperties": true
      },
      "ConformanceRun": {
        "type": "object",
        "title": "ConformanceRun",
        "description": "A run of the conformance checker. Findings are advisory.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "livemode": {
            "type": "boolean"
          },
          "status": {
            "type": "string"
          },
          "rules_version": {
            "type": "string"
          },
          "summary": {
            "type": "object"
          },
          "findings": {
            "type": "array",
            "items": {}
          },
          "markdown": {
            "type": "string",
            "description": "The failing findings as Markdown, to paste into a coding tool."
          }
        },
        "additionalProperties": true
      },
      "Prompt": {
        "type": "object",
        "title": "Prompt",
        "description": "A generated integration prompt. It never contains a key.",
        "properties": {
          "object": {
            "type": "string"
          },
          "id": {
            "type": "string",
            "description": "esc_prompt_..."
          },
          "content_hash": {
            "type": "string"
          },
          "markdown": {
            "type": "string"
          },
          "profiles": {
            "type": "array",
            "items": {}
          },
          "guidance_release": {
            "type": "string"
          }
        },
        "additionalProperties": true
      }
    }
  },
  "x-error-codes": {
    "invalid_request": {
      "status": 400,
      "type": "invalid_request_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#invalid_request"
    },
    "jurisdiction_unknown": {
      "status": 400,
      "type": "invalid_request_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#jurisdiction_unknown"
    },
    "missing_api_key": {
      "status": 401,
      "type": "authentication_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#missing_api_key"
    },
    "invalid_api_key": {
      "status": 401,
      "type": "authentication_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#invalid_api_key"
    },
    "client_token_expired": {
      "status": 401,
      "type": "authentication_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#client_token_expired"
    },
    "domain_not_verified": {
      "status": 403,
      "type": "permission_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#domain_not_verified"
    },
    "domain_mismatch": {
      "status": 403,
      "type": "permission_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#domain_mismatch"
    },
    "insufficient_permission": {
      "status": 403,
      "type": "permission_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#insufficient_permission"
    },
    "plan_feature_unavailable": {
      "status": 403,
      "type": "permission_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#plan_feature_unavailable"
    },
    "signer_certificates_disabled": {
      "status": 403,
      "type": "permission_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#signer_certificates_disabled"
    },
    "not_found": {
      "status": 404,
      "type": "invalid_request_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#not_found"
    },
    "subject_not_found": {
      "status": 404,
      "type": "invalid_request_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#subject_not_found"
    },
    "idempotency_conflict": {
      "status": 409,
      "type": "conflict_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#idempotency_conflict"
    },
    "step_out_of_order": {
      "status": 409,
      "type": "conflict_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#step_out_of_order"
    },
    "session_not_active": {
      "status": 409,
      "type": "conflict_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#session_not_active"
    },
    "domain_already_registered": {
      "status": 409,
      "type": "conflict_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#domain_already_registered"
    },
    "record_not_timestamped": {
      "status": 409,
      "type": "conflict_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#record_not_timestamped"
    },
    "baseline_unchanged": {
      "status": 409,
      "type": "conflict_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#baseline_unchanged"
    },
    "rollback_unavailable": {
      "status": 409,
      "type": "conflict_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#rollback_unavailable"
    },
    "region_mismatch": {
      "status": 421,
      "type": "invalid_request_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#region_mismatch"
    },
    "steps_incomplete": {
      "status": 422,
      "type": "ceremony_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#steps_incomplete"
    },
    "conformance_failed": {
      "status": 422,
      "type": "conformance_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#conformance_failed"
    },
    "render_mismatch": {
      "status": 422,
      "type": "ceremony_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#render_mismatch"
    },
    "document_type_excluded": {
      "status": 422,
      "type": "ceremony_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#document_type_excluded"
    },
    "verification_failed": {
      "status": 422,
      "type": "ceremony_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#verification_failed"
    },
    "version_not_published": {
      "status": 422,
      "type": "ceremony_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#version_not_published"
    },
    "jurisdiction_not_enabled": {
      "status": 422,
      "type": "ceremony_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#jurisdiction_not_enabled"
    },
    "signer_region_required": {
      "status": 422,
      "type": "ceremony_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#signer_region_required"
    },
    "jurisdiction_fact_required": {
      "status": 422,
      "type": "ceremony_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#jurisdiction_fact_required"
    },
    "certificate_set_too_large": {
      "status": 422,
      "type": "invalid_request_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#certificate_set_too_large"
    },
    "certificate_field_unavailable": {
      "status": 422,
      "type": "invalid_request_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#certificate_field_unavailable"
    },
    "file_type_refused": {
      "status": 422,
      "type": "invalid_request_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#file_type_refused"
    },
    "file_hash_mismatch": {
      "status": 422,
      "type": "invalid_request_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#file_hash_mismatch"
    },
    "file_too_large": {
      "status": 422,
      "type": "invalid_request_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#file_too_large"
    },
    "quota_exhausted": {
      "status": 402,
      "type": "quota_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#quota_exhausted"
    },
    "quota_exceeded": {
      "status": 402,
      "type": "quota_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#quota_exceeded"
    },
    "certificate_charge_unconfirmed": {
      "status": 402,
      "type": "billing_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#certificate_charge_unconfirmed"
    },
    "certificate_spend_limit_reached": {
      "status": 402,
      "type": "billing_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#certificate_spend_limit_reached"
    },
    "payment_method_required": {
      "status": 402,
      "type": "billing_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#payment_method_required"
    },
    "storage_limit_reached": {
      "status": 402,
      "type": "quota_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#storage_limit_reached"
    },
    "rate_limit_exceeded": {
      "status": 429,
      "type": "rate_limit_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#rate_limit_exceeded"
    },
    "test_quota_exceeded": {
      "status": 429,
      "type": "rate_limit_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#test_quota_exceeded"
    },
    "internal_error": {
      "status": 500,
      "type": "api_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#internal_error"
    },
    "service_unavailable": {
      "status": 503,
      "type": "api_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#service_unavailable"
    },
    "certificate_verification_failed": {
      "status": 503,
      "type": "api_error",
      "doc_url": "https://esigncomply.com/docs/api/errors#certificate_verification_failed"
    }
  }
}