Docs

SignRequest API Authentication

How to authenticate SignRequest API requests: one Bearer API key plus a connectionId. MindCloud runs the OAuth flow and refreshes SignRequest tokens for you.

Every SignRequest API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your SignRequest 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 SignRequest connection in Connections. SignRequest uses OAuth. When you create the connection, you are redirected to sign in to SignRequest and approve access — MindCloud stores the resulting tokens and refreshes them automatically, so your integration never has to.
  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 SignRequest account that should run the action. MindCloud stores and refreshes the SignRequest 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 SignRequests with an SignRequest connection looks like this:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/signRequest/actions/list-sign-requests/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 SignRequest account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Set up SignRequest OAuth2

You need a SignRequest account with access to OAuth2 applications.

  1. Create a SignRequest OAuth2 application

    Open the SignRequest OAuth2 applications page, create an application, choose Client type Confidential, and choose Authorization grant type Authorization code.

    OAuth2 applications
  2. Add the MindCloud redirect URL

    Add https://api.mindcloud.co/v1/oauth/signRequest/callback as a redirect URI in the SignRequest application.

  3. Connect SignRequest in MindCloud

    Return to MindCloud, start the OAuth2 connection, sign in to SignRequest, and approve access.

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.