Aflux REST API Overview: Base URL, Auth, and Errors

The Aflux REST API gives you programmatic access to the full Aflux document workflow platform. You can automate signature requests, trigger email campaigns, generate and manage QR codes, and pull analytics data — all from your own applications and integrations.

API access is available on Business and Enterprise plans only. If you are on a Free or Pro plan, upgrade your subscription in the Aflux dashboard to unlock API access.

What You Can Do with the API

E-Signatures

Programmatically create and send signature requests, track signer status, retrieve signed documents, and build custom signing workflows into your application.

Email Campaigns

Trigger bulk email campaigns, manage contact lists, and retrieve delivery and engagement analytics without leaving your own system.

QR Codes

Generate QR codes, update their target URLs, control access settings, and retrieve per-code scan analytics from any environment.

Analytics

Retrieve signature completion rates, email delivery statistics, and QR code scan data to feed your own dashboards and reporting tools.

Base URL

All API requests are made to the following base URL:

https://api.aflux.io/v1

Every endpoint path is appended to this base. For example, the signatures endpoint is https://api.aflux.io/v1/signatures.

Authentication

The Aflux API uses API keys passed as Bearer tokens in the Authorization header of every request. See the Authentication page for instructions on generating and managing your API keys.

Request Format

Send all request bodies as JSON and include the Content-Type: application/json header on every request that has a body.

curl https://api.aflux.io/v1/signatures \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response Format

All responses are returned as JSON. The Aflux API uses standard HTTP status codes to indicate the success or failure of a request. Successful responses return the requested resource or a confirmation object. Error responses return a structured error object.

Rate Limiting

Rate limits apply to all API requests and vary by plan. When you exceed your limit, the API returns a 429 Too Many Requests response.

Check your current rate limits and usage in the Aflux dashboard under Settings → API Keys. Exact limits per plan will be published when they are finalised.

Error Format

When a request fails, the API returns a JSON error object with a machine-readable code, a human-readable message, and the HTTP status code.

{
  "error": {
    "code": "invalid_request",
    "message": "The 'signers' field is required.",
    "status": 400
  }
}

HTTP Status Codes

The following table lists all HTTP status codes the Aflux API may return.

Status Code	Meaning
`200`	OK — the request succeeded
`201`	Created — the resource was created successfully
`400`	Bad Request — invalid or missing parameters
`401`	Unauthorized — invalid or missing API key
`403`	Forbidden — feature not available on your plan
`404`	Not Found — the requested resource does not exist
`429`	Too Many Requests — rate limit exceeded
`500`	Internal Server Error — contact Aflux support

Making Your First Request

The example below retrieves your existing signature requests. Replace YOUR_API_KEY with a real key from your dashboard (see Authentication).

curl https://api.aflux.io/v1/signatures \
  -H "Authorization: Bearer afxk_live_abc123..." \
  -H "Content-Type: application/json"

A successful response returns a JSON array of signature request objects. A 401 response means your key is missing or invalid — double-check it in Settings → API Keys.

Use a tool like Postman or Insomnia during development to explore the API interactively before writing code.

​What You Can Do with the API

E-Signatures

Email Campaigns

QR Codes

Analytics

​Base URL

​Authentication

​Request Format

​Response Format

​Rate Limiting

​Error Format

​HTTP Status Codes

​Making Your First Request

What You Can Do with the API

Base URL

Authentication

Request Format

Response Format

Rate Limiting

Error Format

HTTP Status Codes

Making Your First Request