Integrate embedded signing into your application
Integrating embedded signing into your application allows you to seamlessly incorporate BoldSign's document signing functionalities within your app's user interface.
The embedded signing request enables signers to complete the signing process for documents within your website or mobile app by using an iFrame, popup window, or a new tab.
Follow these steps to effectively integrate embedded signing into your application:
1. Send the document for signing
Begin by sending the document to the designated signer. Refer to the documentation Send document for detailed instructions on how to send a document. This process will return a document ID, which you'll use to generate the embedded signing link.
2. Customize UI for embed signing request
Design a user interface (UI) within your application that collects the necessary information for the embedded signing request. This information serves as the foundation for signing the document.
For instance, you can collect user input for the signerEmail
parameter.
The following code examples demonstrate how to create an embedded sign request:
Code snippet
curl -X GET ' https://api.boldsign.com/v1/document/getEmbeddedSignLink?documentId={Your document Id}&signerEmail={signer email} \ -H 'X-API-KEY: {your API key}'
var apiClient = new ApiClient("https://api.boldsign.com", "{your API key}"); var documentClient = new DocumentClient(apiClient); EmbeddedSigningLink embeddedSigningLink = await documentClient.GetEmbeddedSignLinkAsync("{Your document Id}", "{signer email}").ConfigureAwait(false); string signLink = embeddedSigningLink.SignLink;
import requests url = "https://api.boldsign.com/v1/document/getEmbeddedSignLink?documentId={Your document Id}&signerEmail={signer email}" payload={} headers = { 'X-API-KEY': '{your API key}' } response = requests.request("GET", url, headers=headers, data=payload) print(response.text)
const axios = require('axios'); const response = await axios.get('https://api.boldsign.com/v1/document/getEmbeddedSignLink?documentId={Your document Id}&signerEmail={signer email}', { headers: { 'X-API-KEY': '{your API key}' } });
In the provided example, replace the placeholder signerEmail
with the actual input value gathered from your application's UI.
However, parameters like documentId,
redirectUrl,
and signLinkValidTill
should be predefined in your application.
It's essential to verify the signer's identity before granting access to the signing URL. This verification step ensures that the eSignature remains legally binding.
By executing the provided code, you will generate an embed link that allows the signer to access and sign the document.
3. Utilize the generated link in an iFrame
With the embed link in hand, seamlessly integrate it into an iFrame element within your application. This iFrame empowers your application users to sign the document directly within your application's interface. This approach significantly streamlines the document signing process for users, enhances their experience, and fosters efficient document management within your application.