Namirial · Schema

FilePrepareResponse

The response model after parsing the pdf file.

CompanyDigital TrustE-SignatureIdentity VerificationDigital IdentityTrust ServicesCompliance

Properties

Name Type Description
UnassignedElements object The elements which are not assigned to any action.
Activities array The steps for the envelope. One activity may contain elements from multiple documents assigned to the same recipient. The activities will only be generated for advanced document tags.
View JSON Schema on GitHub

JSON Schema

namirial-file-prepare-response-schema.json Raw ↑
{
  "$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": {
         

# --- truncated at 32 KB (56 KB total) ---
# Full source: https://artifacts.apis.io/namirial/json-schema/namirial-file-prepare-response-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/namirial-file-prepare-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.