{
  "type": "object",
  "required": [
    "client_id",
    "template_ids",
    "signers"
  ],
  "properties": {
    "ccs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCC"
      },
      "description": "Add CC email recipients. Required when a CC role exists for the Template."
    },
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      },
      "description": "Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "title": {
      "type": "string",
      "maxLength": 255,
      "description": "The title you want to assign to the SignatureRequest."
    },
    "message": {
      "type": "string",
      "maxLength": 5000,
      "description": "The custom message in the email that will be sent to the signers."
    },
    "signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubSignatureRequestTemplateSigner"
      },
      "description": "Add Signers to your Templated-based Signature Request."
    },
    "subject": {
      "type": "string",
      "maxLength": 255,
      "description": "The subject in the email that will be sent to the signers."
    },
    "metadata": {
      "type": "object",
      "maxItems": 10,
      "description": "Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.",
      "additionalProperties": {}
    },
    "client_id": {
      "type": "string",
      "description": "Client id of the app you're using to create this embedded signature request. Used for security purposes."
    },
    "file_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "test_mode": {
      "type": "boolean",
      "default": false,
      "description": "Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."
    },
    "template_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used."
    },
    "allow_decline": {
      "type": "boolean",
      "default": false,
      "description": "Allows signers to decline to sign a document if `true`. Defaults to `false`."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCustomField"
      },
      "description": "An array defining values and options for custom fields. Required when a custom field exists in the Template."
    },
    "signing_options": {
      "$ref": "#/components/schemas/SubSigningOptions"
    },
    "populate_auto_fill_fields": {
      "type": "boolean",
      "default": false,
      "description": "Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.\n\n⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature."
    }
  }
}

{
  "type": "object",
  "properties": {
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      },
      "description": "Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "title": {
      "type": "string",
      "maxLength": 255,
      "description": "The title you want to assign to the SignatureRequest."
    },
    "is_eid": {
      "type": "boolean",
      "default": false,
      "description": "Send with a value of `true` if you wish to enable\n[electronic identification (eID)](https://www.hellosign.com/features/electronic-id),\nwhich requires the signer to verify their identity with an eID provider to sign a document.<br>\n**Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer."
    },
    "message": {
      "type": "string",
      "maxLength": 5000,
      "description": "The custom message in the email that will be sent to the signers."
    },
    "signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubSignatureRequestSigner"
      },
      "description": "Add Signers to your Signature Request.\n\nThis endpoint requires either **signers** or **grouped_signers**, but not both."
    },
    "subject": {
      "type": "string",
      "maxLength": 255,
      "description": "The subject in the email that will be sent to the signers."
    },
    "metadata": {
      "type": "object",
      "maxItems": 10,
      "description": "Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.",
      "additionalProperties": {}
    },
    "client_id": {
      "type": "string",
      "description": "The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app."
    },
    "file_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "test_mode": {
      "type": "boolean",
      "default": false,
      "description": "Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."
    },
    "expires_at": {
      "type": "integer",
      "nullable": true,
      "description": "When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details."
    },
    "attachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubAttachment"
      },
      "description": "A list describing the attachments"
    },
    "allow_decline": {
      "type": "boolean",
      "default": false,
      "description": "Allows signers to decline to sign a document if `true`. Defaults to `false`."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCustomField"
      },
      "description": "When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.\n\nPre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.\n\nFor using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](https://raw.githubusercontent.com) and then passing `custom_fields` on subsequent signature requests referencing that template."
    },
    "field_options": {
      "$ref": "#/components/schemas/SubFieldOptions"
    },
    "use_text_tags": {
      "type": "boolean",
      "default": false,
      "description": "Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`."
    },
    "allow_reassign": {
      "type": "boolean",
      "default": false,
      "description": "Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.\n\n**Note**: Only available for Premium plan and higher."
    },
    "hide_text_tags": {
      "type": "boolean",
      "default": false,
      "description": "Enables automatic Text Tag removal when set to true.\n\n**NOTE**: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information."
    },
    "grouped_signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubSignatureRequestGroupedSigners"
      },
      "description": "Add Grouped Signers to your Signature Request.\n\nThis endpoint requires either **signers** or **grouped_signers**, but not both."
    },
    "signing_options": {
      "$ref": "#/components/schemas/SubSigningOptions"
    },
    "form_field_rules": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldRule"
      },
      "description": "Conditional Logic rules for fields defined in `form_fields_per_document`."
    },
    "form_field_groups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldGroup"
      },
      "description": "Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`."
    },
    "cc_email_addresses": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "email"
      },
      "description": "The email addresses that should be CCed."
    },
    "signing_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully sign."
    },
    "form_fields_per_document": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
      },
      "description": "The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](https://raw.githubusercontent.com).)\n\n**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.\n\n* Text Field use `SubFormFieldsPerDocumentText`\n* Dropdown Field use `SubFormFieldsPerDocumentDropdown`\n* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`\n* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`\n* Radio Field use `SubFormFieldsPerDocumentRadio`\n* Signature Field use `SubFormFieldsPerDocumentSignature`\n* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`\n* Initials Field use `SubFormFieldsPerDocumentInitials`\n* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`\n* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`"
    }
  }
}

