Docs

Documo API Authentication

How to authenticate Documo API requests: one Bearer API key plus a connectionId. MindCloud stores your Documo API key securely — set it once, never resend it.

Every Documo API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Documo account. This page covers both, plus exactly how to send them, so you do not need to visit any other page to get authenticated.

Steps to authenticate

  1. Create a MindCloud account at app.mindcloud.co if you do not already have one.
  2. Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
  3. Create a Documo connection in Connections. Documo uses an API key. You generate the key in your Documo account, then paste it in when you create the connection — MindCloud stores it securely and never returns it in a response.
  4. Copy the connection’s connectionId — you will send it on every request alongside your MindCloud API Key.

How requests are authenticated

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Documo account that should run the action. MindCloud stores and refreshes the Documo credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions.

For example, calling List Contacts with an Documo connection looks like this:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/documo/actions/list-contacts/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which Documo account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Create a Documo API key

You need a Documo Business plan or higher and the API Add-On purchased for the account.

  1. Purchase the API Add-On

    In the Documo app, open the billing section and purchase the API Add-On for your account. Documo states that this add-on requires a Business plan or higher.

    Billing

  2. Open API Keys

    In the Documo app, open the Toolbox menu and select API Keys.

    Toolbox → API Keys

  3. Create a new key

    Click Create and complete the form. You can check the option to have the key emailed to you if you want a copy sent by email.

  4. Store the key securely

    Copy the API key immediately or use the emailed copy. Documo says you will not be able to view the secret again after creation.

Keep your key safe

Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs. Anyone with the key can call the Universal API as your MindCloud account, across every connection you have created.