Fetch embedded sending URL

post

https://api.signeasy.com/v3/rs/embedded/url

Get a link that opens the sending screen inside your app. Your user places the fields and sends the envelope without leaving your product. You can also place fields ahead of time with fields_payload and fill template merge fields with merge_fields. Your user sees them on the sending screen before sending. Each link works for an hour, and you can create 100 a day.

Generate a URL to embed the sending experience right within your applications. This will let the sender place and assign fields and send signature requests to the recipients declared when the URL is generated.

You can generate 100 URLs per day, each valid for one hour from the time of generation.

Pre-fill by Sender or Earlier Signers
Fill text, checkbox, and combobox fields before the recipient they belong to signs. Give each field a label and a fillable_by. For pre-fill by sender, set fillable_by.sender to true and put the value in prefill_value. For pre-fill by earlier signers, list them in fillable_by.recipients and set is_ordered to true. Both are available only on the API Advanced Plan. Merge fields for templates (merge_fields) stay available on all API plans. Reach support or sales for more details.

Body Params

sources

array of objects

required

The original file id which must be self signed.

sources*

message

string

recipients

array of objects

required

A collection of recipient objects. Recipient emails on reserved test domains such as example.com are rejected with 422 signer_email_rejected_as_spam, so use a real inbox you control when testing.

recipients*

redirect_url

string

embedded_signing

boolean

When set to true suppresses all emails sent for this signature request.

is_ordered

boolean

required

When set to true the recipients will sign the documents in the specified order. The order is the order of the recipients list. Must be true when a field's fillable_by.recipients lets an earlier signer pre-fill it.

signature_panel_types

array of strings

The list of options you'd want your signer to see at the time of signing. Possible values: "draw", "type" and "upload"

signature_panel_types

initial_panel_types

array of strings

initial_panel_types

recipient_role_mapping

array of objects

recipient_role_mapping

fields_payload

array of objects

Programmatically place fields on the documents based on x-y coordinates or a reference text.

fields_payload

merge_fields

array of objects

Collection of dynamic field objects with data to pre-fill data on templates programmatically. These are merge fields for templates, available on all API plans.

merge_fields

expires_at

date

The date the envelope expires, in YYYY-MM-DD. It expires at 23:59:59 UTC on that day, so the earliest date you can send is tomorrow in UTC. Leave it out and the envelope expires 365 days after you create it.

Responses

Pre-fill by Sender or Earlier Signers

201201

400Required fields are missing, an ID or the expiry date is invalid, or the JSON is malformed

401Missing, expired, or invalid access token

422A recipient uses a blocked email domain, or the account is out of credits