{
  "type": "object",
  "required": [
    "signers",
    "template_ids"
  ],
  "properties": {
    "ccs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCC"
      },
      "description": "Add CC email recipients. Required when a CC role exists for the Template."
    },
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      },
      "description": "Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "title": {
      "type": "string",
      "maxLength": 255,
      "description": "The title you want to assign to the SignatureRequest."
    },
    "is_eid": {
      "type": "boolean",
      "default": false,
      "description": "Send with a value of `true` if you wish to enable\n[electronic identification (eID)](https://www.hellosign.com/features/electronic-id),\nwhich requires the signer to verify their identity with an eID provider to sign a document.<br>\n**Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer."
    },
    "message": {
      "type": "string",
      "maxLength": 5000,
      "description": "The custom message in the email that will be sent to the signers."
    },
    "signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubSignatureRequestTemplateSigner"
      },
      "description": "Add Signers to your Templated-based Signature Request."
    },
    "subject": {
      "type": "string",
      "maxLength": 255,
      "description": "The subject in the email that will be sent to the signers."
    },
    "metadata": {
      "type": "object",
      "maxItems": 10,
      "description": "Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.",
      "additionalProperties": {}
    },
    "client_id": {
      "type": "string",
      "description": "Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app."
    },
    "file_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "test_mode": {
      "type": "boolean",
      "default": false,
      "description": "Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."
    },
    "template_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used."
    },
    "allow_decline": {
      "type": "boolean",
      "default": false,
      "description": "Allows signers to decline to sign a document if `true`. Defaults to `false`."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCustomField"
      },
      "description": "An array defining values and options for custom fields. Required when a custom field exists in the Template."
    },
    "signing_options": {
      "$ref": "#/components/schemas/SubSigningOptions"
    },
    "signing_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully sign."
    }
  },
  "description": ""
}

{
  "type": "object",
  "properties": {
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "description": "A list of warnings."
    },
    "signature_request": {
      "$ref": "#/components/schemas/SignatureRequestResponse"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "description": "A list of warnings."
    },
    "list_info": {
      "$ref": "#/components/schemas/ListInfoResponse"
    },
    "signature_requests": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SignatureRequestResponse"
      },
      "description": "Contains information about signature requests."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "email_address"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the signer to send a reminder to. Include if two or more signers share an email address."
    },
    "email_address": {
      "type": "string",
      "format": "email",
      "description": "The email address of the signer to send a reminder to."
    }
  }
}

{
  "type": "object",
  "example": {},
  "properties": {}
}

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "The title the specified Account uses for the SignatureRequest."
    },
    "message": {
      "type": "string",
      "nullable": true,
      "description": "The custom message in the email that was initially sent to the signers."
    },
    "subject": {
      "type": "string",
      "nullable": true,
      "description": "The subject in the email that was initially sent to the signers."
    },
    "metadata": {
      "type": "object",
      "description": "The metadata attached to the signature request."
    },
    "files_url": {
      "type": "string",
      "description": "The URL where a copy of the request's documents can be downloaded."
    },
    "has_error": {
      "type": "boolean",
      "description": "Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings)."
    },
    "test_mode": {
      "type": "boolean",
      "default": false,
      "nullable": true,
      "description": "Whether this is a test signature request. Test requests have no legal value. Defaults to `false`."
    },
    "created_at": {
      "type": "integer",
      "description": "Time the signature request was created."
    },
    "expires_at": {
      "type": "integer",
      "description": "The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details."
    },
    "signatures": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SignatureRequestResponseSignatures"
      },
      "description": "An array of signature objects, 1 for each signer."
    },
    "attachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SignatureRequestResponseAttachment"
      },
      "nullable": true,
      "description": "Signer attachments."
    },
    "details_url": {
      "type": "string",
      "description": "The URL where the requester and the signers can view the current status of the SignatureRequest."
    },
    "is_complete": {
      "type": "boolean",
      "description": "Whether or not the SignatureRequest has been fully executed by all signers."
    },
    "is_declined": {
      "type": "boolean",
      "description": "Whether or not the SignatureRequest has been declined by a signer."
    },
    "signing_url": {
      "type": "string",
      "nullable": true,
      "description": "The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing."
    },
    "template_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "description": "Templates IDs used in this SignatureRequest (if any)."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SignatureRequestResponseCustomFieldBase"
      },
      "nullable": true,
      "description": "An array of Custom Field objects containing the name and type of each custom field.\n\n* Text Field uses `SignatureRequestResponseCustomFieldText`\n* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`"
    },
    "response_data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SignatureRequestResponseDataBase"
      },
      "nullable": true,
      "description": "An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers."
    },
    "final_copy_uri": {
      "type": "string",
      "nullable": true,
      "description": "The path where the completed document can be downloaded"
    },
    "original_title": {
      "type": "string",
      "description": "Default Label for account."
    },
    "bulk_send_job_id": {
      "type": "string",
      "nullable": true,
      "description": "The ID of the Bulk Send job which sent the signature request, if applicable."
    },
    "cc_email_addresses": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed."
    },
    "signature_request_id": {
      "type": "string",
      "description": "The id of the SignatureRequest."
    },
    "signing_redirect_url": {
      "type": "string",
      "nullable": true,
      "description": "The URL you want the signer redirected to after they successfully sign."
    },
    "requester_email_address": {
      "type": "string",
      "description": "The email address of the initiator of the SignatureRequest."
    }
  },
  "x-internal": true,
  "description": "Contains information about a signature request."
}

