v1

latestOpenAPI 3.0.0proprietary2026-07-261695971.5 MB
Signature Request

Retrieves an Embedded Preparation Link for a Signature Request

Returns a short-lived link opening the Signature Request Embedded Preparation. The Signature Request must be in draft status, be initiated via the API, and have at least one Signer and one Signable Document.

get/signature_requests/{signatureRequestId}/embedded_preparation_link

Path parameters

signatureRequestIdstring uuid required

The unique identifier for a resource.

Example:9a93d3b5-fb3b-4abf-9e70-26315b33506c

Signature Request Id

Query parameters

locale'de' | 'en' | 'es' | 'fr' | 'it' | 'nl' | 'pl'
Example:fr

Language of the Signature Request Embedded Preparation UI. Defaults to the organization's language.

Response

Signature Request Embedded Preparation link generated successfully.

urlstring uri required

Short-lived URL opening the Signature Request Embedded Preparation. Expires after 10 minutes.

Example response

{
  "url": "https://app.yousign.com/embedded-preparation/3ddb8590-87d8-4072-a554-63983af849ef?s=eyJ...&r=abc123&lang=fr&sandbox=false"
}