API v1.0.0 · https://api.readyink.ai/v1
Developers

readyink.ai API

Send PDFs for signature from your own software, then download the signed copy when everyone has signed. The API uses the same tokens as the app: one token per signer, and copy recipients are free.

How a send works

Every signing request follows the same five steps. Each step is one or two API calls.

  1. 1
    Create a draftPOST /documents with the PDF, a title and your recipients.
  2. 2
    Place fieldsPOST /documents/{id}/fields to put signature, date and text boxes where each signer fills them in.
  3. 3
    Check the costGET /documents/{id}/quote shows the tokens needed and anything to fix first.
  4. 4
    SendPOST /documents/{id}/send with an Idempotency-Key, so a retry never sends or charges twice.
  5. 5
    Collect the resultsCheck the status, then download the signed PDF and the certificate of completion.
Your first call
curl https://api.readyink.ai/v1/account \
  -H "Authorization: Bearer $READYINK_API_KEY" 
const res = await fetch("https://api.readyink.ai/v1/account", {
  headers: { Authorization: `Bearer ${process.env.READYINK_API_KEY}` },
});
console.log(await res.json());
import os, requests

res = requests.get(
    "https://api.readyink.ai/v1/account",
    headers={"Authorization": "Bearer " + os.environ["READYINK_API_KEY"]},
)
print(res.json())

What's in the API

Area What you can do
Account Check which account a key belongs to, whether it's live or test, and your token balance.
Documents Create drafts, upload the PDF, list and filter documents, change settings, delete drafts.
Recipients Add signers and copy recipients, notify them by email, text or both, and fix a wrong email after sending.
Fields Place up to 200 fields per request across 16 field types, from signatures to dropdowns.
Sending Get a quote, send safely with idempotency keys, and cancel a document that's out.
Results Read the activity history, download the signed PDF and the certificate of completion.

Base URL and format

All requests go to https://api.readyink.ai/v1 over HTTPS. Send JSON with Content-Type: application/json, or multipart/form-data when you upload a PDF. Every response is JSON, except the two download endpoints, which redirect to the file.

Start in test mode

Keys that start with ri_test_ use the sandbox. Sends are free, emails and texts go to your test inbox, and the text code is always 000000. Switch to an ri_live_ key when you're ready. Read about test mode.

Tools and resources

  • Interactive API reference: the full OpenAPI reference, hosted with the API.
  • OpenAPI spec: import it into Postman, Insomnia or a code generator.
  • Pricing: token packs and the Team plan. The API uses the same tokens as the app.
Something unclear or missing? Email info@readyink.ai or use the contact page. A real person will reply.