Dropbox Sign

{
  "type": "object",
  "required": [
    "email_address"
  ],
  "properties": {
    "locale": {
      "type": "string",
      "description": "The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values."
    },
    "client_id": {
      "type": "string",
      "description": "Used when creating a new account with OAuth authorization.\n\nSee [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization)"
    },
    "client_secret": {
      "type": "string",
      "description": "Used when creating a new account with OAuth authorization.\n\nSee [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization)"
    },
    "email_address": {
      "type": "string",
      "format": "email",
      "description": "The email address which will be associated with the new Account."
    }
  }
}

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

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

{
  "type": "object",
  "properties": {
    "locale": {
      "type": "string",
      "nullable": true,
      "description": "The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values."
    },
    "quotas": {
      "$ref": "#/components/schemas/AccountResponseQuotas"
    },
    "team_id": {
      "type": "string",
      "nullable": true,
      "description": "The id of the team account belongs to."
    },
    "is_locked": {
      "type": "boolean",
      "description": "Returns `true` if the user has been locked out of their account by a team admin."
    },
    "role_code": {
      "type": "string",
      "nullable": true,
      "description": "The membership role for the team."
    },
    "account_id": {
      "type": "string",
      "description": "The ID of the Account"
    },
    "is_paid_hf": {
      "type": "boolean",
      "description": "Returns `true` if the user has a paid HelloFax account."
    },
    "is_paid_hs": {
      "type": "boolean",
      "description": "Returns `true` if the user has a paid Dropbox Sign account."
    },
    "callback_url": {
      "type": "string",
      "nullable": true,
      "description": "The URL that Dropbox Sign events will `POST` to."
    },
    "email_address": {
      "type": "string",
      "description": "The email address associated with the Account."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "documents_left": {
      "type": "integer",
      "nullable": true,
      "description": "Signature requests remaining."
    },
    "templates_left": {
      "type": "integer",
      "nullable": true,
      "description": "API templates remaining."
    },
    "templates_total": {
      "type": "integer",
      "nullable": true,
      "description": "Total API templates allowed."
    },
    "sms_verifications_left": {
      "type": "integer",
      "nullable": true,
      "description": "SMS verifications  remaining."
    },
    "api_signature_requests_left": {
      "type": "integer",
      "nullable": true,
      "description": "API signature requests remaining."
    }
  },
  "x-internal": true,
  "description": "Details concerning remaining monthly quotas."
}

{
  "type": "object",
  "properties": {
    "locale": {
      "type": "string",
      "description": "The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values."
    },
    "account_id": {
      "type": "string",
      "nullable": true,
      "description": "The ID of the Account"
    },
    "callback_url": {
      "type": "string",
      "description": "The URL that Dropbox Sign should POST events to."
    }
  }
}

{
  "type": "object",
  "required": [
    "email_address"
  ],
  "properties": {
    "email_address": {
      "type": "string",
      "format": "email",
      "description": "Email address to run the verification for."
    }
  }
}

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

{
  "type": "object",
  "properties": {
    "email_address": {
      "type": "string",
      "description": "The email address associated with the Account."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "name",
    "domains"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name you want to assign to the ApiApp."
    },
    "oauth": {
      "$ref": "#/components/schemas/SubOAuth"
    },
    "domains": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 2,
      "minItems": 1,
      "description": "The domain names the ApiApp will be associated with."
    },
    "options": {
      "$ref": "#/components/schemas/SubOptions"
    },
    "callback_url": {
      "type": "string",
      "description": "The URL at which the ApiApp should receive event callbacks."
    },
    "custom_logo_file": {
      "type": "string",
      "format": "binary",
      "description": "An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)"
    },
    "white_labeling_options": {
      "$ref": "#/components/schemas/SubWhiteLabelingOptions"
    }
  }
}

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

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

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the app"
    },
    "oauth": {
      "$ref": "#/components/schemas/ApiAppResponseOAuth"
    },
    "domains": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The domain name(s) associated with the app"
    },
    "options": {
      "$ref": "#/components/schemas/ApiAppResponseOptions"
    },
    "client_id": {
      "type": "string",
      "description": "The app's client id"
    },
    "created_at": {
      "type": "integer",
      "description": "The time that the app was created"
    },
    "is_approved": {
      "type": "boolean",
      "description": "Boolean to indicate if the app has been approved"
    },
    "callback_url": {
      "type": "string",
      "nullable": true,
      "description": "The app's callback URL (for events)"
    },
    "owner_account": {
      "$ref": "#/components/schemas/ApiAppResponseOwnerAccount"
    },
    "white_labeling_options": {
      "$ref": "#/components/schemas/ApiAppResponseWhiteLabelingOptions"
    }
  },
  "x-internal": true,
  "description": "Contains information about an API App."
}

{
  "type": "object",
  "nullable": true,
  "properties": {
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of OAuth scopes used by the app."
    },
    "secret": {
      "type": "string",
      "description": "The app's OAuth secret, or null if the app does not belong to user."
    },
    "callback_url": {
      "type": "string",
      "description": "The app's OAuth callback URL."
    },
    "charges_users": {
      "type": "boolean",
      "description": "Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests."
    }
  },
  "x-internal": true,
  "description": "An object describing the app's OAuth properties, or null if OAuth is not configured for the app."
}

{
  "type": "object",
  "nullable": true,
  "properties": {
    "can_insert_everywhere": {
      "type": "boolean",
      "description": "Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document"
    }
  },
  "x-internal": true,
  "description": "An object with options that override account settings."
}

{
  "type": "object",
  "properties": {
    "account_id": {
      "type": "string",
      "description": "The owner account's ID"
    },
    "email_address": {
      "type": "string",
      "description": "The owner account's email address"
    }
  },
  "x-internal": true,
  "description": "An object describing the app's owner"
}

{
  "type": "object",
  "nullable": true,
  "properties": {
    "link_color": {
      "type": "string"
    },
    "text_color1": {
      "type": "string"
    },
    "text_color2": {
      "type": "string"
    },
    "legal_version": {
      "type": "string"
    },
    "primary_button_color": {
      "type": "string"
    },
    "page_background_color": {
      "type": "string"
    },
    "secondary_button_color": {
      "type": "string"
    },
    "header_background_color": {
      "type": "string"
    },
    "primary_button_text_color": {
      "type": "string"
    },
    "primary_button_color_hover": {
      "type": "string"
    },
    "secondary_button_text_color": {
      "type": "string"
    },
    "secondary_button_color_hover": {
      "type": "string"
    },
    "primary_button_text_color_hover": {
      "type": "string"
    },
    "secondary_button_text_color_hover": {
      "type": "string"
    }
  },
  "x-internal": true,
  "description": "An object with options to customize the app's signer page"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name you want to assign to the ApiApp."
    },
    "oauth": {
      "$ref": "#/components/schemas/SubOAuth"
    },
    "domains": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 2,
      "description": "The domain names the ApiApp will be associated with."
    },
    "options": {
      "$ref": "#/components/schemas/SubOptions"
    },
    "callback_url": {
      "type": "string",
      "description": "The URL at which the API App should receive event callbacks."
    },
    "custom_logo_file": {
      "type": "string",
      "format": "binary",
      "description": "An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)"
    },
    "white_labeling_options": {
      "$ref": "#/components/schemas/SubWhiteLabelingOptions"
    }
  }
}

