Documo

Documo (mFax) is a cloud fax and document delivery platform. The Documo REST API lets developers send and receive faxes, provision and manage fax numbers, subscribe to delivery events via webhooks, and manage account resources over a JSON/HTTPS interface secured with an API key.

4 APIs 0 Features

FaxCloud FaxDocument DeliveryHIPAACommunications

APIs

Documo Fax API

Send a fax to one or more recipients with cover page, scheduling, tags, and custom fields; resend a previously failed fax; retrieve fax detail and status; list fax history; and ...

Documo Numbers API

Search available inbound fax numbers, provision (add) numbers to an account, list provisioned numbers, and release numbers no longer needed.

Documo Webhooks API

Create, list, and delete webhook subscriptions at the account or number level to receive inbound/outbound fax succeed and failed events plus number add and release events.

Documo Account API

Retrieve account profile and settings information. API keys carry an admin or user access level that governs which endpoints they can call.

Collections

Documo API

OPEN

Pricing Plans

Documo Plans Pricing

5 plans

PLANS

Rate Limits

Documo Rate Limits

4 limits

RATE LIMITS

FinOps

Documo Finops

FINOPS

Resources

Sources

opencollection: 1.0.0
info:
  name: Documo API
  version: '1.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Fax
    type: folder
  items:
  - info:
      name: Send a fax
      type: http
    http:
      method: POST
      url: https://api.documo.com/v1/fax/send
      body:
        type: multipart-form
        data: []
    docs: Sends a fax to one or more recipients with optional cover page, scheduling, tags, and custom fields.
  - info:
      name: Get a fax
      type: http
    http:
      method: GET
      url: https://api.documo.com/v1/fax/{messageId}
    docs: Retrieves the detail and current status of a single fax by its message id.
  - info:
      name: Resend a fax
      type: http
    http:
      method: POST
      url: https://api.documo.com/v1/fax/{messageId}/resend
      body:
        type: json
        data: "{\n  \"recipientFax\": \"12345678900\"\n}"
    docs: Resends a previously failed fax by message id; optionally change the destination via recipientFax.
  - info:
      name: Download a fax
      type: http
    http:
      method: GET
      url: https://api.documo.com/v1/fax/{messageId}/download?format=pdf
    docs: Downloads the document for a delivered or received fax. Use format to select pdf or tiff.
  - info:
      name: List faxes (fax history)
      type: http
    http:
      method: GET
      url: https://api.documo.com/v1/faxes?limit=50&offset=0
    docs: Returns a paginated list of inbound and outbound faxes. Rate limited to 8 calls per minute.
- info:
    name: Numbers
    type: folder
  items:
  - info:
      name: Search available numbers
      type: http
    http:
      method: GET
      url: https://api.documo.com/v1/numbers/search?areaCode=202&country=US
    docs: Searches for available inbound fax numbers that can be provisioned.
  - info:
      name: List provisioned numbers
      type: http
    http:
      method: GET
      url: https://api.documo.com/v1/numbers?limit=50&offset=0
    docs: Lists the inbound fax numbers provisioned on the account.
  - info:
      name: Provision a number
      type: http
    http:
      method: POST
      url: https://api.documo.com/v1/numbers
      body:
        type: json
        data: "{\n  \"faxNumber\": \"+12025550143\",\n  \"label\": \"Front Desk\"\n}"
    docs: Provisions (adds) an available inbound fax number to the account.
  - info:
      name: Release a number
      type: http
    http:
      method: DELETE
      url: https://api.documo.com/v1/numbers/{numberId}
    docs: Releases (removes) a provisioned inbound fax number from the account.
- info:
    name: Webhooks
    type: folder
  items:
  - info:
      name: List webhooks
      type: http
    http:
      method: GET
      url: https://api.documo.com/v1/webhooks
    docs: Lists webhook subscriptions configured on the account.
  - info:
      name: Create a webhook
      type: http
    http:
      method: POST
      url: https://api.documo.com/v1/webhooks
      body:
        type: json
        data: "{\n  \"url\": \"https://example.com/webhooks/documo\",\n  \"events\": [\"fax.v1.inbound.succeed\", \"fax.v1.outbound.succeed\"\
          , \"fax.v1.outbound.failed\"]\n}"
    docs: Creates a webhook subscription at the account or number level for fax and number events.
  - info:
      name: Delete a webhook
      type: http
    http:
      method: DELETE
      url: https://api.documo.com/v1/webhooks/{webhookId}
    docs: Deletes a webhook subscription by id.
- info:
    name: Account
    type: folder
  items:
  - info:
      name: Get account
      type: http
    http:
      method: GET
      url: https://api.documo.com/v1/account
    docs: Retrieves the authenticated account's profile and settings.