{"components":{"responses":{"400":{"description":"The request isn't valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"The API key is missing or doesn't work.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Sending is paused for the organization's plan.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key's plan or permissions don't allow this.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to this key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Not possible in the document's current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Too many requests. Wait for Retry-After seconds.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"CreateEnvelope":{"description":"Give either document (a PDF) or templateId. With a PDF, place fields; a template already has them.","properties":{"cc":{"description":"People who get a copy when it's finished.","items":{"$ref":"#/components/schemas/Person"},"maxItems":10,"type":"array"},"confidential":{"description":"Label it Confidential · HR. The key needs hr:read, from an owner.","type":"boolean"},"document":{"properties":{"base64":{"description":"The PDF, base64-encoded. Up to about 3 MB.","type":"string"},"filename":{"type":"string"},"url":{"description":"A public https address Ink downloads the PDF from. Up to 20 MB.","format":"uri","type":"string"}},"type":"object"},"expiresInDays":{"description":"Days signers have. The organization's default when left out.","maximum":365,"minimum":1,"type":"integer"},"fields":{"items":{"$ref":"#/components/schemas/FieldInput"},"type":"array"},"message":{"description":"A note to the signers, in their email.","maxLength":1000,"type":"string"},"prefill":{"additionalProperties":{"type":"string"},"description":"For a template: answers to its sender-filled fields, by label, such as {\"Start date\": \"2026-12-01\"}.","type":"object"},"reminderIntervalDays":{"description":"Days between automatic reminders. Null for none.","maximum":30,"minimum":1,"type":["integer","null"]},"send":{"default":false,"description":"Send it at once. Needs documents:send. Otherwise it stays a draft.","type":"boolean"},"signers":{"description":"In signing order. For a template, one per role, in role order or named by role.","items":{"$ref":"#/components/schemas/SignerInput"},"maxItems":10,"minItems":1,"type":"array"},"templateId":{"type":"string"},"title":{"maxLength":160,"type":"string"}},"required":["title","signers"],"type":"object"},"Envelope":{"properties":{"completedAt":{"format":"date-time","type":["string","null"]},"confidential":{"type":"boolean"},"createdAt":{"format":"date-time","type":"string"},"declinedAt":{"format":"date-time","type":["string","null"]},"expiresAt":{"format":"date-time","type":["string","null"]},"id":{"type":"string"},"message":{"type":["string","null"]},"object":{"const":"envelope"},"packetId":{"type":["string","null"]},"pageCount":{"type":"integer"},"sender":{"$ref":"#/components/schemas/Person"},"sentAt":{"format":"date-time","type":["string","null"]},"signers":{"items":{"$ref":"#/components/schemas/Signer"},"type":"array"},"status":{"enum":["draft","sent","completed","declined","voided"],"type":"string"},"title":{"type":"string"},"url":{"description":"Where people open it in Ink.","type":["string","null"]},"voidedAt":{"format":"date-time","type":["string","null"]}},"type":"object"},"EnvelopeList":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Envelope"},"type":"array"},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]},"object":{"const":"list"}},"type":"object"},"Error":{"properties":{"error":{"properties":{"message":{"type":"string"},"type":{"enum":["authentication_failed","conflict","insufficient_scope","internal_error","invalid_request","not_found","payload_too_large","plan_required","rate_limited","sending_paused"],"type":"string"}},"type":"object"}},"type":"object"},"FieldInput":{"description":"Where a field sits. x, y, width and height are fractions of the page (0 to 1) from its top left corner.","properties":{"format":{"enum":["email","phone","date","ssn","routing_number","account_number","zip"],"type":"string"},"groupId":{"description":"Radio buttons answered together share one.","type":"string"},"height":{"maximum":1,"type":"number"},"label":{"maxLength":120,"type":"string"},"options":{"description":"A dropdown's choices.","items":{"type":"string"},"type":"array"},"page":{"minimum":1,"type":"integer"},"required":{"default":true,"type":"boolean"},"signer":{"description":"Who fills it: their place in signers, from 1.","minimum":1,"type":"integer"},"type":{"enum":["signature","initials","date","text","checkbox","number","dropdown","radio","attachment"],"type":"string"},"width":{"maximum":1,"type":"number"},"x":{"maximum":1,"minimum":0,"type":"number"},"y":{"maximum":1,"minimum":0,"type":"number"}},"required":["signer","type","page","x","y","width","height"],"type":"object"},"Person":{"properties":{"email":{"format":"email","type":"string"},"name":{"type":"string"}},"required":["name","email"],"type":"object"},"Signer":{"properties":{"declineReason":{"type":["string","null"]},"declinedAt":{"format":"date-time","type":["string","null"]},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"order":{"type":"integer"},"role":{"enum":["signer","cc"],"type":"string"},"signedAt":{"format":"date-time","type":["string","null"]},"status":{"description":"waiting: not their turn yet. notified: their turn, link sent.","enum":["waiting","notified","signed","declined"],"type":"string"},"viewedAt":{"format":"date-time","type":["string","null"]}},"type":"object"},"SignerInput":{"properties":{"accessCode":{"description":"A code you share with them, asked before the document opens.","maxLength":64,"minLength":6,"type":"string"},"email":{"format":"email","type":"string"},"name":{"type":"string"},"requireEmailCode":{"description":"Email them a one-time code to open it.","type":"boolean"},"role":{"description":"For a template: which of its roles they fill.","type":"string"}},"required":["name","email"],"type":"object"},"Template":{"properties":{"confidential":{"type":"boolean"},"createdAt":{"format":"date-time","type":["string","null"]},"folder":{"type":["string","null"]},"id":{"type":"string"},"name":{"type":"string"},"object":{"const":"template"},"prefillFields":{"items":{"properties":{"label":{"type":"string"},"options":{"items":{"type":"string"},"type":["array","null"]},"required":{"type":"boolean"},"type":{"enum":["text","number","dropdown"],"type":"string"}},"type":"object"},"type":"array"},"roles":{"items":{"properties":{"name":{"type":"string"},"order":{"type":"integer"}},"type":"object"},"type":"array"},"shared":{"type":"boolean"}},"type":"object"},"Webhook":{"properties":{"createdAt":{"format":"date-time","type":"string"},"description":{"type":["string","null"]},"events":{"items":{"enum":["packet.completed","packet.stopped","envelope.completed","envelope.sent","envelope.viewed","envelope.signed","envelope.declined","envelope.voided"],"type":"string"},"type":"array"},"id":{"type":"string"},"lastFailureAt":{"format":"date-time","type":["string","null"]},"lastSuccessAt":{"format":"date-time","type":["string","null"]},"object":{"const":"webhook"},"secret":{"description":"The signing secret. Only in the answer that makes it.","type":"string"},"secretHint":{"type":"string"},"url":{"type":"string"}},"type":"object"}},"securitySchemes":{"apiKey":{"bearerFormat":"ink_live_...","description":"An API key from Settings > API keys. It acts as the owner or admin who made it.","scheme":"bearer","type":"http"}}},"info":{"description":"Send documents for signature, follow them and download the signed copies from your own systems. Keys come from Settings > API keys, on the Business plan. Permissions: documents:read, documents:write, documents:send, templates:read, webhooks:manage, hr:read.","title":"Ink API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/envelopes":{"get":{"operationId":"listEnvelopes","parameters":[{"in":"query","name":"status","schema":{"enum":["draft","sent","completed","declined","voided"],"type":"string"}},{"description":"Title, or a signer's name or email.","in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"created_after","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"created_before","schema":{"format":"date-time","type":"string"}},{"in":"query","name":"limit","schema":{"default":25,"maximum":100,"minimum":1,"type":"integer"}},{"in":"query","name":"cursor","schema":{"type":"string"}}],"responses":{"200":{"description":"Newest first.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvelopeList"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"429":{"$ref":"#/components/responses/429"}},"summary":"List envelopes","x-scope":"documents:read"},"post":{"operationId":"createEnvelope","parameters":[{"description":"Any unique string, such as your own order number. Sending the same request again with it returns the first answer instead of doing it twice. Kept for 24 hours.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEnvelope"}}}},"responses":{"201":{"description":"The new envelope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"402":{"$ref":"#/components/responses/402"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}},"summary":"Create an envelope, and send it","x-scope":"documents:write"}},"/envelopes/{id}":{"delete":{"operationId":"deleteDraft","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Deleted."},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"}},"summary":"Delete a draft","x-scope":"documents:write"},"get":{"operationId":"getEnvelope","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The envelope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"summary":"Get an envelope and its signers' progress","x-scope":"documents:read"}},"/envelopes/{id}/certificate":{"get":{"operationId":"downloadCertificate","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The completion certificate.","content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"}},"summary":"Download the certificate and audit trail","x-scope":"documents:read"}},"/envelopes/{id}/document":{"get":{"operationId":"downloadDocument","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The signed PDF.","content":{"application/pdf":{"schema":{"format":"binary","type":"string"}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"}},"summary":"Download the signed PDF","x-scope":"documents:read"}},"/envelopes/{id}/remind":{"post":{"operationId":"remindSigner","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Any unique string, such as your own order number. Sending the same request again with it returns the first answer instead of doing it twice. Kept for 24 hours.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"type":"string"}}],"responses":{"200":{"description":"The envelope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"}},"summary":"Remind the signer whose turn it is","x-scope":"documents:send"}},"/envelopes/{id}/send":{"post":{"operationId":"sendEnvelope","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Any unique string, such as your own order number. Sending the same request again with it returns the first answer instead of doing it twice. Kept for 24 hours.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"expiresInDays":{"type":"integer"},"message":{"type":"string"},"reminderIntervalDays":{"type":["integer","null"]}},"type":"object"}}}},"responses":{"200":{"description":"The envelope, now sent.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"402":{"$ref":"#/components/responses/402"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"}},"summary":"Send a draft","x-scope":"documents:send"}},"/envelopes/{id}/void":{"post":{"operationId":"voidEnvelope","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Any unique string, such as your own order number. Sending the same request again with it returns the first answer instead of doing it twice. Kept for 24 hours.","in":"header","name":"Idempotency-Key","required":false,"schema":{"maxLength":255,"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"reason":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"The envelope, now voided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Envelope"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"}},"summary":"Void a sent envelope","x-scope":"documents:send"}},"/me":{"get":{"operationId":"getMe","responses":{"200":{"description":"The key, its organization and who it sends as."},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}},"summary":"Check a key"}},"/templates":{"get":{"operationId":"listTemplates","responses":{"200":{"description":"Templates the key's person may use.","content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Template"},"type":"array"},"object":{"const":"list"}},"type":"object"}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}},"summary":"List templates","x-scope":"templates:read"}},"/templates/{id}":{"get":{"operationId":"getTemplate","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The template.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"summary":"Get a template's roles and prefill fields","x-scope":"templates:read"}},"/webhooks":{"get":{"operationId":"listWebhooks","responses":{"200":{"description":"The organization's webhooks."},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}},"summary":"List webhooks","x-scope":"webhooks:manage"},"post":{"operationId":"createWebhook","requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"description":{"type":"string"},"events":{"items":{"type":"string"},"type":"array"},"url":{"format":"uri","type":"string"}},"required":["url","events"],"type":"object"}}}},"responses":{"201":{"description":"The webhook, with its secret this once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}},"summary":"Add a webhook","x-scope":"webhooks:manage"}},"/webhooks/{id}":{"delete":{"operationId":"deleteWebhook","parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Removed."},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"summary":"Remove a webhook","x-scope":"webhooks:manage"}}},"security":[{"apiKey":[]}],"servers":[{"url":"https://api.inkdocs.app/v1"}],"webhooks":{"packet.completed":{"post":{"description":"Every document of a packet is signed, such as a new hire's paperwork. Signed with the Ink-Signature header.","summary":"Packet finished"}},"packet.stopped":{"post":{"description":"A packet stopped because a document was declined or voided. Signed with the Ink-Signature header.","summary":"Packet stopped"}},"envelope.completed":{"post":{"description":"Everyone signed a document, in a packet or on its own. Signed with the Ink-Signature header.","summary":"Document finished"}},"envelope.sent":{"post":{"description":"A document went out for signature. Signed with the Ink-Signature header.","summary":"Document sent"}},"envelope.viewed":{"post":{"description":"A signer opened their signing link for the first time. Signed with the Ink-Signature header.","summary":"Document viewed"}},"envelope.signed":{"post":{"description":"One signer signed. The document may still need others. Signed with the Ink-Signature header.","summary":"Signer signed"}},"envelope.declined":{"post":{"description":"A signer declined to sign. Signed with the Ink-Signature header.","summary":"Document declined"}},"envelope.voided":{"post":{"description":"The sender voided a document before everyone signed. Signed with the Ink-Signature header.","summary":"Document voided"}}}}