{
  "type": "object",
  "properties": {
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "description": "A list of warnings."
    },
    "list_info": {
      "$ref": "#/components/schemas/ListInfoResponse"
    },
    "bulk_send_job": {
      "$ref": "#/components/schemas/BulkSendJobResponse"
    },
    "signature_requests": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BulkSendJobGetResponseSignatureRequests"
      },
      "description": "Contains information about the Signature Requests sent in bulk."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/SignatureRequestResponse"
    },
    {
      "properties": {
        "bulk_send_job_id": {
          "type": "string",
          "description": "The id of the BulkSendJob."
        }
      }
    }
  ],
  "title": "BulkSendJobGetResponseSignatureRequests",
  "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"
    },
    "bulk_send_jobs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BulkSendJobResponse"
      },
      "description": "Contains a list of BulkSendJobs that the API caller has access to."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "total": {
      "type": "integer",
      "description": "The total amount of Signature Requests queued for sending."
    },
    "created_at": {
      "type": "integer",
      "description": "Time that the BulkSendJob was created."
    },
    "is_creator": {
      "type": "boolean",
      "description": "True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member."
    },
    "bulk_send_job_id": {
      "type": "string",
      "nullable": true,
      "description": "The id of the BulkSendJob."
    }
  },
  "x-internal": true,
  "description": "Contains information about the BulkSendJob such as when it was created and how many signature requests are queued."
}

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

{
  "type": "object",
  "properties": {
    "cc_roles": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request."
    },
    "test_mode": {
      "type": "boolean",
      "default": false,
      "description": "Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`."
    },
    "merge_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubMergeField"
      },
      "description": "Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template.\n\nRemove all merge fields on the template by passing an empty array `[]`."
    },
    "preview_only": {
      "type": "boolean",
      "default": false,
      "description": "This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).\n\n**Note**: This parameter overwrites `show_preview=true` (if set)."
    },
    "show_preview": {
      "type": "boolean",
      "default": false,
      "description": "This allows the requester to enable the editor/preview experience."
    },
    "allow_edit_ccs": {
      "type": "boolean",
      "default": false,
      "description": "This allows the requester to enable/disable to add or change CC roles when editing the template."
    },
    "editor_options": {
      "$ref": "#/components/schemas/SubEditorOptions"
    },
    "force_signer_roles": {
      "type": "boolean",
      "default": false,
      "description": "Provide users the ability to review/edit the template signer roles."
    },
    "force_subject_message": {
      "type": "boolean",
      "default": false,
      "description": "Provide users the ability to review/edit the template subject and message."
    },
    "show_progress_stepper": {
      "type": "boolean",
      "default": true,
      "description": "When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden."
    }
  }
}

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

{
  "type": "object",
  "properties": {
    "edit_url": {
      "type": "string",
      "description": "A template url that can be opened in an iFrame."
    },
    "expires_at": {
      "type": "integer",
      "description": "The specific time that the the `edit_url` link expires, in epoch."
    }
  },
  "x-internal": true,
  "description": "An embedded template object."
}

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

{
  "type": "object",
  "properties": {
    "sign_url": {
      "type": "string",
      "description": "A signature url that can be opened in an iFrame."
    },
    "expires_at": {
      "type": "integer",
      "description": "The specific time that the the `sign_url` link expires, in epoch."
    }
  },
  "x-internal": true,
  "description": "An object that contains necessary information to set up embedded signing."
}

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "$ref": "#/components/schemas/ErrorResponseError"
    }
  }
}

{
  "type": "object",
  "required": [
    "error_msg",
    "error_name"
  ],
  "properties": {
    "error_msg": {
      "type": "string",
      "description": "Message describing an error."
    },
    "error_name": {
      "type": "string",
      "description": "Name of the error."
    },
    "error_path": {
      "type": "string",
      "description": "Path at which an error occurred."
    }
  },
  "description": "Contains information about an error that occurred."
}

{
  "type": "object",
  "title": "EventCallbackRequest",
  "required": [
    "event"
  ],
  "properties": {
    "event": {
      "$ref": "#/components/schemas/EventCallbackRequestEvent"
    },
    "account": {
      "$ref": "#/components/schemas/AccountResponse"
    },
    "template": {
      "$ref": "#/components/schemas/TemplateResponse"
    },
    "signature_request": {
      "$ref": "#/components/schemas/SignatureRequestResponse"
    }
  }
}

{
  "type": "object",
  "required": [
    "event_time",
    "event_type",
    "event_hash"
  ],
  "properties": {
    "event_hash": {
      "type": "string",
      "description": "Generated hash used to verify source of event data."
    },
    "event_time": {
      "type": "string",
      "description": "Time the event was created (using Unix time)."
    },
    "event_type": {
      "enum": [
        "account_confirmed",
        "unknown_error",
        "file_error",
        "sign_url_invalid",
        "signature_request_viewed",
        "signature_request_signed",
        "signature_request_sent",
        "signature_request_all_signed",
        "signature_request_email_bounce",
        "signature_request_remind",
        "signature_request_incomplete_qes",
        "signature_request_destroyed",
        "signature_request_canceled",
        "signature_request_downloadable",
        "signature_request_declined",
        "signature_request_reassigned",
        "signature_request_invalid",
        "signature_request_prepared",
        "signature_request_expired",
        "template_created",
        "template_error",
        "callback_test",
        "signature_request_signer_removed"
      ],
      "type": "string",
      "description": "Type of callback event that was triggered."
    },
    "event_metadata": {
      "$ref": "#/components/schemas/EventCallbackRequestEventMetadata"
    }
  },
  "description": "Basic information about the event that occurred."
}

{
  "type": "object",
  "properties": {
    "event_message": {
      "type": "string",
      "nullable": true,
      "description": "Message about a declined or failed (due to error) signature flow."
    },
    "reported_for_app_id": {
      "type": "string",
      "nullable": true,
      "description": "App ID the event was reported for."
    },
    "related_signature_id": {
      "type": "string",
      "nullable": true,
      "description": "Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events."
    },
    "reported_for_account_id": {
      "type": "string",
      "nullable": true,
      "description": "Account ID the event was reported for."
    }
  },
  "description": "Specific metadata about the event."
}

