Box Sign API

I am trying to create a Box sign request and want to highlight the signature box in the document where the user needs to add their signature. In the Box Sign portal, there is an option to drag and drop the signature and other fields, which places the signature box at the desired position in the document. I want to replicate this functionality using code. However, when I tried adding the inputs attribute under signers, it didn’t work as expected.Below is my json request body.{  "email_message": "Hello! Please sign the document below",  "email_subject": "Sign Request from UserName",  "parent_folder": {    "id": "2895123232312",    "type": "folder"  },  "signers": [    {      "email": "<useremail>",      "role": "signer",     "order": 1,      "inputs": [        {          "type": "signature",          "x": 100,          "y": 150,          "page_index": 0,          "width": 150,          "height": 50        }      ]    }  ],  "source_files": [    {      "id": "1714359484288",      "t

I put Box Sign projects on hold for a year in hopes box.com would fix various web UI bugs insigning documents.Sadly, I still see an unacceptable overstrike and now even multiple font sizes on that overstrike, etc. But now that I’ve come back, I find that I can no longer get CCG to work with the User ID set inthe app.  ( CCGAuth() in Python SDK. )  The initial authorization works when using Enterprise IDBUT that is not what I want because when using the Enterprise ID, it never could access mytemplates--They were only accessible when using the user id.  (the User ID in the app config.)( It was previously able to access them when using the “user” argument to CCGAuth(). )I changed nothing.  It stopped working.  Yes it was still authorized then reauthorized for good measure.Is this a bug or a feature?  And is there a way to get the old behavior?  Other than this:Sadly I had to switch back to regular OAuth2 using the annoying 1 hour temporary dev tokenswhere it still will access the template

I have a template which works just fine with prefill_tags and defined signature placement, etc. The moment I try to add other files i’ve previously uploaded (and captured id’s of) via source_files and additional_documents in the payload, the template becomes null and the signature request will only include those additional documents. That is to say, I cannot find a way to use both a template and add additional files to a signature request. I am using jwt authentication in python. 

The ID used in the Get Sign Requests by ID endpoint is a 36-character alphanumeric string; the same type as returned from “id” in the response from Create Box Sign Request. Where can I find this id in the UI?The only IDs I can find in the UI are an 8-character alphanumeric “Request ID” when viewing a Sign Request > See Details, or a 13-digit numeric ID on the in the sign request’s document URL. Neither of these work when trying to use the Get Sign Requests by ID endpoint. Alternatively, can I retrieve this elusive ID via an endpoint, using either of the two IDs I can see in the UI?

Hello,I am using the create sign request API with the following body to create a sign request:{"external_id": "id","parent_folder": { "id": "1234", "type": "folder" },"signers": [     { "role": "signer", "email": "email@email.com" },     { "role": "signer", "email": "email2@email.com" },    { "role": "final_copy_reader", "email": "email2@email.com" }],"source_files": [ { "id": "12233", "type": "file" }, { "id": "54321", "type": "file" } ],“is_document_preparation_needed”: true} The sign request successfully achieves the “Created” state. However, the prepare SR URL gives a 404 to the actual user, who is supposed to configure the SR before sending it out. I suspect this is happening because the service account is the actual owner of the SR. My question is, how can I create an SR via API but assign an actual person as its owner? Thank you.

Hi Development Team,As part of our project we need to upload documents to one of the folder in Box CLI. We have folder ready in Box CLI and commands to be given in command prompt. Here we wanted to automate the commands which we are giving in Command prompt of our system using bat file. But it is not accepting the Client Id and Client Secret. Could you please help us to automate this process.Thanks and RegardsSravya Pericherla.

Hi there,I am using the Embedded Signing Experience to embed signable documents into a web page using an iframable_embed_url. I use the Create Box Sign request API to retreive the embeddable URL. The embed is working fine, including te signing functionality, but my document contains one user-fillable field whose value I need to retrieve after signing. In the Sign Template editor, I've given the form field an External Identifier to make the input easer to find, but I can't find a way to fetch what the user put into that field after signing.I hoped that the "Sign Completed" webhook would include all the document's input data, but it does not. https://developer.box.com/reference/resources/webhook-invocation/Then I took the Sign Request ID (additional_info.sign_request_id) from the webhook response, and passed it to the "Get Box Sign request by ID" API. Despite the documentation showing Signers and Inputs on the response, that data is not present in my response. https://developer.box.com/r

Hi there,I'm using the Embedded Signing Experience to show my users a document they need to sign. I call the Create Box Sign request API to retreive the embeddable URL, and immediately embed the iframable_embed_url onto my page. At this point, the cloud matching captcha displays. If I wait 5-7 seconds and then complete the captcha, the signable document displays. But if I complete the captcha immediately, the page shows "Invalid Link: This request link is invalid."It seems like the template file gets copied to make a signable instance at the same time the endpoint returns, but the document copy is not finished yet, and if the users proceeds too fast, they attempt to access an instance that isn't done being created yet.

I would like to download the signed document after all the signers have completed the signatures. In trying to do so, I am trying to call download API by providing the file id:https://{{api.box.com}}/2.0/files/{file_id}/contentAfter checking the status of sign request, which is “signed”, I am trying to download the document. However, it is still resulting in the document which is not signed/without signatures.Can you please help me understand, how to get the signed document through API.Thanks in advance.RegardsVenky

I am getting below error while trying to access the existing templates of Box Sign API.{    "type": "error",    "code": "insufficient_scope",    "status": 403,    "message": "The request requires higher privileges than provided by the access token.",    "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",    "request_id": "0a16c0b7baab4b0e5c0650bd171d679c7"}I am using a developer account with client id: jmhjt9o71zlh3k3crqycqcr9c4tsav9m and using client credentials for authorization.I have checked all the application scope options available but still getting this error while trying invoke the Box Sign API’s.Also, while trying to get the access token, if I give the box type as enterprise, I am able to generate the token but If i give the box type as user, I am getting “invalid_grant” error.PS: I am a beginner, therefore it would be of great help if you give explain with proper details.

good morning, I would like some help, I'm trying to change my wife's account password but the email isn't arriving.

The number of custom and partner built Box Sign integrations is rapidly growing. Box Sign integrations with HCM tools (such as Workday) via Workato, ServiceNow via Reva, Jira via Valiantys, and HubSpot via Eustace Consulting are the latest additions. Take a look at this blog post for more details.Want to learn how to unlock the power of Box Sign? Register for this on-demand webinar.

While using the Box .NET(Gen) SDK I noticed that the TemplateSigner class is missing the label field. However when calling the Box API via curl to get sign templates the label field is a part of the signer objects in the signers array on sign templates. I assume it is supposed to be accessible as this forum post describes the signer object as having the label field. https://community.box.com/topic/show?tid=477&fid=9 Unfortunately, the label field is missing on the Signers object on this page Box Sign template - API Reference - Box Developer Documentation of the Box Developer Documentation. Upon closer inspection it also appears to be missing on all of the SDKs TemplateSigner classes.

Dear Box Support Team,I hope this message finds you well. We are currently in the process of integrating Box API functionalities into our application. While we have successfully accessed sign requests through the Box API, we have encountered specific requirement that we are seeking clarification on:Checking if a User Has Signed a Document: We need functionality in the Box API that allows us to determine whether a specific user has already signed a document. Unfortunately, We didn't find this functionality in the current Box API for sign requests. Are there alternative methods we could utilize?Thanks.

The documentation at https://developer.box.com/guides/embed/box-embed/ briefly mentions that postMessage() is used to retrieve status, but I can’t seem to make it work. I’ve setup an event listener for the message event, but it does not fire. I’ve also tried calling postMessage on the iframes contentWindow property, but to no effect.

In this YouTube tutorial by Box , at minute 1:58, they demonstrate a popup modal with a Box Sign embedded. It seems that this isn’t an iframeable_embed_url because the Cloud Game widget doesn’t pop up. When I use the iframeable_embed_url in my own modal, upon a user signing, instead of the user being shown a screen that says “Finished. Thank you for completing the request” like is shown upon sign completion in the YouTube tutorial, the Cloud Game widget pops up again. When the user completes this game (for a second time now), they then see a blank screen. This makes for a poor user experience because the user has no indication of whether or not their sign was successful. Is it possible for me to embed the embed_url into my modal instead (seemingly like what is done in the tutorial)? It seems like if I do so, the user won’t have to deal with the Cloud Game and weird sign completion experience. If not, what must happen for the user to be shown the “Finished. Thank you for completing the

Api Path : https://{{api.box.com}}/2.0/sign_requests Request Body: { "is_document_preparation_needed": true, "parent_folder": { "id": "242033790140", "type": "folder" }, "name": "new file", "days_valid": 2, "source_files": [ { "id": "1402075677437", "type": "file" } ], "signature_color": "blue", "signers": [ { "email": "abc@gmail.com", "role": "final_copy_reader" } ] } Response : { "type": "error", "code": "bad_request", "status": 400, "message": "Bad request", "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/", "request_id": "0161f8a960ede1346f50bfdc34b75156f", "context_info": { "errors": [ { "name": "source_files", "message": "Enter a valid file.", "reason": "invalid_parameter" } ] } }

Dear Forum, For several months, I’ve been using Box drive for sync’ign with local folders - with no issue. Since last week, I can still login to the online box, but get an SSL error when trying to connect to the Box drive. I checked with my IT team (no change on that side), tried resetting password, no effect. I uninstalled/re-installed, but get to the same point. Coudl it be comign from a recent updates? Any ideas on how to address it? Thanks! 2023-12-16 19:17:49.975 14628 INFO CompleteAuthenticati network_layer Got a SSLError so calling refresh_proxy_settings: BoxHTTPSConnectionPool(host=‘api.box.com’, port=443): Max retries exceeded with url: /oauth2/token (Caused by SSLError(SSLCertVerificationError(1, ‘[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: certificate signature failure (_ssl.c:997)’)))

I have tried to create a signer and and approver order, but it always takes the second email. Referring to the attached code below: When there is a order 1 & order 2, no emails send out When there is a order 2 but no order 1 set, then the approver gets the email. When there is a order 1 but no order 2 set, then the approve When there is no order defined, the approver email sends. I should note, that each email does work when pushed alone. We are using the python SDK “signers”: [ { “email”: signer_email, “role”: “signer”, “embed_url_external_user_id”: signer_email, “password”: “xxxxx”, “order”: 1 }, { “email”: approver_email, “role”: “approver”, “password”: “xxxxx”, “order”: 2 }

Hi, I am currently using the Sign Request API to prefill a pre-created sign template with some data for a signer. Most of the time, my fields prefill completely as expected. (I’m passing them in prefill_tags => {document_tag_id: "tag_name", "text_value": "value" } format, and that seems to be working.) However, every once in a while (maybe like one in every 4 sign requests?) my fields don’t populate correctly and are blank for the signer. I haven’t been able to identify any consistent similarities between these cases, and the success/failure cases have been with the exact same code and request pattern. Any thoughts on what might be going on here?

I am using the create sign request API with the following body to create a sign request: { "external_id": "10000", "parent_folder": { "id": "0", "type": "folder" }, "signers": [ { "role": "signer", "email": "ben.jessup@oasisdigital.com" }, { "role": "approver", "email": "benjamin.jessup@valiantys.com" } ], "source_files": [ { "id": "1056087946155", "type": "file" } ] } After signing and approving the request it goes into a “finalizing” state (shown as “In Progress” in the UI), then eventually goes into a “error_finalizing” status. Initially I encountered this in a Atlassian Connect Express application, but I saw the same behavior after using Postman to create the sign request. Any thoughts on what could be causing this error? Is there any way to see more detail on the error?

Introducing: Template APIs for Box Sign! Finally we can use the ‘/sign_request’ end point to create a signature request. Let’s start with the ‘template_id’: This functionality is currently broken. If a template_id is added to a sign_request, the request fails with a 404. Without the template_id, the sign request works as expected. The same 404 behavior is seen with the sign_templates/:template_id request to get a specific template by ID.

I am using the Box Sign API to create sign requests based on a sign template named “SimpleAckTemplate.pdf” for example. By default, both the sign document and the signing log would be named “SimpleAckTemplate (1).pdf” and “SimpleAckTemplate (1) Signing Log.pdf” respectively. I would like to change the file names using the “name” parameter in the API changing it to “SimpleAckTemplate_nnn” where nnn is our internal number. It seems to work partially as only the log file was changed. The sign file name was still defaulting to “SimpleAckTemplate (2).pdf”. I didn’t see another parameter in API that I can use. When making the sign request on Box Sign Web UI, both file names for log and sign would change per value specified on the “File Name” field. I don’t know what I am missing in the API. Thanks