{
  "type": "object",
  "required": [
    "id",
    "signer",
    "name",
    "required"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique ID for this attachment."
    },
    "name": {
      "type": "string",
      "description": "The name of this attachment."
    },
    "signer": {
      "type": "string",
      "description": "The Signer this attachment is assigned to."
    },
    "required": {
      "type": "boolean",
      "description": "A boolean value denoting if this attachment is required."
    },
    "uploaded_at": {
      "type": "integer",
      "nullable": true,
      "description": "Timestamp when attachment was uploaded by Signer."
    },
    "instructions": {
      "type": "string",
      "nullable": true,
      "description": "Instructions for Signer."
    }
  },
  "x-internal": true,
  "description": "Signer attachments."
}

{
  "type": "object",
  "required": [
    "name",
    "type"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the Custom Field."
    },
    "type": {
      "type": "string",
      "description": "The type of this Custom Field. Only 'text' and 'checkbox' are currently supported."
    },
    "api_id": {
      "type": "string",
      "description": "The unique ID for this field."
    },
    "editor": {
      "type": "string",
      "description": "The name of the Role that is able to edit this field."
    },
    "required": {
      "type": "boolean",
      "description": "A boolean value denoting if this field is required."
    }
  },
  "x-internal": true,
  "description": "An array of Custom Field objects containing the name and type of each custom field.\n\n* Text Field uses `SignatureRequestResponseCustomFieldText`\n* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`",
  "x-base-class": true,
  "discriminator": {
    "mapping": {
      "text": "#/components/schemas/SignatureRequestResponseCustomFieldText",
      "checkbox": "#/components/schemas/SignatureRequestResponseCustomFieldCheckbox"
    },
    "propertyName": "type"
  }
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/SignatureRequestResponseCustomFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "checkbox",
          "description": "The type of this Custom Field. Only 'text' and 'checkbox' are currently supported."
        },
        "value": {
          "type": "boolean",
          "description": "A true/false for checkbox fields"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `SignatureRequestResponseCustomFieldBase`."
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/SignatureRequestResponseCustomFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "text",
          "description": "The type of this Custom Field. Only 'text' and 'checkbox' are currently supported."
        },
        "value": {
          "type": "string",
          "description": "A text string for text fields"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `SignatureRequestResponseCustomFieldBase`."
}

{
  "enum": [
    "text",
    "checkbox"
  ],
  "type": "string"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the form field."
    },
    "type": {
      "type": "string"
    },
    "api_id": {
      "type": "string",
      "description": "The unique ID for this field."
    },
    "required": {
      "type": "boolean",
      "description": "A boolean value denoting if this field is required."
    },
    "signature_id": {
      "type": "string",
      "description": "The ID of the signature to which this response is linked."
    }
  },
  "x-internal": true,
  "description": "An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.",
  "x-base-class": true,
  "discriminator": {
    "mapping": {
      "text": "#/components/schemas/SignatureRequestResponseDataValueText",
      "radio": "#/components/schemas/SignatureRequestResponseDataValueRadio",
      "checkbox": "#/components/schemas/SignatureRequestResponseDataValueCheckbox",
      "dropdown": "#/components/schemas/SignatureRequestResponseDataValueDropdown",
      "initials": "#/components/schemas/SignatureRequestResponseDataValueInitials",
      "signature": "#/components/schemas/SignatureRequestResponseDataValueSignature",
      "text-merge": "#/components/schemas/SignatureRequestResponseDataValueTextMerge",
      "date_signed": "#/components/schemas/SignatureRequestResponseDataValueDateSigned",
      "checkbox-merge": "#/components/schemas/SignatureRequestResponseDataValueCheckboxMerge"
    },
    "propertyName": "type"
  }
}