{
  "type": "object",
  "properties": {
    "file_url": {
      "type": "string",
      "description": "URL to the file."
    },
    "expires_at": {
      "type": "integer",
      "description": "When the link expires."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "data_uri": {
      "type": "string",
      "description": "File as base64 encoded string."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "description": "Number of the page being returned."
    },
    "num_pages": {
      "type": "integer",
      "description": "Total number of pages available."
    },
    "page_size": {
      "type": "integer",
      "description": "Objects returned per page."
    },
    "num_results": {
      "type": "integer",
      "nullable": true,
      "description": "Total number of objects available."
    }
  },
  "x-internal": true,
  "description": "Contains pagination information about the data returned."
}

{
  "type": "object",
  "required": [
    "client_id",
    "client_secret",
    "code",
    "state",
    "grant_type"
  ],
  "properties": {
    "code": {
      "type": "string",
      "description": "The code passed to your callback when the user granted access."
    },
    "state": {
      "type": "string",
      "description": "Same as the state you specified earlier."
    },
    "client_id": {
      "type": "string",
      "description": "The client id of the app requesting authorization."
    },
    "grant_type": {
      "type": "string",
      "default": "authorization_code",
      "description": "When generating a new token use `authorization_code`."
    },
    "client_secret": {
      "type": "string",
      "description": "The secret token of your app."
    }
  }
}

{
  "type": "object",
  "required": [
    "grant_type",
    "refresh_token"
  ],
  "properties": {
    "grant_type": {
      "type": "string",
      "default": "refresh_token",
      "description": "When refreshing an existing token use `refresh_token`."
    },
    "refresh_token": {
      "type": "string",
      "description": "The token provided when you got the expired access token."
    }
  }
}

{
  "type": "object",
  "properties": {
    "state": {
      "type": "string",
      "nullable": true
    },
    "expires_in": {
      "type": "integer",
      "description": "Number of seconds until the `access_token` expires. Uses epoch time."
    },
    "token_type": {
      "type": "string"
    },
    "access_token": {
      "type": "string"
    },
    "refresh_token": {
      "type": "string"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "start_date",
    "end_date",
    "report_type"
  ],
  "properties": {
    "end_date": {
      "type": "string",
      "description": "The (inclusive) end date for the report data in `MM/DD/YYYY` format."
    },
    "start_date": {
      "type": "string",
      "description": "The (inclusive) start date for the report data in `MM/DD/YYYY` format."
    },
    "report_type": {
      "type": "array",
      "items": {
        "enum": [
          "user_activity",
          "document_status"
        ],
        "type": "string"
      },
      "maxItems": 2,
      "minItems": 1,
      "description": "The type(s) of the report you are requesting. Allowed values are `user_activity` and `document_status`. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status)."
    }
  }
}

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

{
  "type": "object",
  "properties": {
    "success": {
      "type": "string",
      "description": "A message indicating the requested operation's success"
    },
    "end_date": {
      "type": "string",
      "description": "The (inclusive) end date for the report data in MM/DD/YYYY format."
    },
    "start_date": {
      "type": "string",
      "description": "The (inclusive) start date for the report data in MM/DD/YYYY format."
    },
    "report_type": {
      "type": "array",
      "items": {
        "enum": [
          "user_activity",
          "document_status"
        ],
        "type": "string"
      },
      "description": "The type(s) of the report you are requesting. Allowed values are \"user_activity\" and \"document_status\". User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status)."
    }
  },
  "x-internal": true,
  "description": "Contains information about the report request."
}

{
  "type": "object",
  "required": [
    "client_id",
    "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."
    },
    "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."
    },
    "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."
    },
    "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`."
    },
    "signer_file": {
      "type": "string",
      "format": "binary",
      "description": "`signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:\n\n- `name`: the name of the signer filling the role of RoleName\n- `email_address`: email address of the signer filling the role of RoleName\n- `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)\n- `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)\n\n    By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).\n\n    **Note**: Not available in test mode and requires a Standard plan or higher.\n- `*_field`: any column with a _field\" suffix will be treated as a custom field (optional)\n\n    You may only specify field values here, any other options should be set in the custom_fields request parameter.\n\nExample CSV:\n\n```\nname, email_address, pin, company_field\nGeorge, george@example.com, d79a3td, ABC Corp\nMary, mary@example.com, gd9as5b, 123 LLC\n```"
    },
    "signer_list": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubBulkSignerList"
      },
      "description": "`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both."
    },
    "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": "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."
    },
    "signing_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully sign."
    }
  }
}

{
  "type": "object",
  "required": [
    "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."
    },
    "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."
    },
    "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."
    },
    "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`."
    },
    "signer_file": {
      "type": "string",
      "format": "binary",
      "description": "`signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:\n\n- `name`: the name of the signer filling the role of RoleName\n- `email_address`: email address of the signer filling the role of RoleName\n- `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)\n- `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)\n\n    By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).\n\n    **Note**: Not available in test mode and requires a Standard plan or higher.\n- `*_field`: any column with a _field\" suffix will be treated as a custom field (optional)\n\n    You may only specify field values here, any other options should be set in the custom_fields request parameter.\n\nExample CSV:\n\n```\nname, email_address, pin, company_field\nGeorge, george@example.com, d79a3td, ABC Corp\nMary, mary@example.com, gd9as5b, 123 LLC\n```"
    },
    "signer_list": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubBulkSignerList"
      },
      "description": "`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both."
    },
    "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": "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."
    },
    "signing_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully sign."
    }
  }
}

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

{
  "type": "object",
  "required": [
    "client_id"
  ],
  "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."
    },
    "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": "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`."
    },
    "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."
    },
    "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."
    },
    "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`"
    },
    "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",
  "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": "string",
  "format": "binary"
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "object",
  "required": [
    "client_id"
  ],
  "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."
    },
    "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": "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`."
    },
    "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."
    },
    "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."
    },
    "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`"
    },
    "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",
  "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`."
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/SubFormFieldsPerDocumentBase"
    },
    {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "default": "text-merge",
          "description": "A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` 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`."
}

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

{
  "type": "object",
  "required": [
    "name",
    "type"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the merge field. Must be unique."
    },
    "type": {
      "enum": [
        "text",
        "checkbox"
      ],
      "type": "string",
      "description": "The type of merge field.",
      "x-enumDescriptions": {
        "text": "Sets merge [field type](/api/reference/constants/#field-types) to `text`.",
        "checkbox": "Sets merge [field type](/api/reference/constants/#field-types) to `checkbox`."
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "scopes": {
      "type": "array",
      "items": {
        "enum": [
          "request_signature",
          "basic_account_info",
          "account_access",
          "signature_request_access",
          "template_access",
          "team_access",
          "api_app_access",
          ""
        ],
        "type": "string"
      },
      "description": "A list of [OAuth scopes](https://raw.githubusercontent.com) to be granted to the app. (Required if `oauth[callback_url]` is provided)."
    },
    "callback_url": {
      "type": "string",
      "description": "The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided)"
    }
  },
  "description": "OAuth related parameters."
}

{
  "type": "object",
  "properties": {
    "can_insert_everywhere": {
      "type": "boolean",
      "default": false,
      "description": "Determines if signers can use \"Insert Everywhere\" when signing a document."
    }
  },
  "description": "Additional options supported by API App."
}

{
  "type": "object",
  "required": [
    "group",
    "signers"
  ],
  "properties": {
    "group": {
      "type": "string",
      "description": "The name of the group."
    },
    "order": {
      "type": "integer",
      "nullable": true,
      "description": "The order the group is required to sign in. Use this instead of Signer-level `order`."
    },
    "signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubSignatureRequestSigner"
      },
      "description": "Signers belonging to this Group.\n\n**NOTE**: Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below."
    }
  }
}

{
  "type": "object",
  "required": [
    "name",
    "email_address"
  ],
  "properties": {
    "pin": {
      "type": "string",
      "maxLength": 12,
      "minLength": 4,
      "description": "The 4- to 12-character access code that will secure this signer's signature page."
    },
    "name": {
      "type": "string",
      "description": "The name of the signer."
    },
    "order": {
      "type": "integer",
      "nullable": true,
      "description": "The order the signer is required to sign in."
    },
    "email_address": {
      "type": "string",
      "format": "email",
      "description": "The email address of the signer."
    },
    "sms_phone_number": {
      "type": "string",
      "description": "An E.164 formatted phone number.\n\nBy using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).\n\n**Note**: Not available in test mode and requires a Standard plan or higher."
    },
    "sms_phone_number_type": {
      "enum": [
        "authentication",
        "delivery"
      ],
      "type": "string",
      "description": "Specifies the feature used with the `sms_phone_number`. Default `authentication`.\n\nIf `authentication`, signer is sent a verification code via SMS that is required to access the document.\n\nIf `delivery`, a link to complete the signature request is delivered via SMS (_and_ email)."
    }
  }
}

