Skip to main content
GET
Get specific document

Authorizations

Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Path Parameters

identifier
string
required

Document's identifier Unique identifier for the document

Query Parameters

format
enum<string>

Specify which format you want the response to be. Default is "json"

Available options:
json,
xml,
hr-xml
compact
boolean

If "true", the response is compacted to annotations' parsed data. Annotations' meta data are excluded. Default is "false".

snake_case
boolean

Whether to return the response in snake_case instead of camelCase. Default is false.

Response

Successfully retrieved document.

extractor
string
required
meta
object
required
data
object
error
object
warnings
object[]