Back to DocuFlow

An API that is safe to retry

An integration that times out cannot tell a lost request from a lost reply. DocuFlow's API is built so that it does not have to: retry any write with the same key and you get the same answer, once.

Idempotent writes,
stable errors

Send Idempotency-Key on any write. The first settled answer is kept for 24 hours and replayed with Idempotent-Replay: true; the same key with a different body is a 422, a retry mid-flight a 409, and a server error releases the key. Every error carries a code to branch on and the request id to quote.

Terminal~/northwind/intake-bridge
$ curl https://docuflow.example/api/v2/documents \
-H "Authorization: Bearer dfk_live_…" \
-H "Idempotency-Key: fax-20260918-0912" \
-F queue=prior-authorizations -F file=@fax_20260918_0912.tif
HTTP/2 201
x-request-id: 3f1c9e2a-6b0d-4c8e-9a51-2b7f0c44d1e8
x-ratelimit-limit: 600
x-ratelimit-remaining: 597
{"documents":[{"id":"cmu8q2x1r000ljw09","duplicate":false}]}
# the connection dropped; send the same request again
HTTP/2 201
idempotent-replay: true
# same key, different file
HTTP/2 422
{"error":"This Idempotency-Key was already used with a
different request body.","code":"idempotency_conflict"}
API & keysNorthwind Health
NameKeyScopesLimitLast used
Epic interface enginedfk_live_7Hq2••••••••3 scopes1200/mina few seconds ago
Fax gatewaydfk_live_Pz81••••••••2 scopes600/min2 minutes ago
Warehouse nightly exportdfk_live_c0Wm••••••••2 scopes120/min9 hours ago

Access for Fax gateway

documents:createdocuments:readdocuments:approvequeues:read

A key can do what its creator can do, narrowed to these scopes. It never holds members, roles or other keys.

Included

Rate limits per keyX-RateLimit headers on every response, 429 with Retry-After
Signed webhooksHMAC over a timestamp and the body
OpenAPIgenerated from the schemas that validate requests, enforced by a test
Eventsreceived, extracted, needs review, approved, rejected, exported, failed
Preserved v1 APIexisting integrations keep working unchanged
Dry runssources and destinations both preview without side effects

Bring the forms your team still retypes

A working session on your own documents: one queue, your fields, your rules, and a count of what would have gone straight through.