Create Embeded RequestUrl

POST {{apiBaseUrl}}/v1/document/createEmbeddedRequestUrl

Generating the embedded request link is the same as sending the regular document but with additional properties to customize the embedded process. Please refer the Send document article for the send document API specific properties.

Asynchronous document processing:

The document creation process is asynchronous in nature. You will receive an embedded request URL and document ID immediately, but the uploaded document might be still processing in the background. In the mean time, if you open the embedded request URL in the browser, you will see the progress of the document processing

Request Body

[{"name"=>"Title", "value"=>"Sample Doc1", "datatype"=>"string"}, {"name"=>"ShowToolbar", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"ShowSaveButton", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"ShowSendButton", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"ShowPreviewButton", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"ShowNavigationButtons", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"SendViewOption", "value"=>"FillingPage", "datatype"=>"string"}, {"name"=>"RedirectUrl", "value"=>"https://boldsign.com/esignature-api/", "datatype"=>"string"}, {"name"=>"SendLinkValidTill", "value"=>"2023-10-21T06:37:57.424Z", "datatype"=>"string"}, {"name"=>"Locale", "value"=>"IT", "datatype"=>"string"}, {"name"=>"ShowTooltip", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"Files", "value"=>nil, "datatype"=>"null"}]

RESPONSES

status: Created

{&quot;documentId&quot;:&quot;12345678-493e-4175-85c7-a71d32b575cd&quot;,&quot;sendUrl&quot;:&quot;https://app.boldsign.com/document/embed/?documentId=12345678-xxxx-xxxx-xxxx-a71d32b575cde_IJ7SAxYi;ef10f61f-5643-47f7-8210-c10bd1161e3c\u0026lang=it&quot;}