{
  "enum": [
    "text",
    "checkbox",
    "date_signed",
    "dropdown",
    "initials",
    "radio",
    "signature",
    "text-merge",
    "checkbox-merge"
  ],
  "type": "string"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/SignatureRequestResponseDataBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "checkbox",
          "description": "A yes/no checkbox"
        },
        "value": {
          "type": "boolean",
          "description": "The value of the form field."
        }
      }
    }
  ]
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/SignatureRequestResponseDataBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "checkbox-merge",
          "description": "A checkbox field that has default value set by the api"
        },
        "value": {
          "type": "string",
          "description": "The value of the form field."
        }
      }
    }
  ]
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/SignatureRequestResponseDataBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "date_signed",
          "description": "A date"
        },
        "value": {
          "type": "string",
          "description": "The value of the form field."
        }
      }
    }
  ]
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/SignatureRequestResponseDataBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "dropdown",
          "description": "An input field for dropdowns"
        },
        "value": {
          "type": "string",
          "description": "The value of the form field."
        }
      }
    }
  ]
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/SignatureRequestResponseDataBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "initials",
          "description": "An input field for initials"
        },
        "value": {
          "type": "string",
          "description": "The value of the form field."
        }
      }
    }
  ]
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/SignatureRequestResponseDataBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "radio",
          "description": "An input field for radios"
        },
        "value": {
          "type": "boolean",
          "description": "The value of the form field."
        }
      }
    }
  ]
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/SignatureRequestResponseDataBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "signature",
          "description": "A signature input field"
        },
        "value": {
          "type": "string",
          "description": "The value of the form field."
        }
      }
    }
  ]
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/SignatureRequestResponseDataBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "text",
          "description": "A text input field"
        },
        "value": {
          "type": "string",
          "description": "The value of the form field."
        }
      }
    }
  ]
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/SignatureRequestResponseDataBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "text-merge",
          "description": "A text field that has default text set by the api"
        },
        "value": {
          "type": "string",
          "description": "The value of the form field."
        }
      }
    }
  ]
}

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "nullable": true,
      "description": "Error message pertaining to this signer, or null."
    },
    "order": {
      "type": "integer",
      "nullable": true,
      "description": "If signer order is assigned this is the 0-based index for this signer."
    },
    "has_pin": {
      "type": "boolean",
      "description": "Boolean to indicate whether this signature requires a PIN to access."
    },
    "signed_at": {
      "type": "integer",
      "nullable": true,
      "description": "Time that the document was signed or null."
    },
    "signer_name": {
      "type": "string",
      "nullable": true,
      "description": "The name of the signer."
    },
    "signer_role": {
      "type": "string",
      "nullable": true,
      "description": "The role of the signer."
    },
    "status_code": {
      "type": "string",
      "description": "The current status of the signature. eg: awaiting_signature, signed, declined."
    },
    "has_sms_auth": {
      "type": "boolean",
      "nullable": true,
      "description": "Boolean to indicate whether this signature has SMS authentication enabled."
    },
    "signature_id": {
      "type": "string",
      "description": "Signature identifier."
    },
    "reassigned_by": {
      "type": "string",
      "nullable": true,
      "description": "Email address of original signer who reassigned to this signer."
    },
    "decline_reason": {
      "type": "string",
      "nullable": true,
      "description": "The reason provided by the signer for declining the request."
    },
    "last_viewed_at": {
      "type": "integer",
      "nullable": true,
      "description": "The time that the document was last viewed by this signer or null."
    },
    "reassigned_from": {
      "type": "string",
      "nullable": true,
      "description": "Previous signature identifier."
    },
    "has_sms_delivery": {
      "type": "boolean",
      "nullable": true,
      "description": "Boolean to indicate whether this signature has SMS delivery enabled."
    },
    "last_reminded_at": {
      "type": "integer",
      "nullable": true,
      "description": "The time the last reminder email was sent to the signer or null."
    },
    "sms_phone_number": {
      "type": "string",
      "nullable": true,
      "description": "The SMS phone number used for authentication or signature request delivery."
    },
    "signer_group_guid": {
      "type": "string",
      "nullable": true,
      "description": "Signer Group GUID"
    },
    "reassignment_reason": {
      "type": "string",
      "nullable": true,
      "description": "Reason provided by original signer who reassigned to this signer."
    },
    "signer_email_address": {
      "type": "string",
      "description": "The email address of the signer."
    }
  },
  "x-internal": true,
  "description": "An array of signature objects, 1 for each signer."
}

{
  "type": "object",
  "properties": {
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      },
      "description": "Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "title": {
      "type": "string",
      "maxLength": 255,
      "description": "The title you want to assign to the SignatureRequest."
    },
    "is_eid": {
      "type": "boolean",
      "default": false,
      "description": "Send with a value of `true` if you wish to enable\n[electronic identification (eID)](https://www.hellosign.com/features/electronic-id),\nwhich requires the signer to verify their identity with an eID provider to sign a document.<br>\n**Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer."
    },
    "message": {
      "type": "string",
      "maxLength": 5000,
      "description": "The custom message in the email that will be sent to the signers."
    },
    "signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubSignatureRequestSigner"
      },
      "description": "Add Signers to your Signature Request.\n\nThis endpoint requires either **signers** or **grouped_signers**, but not both."
    },
    "subject": {
      "type": "string",
      "maxLength": 255,
      "description": "The subject in the email that will be sent to the signers."
    },
    "metadata": {
      "type": "object",
      "maxItems": 10,
      "description": "Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.",
      "additionalProperties": {}
    },
    "client_id": {
      "type": "string",
      "description": "The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app."
    },
    "file_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "test_mode": {
      "type": "boolean",
      "default": false,
      "description": "Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."
    },
    "expires_at": {
      "type": "integer",
      "nullable": true,
      "description": "When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details."
    },
    "attachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubAttachment"
      },
      "description": "A list describing the attachments"
    },
    "allow_decline": {
      "type": "boolean",
      "default": false,
      "description": "Allows signers to decline to sign a document if `true`. Defaults to `false`."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCustomField"
      },
      "description": "When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.\n\nPre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.\n\nFor using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](https://raw.githubusercontent.com) and then passing `custom_fields` on subsequent signature requests referencing that template."
    },
    "field_options": {
      "$ref": "#/components/schemas/SubFieldOptions"
    },
    "use_text_tags": {
      "type": "boolean",
      "default": false,
      "description": "Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`."
    },
    "allow_reassign": {
      "type": "boolean",
      "default": false,
      "description": "Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.\n\n**Note**: Only available for Premium plan and higher."
    },
    "hide_text_tags": {
      "type": "boolean",
      "default": false,
      "description": "Enables automatic Text Tag removal when set to true.\n\n**NOTE**: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information."
    },
    "grouped_signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubSignatureRequestGroupedSigners"
      },
      "description": "Add Grouped Signers to your Signature Request.\n\nThis endpoint requires either **signers** or **grouped_signers**, but not both."
    },
    "signing_options": {
      "$ref": "#/components/schemas/SubSigningOptions"
    },
    "form_field_rules": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldRule"
      },
      "description": "Conditional Logic rules for fields defined in `form_fields_per_document`."
    },
    "form_field_groups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldGroup"
      },
      "description": "Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`."
    },
    "cc_email_addresses": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "email"
      },
      "description": "The email addresses that should be CCed."
    },
    "signing_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully sign."
    },
    "form_fields_per_document": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
      },
      "description": "The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](https://raw.githubusercontent.com).)\n\n**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.\n\n* Text Field use `SubFormFieldsPerDocumentText`\n* Dropdown Field use `SubFormFieldsPerDocumentDropdown`\n* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`\n* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`\n* Radio Field use `SubFormFieldsPerDocumentRadio`\n* Signature Field use `SubFormFieldsPerDocumentSignature`\n* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`\n* Initials Field use `SubFormFieldsPerDocumentInitials`\n* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`\n* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`"
    }
  }
}

