Document

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/signicat/main/json-schema/signicat-document-schema.json",
  "title": "Document",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/signicat-sign-openapi.yml#/components/schemas/Document",
  "type": "object",
  "properties": {
    "mimeType": {
      "type": "string",
      "readOnly": true
    },
    "documentId": {
      "type": "string",
      "readOnly": true
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "documentHash": {
      "readOnly": true,
      "$ref": "#/$defs/DocumentHash"
    },
    "filename": {
      "type": "string",
      "maxLength": 255,
      "description": "A name to use if the document is to be stored as a file. Optional metadata about the stored document which the customer can supply."
    },
    "description": {
      "type": "string",
      "maxLength": 1000,
      "description": "A description of the document for display purposes. Optional metadata about the stored document which the customer can supply."
    },
    "title": {
      "type": "string",
      "maxLength": 255,
      "description": "A title of the document for display purposes. Optional metadata about the stored document which the customer can supply."
    }
  },
  "$defs": {
    "DocumentHash": {
      "type": "object",
      "readOnly": true,
      "properties": {
        "hash": {
          "type": "string"
        },
        "hashAlgorithm": {
          "$ref": "#/$defs/HashAlgorithmEnum"
        }
      }
    },
    "HashAlgorithmEnum": {
      "type": "string",
      "readOnly": true,
      "enum": [
        "SHA256"
      ]
    }
  }
}