Getting started
Inkfree API
Public REST API for the Inkfree e-signature platform.
What the API does
The Inkfree API lets you create and send envelopes for signature, pull envelope and signer state, download completed PDFs, and subscribe to webhooks for signing events.
It is the API used by the official Inkfree integration for Zapier, and it is the same API available to any Inkfree customer on a plan that includes API access.
Base URL
https://{host}/coreAll endpoints below are relative to that base URL. Every path is prefixed with /api/v1/inkfree except the two unauthenticated reference endpoints under /public/inkfree.
For this environment, that resolves to:
https://api-uat.softsages.com/coreThe endpoint reference
27 operations across 24 paths, grouped by what they operate on. Every page is generated from the same OpenAPI document the service publishes, so the reference and the API cannot drift apart.
Field naming
Most request bodies bind typed objects and use camelCase (targetUrl, eventType, emailSubject). Webhook responses and the PATCH /webhooks/{id} request use snake_case (target_url, event_type). Each operation below documents its own casing — follow the schema shown, not a global convention.
Two quirks that are deliberate
POST /webhooks takes targetUrl and eventType, but webhook responses and the PATCH /webhooks/{id} body use target_url and event_type.
GET /signers returns upper-case SQL column labels — SIGNER, ENVELOPE_ID, ENVELOPE_SUBJECT — not camelCase fields.
Both are real behavior of the live API. Follow the schema shown on each operation rather than assuming one convention across the whole surface.
Start here
If you are new to the API, the Quickstart takes you from an API key to a sent envelope and a webhook subscription in five steps.