{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/namirial/json-schema/namirial-file-prepare-response-schema.json",
  "title": "FilePrepareResponse",
  "description": "The response model after parsing the pdf file.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/namirial-file-api-openapi.yml#/components/schemas/FilePrepareResponse",
  "type": "object",
  "properties": {
    "UnassignedElements": {
      "$ref": "#/$defs/FilePrepareElements",
      "description": "The elements which are not assigned to any action."
    },
    "Activities": {
      "description": "The steps for the envelope.\nOne activity may contain elements from multiple documents assigned to the same recipient.\nThe activities will only be generated for advanced document tags.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/FilePrepareActivity"
      }
    }
  },
  "$defs": {
    "FilePrepareATrustCertificateSignatureType": {
      "description": "The configuration of the A-Trust certificate signature.",
      "type": "object",
      "properties": {
        "TemplateId": {
          "description": "The identifier of the A-Trust template.",
          "type": "string"
        },
        "Preferred": {
          "description": "If true, the signature type is set as preferred.",
          "type": "boolean"
        }
      }
    },
    "FilePrepareAction": {
      "description": "The action of the activity.",
      "type": "object",
      "properties": {
        "SignAutomatic": {
          "$ref": "#/$defs/FilePrepareSignAutomatic",
          "description": "The definition of the automatic sign action."
        },
        "Sign": {
          "$ref": "#/$defs/FilePrepareSign",
          "description": "The definition of the sign action."
        }
      }
    },
    "FilePrepareActivity": {
      "description": "Defines an activity in the process.",
      "type": "object",
      "properties": {
        "Action": {
          "$ref": "#/$defs/FilePrepareAction",
          "description": "The action assigned to the activity."
        }
      }
    },
    "FilePrepareAllowedSignatureTypes": {
      "description": "The definition of the allowed signature types for the signature.",
      "type": "object",
      "properties": {
        "ClickToSign": {
          "$ref": "#/$defs/FilePrepareClickToSignSignatureType",
          "description": "Allow signing with \"click to sign\"."
        },
        "DrawToSign": {
          "$ref": "#/$defs/FilePrepareDrawToSignSignatureType",
          "description": "Allow signing with \"draw to sign\"."
        },
        "TypeToSign": {
          "$ref": "#/$defs/FilePrepareTypeToSignSignatureType",
          "description": "Allow signing with \"type to sign\"."
        },
        "LocalCertificate": {
          "$ref": "#/$defs/FilePrepareLocalCertificateSignatureType",
          "description": "Allow signing with a local certificate."
        },
        "DisposableCertificate": {
          "$ref": "#/$defs/FilePrepareDisposableCertificateSignatureType",
          "description": "Allow signing with a disposable certificate."
        },
        "SwissComOnDemand": {
          "$ref": "#/$defs/FilePrepareSwissComOnDemandSignatureType",
          "description": "Allow signing with a Swisscom On-Demand certificate."
        },
        "ATrustCertificate": {
          "$ref": "#/$defs/FilePrepareATrustCertificateSignatureType",
          "description": "Allow signing with an A-Trust certificate."
        },
        "Biometric": {
          "$ref": "#/$defs/FilePrepareBiometricSignatureType",
          "description": "Allow signing with a biometric signature."
        },
        "RemoteCertificate": {
          "$ref": "#/$defs/FilePrepareRemoteCertificateSignatureType",
          "description": "Allow signing with a remote certificate."
        },
        "OneTimePassword": {
          "$ref": "#/$defs/FilePrepareOneTimePasswordSignatureType",
          "description": "Allow signing with a one time password (SMS-OTP)."
        },
        "SwedishBankId": {
          "$ref": "#/$defs/FilePrepareSwedishBankIdSignatureType",
          "description": "Allow signing with Swedish BankID."
        },
        "SignaturePlugins": {
          "description": "Allow signing with signature plugins.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/FilePrepareSignaturePluginSignatureType"
          }
        }
      }
    },
    "FilePrepareAttachment": {
      "description": "The configuration of the attachment element.",
      "type": "object",
      "properties": {
        "ElementId": {
          "description": "The identifier of the element.",
          "type": "string"
        },
        "DocumentNumber": {
          "format": "int32",
          "description": "The reference number of the containing document. It starts with 1.",
          "type": "integer"
        },
        "Required": {
          "description": "If true, the element is required.",
          "type": "boolean"
        },
        "DisplayName": {
          "description": "The displayed name.",
          "type": "string"
        },
        "DisplayIconType": {
          "description": "The type of the displayed icon.",
          "enum": [
            "Paperclip",
            "Graph",
            "PushPin",
            "Tag"
          ],
          "type": "string"
        },
        "GuidingOrder": {
          "format": "int32",
          "description": "The order of the element.",
          "type": "integer"
        },
        "Source": {
          "description": "The element source from where a field originates.",
          "enum": [
            "Document",
            "AdvancedDocumentTag",
            "UserDefined"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "FormFieldSource",
            "modelAsString": false
          }
        },
        "FieldDefinition": {
          "$ref": "#/$defs/FilePrepareAttachmentDefinition",
          "description": "The definition of the attachment element."
        }
      }
    },
    "FilePrepareAttachmentDefinition": {
      "description": "The settings of a positionable element.",
      "type": "object",
      "properties": {
        "Position": {
          "$ref": "#/$defs/FilePreparePosition",
          "description": "The position of the  within the document."
        },
        "Size": {
          "$ref": "#/$defs/FilePrepareSize",
          "description": "The size of the form field."
        }
      }
    },
    "FilePrepareBiometricSignatureType": {
      "description": "The configuration of the Biometric signature.",
      "type": "object",
      "properties": {
        "BiometricVerification": {
          "description": "If true, a biometric verification is performed.",
          "type": "boolean"
        },
        "AllowBiometricStoringOnly": {
          "description": "If true, the biometric signature might be stored without verification.",
          "type": "boolean"
        },
        "StoreSignedResponseWithoutBioData": {
          "description": "If true, the signed response is stored without biometric data.",
          "type": "boolean"
        },
        "BiometricServerUserId": {
          "description": "The identifier of the user on the biometric server.",
          "type": "string"
        },
        "SignaturePositioning": {
          "description": "The allowed positioning of the biometric signature.",
          "enum": [
            "WithinField",
            "OnPage",
            "IntersectsWithField"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "BiometricSignaturePositioning",
            "modelAsString": false
          }
        },
        "Preferred": {
          "description": "If true, the signature type is set as preferred.",
          "type": "boolean"
        }
      }
    },
    "FilePrepareCheckBox": {
      "description": "The configuration of the check box.",
      "type": "object",
      "properties": {
        "ElementId": {
          "description": "The identifier of the element.",
          "type": "string"
        },
        "DocumentNumber": {
          "format": "int32",
          "description": "The reference number of the containing document. It starts with 1.",
          "type": "integer"
        },
        "Required": {
          "description": "If true, the element is required.",
          "type": "boolean"
        },
        "IsChecked": {
          "description": "If true, the check box is checked.",
          "type": "boolean"
        },
        "GuidingOrder": {
          "format": "int32",
          "description": "The order of the element.",
          "type": "integer"
        },
        "Source": {
          "description": "The element source from where a field originates.",
          "enum": [
            "Document",
            "AdvancedDocumentTag",
            "UserDefined"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "FormFieldSource",
            "modelAsString": false
          }
        },
        "FieldDefinition": {
          "$ref": "#/$defs/FilePrepareCheckBoxDefinition",
          "description": "The definition of the check box."
        }
      }
    },
    "FilePrepareCheckBoxDefinition": {
      "description": "The configuration of a check box.",
      "type": "object",
      "properties": {
        "ExportValue": {
          "description": "The value of the check box when it is checked.",
          "type": "string"
        },
        "Position": {
          "$ref": "#/$defs/FilePreparePosition",
          "description": "The position of the  within the document."
        },
        "Size": {
          "$ref": "#/$defs/FilePrepareSize",
          "description": "The size of the form field."
        },
        "ReadOnly": {
          "description": "If true, the element is readonly.",
          "type": "boolean"
        }
      }
    },
    "FilePrepareChoiceItem": {
      "description": "The configuration of the choice item.",
      "type": "object",
      "properties": {
        "ExportValue": {
          "description": "The value of the element when the choice item is selected.",
          "type": "string"
        },
        "DisplayValue": {
          "description": "The displayed value of the choice item.",
          "type": "string"
        }
      }
    },
    "FilePrepareClickToSignSignatureType": {
      "description": "The configuration of the signature image.",
      "type": "object",
      "properties": {
        "UseExternalSignatureImage": {
          "description": "The external signature image mode.",
          "enum": [
            "Optional",
            "Required",
            "Disabled"
          ],
          "type": "string"
        },
        "Preferred": {
          "description": "If true, the signature type is set as preferred.",
          "type": "boolean"
        },
        "StampImprintConfiguration": {
          "$ref": "#/$defs/FilePrepareClickToSignStampImprint",
          "description": "The configuration of the stamp imprint of the signature."
        }
      }
    },
    "FilePrepareClickToSignStampImprint": {
      "description": "The configuration of the stamp imprint used by multiple signature types.",
      "type": "object",
      "properties": {
        "DisplayExtraInformation": {
          "description": "If true, the extra information is displayed.",
          "type": "boolean"
        },
        "FontName": {
          "description": "The name of the font. The font needs to be installed on the server. \nIf it is not available on the server, a fallback font is used.",
          "type": "string"
        },
        "FontSizeInPt": {
          "format": "int32",
          "description": "The size of the font in points.",
          "type": "integer"
        },
        "DisplayEmail": {
          "description": "If true, the email address of the signer is displayed.",
          "type": "boolean"
        },
        "DisplayIp": {
          "description": "If true, the IP address of the signer is displayed.",
          "type": "boolean"
        },
        "DisplayName": {
          "description": "If true, the name of the signer is displayed.",
          "type": "boolean"
        },
        "DisplaySignatureDate": {
          "description": "If true, the timestamp of signing is displayed.",
          "type": "boolean"
        }
      }
    },
    "FilePrepareComboBox": {
      "description": "The configuration of the combo box.",
      "type": "object",
      "properties": {
        "ElementId": {
          "description": "The identifier of the element.",
          "type": "string"
        },
        "DocumentNumber": {
          "format": "int32",
          "description": "The reference number of the containing document. It starts with 1.",
          "type": "integer"
        },
        "Required": {
          "description": "If true, the element is required.",
          "type": "boolean"
        },
        "Value": {
          "description": "The selected value of the combo box.",
          "type": "string"
        },
        "GuidingOrder": {
          "format": "int32",
          "description": "The order of the element.",
          "type": "integer"
        },
        "Source": {
          "description": "The element source from where a field originates.",
          "enum": [
            "Document",
            "AdvancedDocumentTag",
            "UserDefined"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "FormFieldSource",
            "modelAsString": false
          }
        },
        "FieldDefinition": {
          "$ref": "#/$defs/FilePrepareComboBoxDefinition",
          "description": "The definition of the combo box."
        }
      }
    },
    "FilePrepareComboBoxDefinition": {
      "description": "The configuration of the combo box.",
      "type": "object",
      "properties": {
        "TextFormat": {
          "$ref": "#/$defs/FilePrepareTextFormat",
          "description": "The configuration of the text format."
        },
        "Items": {
          "description": "A list of items that can be selected for the element.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/FilePrepareChoiceItem"
          }
        },
        "IsEditable": {
          "description": "If true, the combo box is editable.",
          "type": "boolean"
        },
        "ReadOnly": {
          "description": "If true, the element is readonly.",
          "type": "boolean"
        },
        "Position": {
          "$ref": "#/$defs/FilePreparePosition",
          "description": "The position of the  within the document."
        },
        "Size": {
          "$ref": "#/$defs/FilePrepareSize",
          "description": "The size of the form field."
        }
      }
    },
    "FilePrepareDateValidationConfiguration": {
      "description": "The validation rules for dates.",
      "type": "object",
      "properties": {
        "DateFormat": {
          "description": "The format of the dates.",
          "type": "string"
        },
        "Range": {
          "$ref": "#/$defs/FilePrepareFieldValidationRange",
          "description": "The range of the values."
        }
      }
    },
    "FilePrepareDisposableCertificateSignatureType": {
      "description": "The configuration of the DisposableCertificate signature.",
      "type": "object",
      "properties": {
        "IsLongLived": {
          "description": "If true, the disposable certificate is long lived.",
          "type": "boolean"
        },
        "ValidityInSeconds": {
          "format": "int32",
          "description": "The validity of the certificate in seconds.",
          "type": "integer"
        },
        "UseExternalSignatureImage": {
          "description": "The external signature image mode.",
          "enum": [
            "Optional",
            "Required",
            "Disabled"
          ],
          "type": "string"
        },
        "Preferred": {
          "description": "If true, the signature type is set as preferred.",
          "type": "boolean"
        },
        "StampImprintConfiguration": {
          "$ref": "#/$defs/FilePrepareDisposableCertificateStampImprint",
          "description": "The configuration of the stamp imprint of the signature."
        }
      }
    },
    "FilePrepareDisposableCertificateStampImprint": {
      "description": "The configuration of the stamp imprint used by multiple signature types.",
      "type": "object",
      "properties": {
        "DisplayExtraInformation": {
          "description": "If true, the extra information is displayed.",
          "type": "boolean"
        },
        "FontName": {
          "description": "The name of the font. The font needs to be installed on the server. \nIf it is not available on the server, a fallback font is used.",
          "type": "string"
        },
        "FontSizeInPt": {
          "format": "int32",
          "description": "The size of the font in points.",
          "type": "integer"
        },
        "DisplayIp": {
          "description": "If true, the IP address of the signer is displayed.",
          "type": "boolean"
        },
        "DisplayName": {
          "description": "If true, the name of the signer is displayed.",
          "type": "boolean"
        },
        "DisplaySignatureDate": {
          "description": "If true, the timestamp of signing is displayed.",
          "type": "boolean"
        }
      }
    },
    "FilePrepareDrawToSignSignatureType": {
      "description": "The configuration of the signature image.",
      "type": "object",
      "properties": {
        "UseExternalSignatureImage": {
          "description": "The external signature image mode.",
          "enum": [
            "Optional",
            "Required",
            "Disabled"
          ],
          "type": "string"
        },
        "Preferred": {
          "description": "If true, the signature type is set as preferred.",
          "type": "boolean"
        },
        "StampImprintConfiguration": {
          "$ref": "#/$defs/FilePrepareDrawToSignStampImprint",
          "description": "The configuration of the stamp imprint of the signature."
        }
      }
    },
    "FilePrepareDrawToSignStampImprint": {
      "description": "The configuration of the stamp imprint used by multiple signature types.",
      "type": "object",
      "properties": {
        "DisplayExtraInformation": {
          "description": "If true, the extra information is displayed.",
          "type": "boolean"
        },
        "FontName": {
          "description": "The name of the font. The font needs to be installed on the server. \nIf it is not available on the server, a fallback font is used.",
          "type": "string"
        },
        "FontSizeInPt": {
          "format": "int32",
          "description": "The size of the font in points.",
          "type": "integer"
        },
        "DisplayEmail": {
          "description": "If true, the email address of the signer is displayed.",
          "type": "boolean"
        },
        "DisplayIp": {
          "description": "If true, the IP address of the signer is displayed.",
          "type": "boolean"
        },
        "DisplayName": {
          "description": "If true, the name of the signer is displayed.",
          "type": "boolean"
        },
        "DisplaySignatureDate": {
          "description": "If true, the timestamp of signing is displayed.",
          "type": "boolean"
        }
      }
    },
    "FilePrepareElements": {
      "description": "The configurable elements of the documents.",
      "type": "object",
      "properties": {
        "TextBoxes": {
          "description": "The text boxes.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/FilePrepareTextBox"
          }
        },
        "CheckBoxes": {
          "description": "The check boxes.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/FilePrepareCheckBox"
          }
        },
        "ComboBoxes": {
          "description": "The combo boxes.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/FilePrepareComboBox"
          }
        },
        "RadioButtons": {
          "description": "The radio buttons.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/FilePrepareRadioButtonGroup"
          }
        },
        "ListBoxes": {
          "description": "The list boxes.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/FilePrepareListBox"
          }
        },
        "Signatures": {
          "description": "The signatures.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/FilePrepareSignatureField"
          }
        },
        "Attachments": {
          "description": "The attachments.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/FilePrepareAttachment"
          }
        },
        "LinkConfiguration": {
          "$ref": "#/$defs/FilePrepareLinkConfiguration",
          "description": "The links in the documents."
        }
      }
    },
    "FilePrepareFieldValidation": {
      "description": "The configuration of the field validation rules.",
      "type": "object",
      "properties": {
        "Type": {
          "description": "The type of the value.",
          "enum": [
            "None",
            "Date",
            "Email",
            "Number",
            "Phone",
            "Time"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "FieldValidationType",
            "modelAsString": false
          }
        },
        "DateValidationConfiguration": {
          "$ref": "#/$defs/FilePrepareDateValidationConfiguration",
          "description": "The validation rules for dates."
        },
        "NumberValidationConfiguration": {
          "$ref": "#/$defs/FilePrepareNumberValidationConfiguration",
          "description": "The validation rules for numbers."
        },
        "PhoneValidationConfiguration": {
          "$ref": "#/$defs/FilePreparePhoneValidationConfiguration",
          "description": "The validation rules for phone numbers."
        },
        "TimeValidationConfiguration": {
          "$ref": "#/$defs/FilePrepareTimeValidationConfiguration",
          "description": "The validation rules for time values."
        }
      }
    },
    "FilePrepareFieldValidationRange": {
      "description": "The validation rules for a value range.",
      "type": "object",
      "properties": {
        "From": {
          "description": "The lower boundary of the range.",
          "type": "string"
        },
        "To": {
          "description": "The upper boundary of the range.",
          "type": "string"
        }
      }
    },
    "FilePrepareHyperLink": {
      "description": "The definition of the hyperlink element.",
      "type": "object",
      "properties": {
        "Id": {
          "description": "The identifier of the hyperlink.",
          "type": "string"
        },
        "Uri": {
          "description": "The URI of the hyperlink.",
          "type": "string"
        },
        "DocumentNumber": {
          "format": "int32",
          "description": "The reference number of the containing document. It starts with 1.",
          "type": "integer"
        },
        "Source": {
          "description": "The element source from where a field originates.",
          "enum": [
            "Document",
            "AdvancedDocumentTag",
            "UserDefined"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "FormFieldSource",
            "modelAsString": false
          }
        },
        "FieldDefinition": {
          "$ref": "#/$defs/FilePrepareLinkDefinition",
          "description": "The definition of the hyperlink element."
        }
      }
    },
    "FilePrepareLinkConfiguration": {
      "description": "The configuration of the link elements.",
      "type": "object",
      "properties": {
        "HyperLinks": {
          "description": "The list of hyperlink elements.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/FilePrepareHyperLink"
          }
        }
      }
    },
    "FilePrepareLinkDefinition": {
      "description": "The settings of a positionable element.",
      "type": "object",
      "properties": {
        "Position": {
          "$ref": "#/$defs/FilePreparePosition",
          "description": "The position of the  within the document."
        },
        "Size": {
          "$ref": "#/$defs/FilePrepareSize",
          "description": "The size of the form field."
        }
      }
    },
    "FilePrepareListBox": {
      "description": "The configuration of the list box.",
      "type": "object",
      "properties": {
        "ElementId": {
          "description": "The identifier of the element.",
          "type": "string"
        },
        "DocumentNumber": {
          "format": "int32",
          "description": "The reference number of the containing document. It starts with 1.",
          "type": "integer"
        },
        "Required": {
          "description": "If true, the element is required.",
          "type": "boolean"
        },
        "PreSelectedItems": {
          "description": "The export values of the items which should be initially selected.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "GuidingOrder": {
          "format": "int32",
          "description": "The order of the element.",
          "type": "integer"
        },
        "Source": {
          "description": "The element source from where a field originates.",
          "enum": [
            "Document",
            "AdvancedDocumentTag",
            "UserDefined"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "FormFieldSource",
            "modelAsString": false
          }
        },
        "FieldDefinition": {
          "$ref": "#/$defs/FilePrepareListBoxDefinition",
          "description": "The definition of the list box field."
        }
      }
    },
    "FilePrepareListBoxDefinition": {
      "description": "The configuration of the combo box.",
      "type": "object",
      "properties": {
        "TextFormat": {
          "$ref": "#/$defs/FilePrepareTextFormat",
          "description": "The configuration of the text format."
        },
        "Items": {
          "description": "A list of items that can be selected for the element.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/FilePrepareChoiceItem"
          }
        },
        "IsMultiSelect": {
          "description": "If true, multiple values of the list box can be selected.",
          "type": "boolean"
        },
        "ReadOnly": {
          "description": "If true, the element is readonly.",
          "type": "boolean"
        },
        "Position": {
          "$ref": "#/$defs/FilePreparePosition",
          "description": "The position of the  within the document."
        },
        "Size": {
          "$ref": "#/$defs/FilePrepareSize",
          "description": "The size of the form field."
        }
      }
    },
    "FilePrepareLocalCertificateSignatureType": {
      "description": "The configuration of the LocalCertificate signature.",
      "type": "object",
      "properties": {
        "EnforcePreferredHashAlgorithm": {
          "description": "If true, the usage of the preferred hash algorithm is enforced.",
          "type": "boolean"
        },
        "PreferredHashAlgorithm": {
          "description": "The preferred hash algorithm.",
          "enum": [
            "Sha256",
            "Sha512"
          ],
          "type": "string"
        },
        "UseExternalSignatureImage": {
          "description": "The external signature image mode.",
          "enum": [
            "Optional",
            "Required",
            "Disabled"
          ],
          "type": "string"
        },
        "Preferred": {
          "description": "If true, the signature type is set as preferred.",
          "type": "boolean"
        },
        "StampImprintConfiguration": {
          "$ref": "#/$defs/FilePrepareLocalCertificateStampImprint",
          "description": "The configuration of the stamp imprint of the signature."
        }
      }
    },
    "FilePrepareLocalCertificateStampImprint": {
      "description": "The configuration of the stamp imprint used by multiple signature types.",
      "type": "object",
      "properties": {
        "DisplayExtraInformation": {
          "description": "If true, the extra information is displayed.",
          "type": "boolean"
        },
        "FontName": {
          "description": "The name of the font. The font needs to be installed on the server. \nIf it is not available on the server, a fallback font is used.",
          "type": "string"
        },
        "FontSizeInPt": {
          "format": "int32",
          "description": "The size of the font in points.",
          "type": "integer"
        },
        "DisplayIp": {
          "description": "If true, the IP address of the signer is displayed.",
          "type": "boolean"
        },
        "DisplayName": {
          "description": "If true, the name of the signer is displayed.",
          "type": "boolean"
        },
        "DisplaySignatureDate": {
          "description": "If true, the timestamp of signing is displayed.",
          "type": "boolean"
        }
      }
    },
    "FilePrepareNumberValidationConfiguration": {
      "description": "The validation rules for numbers.",
      "type": "object",
      "properties": {
        "DecimalDigits": {
          "format": "int32",
          "description": "The expected amount of decimal digits.",
          "type": "integer"
        },
        "Symbol": {
          "description": "The expected symbol.",
          "type": "string"
        },
        "SymbolLocation": {
          "description": "The defined symbol location.",
          "enum": [
            "Start",
            "StartWithBlank",
            "End",
            "EndWithBlank"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "SymbolLocationType",
            "modelAsString": false
          }
        },
        "GroupSeparator": {
          "description": "The expected thousands separator.",
          "enum": [
            "Comma",
            "Point",
            "Apostrophe",
            "Blank",
            "None"
          ],
          "type": "string"
        },
        "DecimalSeparator": {
          "description": "The expected decimal separator.",
          "enum": [
            "Comma",
            "Point",
            "Apostrophe",
            "None"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "DecimalSeparatorType",
            "modelAsString": false
          }
        },
        "Range": {
          "$ref": "#/$defs/FilePrepareFieldValidationRange",
          "description": "The range of the values."
        }
      }
    },
    "FilePrepareOneTimePasswordSignatureType": {
      "description": "The configuration of the OneTimePassword signature.",
      "type": "object",
      "properties": {
        "ValidityInSeconds": {
          "format": "int32",
          "description": "The validity of the password in seconds.",
          "type": "integer"
        },
        "UseExternalSignatureImage": {
          "description": "The external signature image mode.",
          "enum": [
            "Optional",
            "Required",
            "Disabled"
          ],
          "type": "string"
        },
        "Preferred": {
          "description": "If true, the signature type is set as preferred.",
          "type": "boolean"
        },
        "StampImprintConfiguration": {
          "$ref": "#/$defs/FilePrepareOneTimePasswordStampImprint",
          "description": "The configuration of the stamp imprint of the signature."
        }
      }
    },
    "FilePrepareOneTimePasswordStampImprint": {
      "description": "The configuration of the stamp imprint used by multiple signature types.",
      "type": "object",
      "properties": {
        "DisplayExtraInformation": {
          "description": "If true, the extra information is displayed.",
          "type": "boolean"
        },
        "FontName": {
          "description": "The name of the font. The font needs to be installed on the server. \nIf it is not available on the server, a fallback font is used.",
          "type": "string"
        },
        "FontSizeInPt": {
          "format": "int32",
          "description": "The size of the font in points.",
          "type": "integer"
        },
        "DisplayTransactionId": {
          "description": "If true, the transaction identifier is displayed.",
          "type": "boolean"
        },
        "DisplayTransactionToken": {
          "description": "If true, the transaction token is displayed.",
          "type": "boolean"
        },
        "DisplayPhoneNumber": {
          "description": "If true, the phone number of the signer is displayed.",
          "type": "boolean"
        },
        "DisplayIp": {
          "description": "If true, the IP address of the signer is displayed.",
          "type": "boolean"
        },
        "DisplayName": {
          "description": "If true, the name of the signer is displayed.",
          "type": "boolean"
        },
        "DisplaySignatureDate": {
          "description": "If true, the timestamp of signing is displayed.",
          "type": "boolean"
        }
      }
    },
    "FilePreparePhoneValidationConfiguration": {
      "description": "The validation rules for phone numbers.",
      "type": "object",
      "properties": {
        "Type": {
          "description": "The format of the phone numbers.",
          "enum": [
            "International",
            "InternationalLeadingZeros",
            "InternationalLeadingPlus"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "PhoneType",
            "modelAsString": false
          }
        }
      }
    },
    "FilePreparePluginStampImprint": {
      "description": "The configuration of the stamp imprint used by multiple signature types.",
      "type": "object",
      "properties": {
        "DisplayExtraInformation": {
          "description": "If true, the extra information is displayed.",
          "type": "boolean"
        },
        "FontName": {
          "description": "The name of the font. The font needs to be installed on the server. \nIf it is not available on the server, a fallback font is used.",
          "type": "string"
        },
        "FontSizeInPt": {
          "format": "int32",
          "description": "The size of the font in points.",
          "type": "integer"
        },
        "DisplayEmail": {
          "description": "If true, the email address of the signer is displayed.",
          "type": "boolean"
        },
        "DisplayIp": {
          "description": "If true, the IP address of the signer is displayed.",
          "type": "boolean"
        },
        "DisplayName": {
          "description": "If true, the name of the signer is displayed.",
          "type": "boolean"
        },
        "DisplaySignatureDate": {
          "description": "If true, the timestamp of signing is displayed.",
          "type": "boolean"
        }
      }
    },
    "FilePreparePosition": {
      "description": "The position of an element on the document.",
      "type": "object",
      "properties": {
        "PageNumber": {
          "format": "int32",
          "description": "The number of the page where the element is located. It starts with 1.",
          "type": "integer"
        },
        "X": {
          "format": "double",
          "description": "The X coordinate in points. It starts from the left.",
          "type": "number"
        },
        "Y": {
          "format": "double",
          "description": "The Y coordinate in points. It starts from the bottom.",
          "type": "number"
        }
      }
    },
    "FilePrepareRadioButtonDefinition": {
      "description": "The configuration of the radio button group definition.",
      "type": "object",
      "properties": {
        "IsSelectUnison": {
          "description": "If true, radio buttons with the same <code>ExportValue</code> are checked and unchecked together.",
          "type": "boolean"
        },
        "Items": {
          "description": "The list of radiobuttons that belong to the same group.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/FilePrepareRadioButtonItemDefinition"
          }
        }
      }
    },
    "FilePrepareRadioButtonGroup": {
      "description": "The configuration of the radio button group.",
      "type": "object",
      "properties": {
        "GroupName": {
          "description": "The name of the radio button group.",
          "type": "string"
        },
        "DocumentNumber": {
          "format": "int32",
          "description": "The reference number of the containing document. It starts with 1.",
          "type": "integer"
        },
        "Required": {
          "description": "If true, the element is required.",
          "type": "boolean"
        },
        "SelectedItem": {
          "description": "The export value of the selected item of the radio button group.",
          "type": "string"
        },
        "GuidingOrder": {
          "format": "int32",
          "description": "The order of the element.",
          "type": "integer"
        },
        "FieldDefinition": {
          "$ref": "#/$defs/FilePrepareRadioButtonDefinition",
          "description": "The definition of the radio button group."
        }
      }
    },
    "FilePrepareRadioButtonItemDefinition": {
      "description": "The configuration of the radio button.",
      "type": "object",
      "properties": {
        "ExportValue": {
          "description": "The value of the element when the radio button is checked.",
          "type": "string"
        },
        "IsChecked": {
          "description": "If true, the radio button is checked by default.",
          "type": "boolean"
        },
        "ReadOnly": {
          "description": "If true, the element is readonly.",
          "type": "boolean"
        },
        "Source": {
          "description": "The element source from where a field originates.",
          "enum": [
            "Document",
            "AdvancedDocumentTag",
            "UserDefined"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "FormFieldSource",
            "modelAsString": false
          }
        },
        "Position": {
          "$ref": "#/$defs/FilePreparePosition",
          "description": "The position of the  within the document."
        },
        "Size": {
          "$ref": "#/$defs/FilePrepareSize",
          "description": "The size of the form field."
        }
      }
    },
    "FilePrepareRemoteCertificateSignatureType": {
      "description": "The configuration of the RemoteCertificate signature.",
      "type": "object",
      "properties": {
        "ValidityInSeconds": {
          "format": "int32",
          "description": "The validity of the certificate in seconds.",
          "type": "integer"
        },
        "UseExternalSignatureImage": {
          "description": "The external signature image mode.",
          "enum": [
            "Optional",
            "Required",
            "Disabled"
          ],
          "type": "string"
        },
        "Preferred": {
          "description": "If true, the signature type is set as preferred.",
          "type": "boolean"
        },
        "StampImprintConfiguration": {
          "$ref": "#/$defs/FilePrepareRemoteCertificateStampImprint",
          "description": "The configuration of the stamp imprint of the signature."
        }
      }
    },
    "FilePrepareRemoteCertificateStampImprint": {
      "description": "The configuration of the stamp imprint used by multiple signature types.",
      "type": "object",
      "properties": {
        "DisplayExtraInformation": {
          "description": "If true, the extra information is displayed.",
          "type": "boolean"
        },
        "FontName": {
          "description": "The name of the font. The font needs to be installed on the server. \nIf it is not available on the server, a fallback font is used.",
          "type": "string"
        },
        "FontSizeInPt": {
          "format": "int32",
          "description": "The size of the font in points.",
          "type": "integer"
        },
        "DisplayIp": {
          "description": "If true, the IP address of the signer is displayed.",
          "type": "boolean"
        },
        "DisplayName": {
          "description": "If true, the name of the signer is displayed.",
          "type": "boolean"
        },
        "DisplaySignatureDate": {
          "description": "If true, the timestamp of signing is displayed.",
          "type": "boolean"
        }
      }
    },
    "FilePrepareSign": {
      "description": "The elements, which are assigned to actions.",
      "type": "object",
      "properties": {
        "Elements": {
          "$ref": "#/$defs/FilePrepareElements",
          "description": "The definition of the assigned elements."
        }
      }
    },
    "FilePrepareSignAutomatic": {
      "description": "An automatic signing action.",
      "type": "object",
      "properties": {
        "VisibleSignatures": {
          "description": "The visible signatures define the optional visual representations for automatic signatures.\nIf none are defined, the automatic signatures are applied to the documents without a visual element.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/FilePrepareVisibleSignature"
          }
        }
      }
    },
    "FilePrepareSignatureField": {
      "description": "The configuration of the signature field.",
      "type": "object",
      "properties": {
        "ElementId": {
          "description": "The identifier of the signature.",
          "type": "string"
        },
        "Required": {
          "description": "If true, the element is required.",
          "type": "boolean"
        },
        "DocumentNumber": {
          "format": "int32",
          "description": "The reference number of the containing document. It starts with 1.",
          "type": "integer"
        },
        "DisplayName": {
          "description": "The displayed name.",
          "type": "string"
        },
        "FieldDescription": {
          "description": "The description of the signature.",
          "type": "string"
        },
        "UseExternalTimestampServer": {
          "description": "If true, an timestamp from an external server is embedded into the signature.",
          "type": "boolean"
        },
        "GuidingOrder": {
          "format": "int32",
          "description": "The order of the element.",
          "type": "integer"
        },
        "Source": {
          "description": "The element source from where a field originates.",
          "enum": [
            "Document",
            "AdvancedDocumentTag",
            "UserDefined"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "FormFieldSource",
            "modelAsString": false
          }
        },
        "FoundSigStringPattern": {
          "description": "Contains the actual pattern found, if this signature field was created from parsing a SigString",
          "type": "string"
        },
        "AllowedSignatureTypes": {
          "$ref": "#/$defs/FilePrepareAllowedSignatureTypes",
          "description": "The allowed types for the signature."
        },
        "FieldDefinition": {
          "$ref": "#/$defs/FilePrepareSignatureFieldDefinition",
          "description": "The definition of the signature field."
        },
        "TaskConfiguration": {
          "$ref": "#/$defs/FilePrepareSignatureTaskConfiguration",
          "description": "The configuration of the task."
        }
      }
    },
    "FilePrepareSignatureFieldDefinition": {
      "description": "The settings of a positionable element.",
      "type": "object",
      "properties": {
        "Position": {
          "$ref": "#/$defs/FilePreparePosition",
          "description": "The position of the  within the document."
        },
        "Size": {
          "$ref": "#/$defs/FilePrepareSize",
          "description": "The size of the form field."
        }
      }
    },
    "FilePrepareSignaturePluginSignatureType": {
      "description": "The configuration of the signature plugin.",
      "type": "object",
      "properties": {
        "PluginId": {
          "description": "The identifier of the plugin.",
          "type": "string"
        },
        "Preferred": {
          "description": "If true, the signature type is set as preferred.",
          "type": "boolean"
        },
        "StampImprintConfiguration": {
          "$ref": "#/$defs/FilePreparePluginStampImprint",
          "description": "The configuration of the stamp imprint of the signature."
        }
      }
    },
    "FilePrepareSignatureTaskConfiguration": {
      "description": "The configuration of the signature task.",
      "type": "object",
      "properties": {
        "StampImprintDateConfiguration": {
          "$ref": "#/$defs/FilePrepareStampImprintDateConfiguration",
          "description": "The configuration of the stamp imprint date."
        },
        "BatchGroup": {
          "description": "The batch group.",
          "type": "string"
        }
      }
    },
    "FilePrepareSize": {
      "description": "The definition of the size of an element.",
      "type": "object",
      "properties": {
        "Width": {
          "format": "double",
          "description": "The width of the element in points.",
          "type": "number"
        },
        "Height": {
          "format": "double",
          "description": "The height of the element in points.",
          "type": "number"
        }
      }
    },
    "FilePrepareStampImprintDateConfiguration": {
      "description": "The configuration of the stamp imprint date",
      "type": "object",
      "properties": {
        "UseLocalTimezone": {
          "description": "If true, the local timezone is used.",
          "type": "boolean"
        },
        "DateTimeFormat": {
          "description": "The format of the timestamp.",
          "type": "string"
        }
      }
    },
    "FilePrepareSwedishBankIdSignatureType": {
      "description": "The configuration of the signature.",
      "type": "object",
      "properties": {
        "Preferred": {
          "description": "If true, the signature type is set as preferred.",
          "type": "boolean"
        },
        "StampImprintConfiguration": {
          "$ref": "#/$defs/FilePrepareSwedishBankIdStampImprint",
          "description": "The configuration of the stamp imprint of the signature."
        }
      }
    },
    "FilePrepareSwedishBankIdStampImprint": {
      "description": "The configuration of the stamp imprint used by multiple signature types.",
      "type": "object",
      "properties": {
        "DisplayExtraInformation": {
          "description": "If true, the extra information is displayed.",
          "type": "boolean"
        },
        "FontName": {
          "description": "The name of the font. The font needs to be installed on the server. \nIf it is not available on the server, a fallback font is used.",
          "type": "string"
        },
        "FontSizeInPt": {
          "format": "int32",
          "description": "The size of the font in points.",
          "type": "integer"
        },
        "DisplayTransactionId": {
          "description": "If true, the transaction identifier is displayed.",
          "type": "boolean"
        },
        "DisplayName": {
          "description": "If true, the name of the signer is displayed.",
          "type": "boolean"
        },
        "DisplaySignatureDate": {
          "description": "If true, the timestamp of signing is displayed.",
          "type": "boolean"
        }
      }
    },
    "FilePrepareSwissComOnDemandSignatureType": {
      "description": "The configuration of the Swisscom On-Demand signature.",
      "type": "object",
      "properties": {
        "ValidityInSeconds": {
          "format": "int32",
          "description": "The certificate validity in seconds.",
          "type": "integer"
        },
        "Preferred": {
          "description": "If true, the signature type is set as preferred.",
          "type": "boolean"
        },
        "StampImprintConfiguration": {
          "$ref": "#/$defs/FilePrepareSwissComOnDemandStampImprint",
          "description": "The configuration of the stamp imprint of the signature."
        }
      }
    },
    "FilePrepareSwissComOnDemandStampImprint": {
      "description": "The configuration of the stamp imprint used by multiple signature types.",
      "type": "object",
      "properties": {
        "DisplayExtraInformation": {
          "description": "If true, the extra information is displayed.",
          "type": "boolean"
        },
        "FontName": {
          "description": "The name of the font. The font needs to be installed on the server. \nIf it is not available on the server, a fallback font is used.",
          "type": "string"
        },
        "FontSizeInPt": {
          "format": "int32",
          "description": "The size of the font in points.",
          "type": "integer"
        },
        "DisplayIp": {
          "description": "If true, the IP address of the signer is displayed.",
          "type": "boolean"
        },
        "DisplayName": {
          "description": "If true, the name of the signer is displayed.",
          "type": "boolean"
        },
        "DisplaySignatureDate": {
          "description": "If true, the timestamp of signing is displayed.",
          "type": "boolean"
        }
      }
    },
    "FilePrepareTextBox": {
      "description": "The configuration of the text box.",
      "type": "object",
      "properties": {
        "ElementId": {
          "description": "The identifier of the element.",
          "type": "string"
        },
        "Required": {
          "description": "If true, the element is required.",
          "type": "boolean"
        },
        "Value": {
          "description": "The value of the text box.",
          "type": "string"
        },
        "DocumentNumber": {
          "format": "int32",
          "description": "The reference number of the containing document. It starts with 1.",
          "type": "integer"
        },
        "GuidingOrder": {
          "format": "int32",
          "description": "The order of the element.",
          "type": "integer"
        },
        "Source": {
          "description": "The element source from where a field originates.",
          "enum": [
            "Document",
            "AdvancedDocumentTag",
            "UserDefined"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "FormFieldSource",
            "modelAsString": false
          }
        },
        "Validation": {
          "$ref": "#/$defs/FilePrepareFieldValidation",
          "description": "The configuration of the validation rules for the text box value."
        },
        "FieldDefinition": {
          "$ref": "#/$defs/FilePrepareTextBoxDefinition",
          "description": "The definition of the text box."
        }
      }
    },
    "FilePrepareTextBoxDefinition": {
      "description": "The configuration of the text box.",
      "type": "object",
      "properties": {
        "ReadOnly": {
          "description": "If true, the element is readonly.",
          "type": "boolean"
        },
        "MaxLength": {
          "format": "int32",
          "description": "The maximum length of the text.",
          "type": "integer"
        },
        "IsMultiline": {
          "description": "If true, the text box can have multiple lines.",
          "type": "boolean"
        },
        "IsPassword": {
          "description": "If true, the text box behaves like a password input field and does not show the actually entered characters.",
          "type": "boolean"
        },
        "TextFormat": {
          "$ref": "#/$defs/FilePrepareTextFormat",
          "description": "The configuration of the text format."
        },
        "Position": {
          "$ref": "#/$defs/FilePreparePosition",
          "description": "The position of the  within the document."
        },
        "Size": {
          "$ref": "#/$defs/FilePrepareSize",
          "description": "The size of the form field."
        }
      }
    },
    "FilePrepareTextFormat": {
      "description": "The configuration of the text format.",
      "type": "object",
      "properties": {
        "TextColor": {
          "description": "The color of the text.\nSix digit hexadecimal color starting with # in #RRGGBB format according to CSS Color Module Level 4, paragraph 5.2.",
          "type": "string"
        },
        "FontSizeInPt": {
          "format": "double",
          "description": "The size of the font in points.",
          "type": "number"
        },
        "FontName": {
          "description": "The name of the font. The font needs to be installed on the server. \nIf it is not available on the server, a fallback font is used.",
          "type": "string"
        },
        "Bold": {
          "description": "If true, the bold font is used.",
          "type": "boolean"
        },
        "Italic": {
          "description": "If true, the italic font is used.",
          "type": "boolean"
        },
        "TextAlign": {
          "description": "The alignment of the text. The default alignment is left.",
          "enum": [
            "Left",
            "Center",
            "Right"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "TextAlignment",
            "modelAsString": false
          }
        }
      }
    },
    "FilePrepareTimeValidationConfiguration": {
      "description": "The validation rules for time values.",
      "type": "object",
      "properties": {
        "TimeFormat": {
          "description": "The format of the time values.",
          "type": "string"
        },
        "Range": {
          "$ref": "#/$defs/FilePrepareFieldValidationRange",
          "description": "The range of the values."
        }
      }
    },
    "FilePrepareTypeToSignSignatureType": {
      "description": "The configuration of the signature image.",
      "type": "object",
      "properties": {
        "UseExternalSignatureImage": {
          "description": "The external signature image mode.",
          "enum": [
            "Optional",
            "Required",
            "Disabled"
          ],
          "type": "string"
        },
        "Preferred": {
          "description": "If true, the signature type is set as preferred.",
          "type": "boolean"
        },
        "StampImprintConfiguration": {
          "$ref": "#/$defs/FilePrepareTypeToSignStampImprint",
          "description": "The configuration of the stamp imprint of the signature."
        }
      }
    },
    "FilePrepareTypeToSignStampImprint": {
      "description": "The configuration of the stamp imprint used by multiple signature types.",
      "type": "object",
      "properties": {
        "DisplayExtraInformation": {
          "description": "If true, the extra information is displayed.",
          "type": "boolean"
        },
        "FontName": {
          "description": "The name of the font. The font needs to be installed on the server. \nIf it is not available on the server, a fallback font is used.",
          "type": "string"
        },
        "FontSizeInPt": {
          "format": "int32",
          "description": "The size of the font in points.",
          "type": "integer"
        },
        "DisplayEmail": {
          "description": "If true, the email address of the signer is displayed.",
          "type": "boolean"
        },
        "DisplayIp": {
          "description": "If true, the IP address of the signer is displayed.",
          "type": "boolean"
        },
        "DisplayName": {
          "description": "If true, the name of the signer is displayed.",
          "type": "boolean"
        },
        "DisplaySignatureDate": {
          "description": "If true, the timestamp of signing is displayed.",
          "type": "boolean"
        }
      }
    },
    "FilePrepareVisibleSignature": {
      "description": "An automatic signature with a visual appearance on the document.",
      "type": "object",
      "properties": {
        "DocumentNumber": {
          "format": "int32",
          "description": "The reference number of the containing document. It starts with 1.",
          "type": "integer"
        },
        "Id": {
          "description": "The identifier of the signature field.",
          "type": "string"
        },
        "UseExternalTimestampServer": {
          "description": "If true, a timestamp from an external server is embedded into the signature.",
          "type": "boolean"
        },
        "FieldDefinition": {
          "$ref": "#/$defs/FilePrepareSignatureFieldDefinition",
          "description": "The definition of the signature field."
        }
      }
    }
  }
}