This article will provide you with a basic overview of embed Ironclad Signature. You can find detailed documentation on our Developer Hub.
What is Embedded Ironclad Signature?
You can embed Ironclad Signature's signing experience directly into your own website. This lets customers sign documents without being redirected to a separate domain, keeping them on your site throughout the entire process. In this embedded experience, your customers can sign, decline, reassign, and cancel signature process.
How Does this Differ From Copy Signing Link Functionality?
This is similar to the Copy Signing Link functionality, in that Embedded Signing provides the ability to generate a URL for a signer’s signing page. There are, however, a few differences:
| Copy Signing Link | Embedded Ironclad Signature |
|---|---|
| Only available with Ironclad Signature | Only available with Ironclad Signature |
| Accessible through the Ironclad CLM UI in the Sign step of a workflow | Not accessible through the Ironclad CLM UI. Requires public API access to generate an embeddable URL. |
| Permissions set in Company Settings, Workflow Designer, and on an OAuth app (if retrieved via the public API) | This requires the same permissions as 'Copy Signing Link' within Company Settings, along with a token scope for the public API endpoint. |
| Public API Documentation | Public API Documentation |
| Link expires in 30 days, just like the one sent in a signature request email. No limit to the number of times the link is used within those 30 days. | Link expires in 5 minutes, and is single-use only. |
| Cannot embed in an iframe | Embeddable in an iframe, specifically in a page whose hostname (e.g. https://example.com) matches the frameAncestor specified in the public API request body |
| N/A | Posts messages to parent page on load, sign, decline, reassign, and error actions, so that the parent page can proceed with the rest of the user flow accordingly. |
The format of the message passed is an object, e.g. { type: 'sign' }, or { type: 'error', action: 'sign'} for errors.
How Do I Use Embed Signing?
You must have Public API access to use this functionality. If you do not have Public API access and would like to learn more, reach out to your Ironclad representative.
With Public API access enabled and the workflow configuration Sign settings set to allow users to copy signing links, you must create an OAuth app with the Embedded Signer URLs token scope.
You can find detailed developer documentation on the Ironclad Developer Hub.