Inkly API reference

The base URL is https://www.inkly.so/api/v1. Requests need an API key from a Pro or Teams workspace, which you create on API settings.

• AuthenticationSend a bearer key, and see what each kind of key can do.
• Requests and responsesJSON bodies, unknown fields, pagination, and request IDs.
• IdempotencyRetry a send safely, without creating a second document.
• LimitsThe monthly allowance, rate limits, and file sizes.
• ErrorsThe error body, and every code by HTTP status.
• WebhooksEvents, payloads, signatures, retries, and duplicates.

Check which workspace a key belongs to and how much of the monthly allowance is left.

• getGet the current key/me

Find a template and the roles you need to fill to send it.

• getList templates/templates
• getGet a template/templates/{id}

Send a document from a template or from a PDF you upload. Both create a real, legally binding document.

• postSend a document from a template/documents
• postStart a PDF upload/uploads
• postSend a document from an uploaded PDF/documents/from-upload

Track documents and act on them after they are sent.

• getList documents/documents
• getGet a document/documents/{id}
• postGet a signing link/documents/{id}/recipients/{recipient_id}/signing-link
• postSend a reminder/documents/{id}/remind
• postVoid a document/documents/{id}/void

Download what a completed document produced. Links work for 5 minutes, so fetch a new one each time.

• getGet the signed PDF/documents/{id}/signed-pdf
• getDownload the Certificate of Completion/documents/{id}/certificate
• getGet a signer attachment/documents/{id}/attachments/{attachment_id}

This API description, as a machine-readable document.

• getGet this API description/openapi.json