Inkit · Schema

Inkit Document

A stored document in the Inkit Secure Document Generation platform

Document GenerationPDFTemplatesDigital SignaturesWorkflowsDocument-ManagementSecure DocumentsComplianceHIPAAEnterprise

Properties

Name	Type	Description
id	string	Unique document identifier
name	string	Document display name
render_id	string	ID of the render that generated this document
template_id	string	ID of the source template
status	string	Document status
created_at	string	Document creation timestamp
updated_at	string	Document last update timestamp

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api-evangelist.github.io/inkit/json-schema/inkit-document.json",
  "title": "Inkit Document",
  "description": "A stored document in the Inkit Secure Document Generation platform",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique document identifier"
    },
    "name": {
      "type": "string",
      "description": "Document display name"
    },
    "render_id": {
      "type": "string",
      "description": "ID of the render that generated this document"
    },
    "template_id": {
      "type": "string",
      "description": "ID of the source template"
    },
    "status": {
      "type": "string",
      "description": "Document status",
      "enum": ["pending", "processing", "completed", "failed", "deleted"]
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Document creation timestamp"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Document last update timestamp"
    }
  },
  "required": ["id"]
}