{
  "type": "object",
  "required": [
    "signers",
    "template_ids"
  ],
  "properties": {
    "ccs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCC"
      },
      "description": "Add CC email recipients. Required when a CC role exists for the Template."
    },
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      },
      "description": "Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "title": {
      "type": "string",
      "maxLength": 255,
      "description": "The title you want to assign to the SignatureRequest."
    },
    "is_eid": {
      "type": "boolean",
      "default": false,
      "description": "Send with a value of `true` if you wish to enable\n[electronic identification (eID)](https://www.hellosign.com/features/electronic-id),\nwhich requires the signer to verify their identity with an eID provider to sign a document.<br>\n**Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer."
    },
    "message": {
      "type": "string",
      "maxLength": 5000,
      "description": "The custom message in the email that will be sent to the signers."
    },
    "signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubSignatureRequestTemplateSigner"
      },
      "description": "Add Signers to your Templated-based Signature Request."
    },
    "subject": {
      "type": "string",
      "maxLength": 255,
      "description": "The subject in the email that will be sent to the signers."
    },
    "metadata": {
      "type": "object",
      "maxItems": 10,
      "description": "Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.",
      "additionalProperties": {}
    },
    "client_id": {
      "type": "string",
      "description": "Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app."
    },
    "file_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "test_mode": {
      "type": "boolean",
      "default": false,
      "description": "Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."
    },
    "template_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used."
    },
    "allow_decline": {
      "type": "boolean",
      "default": false,
      "description": "Allows signers to decline to sign a document if `true`. Defaults to `false`."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCustomField"
      },
      "description": "An array defining values and options for custom fields. Required when a custom field exists in the Template."
    },
    "signing_options": {
      "$ref": "#/components/schemas/SubSigningOptions"
    },
    "signing_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully sign."
    }
  },
  "description": ""
}

{
  "type": "object",
  "required": [
    "signature_id"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The new name for the recipient.\n\n**NOTE**: Optional if `email_address` is provided."
    },
    "expires_at": {
      "type": "integer",
      "nullable": true,
      "description": "The new time when the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details."
    },
    "signature_id": {
      "type": "string",
      "description": "The signature ID for the recipient."
    },
    "email_address": {
      "type": "string",
      "format": "email",
      "description": "The new email address for the recipient.\n\nThis will generate a new `signature_id` value.\n\n**NOTE**: Optional if `name` is provided."
    }
  }
}

{
  "type": "object",
  "required": [
    "name",
    "signer_index"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of attachment."
    },
    "required": {
      "type": "boolean",
      "default": false,
      "description": "Determines if the attachment must be uploaded."
    },
    "instructions": {
      "type": "string",
      "description": "The instructions for uploading the attachment."
    },
    "signer_index": {
      "type": "integer",
      "description": "The signer's index in the `signers` parameter (0-based indexing).\n\n**NOTE**: Only one signer can be assigned per attachment."
    }
  }
}

{
  "type": "object",
  "properties": {
    "signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubSignatureRequestTemplateSigner"
      },
      "description": "Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.\n\nCurrently only templates with a single role are supported. All signers must have the same `role` value."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubBulkSignerListCustomField"
      },
      "description": "An array of custom field values."
    }
  }
}

{
  "type": "object",
  "required": [
    "name",
    "value"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the custom field. Must be the field's `name` or `api_id`."
    },
    "value": {
      "type": "string",
      "description": "The value of the custom field."
    }
  }
}

