Embedded Sign

The embedded sign request will allow the signers to sign the document within your website or mobile app using an iFrame, popup window, or new tab.

Once you successfully create the new document by referring to the article Send document, it will return the document Id, which we can use to generate the embedded signing link.

Please note that Identity Verification enabled signer's documents are not supported at the moment to generate embedded signing link.

Get embedded signing link

get/v1/document/getEmbeddedSignLink

Let us walk through generating the embedded signing link and how it can be embedded into Iframe.

Validating the signer's identity

Please note that you are responsible for verifying the signer's identity before providing them access to the signing URL. This step is required to ensure that the eSignature is legally binding.

BoldSign produces an audit trail with a note saying that the document was signed with an embedded signature link. You must maintain records separately that your system validated the signer's identity before providing them access to the BoldSign embedded document URL for signing.

Code snippet

curl -X GET ' https://api.boldsign.com/v1/document/getEmbeddedSignLink?documentId=17882g56-6686-46d9-dhg3-ce5737751234&signerEmail=alexgayle@cubeflakes.com&redirectUrl=https://www.syncfusion.com/&signLinkValidTill=10/14/2022' \
-H 'X-API-KEY: {use your API-KEY here}'

var apiClient = new ApiClient("https://api.boldsign.com", "{use your API-KEY here}");
var documentClient = new DocumentClient(apiClient);
EmbeddedSigningLink embeddedSigningLink = await documentClient.GetEmbeddedSignLinkAsync("17882g56-6686-46d9-dhg3-ce5737751234", "alexgayle@cubeflakes.com", DateTime.Now.AddDays(30), "https://www.syncfusion.com/").ConfigureAwait(false);
string signLink = embeddedSigningLink.SignLink;

import requests

url = "https://api.boldsign.com/v1/document
/getEmbeddedSignLink?documentId=17882g56-xxxx-xxxx-xxxx-ce5737751234&signerEmail=
alexgayle@cubeflakes.com&
redirectUrl=https:
//www.syncfusion.com/&signLinkValidTill=10/14/2022"

payload={}
headers = {}

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=17882g56-6686-46d9-dhg3-ce5737751234&signerEmail=alexgayle@cubeflakes.com&redirectUrl=https://www.syncfusion.com/&signLinkValidTill=10/14/2022', {
    headers: {
        'X-API-KEY': '{use your API-KEY here}'
    }
});

Query parameters

DocumentIdstringRequired	The document Id that you got after the successful creation of the document.
SignerEmailstring	Define the SignerEmail, which is used to identify to which recipient in the document you need to generate the embedded signing link. The string should be in binary format. Please note that you need to pass the signer email that you used while creating the document. If you send the signer email which is not part of the document, the API will throw an error.
CountryCodestring	Define the CountryCode of the signer phone number which is used to identify to which recipient in the document you need to generate the embedded signing link. Please note that you need to pass the country code of the signer phone number that you used while creating the document.
PhoneNumberstring	Define the PhoneNumber which is used to identify to which recipient in the document you need to generate the embedded signing link. Please note that you need to pass the actual phone number of the signer that you used while creating the document.
SignLinkValidTillstring	It is used to define how long the signers can sign the document using the embedded signing link. The string should be in date-time format.
RedirectUrlstring	You can set this properly once the signer has completed the signing process and needs to be redirected to a specific site.

Example response

200 Success

{
    "signLink": "https://app.boldsign.com/document/sign/?documentId=17882f5a-xxxx-xxxx-xxxx-ce5737756339s_dyU07;dfeab145-xxxx-xxxx-xxxx-d705b85823c8"
}

NOTE: Please note that if you expect the signers to sign the document within your application only, then you can disable the emails sending from the BoldSign application while sending the signature request. Please refer to this article Send document, for more information.