Sign Request (Base)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SignRequest--Base",
  "title": "Sign Request (Base)",
  "type": "object",
  "x-box-resource-id": "sign_request--base",
  "x-box-tag": "sign_requests",
  "x-box-variants": [
    "standard",
    "base"
  ],
  "x-box-variant": "base",
  "description": "A request to create a sign request object",
  "properties": {
    "is_document_preparation_needed": {
      "type": "boolean",
      "description": "Indicates if the sender should receive a `prepare_url` in the response to complete document preparation via UI.",
      "example": true
    },
    "redirect_url": {
      "type": "string",
      "example": "https://www.example.com",
      "description": "When specified, signature request will be redirected to this url when a document is signed.",
      "nullable": true
    },
    "declined_redirect_url": {
      "type": "string",
      "example": "https://declined-redirect.com",
      "description": "The uri that a signer will be redirected to after declining to sign a document.",
      "nullable": true
    },
    "are_text_signatures_enabled": {
      "type": "boolean",
      "description": "Disables the usage of signatures generated by typing (text).",
      "example": true,
      "default": true
    },
    "email_subject": {
      "type": "string",
      "example": "Sign Request from Acme",
      "description": "Subject of sign request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.",
      "nullable": true
    },
    "email_message": {
      "type": "string",
      "example": "Hello! Please sign the document below",
      "description": "Message to include in sign request email. The field is cleaned through sanitization of specific characters. However, some html tags are allowed. Links included in the message are also converted to hyperlinks in the email. The message may contain the following html tags including `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong`. Be aware that when the text to html ratio is too high, the email may end up in spam filters. Custom styles on these tags are not allowed. If this field is not passed, a default message will be used.",
      "nullable": true
    },
    "are_reminders_enabled": {
      "type": "boolean",
      "description": "Reminds signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers.",
      "example": true
    },
    "name": {
      "type": "string",
      "example": "name",
      "description": "Name of the sign request."
    },
    "prefill_tags": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SignRequestPrefillTag"
      },
      "description": "When a document contains sign related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag."
    },
    "days_valid": {
      "type": "integer",
      "description": "Set the number of days after which the created signature request will automatically expire if not completed. By default, we do not apply any expiration date on signature requests, and the signature request does not expire.",
      "minimum": 0,
      "maximum": 730,
      "example": 2,
      "nullable": true
    },
    "external_id": {
      "type": "string",
      "description": "This can be used to reference an ID in an external system that the sign request is related to.",
      "example": "123",
      "nullable": true
    },
    "is_phone_verification_required_to_view": {
      "type": "boolean",
      "description": "Forces signers to verify a text message prior to viewing the document. You must specify the phone number of signers to have this setting apply to them.",
      "example": true,
      "nullable": true
    },
    "template_id": {
      "type": "string",
      "example": "123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb",
      "description": "When a signature request is created from a template this field will indicate the id of that template.",
      "nullable": true
    }
  }
}