Skip to content
HALOWERK

Formatwerk

obligation register

Every sentence is scanned with disclosed German and English modal patterns: obligations (verpflichtet sich, ist verpflichtet, hat zu, muss, obliegt, schuldet, stellt sicher, gewährleistet; shall, must, agrees to, undertakes to), prohibitions (darf nicht, ist untersagt, hat zu unterlassen; shall not, must not, may not), restrictions (darf nur; may only) and permissions/rights (ist berechtigt, hat das Recht, darf, kann; may, is entitled to). Weak signals (soll, will) and present-tense.

POST https://format.halowerk.com/v1/obligation-register

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
textstringNoDocument as plain text (blank lines or line ends after full stops separate paragraphs; form feed separates pages).
content_base64stringNoPDF, DOCX or text file as base64 (a data: prefix is tolerated); at most 10 MB decoded.
formatstringNoFormat of content_base64; auto detects PDF and DOCX by their signature.
partiesarrayNoOptional party names or roles to match (in addition to defined terms and common roles).
include_weakbooleanNoInclude weak signals (soll, will, can, performance verbs).
max_itemsintegerNo
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [],
  "properties": {
    "text": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000000,
      "description": "Document as plain text (blank lines or line ends after full stops separate paragraphs; form feed separates pages)."
    },
    "content_base64": {
      "type": "string",
      "minLength": 8,
      "maxLength": 13981016,
      "description": "PDF, DOCX or text file as base64 (a data: prefix is tolerated); at most 10 MB decoded."
    },
    "format": {
      "type": "string",
      "enum": [
        "auto",
        "pdf",
        "docx",
        "text"
      ],
      "default": "auto",
      "description": "Format of content_base64; auto detects PDF and DOCX by their signature."
    },
    "parties": {
      "type": "array",
      "maxItems": 20,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "minLength": 2,
            "maxLength": 120
          },
          "aliases": {
            "type": "array",
            "maxItems": 10,
            "items": {
              "type": "string",
              "minLength": 2,
              "maxLength": 120
            }
          }
        }
      },
      "description": "Optional party names or roles to match (in addition to defined terms and common roles)."
    },
    "include_weak": {
      "type": "boolean",
      "default": true,
      "description": "Include weak signals (soll, will, can, performance verbs)."
    },
    "max_items": {
      "type": "integer",
      "minimum": 1,
      "maximum": 2000,
      "default": 500
    }
  }
}

Open original schema

Published input example

{
  "text": "§ 1 Pflichten\n(1) Der Auftragnehmer verpflichtet sich, die Software bis zum 31.03.2027 zu liefern.\n(2) Der Auftraggeber ist berechtigt, die Leistungen zu prüfen."
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub →