PayPerFax

Prepare a fax for a person to send with PayPerFax, the pay-per-fax service: no account, no subscription, one payment for one fax. A common use is a letter or a form for the IRS, a doctor, a court, an insurer or a landlord. The tool does not send the fax and does not charge. It returns a link for the person. The person opens the link, sees the preview and the price, and pays in the browser. Then the fax is sent. Rules: 1. Email: ask the person for their email address. Do not guess it. The confirmation and the receipt go there. 2. A document that the person has as a file (a PDF, a scan, a signed form): do not retype it as text. A typed copy of a signed form is not the form. Set file_expected to true, and tell the person that they add the file on the page of the link. 3. The fax number of an agency or a company: take it from its official website (for the IRS: irs.gov), and show the person the source. A number from memory can send private papers to a stranger. 4. A letter that you write goes in markdown. With no cover page, the letter must have its own date, names and address block. With a cover page, keep cover_message short: a long message is cut off. 5. Limits: the markdown text can be at most 100 KB. Headings, lists, bold text and tables are printed. An image is printed as its alt text, a link as its text, and raw HTML as text. 6. If you can run shell commands and the document is a local file, send it with the HTTP call: curl -F "to=+14155550101" -F "[email protected]" -F "documents[]=@/path/to/file.pdf" https://fax.payperfax.com/api/fax 7. After the call, give the person the link, and say that nothing is sent and nothing is charged before they pay. The confirmation email comes after the payment. If the status of the fax is later "failed", the person is not charged, and can send the fax again.

{
  "type": "object",
  "properties": {
    "to": {
      "description": "The fax number in international format: \"+\", the country code, the number. Example: +14155550101.",
      "type": "string"
    },
    "email": {
      "description": "The person's email address, for the confirmation and the receipt. Ask the person; do not guess. Required when you send markdown or a cover page.",
      "type": "string"
    },
    "markdown": {
      "description": "The document as Markdown text that you wrote, for example a letter. Leave it out when the person has the document as a file.",
      "type": "string"
    },
    "file_expected": {
      "description": "true when the person must still add a file (a PDF, a scan, a signed form). Then the link opens a form with what you sent, and the person adds the file there.",
      "type": "boolean"
    },
    "cover_page": {
      "description": "true to put a cover page before the document. The default is no cover page.",
      "type": "boolean"
    },
    "cover_message": {
      "description": "A short note on the cover page, as plain text, at most 5000 characters. Only with cover_page.",
      "type": "string"
    },
    "sender_name": {
      "description": "The sender's name on the cover page. Only with cover_page. At most 100 characters.",
      "type": "string"
    },
    "recipient_name": {
      "description": "The recipient's name on the cover page. Only with cover_page. At most 100 characters.",
      "type": "string"
    },
    "recipient_company": {
      "description": "The recipient's company or agency on the cover page. Only with cover_page. At most 100 characters.",
      "type": "string"
    },
    "language": {
      "description": "The language of the pages that the person sees, and of the emails. The default is en.",
      "enum": [
        "en",
        "es",
        "de",
        "ja",
        "ko",
        "fr"
      ],
      "type": "string"
    },
    "timezone": {
      "description": "The person's time zone as an IANA name, for example America/New_York. Without it, times are shown in UTC.",
      "type": "string"
    },
    "country": {
      "description": "The person's country as a two-letter code (ISO 3166-1 alpha-2), for example US, DE, GB or JP. It sets the currency of the price, and the date format on the cover page and in the emails. Without it, the price is in US dollars, and the dates have the US format.",
      "type": "string"
    }
  },
  "required": [
    "to"
  ]
}

Read where a fax is. Give the id from create_fax, or an address of the fax: the status address from the tracking prompt of the person, or the address of a page of the fax. "status" is pending, delivered, failed or expired. While it is pending, "stage" says more: rendering (we prepare the pages), awaiting_payment (the person did not pay yet; "pages" and "price" are given, and they can still change), sending (paid, on its way). delivered: the fax arrived. failed: the fax was not delivered, the person is not charged, and can send it again; with "render_failed", the document could not be prepared, and the person opens the link to change it. expired: the fax was not paid in time. Do not call this in a loop: read the status when the person asks.

{
  "type": "object",
  "properties": {
    "id": {
      "description": "The id of the fax, or an address of the fax: its status address (https://.../api/fax/{id}/status), or the address of its preview, payment or confirmation page.",
      "type": "string"
    }
  },
  "required": [
    "id"
  ]
}

List what PayPerFax can fax, and the limits: the text that create_fax takes, the file types that a person can add on the form or that a shell can send to the HTTP call, the sizes, and the languages.

{
  "type": "object",
  "properties": {}
}