Quickstart

Time to first signature

The goal is a first signed document within 30 minutes. In order: make a key (below), make a template (step 1), send it to yourself (step 2), open the signing email and sign, then read the executed document (step 3). Use a test key first, then a live one. In a scripted run on our test environment (sign-up, key, template, send, email, sign) the product's own waiting time was about 20 seconds, so almost all of your time is reading and writing the template.

You need a Docustay workspace and a key. In the app open Developers → API keys and make a key with the scopes documents:read and documents:write. Make a test key first (it starts dsk_test_): everything it does is a practice run.

A test key only works on a workspace that has test mode enabled. If your first request answers 401, check that you copied the whole key and that it is a key of this workspace.

The examples use https://app.docustay.app. A self-hosted install or a practice server has its own address: put that address in the commands instead, and pass it to the SDKs as baseUrl (JavaScript) or base_url (Python).

1. Make a template

A template is a document with places for people to sign. The quickest way is HTML with text tags (see Templates and text tags):

curl -X POST https://app.docustay.app/api/v1/templates/html \
  -H "Authorization: Bearer $DOCUSTAY_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Simple NDA","html":"<h1>Mutual NDA</h1><p>Both parties keep each other'"'"'s information private.</p><p>Signed: {{Sign here;type=signature;role=Partner}}</p>"}'

The answer holds the templateId and how many fields were placed.

2. Send it

curl -X POST https://app.docustay.app/api/v1/documents/send \
  -H "Authorization: Bearer $DOCUSTAY_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"templateId":"<templateId>","title":"NDA with Acme","parties":[{"seat":"signer_1","name":"Alex Rivera","email":"alex@example.com"}]}'

seat is the template's seat key. Seats appear in the order roles first appear in the document: the first role is signer_1, the next signer_2. GET /api/v1/templates/{id} lists them.

3. Follow it

curl https://app.docustay.app/api/v1/documents/<id> -H "Authorization: Bearer $DOCUSTAY_KEY"

state moves sent → partially_signed → executed (or declined, expired, void). When it is executed, GET /api/v1/documents/{id}/signed.pdf returns the sealed copy.

The same in code

import { Docustay } from "@docustay/sdk";
const docustay = new Docustay(process.env.DOCUSTAY_KEY);
const { templateId } = await docustay.createTemplateFromHtml({ name: "Simple NDA", html: "<p>Signed: {{Sign here;type=signature;role=Partner}}</p>" });
const { id } = await docustay.sendDocument({ templateId, parties: [{ seat: "signer_1", name: "Alex Rivera", email: "alex@example.com" }] });
console.log((await docustay.getDocument(id)).state);

from docustay import Docustay
d = Docustay(os.environ["DOCUSTAY_KEY"])
t = d.create_template_from_html("Simple NDA", "<p>Signed: {{Sign here;type=signature;role=Partner}}</p>")
doc = d.send_document(t["templateId"], [{"seat": "signer_1", "name": "Alex Rivera", "email": "alex@example.com"}])
print(d.get_document(doc["id"])["state"])

Next: get told when it is signed instead of asking.