Introducing Box Sign APIs

Kourtney Meiss
Jul 26 · 3 min read

Today, July 26th, 2021, begins the roll out of Box Sign! Programmatically harness the full functionality of the Box Sign web app experience by leveraging our newest API endpoints to create, list, resend, and cancel Box Sign requests.

Box Sign must be rolled out to your enterprise before use of these endpoints. We will notify Admins as it becomes available for their Box instance. Over the next few months we plan to support Business, Business Plus, Enterprise, Enterprise Suites, and Starter plans. For details on enablement and access restriction, please see our support article.

Creating a Box Sign request

At a minimum, using the create Box Sign request endpoint requires selecting a file for signature, a destination folder for the signed document/signing log, and designating signers. At this time, only one file can be signed per request.

curl -i -X POST "https://api.box.com/2.0/sign_requests" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-d '{
"signers": [
{
"role": "signer",
"email": "example_email@box.com"
}
],
"source_files": [
{
"type": "file",
"id": "123456789"
}
],
"parent_folder":
{
"type": "folder",
"id": "0987654321"
}
}'

For more details, please see our guide and reference documentation.

Fetching a list of all Box Sign requests

The list sign requests endpoint can be used to view a list of all Box Sign requests created by the user associated with the passed Access Token.

curl -i -X GET "https://api.box.com/2.0/sign_requests" \
-H "Authorization: Bearer <ACCESS_TOKEN>"

For more details, please see our guide and reference documentation.

Fetching a Box Sign request by ID

The get Box Sign request by ID endpoint can be used to view information about a specific Box Sign request. This endpoint requires the sign request’s ID, which can be obtained by using the list Box Sign requests endpoint or in the response when creating a Box Sign request.

curl -i -X GET "https://api.box.com/2.0/sign_requests/<SIGN_REQUEST_ID>" \
-H "Authorization: Bearer <ACCESS_TOKEN>

For more details, please see our guide and reference documentation.

Resending a Box Sign request

The resend a Box sign request endpoint can be used to resend request emails to any remaining signers.

curl -i -X POST
"https://api.box.com/2.0/sign_requests/<SIGN_REQUEST_ID>/resend" \
-H "Authorization: Bearer <ACCESS_TOKEN>"

For more details, please see our guide and reference documentation.

Cancelling a Box Sign request

A Box Sign request, that has not yet been signed or declined, can be cancelled using the cancel Box Sign request endpoint. Any outstanding signers will no longer be able to sign the document.

curl -i -X POST
"https://api.box.com/2.0/sign_requests/<SIGN_REQUEST_ID>/cancel" \
-H "Authorization: Bearer <ACCESS_TOKEN>"

For more details, please see our guide and reference documentation.

SDK support

Currently, only our Java SDK supports Box Sign: GitHub.

Let us know what SDK you’d like to see support for next via Box Pulse.

Feedback and feature requests

We hope you enjoy Box Sign and much as we do!

  • If you encounter any bugs or break/fix issues, please open a ticket directly with our product support team.
  • If you have any how-to questions on API usage, please post on our developer forum.
  • If you have any feedback or encounter issues with our Box Sign developer documentation, please email box-sign-api-feedback@box.com.
  • If you have feature requests for Box Sign, please leverage Box Pulse to surface them to our product team.

Box Developer Blog

News and stories for working with the Box APIs