Embed the document creation into your application
Integrating embedded document creation into your application allows you to seamlessly incorporate BoldSign’s document creation functionalities within your app’s user interface.
When utilizing the embedded document feature, documents generated will remain in the draft
state until users finalize the creation process via the provided URL.
Follow these steps to seamlessly integrate document creation into your application:
Customize UI for embed document request
In your application, create a user interface (UI) that allows users to input relevant information for the embedded document request. This information will be used to create the document.
For instance, collect user inputs for the following parameters:
Title
Message
Signers
- Other customization options (e.g., ShowToolbar, ShowSaveButton, SendViewOption, etc.)
Here are example codes that demonstrate how to create an embedded document:
Code snippet
curl -X POST 'https://api.boldsign.com/v1/document/createEmbeddedRequestUrl' \
-H 'X-API-KEY: {your API key}' \
-F 'Title=Sent from API Curl' \
-F 'ShowToolbar=true' \
-F 'ShowNavigationButtons=true' \
-F 'ShowPreviewButton=true' \
-F 'ShowSendButton=true' \
-F 'ShowSaveButton=true' \
-F 'SendViewOption=PreparePage' \
-F 'ShowTooltip=false' \
-F 'Locale=EN' \
-F 'Message=This is document message sent from API Curl' \
-F 'EnableSigningOrder=false' \
-F 'Signers[0][Name]=Signer Name 1' \
-F 'Signers[0][EmailAddress]=alexgayle@cubeflakes.com' \
-F 'Files=@{Your file Path};type=application/pdf'
In the above example, replace placeholders (Title
, Message
, etc,.) with actual input values gathered from your application’s UI. If your application supports multiple signers, tailor the UI accordingly. Update values within the Signers
array to match customized signers. Customize button options (ShowSaveButton
, ShowSendButton
, etc,.) based on requirements by setting them to true
or false
. To direct users to a form field configuration page, set SendViewOption
to PreparePage
. For a document upload page, set SendViewOption
to FillingPage
.
Executing the provided code will generate an embed link, and the document will be stored in draft status within your BoldSign account.
Utilize the generated link in an iFrame
Once the embed link is generated, integrate it into an iFrame within your application. This iFrame enables your application users to:
- Add extra signers
- Upload additional documents
- Configure form fields
- Send the document to the signer for signing
After sending the document, it will be delivered to the signer via email. This approach streamlines document creation for users, enhancing their experience and promoting efficient document management within your application.