If you want to use the eSign Service API from the Swagger page or from your own HTTP client (Postman, Insomnia, etc.), then you will need an auth token.

You can use this demo page to generate an auth token that is valid for Pre-Prod environments. Clicking on Generate above will give you a token that is valid for 120 minutes.

This is a bearer token, and if you are writing your HTTP headers manually, you can write:
Authorization: Bearer YourTokenGoesHere

Token expired or not yet created...
Please try clicking the Generate button.

Choose the document template, i.e. the "blank" document which is not yet specialized for these parties & details.

Currently.. there are only five document templates available in the demo, but that could certainly change in the future. It would just require some manual work for this page, no change to the eSign software.

There is the SiteLink example, and there is a second version of that document with extra fields added, to show different features.

The parties are the persons involved in the document. You can specify them here and also give a title to this specific document.

In the final product, a party may be referenced by a global ID for that person; a UUID might already exist in Polaris. In this demo, you can give the persons' details and new entities will be created within the eSign database.

These personal details (like names) do not show up in the demo PDF, because it has already been hardcoded with Halle B. Berry, etc. They do show up in the informational parts of the UI.

Property Manager

Tenant

Document Title

FMS

Branding & Theme

Just a few colors within the "light" theme, so you can see & test.

Document Packets

Document packets are a way to group documents together when signed.

Checking this option will link documents in the Create/Prepare stage.

Document packets require filling out the Property Manager/Tenant information above. More specifically the email address is required.

This creates the document and makes it ready for signing. It calls the /prepare API endpoint and "prepares the document [for signing]." This effectively creates a Document and a DocumentPreparation from the document template & party-input specifications.

Here are IDs and basic data from the document that was just created.

Document Packet IDnone
Document IDnone
Manager Party IDnone
Tenant Party IDnone

This link opens the page that the manager would see when signing the current document.

That page might be embedded within another page in the real UX.

This link opens the page that the tenant would see when signing the current document.

That page might be embedded within another page in the real UX.

Creates an invitation for the tenant to sign. Then a URL is produced and the tenant could sign by visiting the URL.

You could create multiple invitations for the same tenant & document using this demo page, and then only the most recent one is represented in the below stages & links. The earlier ones would be lost to history.

When creating the document using the API, you can set "policies," including whether an invitation is required for signing. For this demo page, that policy is not set; invitations are not required for signing.

Follows the link generated above, similar to clicking on a magic link within an email.

Invalidates the above link.

XAdmin summary

This is a data dump describing the document which is available to the other Storable services using the API. Its format & data are WIP, currently an educated guess. Feel free to suggest changes.

(document not yet created)
YDocument prepare DTO

This is the body of the HTTP request sent by this demo page to the eSign Service when preparing the most recent Document.

(document not yet created)
ZDownload completed PDF

This will download the current document.

If the document has been completed by all parties, it will be downloaded to your computer.