Quickstart

From an empty account to a published envelope, in five requests. Everything below uses the production host; a sandbox token targets sandbox automatically.

https://api.signater.com

Before you start

An API token from Settings → Profile → API Tokens (app.signater.com/settings/profile/api-tokens).

An account on the Business plan or above — the API is not available below it.

A vault. A new account has none, and vaultId is required.

Set the token once:

1. Pick a vault

Every envelope lives in a vault. List the ones you can write to and keep an id.

{
  "items": [
    { "id": "0f6a1f0c-7d51-4a7e-9c39-2b3f9e0e11aa", "name": "Contracts", "type": "UserAccount" }
  ],
  "pagination": { "totalItems": 1, "pageSize": 10, "pageNumber": 1, "pageItems": 1 }
}

2. Upload the document

Upload the file first and keep the id it returns. The envelope references it — you cannot post a file inside the envelope payload.

{
  "id": "b21f7a5e-3c44-4a91-90d2-6f0d5d9a77e1",
  "fileName": "contract.pdf",
  "originalFileSize": 184320
}

3. Create the envelope

Bring the vault id, the document id, and the people who sign.

{ "id": "c8d3b120-40aa-4f6f-9a3b-1d2e5f7c9012" }

The envelope is now in Draft. Nobody has been contacted.

4. Publish

Publishing invites the signers and debits one envelope from the account balance.

204 No Content means it is live. Ana receives her invitation.

Two responses worth handling here: 402 means the account has no envelope balance and nothing was consumed; 409 means another request is publishing the same envelope and you should retry shortly.

5. Collect the result

Wait for the envelope.signed Webhooks, or read the envelope:

Once status is Signed, fetch the signed file and the audit certificate:

GET /v1/ecm/documents/{documentId}/signed
GET /v1/ecm/envelopes/{envelopeId}/certificate

Both return a JSON body with a url. That URL is presigned and lives about a minute — download the bytes right away rather than storing the link or passing it to a later job.

Signers without email

If a signer has no email address, create a link and deliver it however you like:

GET /v1/ecm/envelopes/{envelopeId}/signers/{signerId}/signature-link

{ "url": "https://app.signater.com/review/5241f81e-e7e2-447a-8534-ee08931260ae" }

Concepts — the full object model, including form fields and identity checks.

Signer states — what to expect between publication and completion.

Retries and idempotency — before you go to production.

Before you start#

1. Pick a vault#

2. Upload the document#

3. Create the envelope#

4. Publish#

5. Collect the result#

Signers without email#

Next#