> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Box Sign template by ID
> Fetches details of a specific Box Sign template.
This endpoint is in the version **2024.0**. No changes are required to continue using it. For more details, see **[Box API versioning](/guides/api-calls/api-versioning-strategy)**.
Learn more about [Box SDK versioning strategy](/guides/tooling/sdks/sdk-versioning/).
## OpenAPI
````yaml /box-openapi.json GET /sign_templates/{template_id}
openapi: 3.0.2
info:
title: Box Platform API
description: >-
[Box Platform](https://developer.box.com) provides functionality to provide
access to content stored within [Box](https://box.com). It provides
endpoints for basic manipulation of files and folders, management of users
within an enterprise, as well as more complex topics such as legal holds and
retention policies.
termsOfService: https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9
contact:
name: Box, Inc
url: https://developer.box.com
email: devrel@box.com
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: '2024.0'
x-box-commit-hash: 95117b97f9
servers:
- url: https://api.box.com/2.0
description: Box Platform API server.
security:
- OAuth2Security: []
tags:
- name: AI
description: A set of endpoints used to interact with supported LLMs.
x-box-tag: ai
- name: AI Studio
description: A set of endpoints used to interact with AI Studio.
x-box-tag: ai_studio
- name: App item associations
x-box-tag: app_item_associations
- name: Authorization
description: A set of endpoints used to manage user authorization process.
x-box-tag: authorization
x-box-priority: true
- name: Box Sign requests
description: Box Sign requests are used to submit a file for signature.
x-box-tag: sign_requests
- name: Classifications
description: >-
Classification labels are used for content that is sensitive or under
security restrictions.
x-box-tag: classifications
- name: Classifications on files
description: >-
Classification labels are used for files that are sensitive or under
security restrictions.
x-box-tag: file_classifications
- name: Classifications on folders
description: >-
Classification labels are used for folders that are sensitive or under
security restrictions.
x-box-tag: folder_classifications
- name: Collaborations
description: >-
Collaborations define access permissions for users and groups to files and
folders, similar to access control lists.
x-box-tag: user_collaborations
- name: Collaborations (List)
description: >-
A set of endpoints used to retrieve file, folder, pending, and group
collaborations.
x-box-tag: list_collaborations
- name: Collections
description: >-
Collections are a way to group files, folders, and web links without
putting them all into a folder.
x-box-tag: collections
- name: Comments
description: >-
Comments are messages generated users on files, allowing users to
collaborate on a file, discussing any feedback they might have on the
content.
x-box-tag: comments
- name: Device pinners
description: >-
Device pinners allow enterprises to control what devices can use native
Box applications.
x-box-tag: device_pinners
- name: Domain restrictions (User exemptions)
description: >-
A set of endpoints that allow exempting users from restrictions imposed by
the list of allowed collaboration domains for a specific enterprise.
x-box-tag: collaboration_allowlist_exempt_targets
- name: Domain restrictions for collaborations
description: >-
A set of endpoints that manage domains for which users can collaborate
with files and folders in an enterprise.
x-box-tag: collaboration_allowlist_entries
- name: Downloads
description: >-
Downloads allow saving files to the application's server, or directly by
the end user in a browser.
x-box-tag: downloads
- name: Email aliases
description: >-
Email aliases provide a list of emails additional to the user's primary
login email.
x-box-tag: email_aliases
- name: Events
description: >-
Events provide a way for an application to subscribe to any actions
performed by any user, users, or service in an enterprise.
x-box-tag: events
- name: File requests
description: >-
File Requests provide a fast and secure way to request files and
associated metadata from anyone. Users can create new file requests based
on an existing file request, update file request settings, activate,
deactivate, and delete file requests programmatically.
x-box-tag: file_requests
- name: File version legal holds
description: >-
A legal hold is a process that an enterprise can use to preserve all forms
of potentially relevant information when litigation is pending or
reasonably anticipated. A File Version Legal Hold represents all the
policies that are assigned to a specific file version.
x-box-tag: file_version_legal_holds
- name: File version retentions
description: >-
A retention policy blocks permanent deletion of content for a specified
amount of time. A file version retention is a record for a retained file.
x-box-tag: file_version_retentions
- name: File versions
description: A set of endpoints used to manage specific versions of a file.
x-box-tag: file_versions
- name: Files
description: >-
Files, together with Folders, are at the core of the Box API. Files can be
uploaded and downloaded, as well as hold important metadata information
about the content.
x-box-tag: files
- name: Folder Locks
description: >-
Folder locks define access restrictions placed by folder owners to prevent
specific folders from being moved or deleted.
x-box-tag: folder_locks
- name: Folders
description: >-
Folders, together with Files, are at the core of the Box API. Folders can
be uploaded and downloaded, as well as hold important metadata information
about the content.
x-box-tag: folders
- name: Integration mappings
description: >-
Integration Mappings allow the users to manage where content from partner
apps is stored in Box.
x-box-tag: integration_mappings
- name: Group memberships
description: Group memberships signify that a user is a part of the group.
x-box-tag: memberships
- name: Groups
description: Groups created in an enterprise.
x-box-tag: groups
- name: Invites
description: Invites are used to invite the user to an enterprise.
x-box-tag: invites
- name: Legal hold policies
description: >-
A legal hold is a process that an enterprise can use to preserve all forms
of potentially relevant information when litigation is pending or
reasonably anticipated.
x-box-tag: legal_hold_policies
- name: Legal hold policy assignments
description: >-
A Legal Hold Policy Assignment is a relation between a policy and
custodian. In this case, as custodian can be a user, folder, file, or file
version.
x-box-tag: legal_hold_policy_assignments
- name: Metadata cascade policies
description: >-
A metadata cascade policy describes how metadata instances applied to a
folder should be applied to any item within that folder.
x-box-tag: metadata_cascade_policies
- name: Metadata instances (Files)
description: >-
A metadata instance describes the relation between a template and a file,
including the values that are assigned for every field.
x-box-tag: file_metadata
- name: Metadata instances (Folders)
description: >-
A metadata instance describes the relation between a template and a
folder, including the values that are assigned for every field.
x-box-tag: folder_metadata
- name: Metadata taxonomies
description: >-
A metadata taxonomy is a hierarchical classification system that helps
organize and manage metadata within an enterprise.
x-box-tag: metadata_taxonomies
- name: Metadata templates
description: >-
A metadata template describes a reusable set of key/value pairs that can
be assigned to a file.
x-box-tag: metadata_templates
- name: Recent items
description: >-
Recent items represent items such as files or folders that the user
accessed recently.
x-box-tag: recent_items
- name: Retention policies
description: >-
A retention policy blocks permanent deletion of content for a specified
amount of time. Admins can create retention policies and then assign them
to specific folders or their entire enterprise.
x-box-tag: retention_policies
- name: Retention policy assignments
description: >-
A Retention Policy Assignment is a relation between a policy and folder or
enterprise. Creating an assignment puts a retention on all the file
versions that belong to that folder or enterprise.
x-box-tag: retention_policy_assignments
- name: Search
description: >-
The Box API provides a way to find content in Box using full-text search
queries.
x-box-tag: search
- name: Session termination
description: >-
Session termination API is used to validate the roles and permissions of
the group, and creates asynchronous jobs to terminate the group's
sessions.
x-box-tag: session_termination
- name: Shared links (Files)
description: >-
Files shared links are URLs that are generated for files stored in Box,
which provide direct, read-only access to the resource.
x-box-tag: shared_links_files
- name: Shared links (Folders)
description: >-
Folders shared links are URLs that are generated for folders stored in
Box, which provide direct, read-only access to the resource.
x-box-tag: shared_links_folders
- name: Shared links (Web Links)
description: >-
Web links for files are URLs that are generated for web links in Box,
which provide direct, read-only access to the resource.
x-box-tag: shared_links_web_links
- name: Shared links (App Items)
description: >-
URLs generated for app items stored in Box, which provide direct,
read-only access to the resource.
x-box-tag: shared_links_app_items
- name: Shield information barriers
description: >-
Shield information barrier in Box defines an ethical wall. An ethical wall
is a mechanism that prevents exchanges or communication that could lead to
conflicts of interest and therefore result in business activities
ethically or legally questionable.
x-box-tag: shield_information_barriers
- name: Shield information barrier segments
description: >-
Shield information barrier segment represents a defined group of users. A
user can be a member of only one segment, which makes segments different
from groups.
x-box-tag: shield_information_barrier_segments
- name: Shield information barrier segment members
description: >-
Shield information barrier segment member represents a user that is
assigned to a specific segment.
x-box-tag: shield_information_barrier_segment_members
- name: Shield information barrier reports
description: >-
Shield information barrier reports contain information on what existing
collaborations will be removed permanently when the information barrier is
enabled.
x-box-tag: shield_information_barrier_reports
- name: Shield information barrier segment restrictions
description: >-
Shield information barrier segment restriction is an access restriction
based on the content (file or folder) owner.
x-box-tag: shield_information_barrier_segment_restrictions
- name: Box Sign templates
description: >-
Sign templates allow you to use a predefined Box Sign template when
creating a signature request. The template includes placeholders that are
automatically populated with data when creating the request.
x-box-tag: sign_templates
- name: Skills
description: >-
Box Skills are designed to allow custom processing of files uploaded to
Box, with the intent of enhancing the underlying metadata of the file.
x-box-tag: skills
- name: Standard and Zones Storage Policies
description: >-
Storage policy assignment represents the storage zone for items in a given
enterprise.
x-box-tag: storage_policies
- name: Standard and Zones Storage Policy Assignments
description: >-
Storage policy assignment represents the relation between storage zone and
the assigned item (for example a file stored in a specific zone).
x-box-tag: storage_policy_assignments
- name: Task assignments
description: >-
A task assignment defines which task is assigned to which user to
complete.
x-box-tag: task_assignments
- name: Tasks
description: >-
Tasks allow users to request collaborators on a file to review a file or
complete a piece of work. Tasks can be used by developers to create
file-centric workflows.
x-box-tag: tasks
- name: Terms of service
description: A set of endpoints used to manage terms of service agreements.
x-box-tag: terms_of_services
- name: Terms of service user statuses
description: >-
A set of endpoints used to manage the status of terms of service for a
particular user.
x-box-tag: terms_of_service_user_statuses
- name: Transfer folders
description: >-
API designed to move all of the items (files, folders and workflows) owned
by a user into another user's account.
x-box-tag: transfer
- name: Trashed files
description: Files that were deleted and are in trash.
x-box-tag: trashed_files
- name: Trashed folders
description: Folders that were deleted and are in trash.
x-box-tag: trashed_folders
- name: Trashed items
description: Items that were deleted and are in trash.
x-box-tag: trashed_items
- name: Trashed web links
description: Web links that were deleted and are in trash.
x-box-tag: trashed_web_links
- name: Uploads
description: >-
The direct file upload API supports files up to 50MB in size and sends all
the binary data to the Box API in 1 API request.
x-box-tag: uploads
- name: Uploads (Chunked)
description: >-
The chunked upload endpoints support files from 20MB in size and allow an
application to upload the file in parts, allowing for more control to
catch any errors and retry parts individually.
x-box-tag: chunked_uploads
- name: User avatars
description: >-
User avatars are JPG or PNG files uploaded to Box to represent the user
image. They are then displayed in the user account.
x-box-tag: avatars
- name: Users
description: >-
Box API supports a variety of users, ranging from real employees logging
in with their Managed User account, to applications using App Users to
drive powerful automation workflows.
x-box-tag: users
- name: Watermarks (Files)
description: >-
A watermark is a semi-transparent overlay on an embedded file preview that
displays a viewer's email address or user ID and the time of access over
the file.
x-box-tag: file_watermarks
- name: Watermarks (Folders)
description: >-
A watermark is a semi-transparent overlay on an embedded folder preview
that displays a viewer's email address or user ID and the time of access
over the folder content.
x-box-tag: folder_watermarks
- name: Web links
description: >-
Web links are objects that point to URLs. These objects are also known as
bookmarks within the Box web application.
x-box-tag: web_links
- name: Webhooks
description: >-
Webhooks allow you to monitor Box content for events, and receive
notifications to a URL of your choice when they occur. For example, a
workflow may include waiting for a file to be downloaded to delete a
shared link.
x-box-tag: webhooks
- name: Workflows
description: >-
Box Relay Workflows are objects that represent a named collection of
flows.
x-box-tag: workflows
- name: Zip Downloads
description: >-
Zip downloads represent a successful request to create a ZIP archive with
files and folders.
x-box-tag: zip_downloads
externalDocs:
description: Box Developer Documentation.
url: https://developer.box.com
paths:
/sign_templates/{template_id}:
get:
tags:
- Box Sign templates
summary: Get Box Sign template by ID
description: Fetches details of a specific Box Sign template.
operationId: get_sign_templates_id
parameters:
- name: template_id
in: path
description: The ID of a Box Sign template.
required: true
schema:
type: string
example: 123075213-7d117509-8f05-42e4-a5ef-5190a319d41d
responses:
'200':
description: Returns details of a template.
content:
application/json:
schema:
$ref: '#/components/schemas/SignTemplate'
'401':
description: >-
Returned when the access token provided in the `Authorization`
header is not recognized or not provided.
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
'404':
description: >-
Returned if the template is not found or the user does not have
access to the associated template.
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
default:
description: An unexpected client error.
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
x-codeSamples:
- lang: curl
label: Get Box Sign template by ID
source: |-
curl -L -X GET "https://api.box.com/2.0/sign_templates/12345678" \
-H "accept: application/json" \
-H "authorization: Bearer " \
- lang: dotnet
label: Get Box Sign template by ID
source: >-
await client.SignTemplates.GetSignTemplateByIdAsync(templateId:
NullableUtils.Unwrap(NullableUtils.Unwrap(signTemplates.Entries)[0].Id));
- lang: swift
label: Get Box Sign template by ID
source: >-
try await client.signTemplates.getSignTemplateById(templateId:
signTemplates.entries![0].id!)
- lang: java
label: Get Box Sign template by ID
source: >-
client.getSignTemplates().getSignTemplateById(signTemplates.getEntries().get(0).getId())
- lang: node
label: Get Box Sign template by ID
source: >-
await
client.signTemplates.getSignTemplateById(signTemplates.entries![0].id!);
- lang: python
label: Get Box Sign template by ID
source: >-
client.sign_templates.get_sign_template_by_id(sign_templates.entries[0].id)
components:
schemas:
SignTemplate:
description: A Box Sign template object.
type: object
allOf:
- properties:
type:
description: The value will always be `sign-template`.
type: string
example: sign-template
enum:
- sign-template
id:
description: Template identifier.
type: string
example: 4206996024-14944f75-c34b-478a-95a1-264b1ff80d35
name:
description: The name of the template.
type: string
example: Official contract
nullable: true
email_subject:
description: >-
Subject of signature request email. This is cleaned by sign
request. If this field is not passed, a default subject will be
used.
type: string
example: Sign Request from Acme
nullable: true
email_message:
description: >-
Message to include in signature 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.
type: string
example: Hello! Please sign the document below
nullable: true
days_valid:
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.
type: integer
example: 2
maximum: 730
minimum: 0
nullable: true
parent_folder:
allOf:
- $ref: '#/components/schemas/Folder--Mini'
- description: >-
The destination folder to place final, signed document and
signing log. Only `ID` and `type` fields are required. The
root folder, folder ID `0`, cannot be used.
source_files:
description: >-
List of files to create a signing document from. Only the ID and
type fields are required for each file.
type: array
items:
$ref: '#/components/schemas/File--Mini'
are_fields_locked:
description: Indicates if the template input fields are editable or not.
type: boolean
example: false
are_options_locked:
description: >-
Indicates if the template document options are editable or not,
for example renaming the document.
type: boolean
example: true
are_recipients_locked:
description: Indicates if the template signers are editable or not.
type: boolean
example: false
are_email_settings_locked:
description: Indicates if the template email settings are editable or not.
type: boolean
example: true
are_files_locked:
description: >-
Indicates if the template files are editable or not. This
includes deleting or renaming template files.
type: boolean
example: true
signers:
description: >-
Array of signers for the template.
**Note**: It may happen that some signers specified in the
template belong to conflicting
[segments](/reference/resources/shield-information-barrier-segment-member)
(user groups). This means that due to the security policies,
users are assigned to segments to prevent exchanges or
communication that could lead to ethical conflicts. In such a
case, an attempt to send a sign request based on a template that
lists signers in conflicting segments will result in an error.
Read more about [segments and ethical
walls](https://support.box.com/hc/en-us/articles/9920431507603-Understanding-Information-Barriers#h_01GFVJEHQA06N7XEZ4GCZ9GFAQ).
type: array
items:
$ref: '#/components/schemas/TemplateSigner'
additional_info:
description: >-
Additional information on which fields are required and which
fields are not editable.
type: object
properties:
non_editable:
description: Non editable fields.
type: array
items:
type: string
enum:
- email_subject
- email_message
- name
- days_valid
- signers
- source_files
example:
- email_subject
- name
required:
description: Required fields.
type: object
properties:
signers:
description: Required signer fields.
type: array
items:
type: array
items:
type: string
enum:
- email
example:
- email
example:
- - email
- - email
ready_sign_link:
description: >-
Box's ready-sign link feature enables you to create a link to a
signature request that you've created from a template. Use this
link when you want to post a signature request on a public form
— such as an email, social media post, or web page — without
knowing who the signers will be. Note: The ready-sign link
feature is limited to Enterprise Plus customers and not
available to Box Verified Enterprises.
type: object
nullable: true
properties:
url:
description: The URL that can be sent to signers.
type: string
example: |-
"https://app.box.com/sign/
ready-sign-link/a1cdf2c7-fa81-4a67-8163-1e5f4dbe5178"
name:
description: Request name.
type: string
example: Official contract
nullable: true
instructions:
description: Extra instructions for all signers.
type: string
example: Hello! Please sign the document below
nullable: true
folder_id:
description: >-
The destination folder to place final, signed document and
signing log. Only `ID` and `type` fields are required. The
root folder, folder ID `0`, cannot be used.
type: string
example: '12345'
nullable: true
is_notification_disabled:
description: Whether to disable notifications when a signer has signed.
type: boolean
example: true
is_active:
description: Whether the ready sign link is enabled or not.
type: boolean
example: false
custom_branding:
description: Custom branding applied to notifications and signature requests.
type: object
nullable: true
properties:
company_name:
description: Name of the company.
type: string
example: Corporation inc.
nullable: true
logo_uri:
description: Custom branding logo URI in the form of a base64 image.
type: string
example: |-
data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA
AAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A
8AAQUBAScY42YAAAAASUVORK5CYII=
nullable: true
branding_color:
description: Custom branding color in hex.
type: string
example: 9E5E6F
nullable: true
email_footer_text:
description: Content of the email footer.
type: string
example: Contact email email@mail.com
nullable: true
title: Box Sign template
x-box-resource-id: sign_template
x-box-tag: sign_templates
ClientError:
description: A generic error.
type: object
properties:
type:
description: The value will always be `error`.
type: string
example: error
enum:
- error
nullable: false
status:
description: The HTTP status of the response.
type: integer
format: int32
example: 400
nullable: false
code:
description: A Box-specific error code.
type: string
example: item_name_invalid
enum:
- created
- accepted
- no_content
- redirect
- not_modified
- bad_request
- unauthorized
- forbidden
- not_found
- method_not_allowed
- conflict
- precondition_failed
- too_many_requests
- internal_server_error
- unavailable
- item_name_invalid
- insufficient_scope
message:
description: A short message describing the error.
type: string
example: Method Not Allowed
nullable: false
context_info:
description: >-
A free-form object that contains additional context about the error.
The possible fields are defined on a per-endpoint basis. `message`
is only one example.
type: object
example:
message: Something went wrong
additionalProperties: {}
nullable: true
help_url:
description: A URL that links to more information about why this error occurred.
type: string
example: >-
https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/
nullable: false
request_id:
description: >-
A unique identifier for this response, which can be used when
contacting Box support.
type: string
example: abcdef123456
nullable: false
title: Client error
x-box-resource-id: client_error
Folder--Mini:
description: >-
A mini representation of a file version, used when nested under another
resource.
type: object
allOf:
- $ref: '#/components/schemas/Folder--Base'
- properties:
sequence_id:
allOf:
- type: string
example: '3'
nullable: true
description: >-
A numeric identifier that represents the most recent user
event that has been applied to this item.
This can be used in combination with the `GET
/events`-endpoint to filter out user events that would have
occurred before this identifier was read.
An example would be where a Box Drive-like application would
fetch an item via the API, and then listen to incoming user
events for changes to the item. The application would ignore
any user events where the `sequence_id` in the event is
smaller than or equal to the `sequence_id` in the originally
fetched resource.
- nullable: false
name:
description: The name of the folder.
type: string
example: Contracts
nullable: false
title: Folder (Mini)
x-box-resource-id: folder--mini
x-box-tag: folders
x-box-variant: mini
File--Mini:
description: >-
A mini representation of a file, used when nested under another
resource.
type: object
allOf:
- $ref: '#/components/schemas/File--Base'
- properties:
sequence_id:
allOf:
- type: string
example: '3'
nullable: true
description: >-
A numeric identifier that represents the most recent user
event that has been applied to this item.
This can be used in combination with the `GET
/events`-endpoint to filter out user events that would have
occurred before this identifier was read.
An example would be where a Box Drive-like application would
fetch an item via the API, and then listen to incoming user
events for changes to the item. The application would ignore
any user events where the `sequence_id` in the event is
smaller than or equal to the `sequence_id` in the originally
fetched resource.
- nullable: false
name:
description: The name of the file.
type: string
example: Contract.pdf
sha1:
description: >-
The SHA1 hash of the file. This can be used to compare the
contents of a file on Box with a local file.
type: string
format: digest
example: 85136C79CBF9FE36BB9D05D0639C70C265C18D37
nullable: false
file_version:
allOf:
- $ref: '#/components/schemas/FileVersion--Mini'
- description: The information about the current version of the file.
nullable: true
title: File (Mini)
x-box-resource-id: file--mini
x-box-tag: files
x-box-variant: mini
TemplateSigner:
description: The schema for a Signer for Templates.
type: object
properties:
inputs:
type: array
items:
$ref: '#/components/schemas/TemplateSignerInput'
readOnly: true
email:
description: Email address of the signer.
type: string
example: example@mail.com
nullable: true
role:
description: >-
Defines the role of the signer in the signature request. A role of
`signer` needs to sign the document, a role `approver` approves the
document and a `final_copy_reader` role only receives the final
signed document and signing log.
type: string
example: signer
default: signer
enum:
- signer
- approver
- final_copy_reader
is_in_person:
description: >-
Used in combination with an embed URL for a sender. After the sender
signs, they will be redirected to the next `in_person` signer.
type: boolean
example: true
order:
description: Order of the signer.
type: integer
example: 2
minimum: 0
signer_group_id:
description: >-
If provided, this value points signers that are assigned the same
inputs and belongs to same signer group. A signer group is not a Box
Group. It is an entity that belongs to the template itself and can
only be used within Box Sign requests created from it.
type: string
example: cd4ff89-8fc1-42cf-8b29-1890dedd26d7
nullable: true
label:
description: >-
A placeholder label for the signer set by the template creator to
differentiate between signers.
type: string
example: Jane Doe
nullable: true
public_id:
description: >-
An identifier for the signer. This can be used to identify a signer
within the template.
type: string
example: RJZYYVPR
is_password_required:
description: >-
If true for signers with a defined email, the password provided when
the template was created is used by default. If true for signers
without a specified / defined email, the creator needs to provide a
password when using the template.
type: boolean
example: true
nullable: true
is_phone_number_required:
description: >-
If true for signers with a defined email, the phone number provided
when the template was created is used by default. If true for
signers without a specified / defined email, the template creator
needs to provide a phone number when creating a request.
type: boolean
example: true
nullable: true
login_required:
description: If true, the signer is required to login to access the document.
type: boolean
example: true
nullable: true
title: Signer fields for Templates
Folder--Base:
description: >-
The bare basic representation of a folder, the minimal amount of fields
returned when using the `fields` query parameter.
type: object
properties:
id:
description: >-
The unique identifier that represent a folder.
The ID for any folder can be determined by visiting a folder in the
web application and copying the ID from the URL. For example, for
the URL `https://*.app.box.com/folders/123` the `folder_id` is
`123`.
type: string
example: '12345'
nullable: false
etag:
description: >-
The HTTP `etag` of this folder. This can be used within some API
endpoints in the `If-Match` and `If-None-Match` headers to only
perform changes on the folder if (no) changes have happened.
type: string
example: '1'
nullable: true
type:
description: The value will always be `folder`.
type: string
example: folder
enum:
- folder
nullable: false
required:
- id
- type
title: Folder (Base)
x-box-resource-id: folder--base
x-box-tag: folders
x-box-variant: base
x-box-variants:
- base
- mini
- standard
- full
File--Base:
description: >-
The bare basic representation of a file, the minimal amount of fields
returned when using the `fields` query parameter.
type: object
properties:
id:
description: >-
The unique identifier that represent a file.
The ID for any file can be determined by visiting a file in the web
application and copying the ID from the URL. For example, for the
URL `https://*.app.box.com/files/123` the `file_id` is `123`.
type: string
example: '12345'
nullable: false
etag:
description: >-
The HTTP `etag` of this file. This can be used within some API
endpoints in the `If-Match` and `If-None-Match` headers to only
perform changes on the file if (no) changes have happened.
type: string
example: '1'
nullable: true
type:
description: The value will always be `file`.
type: string
example: file
enum:
- file
nullable: false
nullable: true
required:
- id
- type
title: File (Base)
x-box-resource-id: file--base
x-box-tag: files
x-box-variant: base
x-box-variants:
- base
- mini
- standard
- full
FileVersion--Mini:
description: >-
A mini representation of a file version, used when nested within another
resource.
type: object
allOf:
- $ref: '#/components/schemas/FileVersion--Base'
- properties:
sha1:
description: The SHA1 hash of this version of the file.
type: string
example: 134b65991ed521fcfe4724b7d814ab8ded5185dc
title: File version (Mini)
x-box-resource-id: file_version--mini
x-box-variant: mini
TemplateSignerInput:
description: Input created by a Signer on a Template.
type: object
allOf:
- $ref: '#/components/schemas/SignRequestPrefillTag'
- properties:
type:
description: Type of input.
type: string
example: text
enum:
- signature
- date
- text
- checkbox
- attachment
- radio
- dropdown
content_type:
description: Content type of input.
type: string
example: text
enum:
- signature
- initial
- stamp
- date
- checkbox
- text
- full_name
- first_name
- last_name
- company
- title
- email
- attachment
- radio
- dropdown
is_required:
description: Whether or not the input is required.
type: boolean
example: true
page_index:
description: Index of page that the input is on.
type: integer
example: 4
document_id:
description: Document identifier.
type: string
example: 123075213-eb54b537-8b25-445e-87c1-5a1c67d8cbd7
nullable: true
dropdown_choices:
description: >-
When the input is of the type `dropdown` this values will be
filled with all the dropdown options.
type: array
items:
type: string
example:
- 'Yes'
- 'No'
- Maybe
nullable: true
group_id:
description: >-
When the input is of type `radio` they can be grouped to gather
with this identifier.
type: string
example: da317330-225a-4c72-89ad-0d6dcaaf4df6
nullable: true
coordinates:
description: Where the input is located on a page.
type: object
properties:
x:
description: >-
Relative x coordinate to the page the input is on, ranging
from 0 to 1.
type: number
example: 0.672258592471358
'y':
description: >-
Relative y coordinate to the page the input is on, ranging
from 0 to 1.
type: number
example: 0.18654283173599448
dimensions:
description: The size of the input.
type: object
properties:
width:
description: >-
Relative width to the page the input is on, ranging from 0
to 1.
type: number
example: 0.2618657937806874
height:
description: >-
Relative height to the page the input is on, ranging from 0
to 1.
type: number
example: 0.05311728090109673
label:
description: >-
The label field is used especially for text, attachment, radio,
and checkbox type inputs.
type: string
example: Legal name
nullable: true
read_only:
description: >-
Indicates whether this input is read-only (cannot be modified by
signers).
type: boolean
example: true
validation:
description: >-
Specifies the formatting rules that signers must follow for text
field inputs. If set, this validation is mandatory.
example:
validation_type: email
anyOf:
- $ref: '#/components/schemas/SignRequestSignerInputValidation'
- title: OpenAPI 3.0 null schema type
description: The definition for a null schema type in OpenAPI `3.0`.
type: object
nullable: true
additionalProperties: false
required:
- page_index
title: Template Signer Input
FileVersion--Base:
description: >-
The bare basic representation of a file version, the minimal amount of
fields returned when using the `fields` query parameter.
type: object
properties:
id:
description: The unique identifier that represent a file version.
type: string
example: '12345'
nullable: false
type:
description: The value will always be `file_version`.
type: string
example: file_version
enum:
- file_version
nullable: false
required:
- id
- type
title: File version (Base)
x-box-resource-id: file_version--base
x-box-variant: base
x-box-variants:
- base
- mini
- standard
- full
SignRequestPrefillTag:
description: >-
Prefill tags are used to prefill placeholders with signer input data.
Only one value field can be included.
type: object
properties:
document_tag_id:
description: >-
This references the ID of a specific tag contained in a file of the
signature request.
type: string
example: '1234'
nullable: true
text_value:
description: Text prefill value.
type: string
example: text
nullable: true
checkbox_value:
description: Checkbox prefill value.
type: boolean
example: true
nullable: true
date_value:
description: Date prefill value.
type: string
format: date
example: '2021-04-26'
nullable: true
title: Sign request prefill tag
SignRequestSignerInputValidation:
description: >-
Specifies the formatting rules that signers must follow for text field
inputs. If set, this validation is mandatory. The format can be selected
from a predefined list of options (e.g., email, phone number, date) or
defined using a custom regular expression.
oneOf:
- $ref: '#/components/schemas/SignRequestSignerInputEmailValidation'
- $ref: '#/components/schemas/SignRequestSignerInputCustomValidation'
- $ref: '#/components/schemas/SignRequestSignerInputZIPValidation'
- $ref: '#/components/schemas/SignRequestSignerInputZIP4Validation'
- $ref: '#/components/schemas/SignRequestSignerInputSSNValidation'
- $ref: >-
#/components/schemas/SignRequestSignerInputNumberWithPeriodValidation
- $ref: '#/components/schemas/SignRequestSignerInputNumberWithCommaValidation'
- $ref: '#/components/schemas/SignRequestSignerInputDateISOValidation'
- $ref: '#/components/schemas/SignRequestSignerInputDateUSValidation'
- $ref: '#/components/schemas/SignRequestSignerInputDateEUValidation'
- $ref: '#/components/schemas/SignRequestSignerInputDateAsiaValidation'
title: Sign Request Signer Input Validation
SignRequestSignerInputEmailValidation:
description: >-
Specifies the formatting rules that signers must follow for text field
inputs. If set, this validation is mandatory.
type: object
properties:
validation_type:
description: Validates that the text input is an email address.
type: string
example: email
enum:
- email
required:
- validation_type
title: Sign Request Signer Input Email Validation
SignRequestSignerInputCustomValidation:
description: >-
Specifies the custom validation rules for a text field input by the
signer. If set, this validation is mandatory.
type: object
properties:
validation_type:
description: >-
Defines the validation format for the text input as custom. A custom
regular expression is used for validation.
type: string
example: custom
enum:
- custom
custom_regex:
description: Regular expression used for validation.
type: string
example: (^[a-zA-Z0-9._%+-]+)
nullable: true
custom_error_message:
description: >-
Error message shown if input fails custom regular expression
validation.
type: string
example: Please enter a valid value.
nullable: true
required:
- validation_type
- custom_regex
- custom_error_message
title: Sign Request Signer Input Custom Validation
SignRequestSignerInputZIPValidation:
description: >-
Specifies the validation rules for a text field input by the signer. If
set, this validation is mandatory.
type: object
properties:
validation_type:
description: Validates that the text input is a ZIP code.
type: string
example: zip
enum:
- zip
required:
- validation_type
title: Sign Request Signer Input ZIP Validation
SignRequestSignerInputZIP4Validation:
description: >-
Specifies the validation rules for a text field input by the signer. If
set, this validation is mandatory.
type: object
properties:
validation_type:
description: Validates that the text input is a ZIP+4 code.
type: string
example: zip_4
enum:
- zip_4
required:
- validation_type
title: Sign Request Signer Input ZIP 4 Validation
SignRequestSignerInputSSNValidation:
description: >-
Specifies the validation rules for a text field input by the signer. If
set, this validation is mandatory.
type: object
properties:
validation_type:
description: Validates that the text input is a Social Security Number (SSN).
type: string
example: ssn
enum:
- ssn
required:
- validation_type
title: Sign Request Signer Input SSN Validation
SignRequestSignerInputNumberWithPeriodValidation:
description: >-
Specifies the number with period formatting rules for a text field input
by the signer. If set, this validation is mandatory.
type: object
properties:
validation_type:
description: >-
Validates that the text input uses a number format with a period as
the decimal separator (for example, 1.23).
type: string
example: number_with_period
enum:
- number_with_period
title: Sign Request Signer Input Number With Period Validation
SignRequestSignerInputNumberWithCommaValidation:
description: >-
Specifies the number with comma formatting rules for a text field input
by the signer. If set, this validation is mandatory.
type: object
properties:
validation_type:
description: >-
Validates that the text input uses a number format with a comma as
the decimal separator (for example, 1,23).
type: string
example: number_with_comma
enum:
- number_with_comma
title: Sign Request Signer Input Number With Comma Validation
SignRequestSignerInputDateISOValidation:
description: >-
Specifies the ISO date formatting rules for a text field input by the
signer. If set, this validation is mandatory. The date format follows
`YYYY-MM-DD` pattern.
type: object
properties:
validation_type:
description: Validates that the text input uses the ISO date format `YYYY-MM-DD`.
type: string
example: date_iso
enum:
- date_iso
title: Sign Request Signer Input Date ISO Validation
SignRequestSignerInputDateUSValidation:
description: >-
Specifies the US date formatting rules for a text field input by the
signer. If set, this validation is mandatory. The date format follows
`MM/DD/YYYY` pattern.
type: object
properties:
validation_type:
description: Validates that the text input uses the US date format `MM/DD/YYYY`.
type: string
example: date_us
enum:
- date_us
title: Sign Request Signer Input Date US Validation
SignRequestSignerInputDateEUValidation:
description: >-
Specifies the date formatting rules used in Europe for a text field
input by the signer. If set, this validation is mandatory. The date
format follows `DD/MM/YYYY` pattern.
type: object
properties:
validation_type:
description: >-
Validates that the text input uses the European date format
`DD/MM/YYYY`.
type: string
example: date_eu
enum:
- date_eu
title: Sign Request Signer Input Date EU Validation
SignRequestSignerInputDateAsiaValidation:
description: >-
Specifies the date formatting rules used in Asia for a text field input
by the signer. If set, this validation is mandatory. The date format
follows `YYYY/MM/DD` pattern.
type: object
properties:
validation_type:
description: >-
Validates that the text input uses the Asian date format
`YYYY/MM/DD`.
type: string
example: date_asia
enum:
- date_asia
title: Sign Request Signer Input Date Asia Validation
securitySchemes:
OAuth2Security:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://account.box.com/api/oauth2/authorize
tokenUrl: https://api.box.com/oauth2/token
scopes:
root_readonly: Read all files and folders stored in Box
root_readwrite: Read and write all files and folders stored in Box
manage_app_users: Provision and manage app users
manage_managed_users: Provision and manage managed users
manage_groups: Manage an enterprise's groups
manage_webhook: Create webhooks programmatically through the API
manage_enterprise_properties: Manage enterprise properties
manage_data_retention: Manage data retention polices
manage_legal_hold: Manage Legal Holds
````