Docuflex › E-signature › API › Clickwrap (feature-flagged, off in production)
API reference: Clickwrap (feature-flagged, off in production)
Clickwrap agreements and acceptance capture.
Create a Docuflex account Read the API reference Connect your AI agent
| Method | Path | What it does |
|---|---|---|
POST | /v1/accounts/{accountId}/clickwraps | Create a clickwrap agreement |
GET | /v1/accounts/{accountId}/clickwraps | List clickwrap agreements |
GET | /v1/accounts/{accountId}/clickwraps/{clickwrapId} | Get a clickwrap agreement |
PUT | /v1/accounts/{accountId}/clickwraps/{clickwrapId} | Update a clickwrap agreement |
DELETE | /v1/accounts/{accountId}/clickwraps/{clickwrapId} | Deactivate a clickwrap (acceptances are kept) |
GET | /v1/accounts/{accountId}/clickwraps/{clickwrapId}/acceptances | List acceptances (paginated JSON, or ?format=csv for a full export) |
POST | /v1/clickwraps/{clickwrapId}/accept | Record a clickwrap acceptance (public; captures ip/user-agent) |
Conventions
- Base URL:
https://api.docuflex.net; tenant routes are/v1/accounts/{accountId}/.... - Auth:
x-api-key: dfx_live_..., orAuthorization: Bearer <OAuth2 access token>. - Errors: always
{"error":{"code","message","details","requestId"}}; the requestId is also in thex-request-idheader. - Pagination: offset (
?page=&pageSize=, max 100) or cursor (?cursor=&limit=, follownextCursoruntilhasMoreis false). - Idempotency: any POST or PUT accepts
Idempotency-Key; same key + different body is409 IDEMPOTENCY_KEY_REUSED. - Rate limits:
X-RateLimit-Limit,X-RateLimit-Remaining,X-RateLimit-Reseton every response;429 RATE_LIMITEDwithRetry-After. - Tabs: coordinates are fractions of the page (origin top-left);
documentIndexandrecipientIndexrefer to positions in the same request. - Spec: /openapi.json (OpenAPI 3). TypeScript client
@docuflex/sdk; Postman and Bruno collections ship with the repo.