Embedded Signing

Embed a PandaDoc document and invite customers to sign documents right on your website or in an app, without them having to check email.

Here’s how you create a wireframe to embed a document:

Generate a Session Id

Your application must perform this sequence of calls:

  1. Create a document from a template or a PDF: POST https://api.pandadoc.com/public/v1/documents. Fetch document_id from the response.
  2. Since the Create Document endpoint is asynchronous, make sure that your document is ready for embedding. For this, use document_id to call Document Status until the document status is document.draft: GET https://api.pandadoc.com/public/v1/documents/{document_id}.
  3. Send your document: POST https://api.pandadoc.com/public/v1/documents/{document_id}/send. Use the silent: true parameter so that you don't send any emails to recepients.
  4. Create a document link: POST https://api.pandadoc.com/public/v1/documents/{document_id}/session. Use the id from the response to create a session.

The optimal flow we recommend is as follows:

Embed Document

Use the session_id from the previous section within an HTML iframe like this:

<iframe src="https://app.pandadoc.com/s/{document_id}/"></iframe>

❗️

Identity Verification

Any user who views a document within the generated session ID can act on behalf of the recipient you created a view session for. It's your responsibility to verify viewers' identities.

Embedded Document JavaScript Events

When embedding a PandaDoc document, you may wish to perform custom application events based on viewer activity. For example, when the document is completed, redirect a user to another application page. That's where view session JavaScript events come in handy.

There are three available events:

  1. session_view.document.loaded - the document loaded.
  2. session_view.document.completed - a document recipient filled in the assigned fields and finalized the document. At this point, the document can be in the Viewed status in case there are several Signers in the document or in the Completed status in case there is only one Signer or the last Signer has finalized the document.
  3. session_view.document.exception - an error occurred while finalizing the document.

Here's a snippet of how you can register an event handler and process these events. Make sure to replace the iframe src URL with your own session id:

<!doctype html>
<html>
<body>
<iframe src="https://app.pandadoc.com/s/{id}/" width="800" height="800"></iframe>
<script>
window.addEventListener('message', (event) => {
  const type = event.data && event.data.type;
  const payload = event.data && event.data.payload;

  switch (type) {
    case 'session_view.document.loaded':
      console.log('Session view is loaded');
      break;
    case 'session_view.document.completed':
      console.log('Document is completed');
      console.log(payload);
      break;
    case 'session_view.document.exception':
      console.log('Exception during document finalization');
      console.log(payload);
  }
});

</script>
</body>
</html>