SignTaskRequestSign

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/dottedsign-com/json-schema/dottedsign-com-sign-task-request-sign-schema.json",
  "title": "SignTaskRequestSign",
  "description": "Sign task sign.",
  "x-generated": "2026-11-06",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/dottedsign-com-signtasks-api-openapi.yml#/components/schemas/SignTaskRequestSign",
  "type": "object",
  "required": [
    "task_id"
  ],
  "properties": {
    "task_id": {
      "type": "integer",
      "description": "Task ID."
    },
    "sign_infos": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "field_object_id",
          "field_type"
        ],
        "properties": {
          "field_object_id": {
            "type": "string",
            "description": "Field object ID returned from the [Read a task](ref:readsigntask) API."
          },
          "field_type": {
            "type": "string",
            "description": "Field type."
          },
          "field_value": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "boolean"
              },
              {
                "type": "integer"
              }
            ],
            "description": "Field value.\nInteger if `field_type` is signature or image; Boolean if `field_type` is checkbox or radio; String if `field_type` is text_field or date_field.\n"
          },
          "field_value_type": {
            "type": "string",
            "description": "Field value type, including `signature` and `seal`. Required if `field_type` is signature."
          },
          "changed": {
            "type": "boolean",
            "description": "Record whether the field has been changed."
          },
          "options": {
            "$ref": "#/$defs/SignTaskRequestSignOptions"
          }
        }
      }
    },
    "attachment_infos": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "attachment_id",
          "attachment_type"
        ],
        "properties": {
          "attachment_id": {
            "type": "string",
            "description": "Attachment ID."
          },
          "attachment_type": {
            "type": "string",
            "description": "Attachment type.",
            "enum": [
              "csv",
              "doc",
              "docx",
              "jpeg",
              "jpg",
              "pdf",
              "png",
              "ppt",
              "pptx",
              "txt",
              "xls",
              "xlsx"
            ]
          },
          "changed": {
            "type": "boolean",
            "description": "Record whether the attachment has been changed."
          },
          "uploaded": {
            "type": "boolean",
            "description": "Whether the attachment has been uploaded."
          }
        }
      }
    },
    "verify_info": {
      "type": "object",
      "description": "Verify information for identity verification, account protection, and quick sign. See [Verify Identity with OTP](doc:05-quick-start-scenarios-05-read-a-task-with-otp-verification) for more details about the verification process.",
      "properties": {
        "uuid": {
          "type": "string",
          "description": "Verify method UUID."
        },
        "verify_data": {
          "type": "string",
          "description": "OTP code."
        },
        "identity_verify_token": {
          "type": "string",
          "description": "Identity verify token."
        },
        "account_protect_token": {
          "type": "string",
          "description": "Account protect token."
        },
        "verify_token": {
          "type": "string",
          "description": "Verify token returned from the [Consent to quick sign](ref:consenttoquicksign) API. *Required if authentication is via JWT Code.*"
        }
      }
    }
  },
  "$defs": {
    "SignTaskRequestSignOptions": {
      "type": "object",
      "properties": {
        "font_size": {
          "type": "integer",
          "description": "Font size.\n*Available field_types include `textfield`, `datefield`, and `link`.*\n",
          "minimum": 8,
          "maximum": 34
        },
        "alignment": {
          "type": "string",
          "description": "Alignment.\n*Available field_types include `textfield`, `datefield`, and `link`. Default `left`*\n",
          "enum": [
            "left",
            "center",
            "right"
          ]
        },
        "date_format": {
          "type": "string",
          "description": "Date format.\n*Available field_types include `datefield`.*\n",
          "enum": [
            "yyyy-mm-dd",
            "yyyy/mm/dd",
            "dd/mm/yyyy",
            "mm-dd-yyyy"
          ]
        },
        "zone": {
          "type": "integer",
          "description": "Time zone.\n*Available field_types include `datefield`.*\n",
          "minimum": -12,
          "maximum": 14
        }
      },
      "description": "Field options."
    }
  }
}