Box Developer Documentation
Log in

Sign Requests

A standard representation of a sign request, as returned from any Box Sign API endpoints by default.

Sign Request array
integer / int64
1000

The limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.

integer / int64
3000

The marker for the start of the next page of results.

integer / int64
1000

The marker for the start of the previous page of results.

Response Example

{
  "entries": [
    {
      "name": "document sign request",
      "is_document_preparation_needed": true,
      "redirect_url": "https://example.com",
      "declined_redirect_url": "https://declined-example.com",
      "are_text_signatures_enabled": true,
      "email_subject": "Sign Request from Acme",
      "email_message": "Hello! Please sign the document below",
      "are_reminders_enabled": true,
      "signers": [
        {
          "email": "example@gmail.com",
          "role": "signer",
          "is_in_person": true,
          "order": 2,
          "embed_url_external_user_id": 1234,
          "redirect_url": "https://example.com",
          "declined_redirect_url": "https://declined-example.com",
          "login_required": true,
          "verification_phone_number": 6314578901,
          "password": "SecretPassword123",
          "has_viewed_document": true,
          "signer_decision": {
            "type": "signed",
            "finalized_at": "2021-04-26T08:12:13.982Z"
          },
          "inputs": [
            {
              "document_tag_id": 1234,
              "text_value": "text",
              "checkbox_value": true,
              "date_value": "2021-04-26T08:12:13.982Z",
              "type": "text",
              "content_type": "signature",
              "page_index": 4
            }
          ],
          "embed_url": "https://example.com"
        }
      ],
      "source_files": [
        {
          "id": 12345,
          "etag": 1,
          "type": "file"
        }
      ],
      "parent_folder": {
        "id": 12345,
        "etag": 1,
        "type": "folder",
        "sequence_id": 3,
        "name": "Contracts"
      },
      "prefill_tags": [
        {
          "document_tag_id": 1234,
          "text_value": "text",
          "checkbox_value": true,
          "date_value": "2021-04-26T08:12:13.982Z"
        }
      ],
      "days_valid": 2,
      "external_id": 123,
      "is_phone_verification_required_to_view": true,
      "signature_color": "blue",
      "type": "sign-request",
      "id": 12345,
      "prepare_url": "https://prepareurl.com",
      "signing_log": {
        "id": 12345,
        "etag": 1,
        "type": "file",
        "sequence_id": 3,
        "name": "Contract.pdf",
        "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
        "file_version": {
          "id": 12345,
          "type": "file_version",
          "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
        }
      },
      "status": "converting",
      "sign_files": {
        "files": [
          {
            "id": 12345,
            "etag": 1,
            "type": "file",
            "sequence_id": 3,
            "name": "Contract.pdf",
            "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
            "file_version": {
              "id": 12345,
              "type": "file_version",
              "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
            }
          }
        ],
        "is_ready_for_download": true
      },
      "auto_expire_at": "2021-04-26T08:12:13.982Z"
    }
  ],
  "limit": 1000,
  "next_marker": 3000,
  "prev_marker": 1000
}