{
  "type": "object",
  "required": [
    "role",
    "email_address"
  ],
  "properties": {
    "role": {
      "type": "string",
      "description": "Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role."
    },
    "email_address": {
      "type": "string",
      "format": "email",
      "description": "The email address of the CC recipient."
    }
  }
}

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing."
    },
    "value": {
      "type": "string",
      "description": "The string that resolves (aka \"pre-fills\") to the merge field on the final document(s) used for signing."
    },
    "editor": {
      "type": "string",
      "description": "Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.\n\n**Note**: Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable."
    },
    "required": {
      "type": "boolean",
      "default": false,
      "description": "Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`."
    }
  },
  "description": "When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.\n\nPre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.\n\nFor using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](https://raw.githubusercontent.com) and then passing `custom_fields` on subsequent signature requests referencing that template."
}

{
  "type": "object",
  "properties": {
    "allow_edit_signers": {
      "type": "boolean",
      "default": false,
      "description": "Allows requesters to edit the list of signers"
    },
    "allow_edit_documents": {
      "type": "boolean",
      "default": false,
      "description": "Allows requesters to edit documents, including delete and add"
    }
  },
  "description": "This allows the requester to specify editor options when a preparing a document"
}

{
  "type": "object",
  "required": [
    "date_format"
  ],
  "properties": {
    "date_format": {
      "enum": [
        "MM / DD / YYYY",
        "MM - DD - YYYY",
        "DD / MM / YYYY",
        "DD - MM - YYYY",
        "YYYY / MM / DD",
        "YYYY - MM - DD"
      ],
      "type": "string",
      "description": "Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))\n\n**Note**: Only available for Premium and higher.",
      "x-enum-varnames": [
        "MMDDYYYY",
        "MM_DD_YYYY",
        "DDMMYYYY",
        "DD_MM_YYYY",
        "YYYYMMDD",
        "YYYY_MM_DD"
      ]
    }
  },
  "description": "This allows the requester to specify field options for a signature request."
}

{
  "type": "object",
  "required": [
    "group_id",
    "group_label",
    "requirement"
  ],
  "properties": {
    "group_id": {
      "type": "string",
      "description": "ID of group. Use this to reference a specific group from the `group` value in `form_fields_per_document`."
    },
    "group_label": {
      "type": "string",
      "description": "Name of the group"
    },
    "requirement": {
      "type": "string",
      "description": "Examples: `require_0-1` `require_1` `require_1-ormore`\n\n- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping).\n- Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping).\n- Radio groups require **at least** two fields per group."
    }
  }
}

{
  "type": "object",
  "required": [
    "id",
    "trigger_operator",
    "triggers",
    "actions"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Must be unique across all defined rules."
    },
    "actions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldRuleAction"
      },
      "minItems": 1,
      "description": "An array of action definitions, the \"then that\" part of \"if this, **then that**\". Any number of actions may be attached to a single rule."
    },
    "triggers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldRuleTrigger"
      },
      "maxItems": 1,
      "minItems": 1,
      "description": "An array of trigger definitions, the \"if this\" part of \"**if this**, then that\". Currently only a single trigger per rule is allowed."
    },
    "trigger_operator": {
      "type": "string",
      "default": "AND",
      "description": "Currently only `AND` is supported. Support for `OR` is being worked on."
    }
  }
}

{
  "type": "object",
  "required": [
    "hidden",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "change-field-visibility",
        "change-group-visibility"
      ],
      "type": "string"
    },
    "hidden": {
      "type": "boolean",
      "description": "`true` to hide the target field when rule is satisfied, otherwise `false`."
    },
    "field_id": {
      "type": "string",
      "description": "**field_id** or **group_id** is required, but not both.\n\nMust reference the `api_id` of an existing field defined within `form_fields_per_document`.\n\nCannot use with `group_id`. Trigger and action fields must belong to the same signer."
    },
    "group_id": {
      "type": "string",
      "description": "**group_id** or **field_id** is required, but not both.\n\nMust reference the ID of an existing group defined within `form_field_groups`.\n\nCannot use with `field_id`. Trigger and action fields and groups must belong to the same signer."
    }
  }
}

{
  "type": "object",
  "required": [
    "id",
    "operator"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Trigger and action fields and groups must belong to the same signer."
    },
    "value": {
      "type": "string",
      "description": "**value** or **values** is required, but not both.\n\nThe value to match against **operator**.\n\n- When **operator** is one of the following, **value** must be `String`:\n  - `is`\n  - `not`\n  - `match`\n\nOtherwise,\n- **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1`\n- **radio**: When **type** of trigger is **radio**, **value** must be `1`"
    },
    "values": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "**values** or **value** is required, but not both.\n\nThe values to match against **operator** when it is one of the following:\n\n- `any`\n- `none`"
    },
    "operator": {
      "enum": [
        "any",
        "is",
        "match",
        "none",
        "not"
      ],
      "type": "string",
      "description": "Different field types allow different `operator` values:\n- Field type of **text**:\n  - **is**: exact match\n  - **not**: not exact match\n  - **match**: regular expression, without /. Example:\n    - OK `[a-zA-Z0-9]`\n    - Not OK `/[a-zA-Z0-9]/`\n- Field type of **dropdown**:\n  - **is**: exact match, single value\n  - **not**: not exact match, single value\n  - **any**: exact match, array of values.\n  - **none**: not exact match, array of values.\n- Field type of **checkbox**:\n  - **is**: exact match, single value\n  - **not**: not exact match, single value\n- Field type of **radio**:\n  - **is**: exact match, single value\n  - **not**: not exact match, single value"
    }
  }
}

