How squiggli works
Envelopes, documents, signers and fields, the statuses they move through, and the difference between test and live.
Envelopes
An envelope is one signing job. It holds up to 10 documents, up to 20 signers and up to 500 fields. It is billed once, the first time it is sent, however many files or signers it has.
| Status | Means |
|---|---|
draft | Created, not sent. Change it, send it with POST /v1/envelopes/{id}/send, or delete it. |
sent | Out for signing. Nobody has opened it yet. |
viewed | At least one signer has opened it. |
signed | Everyone has signed. The signed PDF and certificate are ready. |
declined | A signer declined. Nobody else can sign it. |
voided | The sender cancelled it. |
expired | The deadline passed before everyone signed. |
Signers
Signers never need an account. Each one has a private signing link. With delivery: "email" squiggli emails it and sends the reminders; with delivery: "link" it sends nothing, and you show signing_url in your own app or embed it.
| Signer status | Means |
|---|---|
pending | Waiting for their turn (sequential signing). |
sent | Their link is out. |
viewed | They opened it. |
signed | They signed. |
declined | They declined, with an optional reason. |
Fields
A field is something one signer does at one place on one page.
| Type | The signer | Default size (points) |
|---|---|---|
signature | Draws or types their signature. | 200 x 50 |
initials | Draws or types their initials (or reuses their signature). | 60 x 32 |
date_signed | Nothing: filled with the date they sign. | 160 x 22 |
name | Confirms their name (prefilled). | 160 x 22 |
email | Confirms their email (prefilled). | 160 x 22 |
text | Types an answer. Prefill it with value. | 160 x 22 |
checkbox | Ticks a box. Optional unless required: true. | 14 x 14 |
Positions are in PDF points from the top-left corner of the page. An A4 page is 595 x 842 points; US Letter is 612 x 792. The envelope tells you every page's size in documents[].pages.
Test and live
| Test | Live | |
|---|---|---|
| Key | sq_test_..., or test: true with a live key | sq_live_... |
| Cost | Free, unlimited (100 sends a day) | $1.00 per envelope, $1.50 white-labelled, first 15 free |
| Documents | Watermarked "TEST - NOT LEGALLY BINDING" | Clean |
| Emails | Subject starts with [Test] | Normal |
| Everything else | Identical | Identical |