eESignDocs

REST API

The ESign REST API lets you manage documents and signing flows from your own systems. The base URL on staging is https://web.esign.codeless.au/api/v1.

Authentication

Authenticate with an API key sent as a bearer token. Create keys from your account settings in the web app.

curl https://web.esign.codeless.au/api/v1/documents \
  -H "Authorization: Bearer <YOUR_API_KEY>"

Resources

  • GET /api/v1/documents — list documents.
  • POST /api/v1/documents — create a document and place fields.
  • POST /api/v1/documents/{id}/send — send for signature.
  • GET /api/v1/documents/{id} — fetch status and recipients.
  • POST /api/v1/webhooks — manage webhook endpoints.

Conventions

  • All requests and responses are JSON.
  • Provide an Idempotency-Key header on writes to safely retry requests.
  • Rate limits apply per API key; exceeding them returns 429.

OpenAPI

The API is described by an OpenAPI specification generated from the same schemas the server validates against, so it never drifts from the implementation. A machine-readable openapi.json is published alongside the API for code generation.

Errors

Errors use standard HTTP status codes with a JSON body containing a code and a human-readable message. Common codes: 400 (invalid request), 401 (missing or invalid key), 404 (not found), 409 (conflict), 429 (rate limited).