Skip to content
DocsSign in
Browse the docs

Changelog

What each day added to the API. A change that would break your code ships only in a new version, and one that adds ships to every version.

2026-11-05

Added

  • POST /draft/send: the draft sent to the number or the office you name, its documents as you name them, as far as your key or app may send without you: on your plan, or by your key on the card you saved; otherwise, nothing sent, and the link where it waits for you on xipfax.com.
  • GET /faxes/{fax_id}: a fax of your log, or your draft by its id, as GET /faxes gives it.
  • GET /faxes/{fax_id}/confirmation: a delivered fax’s confirmation, by a link that reads it for a few minutes.

2026-11-04

Added

  • An app’s access token as the bearer of every request, beside an API key: the token XipFax’s OAuth server gives an app XipFax registers for the API, once a client connects it, for the resource https://api.xipfax.com and the scope fax, which stops when the client disconnects the app; and 403 insufficient_scope for a token without that scope.
  • GET /faxes: your log, every fax you sent and received, newest first, a page at a time, one way’s alone where direction names it.
  • GET /plan: your plan, its price and its period, its fax number and this month’s pages.
  • GET /offices: the government offices XipFax gives the fax number of, those a search finds, for a place where the agency gives a number for each.
  • Webhooks: fax.delivered, fax.failed and fax.received, posted to each webhook endpoint of your account as a fax you sent is delivered or fails for good and as a fax sent to your number arrives, signed per Standard Webhooks with the endpoint’s own secret, and tried again over about three days until the endpoint takes it. XipFax doesn’t offer a way to register an endpoint yet.

2026-11-03

Added

  • The API, at https://api.xipfax.com, in version 2026-11-03: an API key as the bearer of every request, the Xip-Version header, and this document at /openapi.json.
  • GET /quote: the price of one fax of so many pages, sent without a plan, from XipFax’s price list.
  • GET /draft, the fax you prepare; its documents added by POST /draft/documents, from a file you upload by the link it gives or from a link XipFax fetches, completed by POST /draft/documents/{document_id}/complete and removed by DELETE /draft/documents/{document_id}.
  • Idempotency-Key on every POST, which runs once for each key.