Skip to main content
The partner API lets your systems upload documents and read extraction results.

​
Base URL

All partner routes are under /api/v1.

​
Authentication

Send your business API key on every request. See Authentication.

​
Channel ID

Path parameter queueId is the channel ID from the Documate app.

​
Response shape

JSON responses use camelCase property names (for example fileIds, publicStatusKey, resultJson). Outbound webhooks use snake_case — see Webhooks.

​
Playground

Each endpoint page includes an interactive playground. Enter your X-Api-Key and a real queueId from a test business. Requests are sent to production. Code samples are available for cURL, Node.js, Python, C#, and PHP.