{
  "type": "object",
  "required": [
    "role",
    "name",
    "email_address"
  ],
  "properties": {
    "pin": {
      "type": "string",
      "maxLength": 12,
      "minLength": 4,
      "description": "The 4- to 12-character access code that will secure this signer's signature page."
    },
    "name": {
      "type": "string",
      "description": "The name of the signer."
    },
    "role": {
      "type": "string",
      "description": "Must match an existing role in chosen Template(s). It's case-sensitive."
    },
    "email_address": {
      "type": "string",
      "format": "email",
      "description": "The email address of the signer."
    },
    "sms_phone_number": {
      "type": "string",
      "description": "An E.164 formatted phone number.\n\nBy using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).\n\n**Note**: Not available in test mode and requires a Standard plan or higher."
    },
    "sms_phone_number_type": {
      "enum": [
        "authentication",
        "delivery"
      ],
      "type": "string",
      "description": "Specifies the feature used with the `sms_phone_number`. Default `authentication`.\n\nIf `authentication`, signer is sent a verification code via SMS that is required to access the document.\n\nIf `delivery`, a link to complete the signature request is delivered via SMS (_and_ email)."
    }
  }
}

{
  "type": "object",
  "required": [
    "default_type"
  ],
  "properties": {
    "draw": {
      "type": "boolean",
      "default": false,
      "description": "Allows drawing the signature"
    },
    "type": {
      "type": "boolean",
      "default": false,
      "description": "Allows typing the signature"
    },
    "phone": {
      "type": "boolean",
      "default": false,
      "description": "Allows using a smartphone to email the signature"
    },
    "upload": {
      "type": "boolean",
      "default": false,
      "description": "Allows uploading the signature"
    },
    "default_type": {
      "enum": [
        "draw",
        "phone",
        "type",
        "upload"
      ],
      "type": "string",
      "description": "The default type shown (limited to the listed types)"
    }
  },
  "description": "This allows the requester to specify the types allowed for creating a signature.\n\n**Note**: If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings."
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of a team"
    },
    "team_id": {
      "type": "string",
      "description": "The id of a team"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The role name of the signer that will be displayed when the template is used to create a signature request."
    },
    "order": {
      "type": "integer",
      "nullable": true,
      "description": "The order in which this signer role is required to sign."
    }
  }
}

{
  "type": "object",
  "required": [
    "name",
    "email_address"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the signer."
    },
    "order": {
      "type": "integer",
      "nullable": true,
      "description": "The order the signer is required to sign in."
    },
    "email_address": {
      "type": "string",
      "format": "email",
      "description": "The email address of the signer."
    }
  }
}

{
  "type": "object",
  "required": [
    "role",
    "name",
    "email_address"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the signer filling the role of `role`."
    },
    "role": {
      "type": "string",
      "description": "Must match an existing role in chosen Template(s)."
    },
    "email_address": {
      "type": "string",
      "format": "email",
      "description": "The email address of the signer filling the role of `role`."
    }
  }
}

{
  "type": "object",
  "properties": {
    "link_color": {
      "type": "string",
      "default": "#00B3E6"
    },
    "text_color1": {
      "type": "string",
      "default": "#808080"
    },
    "text_color2": {
      "type": "string",
      "default": "#FFFFFF"
    },
    "legal_version": {
      "enum": [
        "terms1",
        "terms2"
      ],
      "type": "string",
      "default": "terms1"
    },
    "reset_to_default": {
      "type": "boolean",
      "description": "Resets white labeling options to defaults. Only useful when updating an API App."
    },
    "primary_button_color": {
      "type": "string",
      "default": "#00B3E6"
    },
    "page_background_color": {
      "type": "string",
      "default": "#F7F8F9"
    },
    "secondary_button_color": {
      "type": "string",
      "default": "#FFFFFF"
    },
    "header_background_color": {
      "type": "string",
      "default": "#1A1A1A"
    },
    "primary_button_text_color": {
      "type": "string",
      "default": "#FFFFFF"
    },
    "primary_button_color_hover": {
      "type": "string",
      "default": "#00B3E6"
    },
    "secondary_button_text_color": {
      "type": "string",
      "default": "#00B3E6"
    },
    "secondary_button_color_hover": {
      "type": "string",
      "default": "#FFFFFF"
    },
    "primary_button_text_color_hover": {
      "type": "string",
      "default": "#FFFFFF"
    },
    "secondary_button_text_color_hover": {
      "type": "string",
      "default": "#00B3E6"
    }
  },
  "description": "An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans)\n\nTake a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more."
}

{
  "type": "object",
  "properties": {
    "role": {
      "enum": [
        "Member",
        "Developer",
        "Team Manager",
        "Admin"
      ],
      "type": "string",
      "description": "A role member will take in a new Team.\n\n**Note**: This parameter is used only if `team_id` is provided."
    },
    "account_id": {
      "type": "string",
      "description": "`account_id` or `email_address` is required. If both are provided, the account id prevails.\n\nAccount id of the user to invite to your Team."
    },
    "email_address": {
      "type": "string",
      "format": "email",
      "description": "`account_id` or `email_address` is required, If both are provided, the account id prevails.\n\nEmail address of the user to invite to your Team."
    }
  }
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "default": "Untitled Team",
      "description": "The name of your Team."
    }
  }
}

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

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

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of a team"
    },
    "team_id": {
      "type": "string",
      "description": "The id of a team"
    },
    "num_members": {
      "type": "integer",
      "description": "Number of members within a team"
    },
    "team_parent": {
      "$ref": "#/components/schemas/TeamParentResponse"
    },
    "num_sub_teams": {
      "type": "integer",
      "description": "Number of sub teams within a team"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "role": {
      "type": "string",
      "description": "Role of the user invited to this team."
    },
    "sent_at": {
      "type": "integer",
      "description": "Timestamp when the invitation was sent."
    },
    "team_id": {
      "type": "string",
      "description": "Id of the team."
    },
    "expires_at": {
      "type": "integer",
      "description": "Timestamp when the invitation is expiring."
    },
    "redeemed_at": {
      "type": "integer",
      "description": "Timestamp when the invitation was redeemed."
    },
    "email_address": {
      "type": "string",
      "description": "Email address of the user invited to this team."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      }
    },
    "team_invites": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TeamInviteResponse"
      },
      "description": "Contains a list of team invites and their roles."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "role": {
      "type": "string",
      "description": "The specific role a member has on the team."
    },
    "account_id": {
      "type": "string",
      "description": "Account id of the team member."
    },
    "email_address": {
      "type": "string",
      "description": "Email address of the team member."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      }
    },
    "list_info": {
      "$ref": "#/components/schemas/ListInfoResponse"
    },
    "team_members": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TeamMemberResponse"
      },
      "description": "Contains a list of team members and their roles for a specific team."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "nullable": true,
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of a team"
    },
    "team_id": {
      "type": "string",
      "description": "The id of a team"
    }
  },
  "x-internal": true,
  "description": "Information about the parent team if a team has one, set to `null` otherwise."
}

