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, have at least one Signer and one Signable Document, and must not have Document visibility restrictions.
get/signature_requests/{signatureRequestId}/embedded_preparation_link
Request
- Base URLhttps://api-sandbox.yousign.app/v3
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
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.
Example response
{
"url": "https://app.yousign.com/embedded-preparation/3ddb8590-87d8-4072-a554-63983af849ef?s=eyJ...&r=abc123&lang=fr&sandbox=false"
}Changes
No recorded changes to this operation across all 2 revisions of this API.