One-time send API reference

GET /v1/one-time-sends

List the organization's one-time orders, newest first

Credential: an API key or a signed-in session. Scope: fax:read.

Parameters

Responses

Response fields

Example

curl https://api.faxforagents.com/v1/one-time-sends \
  -H "Authorization: Bearer ffa_test_..."

POST /v1/one-time-sends

Create a one-time order: one document to one fax number, priced from the card

No credential is needed. The answer carries the price, the page count and the status token; the next step is the checkout. A live key with fax:send or a signed-in session may create an order for its organization. Nothing is charged and nothing is sent by this call.

Credential: an API key or a signed-in session. Works without one too. Scope: fax:send.

Parameters

Request body application/json, required

The JSON form of an order: text only. A file (PDF, PNG, JPEG, TIFF) goes as ``multipart/form-data`` with the same field names and the part ``file``.

Request body multipart/form-data, required

The JSON form of an order: text only. A file (PDF, PNG, JPEG, TIFF) goes as ``multipart/form-data`` with the same field names and the part ``file``.

Responses

Response fields

Example

curl https://api.faxforagents.com/v1/one-time-sends \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"sender_name":"example","to":"+15550000001","accept_aup":false,"text":"example"}'

POST /v1/one-time-sends/by-token

What a confirmation link is for, without using it

The confirm page reads this before the click, with the token in the body. Nothing is consumed by reading it, and nothing is changed: the call is a read that keeps the token out of the address. Idempotency-Key is accepted but ignored.

Credential: none.

Request body application/json, required

Responses

Response fields

Example

curl https://api.faxforagents.com/v1/one-time-sends/by-token \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"token":"example"}'

GET /v1/one-time-sends/by-token/{token}

What a confirmation link is for, without using it (token in the path)

Kept for pages loaded before 2026-11-12. The token in a path reaches access logs, so new callers post it to /v1/one-time-sends/by-token instead. Nothing is consumed by reading it.

Credential: none.

Parameters

Responses

Response fields

Example

curl https://api.faxforagents.com/v1/one-time-sends/by-token/TOKEN

GET /v1/one-time-sends/config

Whether one-time sends are open here, and the card and limits an order is priced and checked by

Credential: none.

Responses

Response fields

Example

curl https://api.faxforagents.com/v1/one-time-sends/config

POST /v1/one-time-sends/from-quote

Create a one-time order from a live quote the wallet does not cover

The quote supplies the document, the destination and the cover; the price is the card's one-time price, not the quote's. The quote then belongs to the order. Needs a live key with fax:send. A key needs what a wallet send of the quote needs: approval_id, or a delegated policy that allows the send. Paying by card replaces neither; without one the answer is 403 approval_required.

Credential: an API key or a signed-in session. Scope: fax:send.

Parameters

Request body application/json, required

Responses

Response fields

Example

curl https://api.faxforagents.com/v1/one-time-sends/from-quote \
  -X POST \
  -H "Authorization: Bearer ffa_test_..." \
  -H "Content-Type: application/json" \
  -d '{"quote_id":"quote_example","sender_name":"example"}'

GET /v1/one-time-sends/{one_time_order_id}

Read a one-time order: where it stands, what to do next, and the fax with its evidence

Credential: an API key, a signed-in session or the status token of the order. Scope: fax:read.

Parameters

Responses

Response fields

Example

curl https://api.faxforagents.com/v1/one-time-sends/ONE_TIME_ORDER_ID \
  -H "Authorization: Bearer ffa_test_..."

POST /v1/one-time-sends/{one_time_order_id}/checkout

Open the card payment of a one-time order

Answers the hosted payment page of the order. The card is authorized there, not charged: it is charged when the carrier confirms delivery. A second call answers the same page while it can still be paid, and a new one after it expired. An order whose aup_accepted is false needs {"accept_aup": true} in the body once, from the status token or a session: the person who pays accepts the policy, never a key.

Credential: an API key, a signed-in session or the status token of the order. Scope: fax:send.

Parameters

Request body application/json

Responses

Response fields

Example

curl https://api.faxforagents.com/v1/one-time-sends/ONE_TIME_ORDER_ID/checkout \
  -X POST \
  -H "Authorization: Bearer ffa_test_..."

POST /v1/one-time-sends/{one_time_order_id}/confirm

Confirm a one-time order with the token of the mailed link: the fax is released

Proves the sender's address and releases the fax. In a browser without a session it also signs the payer in and sets the session cookies. Idempotency-Key is accepted but ignored: the link works once. A repeat by the same signed-in person answers the confirmed order again; any other repeat answers 409 link_used and sends nothing.

Credential: none.

Parameters

Request body application/json, required

Responses

Response fields

Example

curl https://api.faxforagents.com/v1/one-time-sends/ONE_TIME_ORDER_ID/confirm \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"token":"example"}'

GET /v1/one-time-sends/{one_time_order_id}/receipt.pdf

The receipt of a one-time order's fax as a one-page PDF

The delivery receipt of the order's fax: the state, the pages, the document hash, the carrier's evidence as it was reported, and what became of the card. It says charged only once the payment provider confirmed the capture. A key or session of the order's organization may read it, and so may the status token, as the header or as ?t=. 409 conflict while the fax has not ended or the order has no fax.

Credential: an API key, a signed-in session or the status token of the order. Scope: fax:read.

Parameters

Responses

Example

curl https://api.faxforagents.com/v1/one-time-sends/ONE_TIME_ORDER_ID/receipt.pdf \
  -H "Authorization: Bearer ffa_test_..."

POST /v1/one-time-sends/{one_time_order_id}/resend-confirmation

Mail the confirmation link of a one-time order again

At most three times per order and once in ten minutes. The earlier links keep working.

Credential: an API key, a signed-in session or the status token of the order. Scope: fax:send.

Parameters

Responses

Response fields

Example

curl https://api.faxforagents.com/v1/one-time-sends/ONE_TIME_ORDER_ID/resend-confirmation \
  -X POST \
  -H "Authorization: Bearer ffa_test_..."