{
  "type": "object",
  "properties": {
    "new_role": {
      "enum": [
        "Member",
        "Developer",
        "Team Manager",
        "Admin"
      ],
      "type": "string",
      "description": "A new role member will take in a new Team.\n\n**Note**: This parameter is used only if `new_team_id` is provided."
    },
    "account_id": {
      "type": "string",
      "description": "**account_id** or **email_address** is required. If both are provided, the account id prevails.\n\nAccount id to remove from your Team."
    },
    "new_team_id": {
      "type": "string",
      "description": "Id of the new Team."
    },
    "email_address": {
      "type": "string",
      "format": "email",
      "description": "**account_id** or **email_address** is required. If both are provided, the account id prevails.\n\nEmail address of the Account to remove from your Team."
    },
    "new_owner_email_address": {
      "type": "string",
      "format": "email",
      "description": "The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account.\n\n**Note**: Only available for Enterprise plans."
    }
  }
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of your Team"
    },
    "accounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AccountResponse"
      }
    },
    "invited_emails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account."
    },
    "invited_accounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AccountResponse"
      },
      "description": "A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`."
    }
  },
  "x-internal": true,
  "description": "Contains information about your team and its members"
}

{
  "type": "object",
  "properties": {
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      }
    },
    "list_info": {
      "$ref": "#/components/schemas/ListInfoResponse"
    },
    "sub_teams": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubTeamResponse"
      },
      "description": "Contains a list with sub teams."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of your Team."
    }
  }
}

{
  "type": "object",
  "properties": {
    "account_id": {
      "type": "string",
      "description": "The id of the Account to give access to the Template.\n<b>Note</b> The account id prevails if email address is also provided."
    },
    "email_address": {
      "type": "string",
      "format": "email",
      "description": "The email address of the Account to give access to the Template.\n<b>Note</b> The account id prevails if it is also provided."
    },
    "skip_notification": {
      "type": "boolean",
      "default": false,
      "description": "If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`."
    }
  }
}

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

{
  "type": "object",
  "required": [
    "client_id"
  ],
  "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",
      "description": "The title you want to assign to the SignatureRequest."
    },
    "message": {
      "type": "string",
      "maxLength": 5000,
      "description": "The default template email message."
    },
    "subject": {
      "type": "string",
      "maxLength": 200,
      "description": "The template title (alias)."
    },
    "cc_roles": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The CC roles that must be assigned when using the template to send a signature request"
    },
    "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": {}
    },
    "allow_ccs": {
      "type": "boolean",
      "default": true,
      "description": "This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template."
    },
    "client_id": {
      "type": "string",
      "description": "Client id of the app you're using to create this draft. 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 created from this draft will not be legally binding if set to `true`. Defaults to `false`."
    },
    "attachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubAttachment"
      },
      "description": "A list describing the attachments"
    },
    "skip_me_now": {
      "type": "boolean",
      "default": false,
      "description": "Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`."
    },
    "merge_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubMergeField"
      },
      "description": "Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter.\nIf the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document."
    },
    "show_preview": {
      "type": "boolean",
      "default": false,
      "description": "This allows the requester to enable the editor/preview experience.\n\n- `show_preview=true`: Allows requesters to enable the editor/preview experience.\n- `show_preview=false`: Allows requesters to disable the editor/preview experience."
    },
    "signer_roles": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubTemplateRole"
      },
      "description": "An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template."
    },
    "field_options": {
      "$ref": "#/components/schemas/SubFieldOptions"
    },
    "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."
    },
    "editor_options": {
      "$ref": "#/components/schemas/SubEditorOptions"
    },
    "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`."
    },
    "force_signer_roles": {
      "type": "boolean",
      "default": false,
      "description": "Provide users the ability to review/edit the template signer roles."
    },
    "force_subject_message": {
      "type": "boolean",
      "default": false,
      "description": "Provide users the ability to review/edit the template subject and message."
    },
    "show_progress_stepper": {
      "type": "boolean",
      "default": true,
      "description": "When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden."
    },
    "use_preexisting_fields": {
      "type": "boolean",
      "default": false,
      "description": "Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`)."
    },
    "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",
  "properties": {
    "template": {
      "$ref": "#/components/schemas/TemplateCreateEmbeddedDraftResponseTemplate"
    },
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "description": "A list of warnings."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "edit_url": {
      "type": "string",
      "description": "Link to edit the template."
    },
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "deprecated": true,
      "description": "A list of warnings."
    },
    "expires_at": {
      "type": "integer",
      "description": "When the link expires."
    },
    "template_id": {
      "type": "string",
      "description": "The id of the Template."
    }
  },
  "x-internal": true,
  "description": "Template object with parameters: `template_id`, `edit_url`, `expires_at`."
}

{
  "type": "object",
  "required": [
    "signer_roles",
    "form_fields_per_document"
  ],
  "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",
      "description": "The title you want to assign to the SignatureRequest."
    },
    "message": {
      "type": "string",
      "maxLength": 5000,
      "description": "The default template email message."
    },
    "subject": {
      "type": "string",
      "maxLength": 200,
      "description": "The template title (alias)."
    },
    "cc_roles": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The CC roles that must be assigned when using the template to send a signature request"
    },
    "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 draft. 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 created from this draft will not be legally binding if set to `true`. Defaults to `false`."
    },
    "attachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubAttachment"
      },
      "description": "A list describing the attachments"
    },
    "merge_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubMergeField"
      },
      "description": "Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter.\nIf the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document."
    },
    "signer_roles": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubTemplateRole"
      },
      "description": "An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template."
    },
    "field_options": {
      "$ref": "#/components/schemas/SubFieldOptions"
    },
    "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."
    },
    "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`."
    },
    "use_preexisting_fields": {
      "type": "boolean",
      "default": false,
      "description": "Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`)."
    },
    "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",
  "properties": {
    "template": {
      "$ref": "#/components/schemas/TemplateCreateResponseTemplate"
    },
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "description": "A list of warnings."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "template_id": {
      "type": "string",
      "description": "The id of the Template."
    }
  },
  "x-internal": true,
  "description": "Template object with parameters: `template_id`."
}

{
  "type": "object",
  "properties": {
    "template_id": {
      "type": "string",
      "description": "The id of the Template."
    }
  }
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "object",
  "properties": {
    "template": {
      "$ref": "#/components/schemas/TemplateResponse"
    },
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "description": "A list of warnings."
    }
  },
  "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"
    },
    "templates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TemplateResponse"
      },
      "description": "List of templates that the API caller has access to."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "account_id": {
      "type": "string",
      "description": "The id or email address of the Account to remove access to the Template. The account id prevails if both are provided."
    },
    "email_address": {
      "type": "string",
      "format": "email",
      "description": "The id or email address of the Account to remove access to the Template. The account id prevails if both are provided."
    }
  }
}

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest."
    },
    "message": {
      "type": "string",
      "description": "The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest."
    },
    "accounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TemplateResponseAccount"
      },
      "nullable": true,
      "description": "An array of the Accounts that can use this Template."
    },
    "can_edit": {
      "type": "boolean",
      "nullable": true,
      "description": "Indicates whether edit rights have been granted to you by the owner (always `true` if that's you)."
    },
    "cc_roles": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TemplateResponseCCRole"
      },
      "description": "An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template."
    },
    "metadata": {
      "type": "object",
      "description": "The metadata attached to the template."
    },
    "documents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TemplateResponseDocument"
      },
      "description": "An array describing each document associated with this Template. Includes form field data for each document."
    },
    "is_locked": {
      "type": "boolean",
      "nullable": true,
      "description": "Indicates whether the template is locked.\nIf `true`, then the template was created outside your quota and can only be used in `test_mode`.\nIf `false`, then the template is within your quota and can be used to create signature requests."
    },
    "is_creator": {
      "type": "boolean",
      "nullable": true,
      "description": "`true` if you are the owner of this template, `false` if it's been shared with you by a team member."
    },
    "updated_at": {
      "type": "integer",
      "description": "Time the template was last updated."
    },
    "is_embedded": {
      "type": "boolean",
      "nullable": true,
      "description": "`true` if this template was created using an embedded flow, `false` if it was created on our website."
    },
    "template_id": {
      "type": "string",
      "description": "The id of the Template."
    },
    "signer_roles": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TemplateResponseSignerRole"
      },
      "description": "An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TemplateResponseDocumentCustomFieldBase"
      },
      "nullable": true,
      "deprecated": true,
      "description": "Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead."
    },
    "named_form_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TemplateResponseDocumentFormFieldBase"
      },
      "nullable": true,
      "deprecated": true,
      "description": "Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead."
    }
  },
  "x-internal": true,
  "description": "Contains information about the templates you and your team have created."
}