{
  "type": "object",
  "required": [
    "document_index",
    "api_id",
    "type",
    "required",
    "signer",
    "width",
    "height",
    "x",
    "y"
  ],
  "properties": {
    "x": {
      "type": "integer",
      "description": "Location coordinates of the field in pixels."
    },
    "y": {
      "type": "integer",
      "description": "Location coordinates of the field in pixels."
    },
    "name": {
      "type": "string",
      "description": "Display name for the field."
    },
    "page": {
      "type": "integer",
      "nullable": true,
      "description": "Page in the document where the field should be placed (requires documents be PDF files).\n\n- When the page number parameter is supplied, the API will use the new coordinate system.\n- Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them."
    },
    "type": {
      "type": "string"
    },
    "width": {
      "type": "integer",
      "description": "Size of the field in pixels."
    },
    "api_id": {
      "type": "string",
      "description": "An identifier for the field that is unique across all documents in the request."
    },
    "height": {
      "type": "integer",
      "description": "Size of the field in pixels."
    },
    "signer": {
      "type": "string",
      "description": "Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.\n\n**NOTE**: To set the value of the field as the preparer you must set this to `me_now`\n\n**NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.",
      "x-int-or-string": true
    },
    "required": {
      "type": "boolean",
      "description": "Whether this field is required."
    },
    "document_index": {
      "type": "integer",
      "description": "Represents the integer index of the `file` or `file_url` document the field should be attached to."
    }
  },
  "x-internal": true,
  "description": "The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](https://raw.githubusercontent.com).)\n\n**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.\n\n* Text Field use `SubFormFieldsPerDocumentText`\n* Dropdown Field use `SubFormFieldsPerDocumentDropdown`\n* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`\n* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`\n* Radio Field use `SubFormFieldsPerDocumentRadio`\n* Signature Field use `SubFormFieldsPerDocumentSignature`\n* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`\n* Initials Field use `SubFormFieldsPerDocumentInitials`\n* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`\n* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`",
  "x-base-class": true,
  "discriminator": {
    "mapping": {
      "text": "#/components/schemas/SubFormFieldsPerDocumentText",
      "radio": "#/components/schemas/SubFormFieldsPerDocumentRadio",
      "checkbox": "#/components/schemas/SubFormFieldsPerDocumentCheckbox",
      "dropdown": "#/components/schemas/SubFormFieldsPerDocumentDropdown",
      "initials": "#/components/schemas/SubFormFieldsPerDocumentInitials",
      "hyperlink": "#/components/schemas/SubFormFieldsPerDocumentHyperlink",
      "signature": "#/components/schemas/SubFormFieldsPerDocumentSignature",
      "text-merge": "#/components/schemas/SubFormFieldsPerDocumentTextMerge",
      "date_signed": "#/components/schemas/SubFormFieldsPerDocumentDateSigned",
      "checkbox-merge": "#/components/schemas/SubFormFieldsPerDocumentCheckboxMerge"
    },
    "propertyName": "type"
  }
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
    },
    {
      "type": "object",
      "required": [
        "type",
        "is_checked"
      ],
      "properties": {
        "type": {
          "type": "string",
          "default": "checkbox",
          "description": "A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class."
        },
        "group": {
          "type": "string",
          "description": "String referencing group defined in `form_field_groups` parameter."
        },
        "is_checked": {
          "type": "boolean",
          "description": "`true` for checking the checkbox field by default, otherwise `false`."
        }
      }
    },
    {
      "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
    }
  ],
  "description": "This class extends `SubFormFieldsPerDocumentBase`."
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
    },
    {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "default": "checkbox-merge",
          "description": "A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class."
        }
      }
    },
    {
      "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
    }
  ],
  "description": "This class extends `SubFormFieldsPerDocumentBase`."
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
    },
    {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "default": "date_signed",
          "description": "A date. Use the `SubFormFieldsPerDocumentDateSigned` class."
        },
        "font_size": {
          "type": "integer",
          "default": 12,
          "description": "The initial px font size for the field contents. Can be any integer value between `7` and `49`.\n\n**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field."
        },
        "font_family": {
          "enum": [
            "helvetica",
            "arial",
            "courier",
            "calibri",
            "cambria",
            "georgia",
            "times",
            "trebuchet",
            "verdana",
            "roboto",
            "robotoMono",
            "notoSans",
            "notoSerif",
            "notoCJK-JP-Regular",
            "notoHebrew-Regular",
            "notoSanThaiMerged"
          ],
          "type": "string",
          "description": "Font family for the field."
        }
      }
    },
    {
      "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
    }
  ],
  "description": "This class extends `SubFormFieldsPerDocumentBase`."
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
    },
    {
      "type": "object",
      "required": [
        "type",
        "options"
      ],
      "properties": {
        "type": {
          "type": "string",
          "default": "dropdown",
          "description": "An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class."
        },
        "content": {
          "type": "string",
          "description": "Selected value in `options` array. Value must exist in array."
        },
        "options": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "minItems": 1,
          "description": "Array of string values representing dropdown values."
        },
        "font_size": {
          "type": "integer",
          "default": 12,
          "description": "The initial px font size for the field contents. Can be any integer value between `7` and `49`.\n\n**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field."
        },
        "font_family": {
          "enum": [
            "helvetica",
            "arial",
            "courier",
            "calibri",
            "cambria",
            "georgia",
            "times",
            "trebuchet",
            "verdana",
            "roboto",
            "robotoMono",
            "notoSans",
            "notoSerif",
            "notoCJK-JP-Regular",
            "notoHebrew-Regular",
            "notoSanThaiMerged"
          ],
          "type": "string",
          "description": "Font family for the field."
        }
      }
    },
    {
      "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
    }
  ],
  "description": "This class extends `SubFormFieldsPerDocumentBase`."
}

