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."
    }
  }
}