{
  "type": "object",
  "properties": {
    "quotas": {
      "$ref": "#/components/schemas/TemplateResponseAccountQuota"
    },
    "is_locked": {
      "type": "boolean",
      "description": "Returns `true` if the user has been locked out of their account by a team admin."
    },
    "account_id": {
      "type": "string",
      "description": "The id of the Account."
    },
    "is_paid_hf": {
      "type": "boolean",
      "description": "Returns `true` if the user has a paid HelloFax account."
    },
    "is_paid_hs": {
      "type": "boolean",
      "description": "Returns `true` if the user has a paid Dropbox Sign account."
    },
    "email_address": {
      "type": "string",
      "description": "The email address associated with the Account."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "documents_left": {
      "type": "integer",
      "description": "Signature requests remaining."
    },
    "templates_left": {
      "type": "integer",
      "description": "API templates remaining."
    },
    "sms_verifications_left": {
      "type": "integer",
      "description": "SMS verifications remaining."
    },
    "api_signature_requests_left": {
      "type": "integer",
      "description": "API signature requests remaining."
    }
  },
  "x-internal": true,
  "description": "An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template."
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the Role."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the associated file."
    },
    "index": {
      "type": "integer",
      "description": "Document ordering, the lowest index is displayed first and the highest last (0-based indexing)."
    },
    "form_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TemplateResponseDocumentFormFieldBase"
      },
      "description": "An array of Form Field objects containing the name and type of each named field."
    },
    "field_groups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TemplateResponseDocumentFieldGroup"
      },
      "description": "An array of Form Field Group objects."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TemplateResponseDocumentCustomFieldBase"
      },
      "description": "An array of Form Field objects containing the name and type of each named field."
    },
    "static_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TemplateResponseDocumentStaticFieldBase"
      },
      "nullable": true,
      "description": "An array describing static overlay fields. **Note** only available for certain subscriptions."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "x": {
      "type": "integer",
      "description": "The horizontal offset in pixels for this form field."
    },
    "y": {
      "type": "integer",
      "description": "The vertical offset in pixels for this form field."
    },
    "name": {
      "type": "string",
      "description": "The name of the Custom Field."
    },
    "type": {
      "type": "string"
    },
    "group": {
      "type": "string",
      "nullable": true,
      "description": "The name of the group this field is in. If this field is not a group, this defaults to `null`."
    },
    "width": {
      "type": "integer",
      "description": "The width in pixels of this form field."
    },
    "api_id": {
      "type": "string",
      "description": "The unique ID for this field."
    },
    "height": {
      "type": "integer",
      "description": "The height in pixels of this form field."
    },
    "signer": {
      "type": "string",
      "nullable": true,
      "description": "The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender)."
    },
    "required": {
      "type": "boolean",
      "description": "Boolean showing whether or not this field is required."
    }
  },
  "x-internal": true,
  "description": "An array of Form Field objects containing the name and type of each named field.",
  "x-base-class": true,
  "discriminator": {
    "mapping": {
      "text": "#/components/schemas/TemplateResponseDocumentCustomFieldText",
      "checkbox": "#/components/schemas/TemplateResponseDocumentCustomFieldCheckbox"
    },
    "propertyName": "type"
  }
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentCustomFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "checkbox",
          "description": "The type of this Custom Field. Only `text` and `checkbox` are currently supported.\n\n* Text uses `TemplateResponseDocumentCustomFieldText`\n* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentCustomFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentCustomFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "text",
          "description": "The type of this Custom Field. Only `text` and `checkbox` are currently supported.\n\n* Text uses `TemplateResponseDocumentCustomFieldText`\n* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`"
        },
        "fontFamily": {
          "type": "string",
          "description": "Font family used in this form field's text."
        },
        "isMultiline": {
          "type": "boolean",
          "description": "Whether this form field is multiline text."
        },
        "avg_text_length": {
          "$ref": "#/components/schemas/TemplateResponseFieldAvgTextLength"
        },
        "originalFontSize": {
          "type": "integer",
          "description": "Original font size used in this form field's text."
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentCustomFieldBase`"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the form field group."
    },
    "rule": {
      "$ref": "#/components/schemas/TemplateResponseDocumentFieldGroupRule"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "groupLabel": {
      "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."
    }
  },
  "x-internal": true,
  "description": "The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping)."
}

{
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "x": {
      "type": "integer",
      "description": "The horizontal offset in pixels for this form field."
    },
    "y": {
      "type": "integer",
      "description": "The vertical offset in pixels for this form field."
    },
    "name": {
      "type": "string",
      "description": "The name of the form field."
    },
    "type": {
      "type": "string"
    },
    "group": {
      "type": "string",
      "nullable": true,
      "description": "The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields."
    },
    "width": {
      "type": "integer",
      "description": "The width in pixels of this form field."
    },
    "api_id": {
      "type": "string",
      "description": "A unique id for the form field."
    },
    "height": {
      "type": "integer",
      "description": "The height in pixels of this form field."
    },
    "signer": {
      "type": "string",
      "description": "The signer of the Form Field."
    },
    "required": {
      "type": "boolean",
      "description": "Boolean showing whether or not this field is required."
    }
  },
  "x-internal": true,
  "description": "An array of Form Field objects containing the name and type of each named field.",
  "x-base-class": true,
  "discriminator": {
    "mapping": {
      "text": "#/components/schemas/TemplateResponseDocumentFormFieldText",
      "radio": "#/components/schemas/TemplateResponseDocumentFormFieldRadio",
      "checkbox": "#/components/schemas/TemplateResponseDocumentFormFieldCheckbox",
      "dropdown": "#/components/schemas/TemplateResponseDocumentFormFieldDropdown",
      "initials": "#/components/schemas/TemplateResponseDocumentFormFieldInitials",
      "hyperlink": "#/components/schemas/TemplateResponseDocumentFormFieldHyperlink",
      "signature": "#/components/schemas/TemplateResponseDocumentFormFieldSignature",
      "date_signed": "#/components/schemas/TemplateResponseDocumentFormFieldDateSigned"
    },
    "propertyName": "type"
  }
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentFormFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "checkbox",
          "description": "The type of this form field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentFormFieldText`\n* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentFormFieldRadio`\n* Signature Field uses `TemplateResponseDocumentFormFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentFormFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentFormFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentFormFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "date_signed",
          "description": "The type of this form field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentFormFieldText`\n* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentFormFieldRadio`\n* Signature Field uses `TemplateResponseDocumentFormFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentFormFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentFormFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentFormFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "dropdown",
          "description": "The type of this form field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentFormFieldText`\n* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentFormFieldRadio`\n* Signature Field uses `TemplateResponseDocumentFormFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentFormFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentFormFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentFormFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "hyperlink",
          "description": "The type of this form field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentFormFieldText`\n* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentFormFieldRadio`\n* Signature Field uses `TemplateResponseDocumentFormFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentFormFieldInitials`"
        },
        "fontFamily": {
          "type": "string",
          "description": "Font family used in this form field's text."
        },
        "isMultiline": {
          "type": "boolean",
          "description": "Whether this form field is multiline text."
        },
        "avg_text_length": {
          "$ref": "#/components/schemas/TemplateResponseFieldAvgTextLength"
        },
        "originalFontSize": {
          "type": "integer",
          "description": "Original font size used in this form field's text."
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentFormFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentFormFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "initials",
          "description": "The type of this form field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentFormFieldText`\n* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentFormFieldRadio`\n* Signature Field uses `TemplateResponseDocumentFormFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentFormFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentFormFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentFormFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "radio",
          "description": "The type of this form field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentFormFieldText`\n* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentFormFieldRadio`\n* Signature Field uses `TemplateResponseDocumentFormFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentFormFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type",
    "group"
  ],
  "description": "This class extends `TemplateResponseDocumentFormFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentFormFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "signature",
          "description": "The type of this form field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentFormFieldText`\n* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentFormFieldRadio`\n* Signature Field uses `TemplateResponseDocumentFormFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentFormFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentFormFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentFormFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "text",
          "description": "The type of this form field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentFormFieldText`\n* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentFormFieldRadio`\n* Signature Field uses `TemplateResponseDocumentFormFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentFormFieldInitials`"
        },
        "fontFamily": {
          "type": "string",
          "description": "Font family used in this form field's text."
        },
        "isMultiline": {
          "type": "boolean",
          "description": "Whether this form field is multiline text."
        },
        "avg_text_length": {
          "$ref": "#/components/schemas/TemplateResponseFieldAvgTextLength"
        },
        "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",
          "nullable": true,
          "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."
        },
        "originalFontSize": {
          "type": "integer",
          "description": "Original font size used in this form field's text."
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentFormFieldBase`"
}

{
  "type": "object",
  "required": [
    "type"
  ],
  "properties": {
    "x": {
      "type": "integer",
      "description": "The horizontal offset in pixels for this static field."
    },
    "y": {
      "type": "integer",
      "description": "The vertical offset in pixels for this static field."
    },
    "name": {
      "type": "string",
      "description": "The name of the static field."
    },
    "type": {
      "type": "string"
    },
    "group": {
      "type": "string",
      "nullable": true,
      "description": "The name of the group this field is in. If this field is not a group, this defaults to `null`."
    },
    "width": {
      "type": "integer",
      "description": "The width in pixels of this static field."
    },
    "api_id": {
      "type": "string",
      "description": "A unique id for the static field."
    },
    "height": {
      "type": "integer",
      "description": "The height in pixels of this static field."
    },
    "signer": {
      "type": "string",
      "default": "me_now",
      "description": "The signer of the Static Field."
    },
    "required": {
      "type": "boolean",
      "description": "Boolean showing whether or not this field is required."
    }
  },
  "x-internal": true,
  "description": "An array describing static overlay fields. **Note** only available for certain subscriptions.",
  "x-base-class": true,
  "discriminator": {
    "mapping": {
      "text": "#/components/schemas/TemplateResponseDocumentStaticFieldText",
      "radio": "#/components/schemas/TemplateResponseDocumentStaticFieldRadio",
      "checkbox": "#/components/schemas/TemplateResponseDocumentStaticFieldCheckbox",
      "dropdown": "#/components/schemas/TemplateResponseDocumentStaticFieldDropdown",
      "initials": "#/components/schemas/TemplateResponseDocumentStaticFieldInitials",
      "hyperlink": "#/components/schemas/TemplateResponseDocumentStaticFieldHyperlink",
      "signature": "#/components/schemas/TemplateResponseDocumentStaticFieldSignature",
      "date_signed": "#/components/schemas/TemplateResponseDocumentStaticFieldDateSigned"
    },
    "propertyName": "type"
  }
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentStaticFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "checkbox",
          "description": "The type of this static field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentStaticFieldText`\n* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`\n* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentStaticFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentStaticFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "date_signed",
          "description": "The type of this static field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentStaticFieldText`\n* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`\n* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentStaticFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentStaticFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "dropdown",
          "description": "The type of this static field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentStaticFieldText`\n* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`\n* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentStaticFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentStaticFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "hyperlink",
          "description": "The type of this static field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentStaticFieldText`\n* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`\n* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentStaticFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentStaticFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "initials",
          "description": "The type of this static field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentStaticFieldText`\n* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`\n* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentStaticFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentStaticFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "radio",
          "description": "The type of this static field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentStaticFieldText`\n* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`\n* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentStaticFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentStaticFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "signature",
          "description": "The type of this static field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentStaticFieldText`\n* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`\n* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentStaticFieldBase`"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/TemplateResponseDocumentStaticFieldBase"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "default": "text",
          "description": "The type of this static field. See [field types](/api/reference/constants/#field-types).\n\n* Text Field uses `TemplateResponseDocumentStaticFieldText`\n* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`\n* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`\n* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`\n* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`\n* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`\n* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`\n* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`"
        }
      }
    }
  ],
  "required": [
    "type"
  ],
  "description": "This class extends `TemplateResponseDocumentStaticFieldBase`"
}

