Developers

The Ink API

Send documents for signature from your own systems, follow every signer, and pick up the sealed PDF the moment it's done.

Keys with only the access they need

Owners and admins make keys in Settings, choose exactly what each may do, and revoke them in one click.

Signed webhooks

Hear when a document is sent, opened, signed, declined, voided or finished, without asking over and over.

Safe to retry

Send an Idempotency-Key and a request that timed out can be sent again without a second document going out.

The same rules as the app

Every API send gets the same consent, signer checks, sealed PDF and audit trail as one sent by hand.

Generous limits

120 requests a minute per key, and up to 1,000 documents sent a day per organization.

OpenAPI 3.1

Generate a client in any language from the published contract, or call it with plain HTTPS and JSON.

Quickstart

Send your first document in five minutes

The API is part of the Business plan. Every request goes to the address below over HTTPS, with JSON in and out.

Base URLhttps://api.inkdocs.app/v1

  1. Step 1

    Make a key

    In Ink, an owner or admin opens Settings, then API keys, names the key, and picks what it may do. The key is shown once. Keep it in your system's secret store, never in a web page or app people download. It acts as the person who made it, so documents it sends come from them.

  2. Step 2

    Check it works

    Request
    curl https://api.inkdocs.app/v1/me \
      -H "Authorization: Bearer $INK_API_KEY"
  3. Step 3

    Send a document

    Give Ink the PDF as a public https link (up to 20 MB) or as base64, name the signers in signing order, and place each field. Positions are fractions of the page from its top left corner, so 0.5 is halfway across.

    Request
    curl https://api.inkdocs.app/v1/envelopes \
      -H "Authorization: Bearer $INK_API_KEY" \
      -H "Content-Type: application/json" \
      -H "Idempotency-Key: offer-1042" \
      -d '{
        "title": "Offer letter for Jordan Lee",
        "document": { "url": "https://files.example.com/offer-1042.pdf" },
        "signers": [{ "name": "Jordan Lee", "email": "jordan@example.com" }],
        "fields": [
          { "signer": 1, "type": "signature", "page": 1,
            "x": 0.1, "y": 0.82, "width": 0.3, "height": 0.05 },
          { "signer": 1, "type": "date", "page": 1,
            "x": 0.6, "y": 0.82, "width": 0.2, "height": 0.04 }
        ],
        "send": true
      }'

    Or start from a template: list them with GET /templates, name one person per role, and fill the fields the sender answers by their label.

    From a template
    curl https://api.inkdocs.app/v1/envelopes \
      -H "Authorization: Bearer $INK_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "title": "Welcome packet: Jordan Lee",
        "templateId": "TEMPLATE_ID",
        "signers": [
          { "role": "Employee", "name": "Jordan Lee", "email": "jordan@example.com" },
          { "role": "HR", "name": "Sam Ortiz", "email": "sam@example.com" }
        ],
        "prefill": { "Start date": "2026-12-01", "Job title": "Technician" },
        "send": true
      }'
  4. Step 4

    Hear when it's done

    Add a webhook in Settings, or with POST /webhooks. Ink sends a signed JSON message for each event you choose, and tries again for a day if your system doesn't answer. Then download the sealed PDF and its certificate.

    Download
    curl https://api.inkdocs.app/v1/envelopes/$ID/document \
      -H "Authorization: Bearer $INK_API_KEY" -o signed.pdf
    Check a webhook
    // Node.js: check Ink-Signature before trusting a webhook
    import crypto from "node:crypto";
    
    function fromInk(rawBody, header, secret) {
      const [t, v1] = header.split(",").map((part) => part.split("=")[1]);
      const expected = crypto
        .createHmac("sha256", secret)
        .update(`${t}.${rawBody}`)
        .digest("hex");
    
      return (
        v1.length === expected.length &&
        crypto.timingSafeEqual(Buffer.from(v1), Buffer.from(expected)) &&
        Math.abs(Date.now() / 1000 - Number(t)) < 300
      );
    }

Reference

Endpoints

Every endpoint, and the permission its key needs.

  • get/envelopesList envelopesdocuments:read
  • post/envelopesCreate an envelope, and send itdocuments:write
  • delete/envelopes/{id}Delete a draftdocuments:write
  • get/envelopes/{id}Get an envelope and its signers' progressdocuments:read
  • get/envelopes/{id}/certificateDownload the certificate and audit traildocuments:read
  • get/envelopes/{id}/documentDownload the signed PDFdocuments:read
  • post/envelopes/{id}/remindRemind the signer whose turn it isdocuments:send
  • post/envelopes/{id}/sendSend a draftdocuments:send
  • post/envelopes/{id}/voidVoid a sent envelopedocuments:send
  • get/meCheck a key
  • get/templatesList templatestemplates:read
  • get/templates/{id}Get a template's roles and prefill fieldstemplates:read
  • get/webhooksList webhookswebhooks:manage
  • post/webhooksAdd a webhookwebhooks:manage
  • delete/webhooks/{id}Remove a webhookwebhooks:manage

The full contract, with every field, is the OpenAPI file. Load it into Postman or any OpenAPI tool, or generate a client from it.

Permissions

documents:read
List envelopes, read their status and download the files.
documents:write
Upload PDFs and create drafts, from a file or a template.
documents:send
Send documents for signature, remind signers and void.
templates:read
List templates and the people and fields they need.
webhooks:manage
Add and remove webhook addresses.
hr:read
Also reach documents labeled Confidential · HR. Owners only.

Webhook events

packet.completed
Every document of a packet is signed, such as a new hire's paperwork.
packet.stopped
A packet stopped because a document was declined or voided.
envelope.completed
Everyone signed a document, in a packet or on its own.
envelope.sent
A document went out for signature.
envelope.viewed
A signer opened their signing link for the first time.
envelope.signed
One signer signed. The document may still need others.
envelope.declined
A signer declined to sign.
envelope.voided
The sender voided a document before everyone signed.

Errors

Errors use the HTTP status and always have the same shape, with a type your code can check and a message a person can read.

Example
HTTP/1.1 403 Forbidden
{
  "error": {
    "type": "insufficient_scope",
    "message": "This API key can't do this. It needs the \"documents:send\" permission."
  }
}

Limits, paging and retries

  • 120 requests a minute per key and 600 per organization. Every answer says how many are left in RateLimit-Remaining, and a 429 says when to try again in Retry-After.
  • Lists come newest first, up to 100 at a time. Pass nextCursor back as cursor for the next page.
  • Send an Idempotency-Key header on a POST and sending it again within a day returns the first answer instead of doing it twice.
  • Within v1 we only add: new fields and endpoints, never removed or renamed ones. Ignore fields you don't know.