API referenceDocuments
Get a document
GET
/documents/{id}Returns the document: { id, fileName, status, createdAt, durationSeconds, numPages, reference, ... }. Pass ?expand=metadata,dataGroups to inline the structured MetadataField values ([{ fieldId, name, value }]) and/or data-group associations ([{ id, name }]).
Authorization
bearerAuth AuthorizationBearer <token>
An API key created in Settings → API Keys.
In: header
Path Parameters
id*string
Format
uuidQuery Parameters
expand?string
Comma-separated: metadata and/or dataGroups.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/documents/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "fileName": "string", "createdAt": "2019-08-24T14:15:22Z", "numPages": 0, "reference": { "property1": "string", "property2": "string" }, "status": "uploaded", "durationSeconds": 0, "error": "parse_failed", "metadata": [ { "fieldId": "84922011-b03d-4966-bc95-c5b49bc2e342", "name": "string", "value": "string" } ], "dataGroups": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" } ], "path": "string", "isActive": true, "isInProgress": true, "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f" }, "meta": { "requestId": "string", "timestamp": "string" }}