{
  "type": "object",
  "properties": {
    "num_lines": {
      "type": "integer",
      "description": "Number of lines."
    },
    "num_chars_per_line": {
      "type": "integer",
      "description": "Number of characters per line."
    }
  },
  "x-internal": true,
  "description": "Average text length in this field."
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the Role."
    },
    "order": {
      "type": "integer",
      "description": "If signer order is assigned this is the 0-based index for this role."
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      },
      "description": "Use `files[]` to indicate the uploaded file(s) to use for the template.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "message": {
      "type": "string",
      "maxLength": 5000,
      "description": "The new default template email message."
    },
    "subject": {
      "type": "string",
      "maxLength": 100,
      "description": "The new default template email subject."
    },
    "client_id": {
      "type": "string",
      "description": "Client id of the app you're using to update this template."
    },
    "file_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `file_urls[]` to have Dropbox Sign download the file(s) to use for the template.\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 created from this draft will not be legally binding if set to `true`. Defaults to `false`."
    }
  }
}

{
  "type": "object",
  "properties": {
    "template": {
      "$ref": "#/components/schemas/TemplateUpdateFilesResponseTemplate"
    }
  },
  "x-internal": true
}

{
  "type": "object",
  "properties": {
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "deprecated": true,
      "description": "A list of warnings."
    },
    "template_id": {
      "type": "string",
      "description": "The id of the Template."
    }
  },
  "x-internal": true,
  "description": "Contains template id"
}

