{
  "name": "Template Name",
  "description": "What this document is",
  "locks": [
    {
      "name": "field_name",
      "data_type": "string|number|date|boolean",
      "description": "What this field represents",
      "validation": { ... },
      "weight": 20,
      "required": true
    }
  ]
}

curl -X POST https://api.docyard.io/v1/templates \
  -H "X-API-Key: dk_live_dist_aaaaaaaa" \
  -H "X-API-Secret: dk_secret_dist_bbbbbbbb" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Insurance Declaration Page",
    "description": "Standard insurance policy declaration document containing coverage details",
    "locks": [
      {
        "name": "policy_number",
        "data_type": "string",
        "description": "Unique insurance policy identifier",
        "validation": {
          "pattern": "^POL-[0-9]{8}$",
          "min_length": 12,
          "max_length": 12
        },
        "weight": 20,
        "required": true
      },
      {
        "name": "effective_date",
        "data_type": "date",
        "description": "Date the policy coverage begins",
        "weight": 10,
        "required": true
      },
      {
        "name": "expiration_date",
        "data_type": "date",
        "description": "Date the policy coverage ends",
        "weight": 5,
        "required": true
      },
      {
        "name": "mortgagee_name",
        "data_type": "string",
        "description": "Name of the lender/mortgagee",
        "validation": {
          "min_length": 2,
          "max_length": 100
        },
        "weight": 5,
        "required": false
      },
      {
        "name": "property_address",
        "data_type": "string",
        "description": "Insured property address",
        "weight": 5,
        "required": false
      },
      {
        "name": "coverage_amount",
        "data_type": "number",
        "description": "Policy coverage amount in dollars",
        "weight": 3,
        "required": false
      }
    ]
  }'

curl -X GET https://api.docyard.io/v1/templates \
  -H "X-API-Key: dk_live_dist_aaaaaaaa"

{
  "templates": [
    {
      "template_id": "tmpl-ins-dec-001",
      "name": "Insurance Declaration Page",
      "status": "pending_approval",
      "locks_count": 6,
      "required_locks_count": 3
    }
  ]
}

{ "name": "policy_number" }
{ "name": "mortgagee_name" }

{ "name": "pn" }
{ "name": "mname" }

{
  "name": "policy_number",
  "required": true,
  "weight": 20
}

{
  "locks": {
    "policy_number": { "weight": 20 },
    "effective_date": { "weight": 10 },
    "mortgagee_name": { "weight": 5 }
  },
  "threshold": 35
}

{
  "locks": {
    "policy_number": { "weight": 20 },
    "effective_date": { "weight": 10 },
    "mortgagee_name": { "weight": 5 }
  },
  "threshold": 20
}

{
  "locks": {
    "policy_number": { "weight": 20 },
    "effective_date": { "weight": 10 }
  },
  "threshold": 10
}

{
  "pattern": "^POL-[0-9]{8}$"
}

{
  "data_type": "date"
}

{
  "min": 0,
  "max": 10000000
}

draft ──► pending_approval ──► published ──► deprecated
  │              │                   │            │
  │              │                   │            │
  ▼              ▼                   ▼            ▼
Create      Awaiting            Live &        No new
template    review              usable        uploads

curl -X PUT https://api.docyard.io/v1/templates/tmpl-ins-dec-001 \
  -H "X-API-Key: dk_live_dist_aaaaaaaa" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Insurance Declaration Page v2",
    "description": "Updated with additional fields"
  }'

{
  "error": "template_locked",
  "message": "Cannot update published template. Create a new version."
}

{
  "name": "Insurance Declaration Page",
  "locks": ["policy_number", "effective_date", "mortgagee_name", "property_address"]
}

{
  "name": "Insurance Endorsement",
  "locks": ["policy_number", "effective_date", "endorsement_type", "change_description"]
}

{
  "name": "Insurance Renewal Notice",
  "locks": ["policy_number", "renewal_date", "premium_amount", "expiration_date"]
}

{
  "status": "rejected",
  "feedback": "The validation pattern for policy_number is too restrictive. Consider using min_length instead."
}

[email protected]