DocumentPro API Documentation
This is the complete API documentation for connecting to the DocumentPro API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet DocumentPro: DocumentPro extracts structured data from documents and manages extraction workflows over the DocumentPro REST API. Keep reading to get started.
Quickstart
Before you run your first DocumentPro request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one DocumentPro connection — create or choose one in Connections. Note its
connectionId.
Every DocumentPro action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/documentPro/latest/actions/{actionSlug}You need a MindCloud API Key and a DocumentPro connection. Then call an action such as Get Large Upload URL:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/documentPro/latest/actions/get-large-upload-url" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID"Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authentication
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 DocumentPro account that should run the action. MindCloud stores and refreshes the DocumentPro 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. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.
DocumentPro actions
All 31 published actions for this DocumentPro version. Each page documents the endpoint, arguments, and response controls.
- POSTConfirm Uploaded Document
- POSTCreate Workflow
- DELETEDelete Job
- DELETEDelete Workflow
- PUTDisable Email Attachment Parsing
- PUTDisable Email Body Parsing
- PUTDisable Footer Removal
- PUTDisable Header Removal
- PUTDisable OCR Checkbox Detection
- PUTDisable OCR Layout Detection
- PUTDisable OCR Table Detection
- PUTDisable PDF Splitting
- PUTDisable Table Removal
- PUTEnable Email Attachment Parsing
- PUTEnable Email Body Parsing
- PUTEnable Footer Removal
- PUTEnable Header Removal
- PUTEnable OCR Checkbox Detection
- PUTEnable OCR Layout Detection
- PUTEnable OCR Table Detection
- PUTEnable PDF Splitting
- PUTEnable Table Removal
- GETGet Large Upload URL
- GETGet Workflow
- GETList Workflows
- GETPoll Extract
- POSTRun Extract
- PUTSet Workflow Date Format
- PUTSet Workflow Webhook URL
- PUTUpdate Workflow
- POSTUpload Document
Related apps
More apps on the Universal API, behind the same REST shape. Or browse all apps.