Skip to main content

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/reference/get-sign-requests-id/

Is it possible to get the user-filled field input from a Box Sign request after it has been signed?

The /2.0/sign_requests/:sign_request_id endpoint is what we are using to get the filled form inputs for our solution.

Once the status of the request is signed, then you can retrieve the inputs from within the response’s signers array, under the role: "signer" object, you can refer to the inputs array for the filled data

e.g. 

 

"signers": i{

"email": "exampletest@gmail.com",

"role": "signer",

...

"inputs": i

  {

  "document_tag_id": "BusinessZIP",

  "text_value": "07304",

  "checkbox_value": null,

  "date_value": null,

  "type": "text",

  "content_type": "text",

  "page_index": 0,

  "read_only": false

  } ]

...
}]

The External Identifier you set would be available as the document_tag_id and the user input available as text_value. Note that the access token you are calling the API with must have the sign_requests.readwrite scope applied to it.

 

Hope this is helpful!


Thanks for the detailed response, @mike.curry  I'm going to dig more into access token permissions. I'm using JWT tokens to authenticate with the Box API. I thought JWT had full permissions to everything, but my response to that API call leaves off the signers key. The response I get is below, with ids obscured.

{
"id": "<uuid>",
"type": "sign-request",
"name": "<filename>.pdf",
"sign_files": {
"files": :
{
"id": "<integer id>",
"etag": "2",
"type": "file",
"sequence_id": "2",
"name": "<filename>.pdf",
"sha1": "<hash>",
"file_version": {
"id": "<integer id>",
"type": "file_version",
"sha1": "<hash>"
}
}
],
"is_ready_for_download": true
},
"signing_log": {
"id": "<integer id>",
"type": "file",
"etag": "0",
"file_version": {
"id": "<integer id>",
"type": "file_version",
"sha1": "<hash>"
},
"name": "<filename>.pdf",
"sequence_id": "0",
"sha1": "<hash>"
},
"source_files": :],
}


 


Reply