{
  "type": "object",
  "required": [
    "client_id",
    "requester_email_address"
  ],
  "properties": {
    "type": {
      "enum": [
        "send_document",
        "request_signature"
      ],
      "type": "string",
      "default": "request_signature",
      "description": "The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it."
    },
    "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."
    },
    "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/SubUnclaimedDraftSigner"
      },
      "description": "Add Signers to your Unclaimed Draft Signature Request."
    },
    "subject": {
      "type": "string",
      "maxLength": 200,
      "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": {}
    },
    "allow_ccs": {
      "type": "boolean",
      "default": true,
      "description": "This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft."
    },
    "client_id": {
      "type": "string",
      "description": "Client id of the app used to create the draft. 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 created from this draft 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.\n\n**Note**: This does not correspond to the **expires_at** returned in the response."
    },
    "attachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubAttachment"
      },
      "description": "A list describing the attachments"
    },
    "skip_me_now": {
      "type": "boolean",
      "default": false,
      "description": "Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`."
    },
    "hold_request": {
      "type": "boolean",
      "default": false,
      "description": "The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](https://raw.githubusercontent.com) the request from hold when ready to send. Defaults to `false`."
    },
    "show_preview": {
      "type": "boolean",
      "description": "This allows the requester to enable the editor/preview experience.\n\n- `show_preview=true`: Allows requesters to enable the editor/preview experience.\n- `show_preview=false`: Allows requesters to disable the editor/preview experience."
    },
    "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": "Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both."
    },
    "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."
    },
    "editor_options": {
      "$ref": "#/components/schemas/SubEditorOptions"
    },
    "hide_text_tags": {
      "type": "boolean",
      "default": false,
      "description": "Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details."
    },
    "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`."
    },
    "force_signer_page": {
      "type": "boolean",
      "default": false,
      "description": "Provide users the ability to review/edit the signers."
    },
    "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."
    },
    "force_subject_message": {
      "type": "boolean",
      "default": false,
      "description": "Provide users the ability to review/edit the subject and message."
    },
    "show_progress_stepper": {
      "type": "boolean",
      "default": true,
      "description": "When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden."
    },
    "use_preexisting_fields": {
      "type": "boolean",
      "default": false,
      "description": "Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both."
    },
    "is_for_embedded_signing": {
      "type": "boolean",
      "default": false,
      "description": "The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`."
    },
    "requester_email_address": {
      "type": "string",
      "format": "email",
      "description": "The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`."
    },
    "requesting_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully request a signature."
    },
    "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`"
    },
    "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."
    }
  },
  "description": ""
}

{
  "type": "object",
  "required": [
    "client_id",
    "requester_email_address",
    "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 append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored.\n\n**files** or **file_urls[]** is required, 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/SubUnclaimedDraftTemplateSigner"
      },
      "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": {}
    },
    "allow_ccs": {
      "type": "boolean",
      "default": false,
      "description": "This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft."
    },
    "client_id": {
      "type": "string",
      "description": "Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app."
    },
    "file_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use file_urls[] to append additional files to the signature request being created from the template. Dropbox Sign will download the file, then parse it for [text tags](https://app.hellosign.com/api/textTagsWalkthrough), and append to the signature request. Text tags for signers not on the template(s) will be ignored.\n\n**files** or **file_urls[]** is required, but not both."
    },
    "test_mode": {
      "type": "boolean",
      "default": false,
      "description": "Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`."
    },
    "skip_me_now": {
      "type": "boolean",
      "default": false,
      "description": "Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`."
    },
    "hold_request": {
      "type": "boolean",
      "default": false,
      "description": "The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](https://raw.githubusercontent.com) the request from hold when ready to send. Defaults to `false`."
    },
    "preview_only": {
      "type": "boolean",
      "default": false,
      "description": "This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).\n\n- `preview_only=true`: Allows requesters to enable the preview only experience.\n- `preview_only=false`: Allows requesters to disable the preview only experience.\n\n**Note**: This parameter overwrites `show_preview=1` (if set)."
    },
    "show_preview": {
      "type": "boolean",
      "default": false,
      "description": "This allows the requester to enable the editor/preview experience.\n\n- `show_preview=true`: Allows requesters to enable the editor/preview experience.\n- `show_preview=false`: Allows requesters to disable the editor/preview experience."
    },
    "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 templates 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."
    },
    "field_options": {
      "$ref": "#/components/schemas/SubFieldOptions"
    },
    "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."
    },
    "editor_options": {
      "$ref": "#/components/schemas/SubEditorOptions"
    },
    "signing_options": {
      "$ref": "#/components/schemas/SubSigningOptions"
    },
    "force_signer_roles": {
      "type": "boolean",
      "default": false,
      "description": "Provide users the ability to review/edit the template signer roles."
    },
    "signing_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully sign."
    },
    "force_subject_message": {
      "type": "boolean",
      "default": false,
      "description": "Provide users the ability to review/edit the template subject and message."
    },
    "show_progress_stepper": {
      "type": "boolean",
      "default": true,
      "description": "When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden."
    },
    "is_for_embedded_signing": {
      "type": "boolean",
      "default": false,
      "description": "The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`."
    },
    "requester_email_address": {
      "type": "string",
      "format": "email",
      "description": "The email address of the user that should be designated as the requester of this draft."
    },
    "requesting_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully request a signature."
    },
    "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",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "send_document",
        "request_signature"
      ],
      "type": "string",
      "description": "The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional."
    },
    "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."
    },
    "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/SubUnclaimedDraftSigner"
      },
      "description": "Add Signers to your Unclaimed Draft Signature Request."
    },
    "subject": {
      "type": "string",
      "maxLength": 200,
      "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 used to create the draft. 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 created from this draft 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.\n\n**Note**: This does not correspond to the **expires_at** returned in the response."
    },
    "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": "Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both."
    },
    "hide_text_tags": {
      "type": "boolean",
      "default": false,
      "description": "Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details."
    },
    "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."
    },
    "show_progress_stepper": {
      "type": "boolean",
      "default": true,
      "description": "When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden."
    },
    "use_preexisting_fields": {
      "type": "boolean",
      "default": false,
      "description": "Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both."
    },
    "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`"
    }
  },
  "description": ""
}

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

{
  "type": "object",
  "required": [
    "client_id"
  ],
  "properties": {
    "client_id": {
      "type": "string",
      "description": "Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app."
    },
    "test_mode": {
      "type": "boolean",
      "default": false,
      "description": "Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`."
    },
    "editor_options": {
      "$ref": "#/components/schemas/SubEditorOptions"
    },
    "signing_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully sign."
    },
    "show_progress_stepper": {
      "type": "boolean",
      "default": true,
      "description": "When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden."
    },
    "is_for_embedded_signing": {
      "type": "boolean",
      "description": "The request created from this draft will also be signable in embedded mode if set to `true`."
    },
    "requester_email_address": {
      "type": "string",
      "format": "email",
      "description": "The email address of the user that should be designated as the requester of this draft. If not set, original requester's email address will be used."
    },
    "requesting_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully request a signature."
    }
  }
}

{
  "type": "object",
  "properties": {
    "claim_url": {
      "type": "string",
      "description": "The URL to be used to claim this UnclaimedDraft."
    },
    "test_mode": {
      "type": "boolean",
      "description": "Whether this is a test draft. Signature requests made from test drafts have no legal value."
    },
    "expires_at": {
      "type": "integer",
      "nullable": true,
      "description": "When the link expires."
    },
    "signature_request_id": {
      "type": "string",
      "nullable": true,
      "description": "The ID of the signature request that is represented by this UnclaimedDraft."
    },
    "signing_redirect_url": {
      "type": "string",
      "nullable": true,
      "description": "The URL you want signers redirected to after they successfully sign."
    },
    "requesting_redirect_url": {
      "type": "string",
      "nullable": true,
      "description": "The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.)."
    }
  },
  "x-internal": true,
  "description": "A group of documents that a user can take ownership of via the claim URL."
}

{
  "type": "object",
  "required": [
    "warning_msg",
    "warning_name"
  ],
  "properties": {
    "warning_msg": {
      "type": "string",
      "description": "Warning message"
    },
    "warning_name": {
      "type": "string",
      "description": "Warning name"
    }
  },
  "description": "A list of warnings."
}