Document Get Embeded Signing Link

GET {{apiBaseUrl}}/v1/document/getEmbeddedSignLink?documentId={{documentId}}&signerEmail=hankwhite@cubeflakes.com&countryCode=+1&phoneNumber=234****45&redirectUrl=https://boldsign.com/esignature-api/

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

Request Params

KeyDatatypeRequiredDescription
documentIdstringThe document Id which you got after the successful creation of the document.
signerEmailstringDefine 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.
countryCodestringDefine the country code 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.
phoneNumberstringDefine the Actual 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 actual phone number of the signer that you used while creating the document.
redirectUrlstring

RESPONSES

status: OK

{"signLink":"https://app.boldsign.com/document/sign/?documentId=12345678-xxxx-xxxx-xxxx-1234a78abc90_Qurno;ef10f61f-5643-47f7-8210-c10bd1161e3c"}