Documents
List
Gets the documents associated with the id
GET
/
documents
/
{documentId}
Authorizations
x-api-key
string
headerrequiredPath Parameters
documentId
integer
requiredThe document id
Query Parameters
includeOrginal
boolean
default: trueSet to true to include orginal document
includeTransformed
boolean
default: trueSet to true to include transformed documents
Response
200 - application/json
documentId
integer
documentFolderId
integer
originsFromDocumentId
integer | null
companyId
integer | null
externalId1
string | null
externalId2
string | null
description
string | null
documentType
enum<string>
Available options:
unspecific
, annualReport
fileName
string | null
fileMimeType
string | null
documentTransformType
enum<string>
Available options:
transformToSearchablePDF
, transformToOCR
, transformToMetadata
, transformToEntity
documentTransformStatusType
enum<string>
Available options:
requested
, processing
, success
, warning
, failed
documentFileSystemType
enum<string>
Available options:
orginal
, pdfSearchable
, jsonOcrV1
, jsonEntityV1
, jsonOcrV2
, jsonEntityV2
isDeleted
boolean | null
lastUpdatedAtUtc
string