{
  "enum": [
    "helvetica",
    "arial",
    "courier",
    "calibri",
    "cambria",
    "georgia",
    "times",
    "trebuchet",
    "verdana",
    "roboto",
    "robotoMono",
    "notoSans",
    "notoSerif",
    "notoCJK-JP-Regular",
    "notoHebrew-Regular",
    "notoSanThaiMerged"
  ],
  "type": "string"
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
    },
    {
      "type": "object",
      "required": [
        "type",
        "content",
        "content_url"
      ],
      "properties": {
        "type": {
          "type": "string",
          "default": "hyperlink",
          "description": "A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class."
        },
        "content": {
          "type": "string",
          "description": "Link Text."
        },
        "font_size": {
          "type": "integer",
          "default": 12,
          "description": "The initial px font size for the field contents. Can be any integer value between `7` and `49`.\n\n**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field."
        },
        "content_url": {
          "type": "string",
          "description": "Link URL."
        },
        "font_family": {
          "enum": [
            "helvetica",
            "arial",
            "courier",
            "calibri",
            "cambria",
            "georgia",
            "times",
            "trebuchet",
            "verdana",
            "roboto",
            "robotoMono",
            "notoSans",
            "notoSerif",
            "notoCJK-JP-Regular",
            "notoHebrew-Regular",
            "notoSanThaiMerged"
          ],
          "type": "string",
          "description": "Font family for the field."
        }
      }
    },
    {
      "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
    }
  ],
  "description": "This class extends `SubFormFieldsPerDocumentBase`."
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
    },
    {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "default": "initials",
          "description": "An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class."
        }
      }
    },
    {
      "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
    }
  ],
  "description": "This class extends `SubFormFieldsPerDocumentBase`."
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
    },
    {
      "type": "object",
      "required": [
        "type",
        "group",
        "is_checked"
      ],
      "properties": {
        "type": {
          "type": "string",
          "default": "radio",
          "description": "An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class."
        },
        "group": {
          "type": "string",
          "description": "String referencing group defined in `form_field_groups` parameter."
        },
        "is_checked": {
          "type": "boolean",
          "description": "`true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`."
        }
      }
    },
    {
      "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
    }
  ],
  "description": "This class extends `SubFormFieldsPerDocumentBase`."
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
    },
    {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "default": "signature",
          "description": "A signature input field. Use the `SubFormFieldsPerDocumentSignature` class."
        }
      }
    },
    {
      "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
    }
  ],
  "description": "This class extends `SubFormFieldsPerDocumentBase`."
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
    },
    {
      "type": "object",
      "required": [
        "type",
        "options"
      ],
      "properties": {
        "type": {
          "type": "string",
          "default": "text",
          "description": "A text input field. Use the `SubFormFieldsPerDocumentText` class."
        },
        "masked": {
          "type": "boolean",
          "description": "Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`."
        },
        "content": {
          "type": "string",
          "description": "Content of a `me_now` text field"
        },
        "link_id": {
          "type": "string",
          "description": "Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields."
        },
        "font_size": {
          "type": "integer",
          "default": 12,
          "description": "The initial px font size for the field contents. Can be any integer value between `7` and `49`.\n\n**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field."
        },
        "font_family": {
          "enum": [
            "helvetica",
            "arial",
            "courier",
            "calibri",
            "cambria",
            "georgia",
            "times",
            "trebuchet",
            "verdana",
            "roboto",
            "robotoMono",
            "notoSans",
            "notoSerif",
            "notoCJK-JP-Regular",
            "notoHebrew-Regular",
            "notoSanThaiMerged"
          ],
          "type": "string",
          "description": "Font family for the field."
        },
        "placeholder": {
          "type": "string",
          "description": "Placeholder value for text field."
        },
        "auto_fill_type": {
          "type": "string",
          "description": "Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values."
        },
        "validation_type": {
          "enum": [
            "numbers_only",
            "letters_only",
            "phone_number",
            "bank_routing_number",
            "bank_account_number",
            "email_address",
            "zip_code",
            "social_security_number",
            "employer_identification_number",
            "custom_regex"
          ],
          "type": "string",
          "description": "Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.\n\n**NOTE**: When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value."
        },
        "validation_custom_regex": {
          "type": "string"
        },
        "validation_custom_regex_format_label": {
          "type": "string"
        }
      }
    },
    {
      "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
    }
  ],
  "description": "This class extends `SubFormFieldsPerDocumentBase`."
}