edocr Public API Reference
About the edocr API
The edocr public API allows you to access information about documents and users.
This section provides some general information about using the edocr API:
● Prerequisites
● Authentication
● HTTP Status Codes
Prerequisites
To access the API, you need an API key, which is only available to paid/premium
accounts. You can generate your key under Account Settings > Integrations > API
Integration.
Authentication
Authentication is performed by passing the API key, by either setting the apikey header
in the HTTP request, or using the apikey query parameter.
HTTP Status Codes
● 200 - OK
The response body will be as outlined below based on the specific request type.
● 401 - Unauthorized
All requests require apikey as either a query parameter or in the request header.
If no API key is provided, or if the API key provided is invalid, the request will be
rejected with HTTP status 401, with response body {"errorCode": "Unauthorized"}
● 403 - Forbidden
If a request is made for an item to which the requesting user does not have
access (e.g., requesting another user's private document), the API will return
HTTP status 403 with response body {"errorCode": "Forbidden" }
● 404 - NotFound
If the requested item is not found, it will return HTTP status 404, with response
body {"errorCode": "NotFound"}
● 580 - [varied]
If some other unexpected error occurs, the API will return a status 580, with a
similar response body as the above examples, but the errorCode will vary
depending on the cause.
API Reference
The edocr public API allows you to access information about Documents and Users.
Documents
You can do the following:
● Get User Document Count
● Get User Document List
● Get Single Document
● Get Document Analytics
Get User Document Count
/api/v1/users/:userguid/documents/count
/api/v1/users/current/documents/count (user identified by API key)
Get User Document List
/api/v1/users/:userguid/documents
/api/v1/users/curr