Powered by Redocly

Documents

Endpoints for document management

Retrieve a list of documents

Retrieve a list of documents.

SecurityOAuth2
Request
query Parameters
projectId
Array of strings

Project ids to to find items by. If ommitted, items from all existing projects are returned.

offset
integer >= 0

A zero-based offset of the first item in the data collection to return.

limit
integer [ 0 .. 50 ]
Default: 20

Limit the amount of items returned in the response. If the value exceeds the maximum, then the maximum value will be used.

sort
string
Default: "-createdAt"

The field to sort reponse items by.

Enum: "createdAt" "-createdAt" "+createdAt" "updatedAt" "-updatedAt" "+updatedAt"
state
Array of strings (DocumentState)

Used to retrieve documents that are in specific states only. Multiple states can be used for this filtering. By default, documents in all states are returned.

Items Enum: "done" "doneAutomatically" "extracted" "failed" "inCompletion" "junk" "new" "processing" "rejected" "reviewRequired" "split" "transferFailed" "transferred"
fileId
string

File identifier to retrieve documents that were created from that file

Responses
200

List of documents

400

Bad request

429

Rate limit exceeded

get/documents
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "limit": 20,
  • "offset": 0,
  • "totalCount": 1000
}
Request processing of a file
Request a processing of a file that was previously uploaded. 
The fileId in the request body is representing the identifier of the file that was returned by the upload endpoint. 
As a result of this request a document will be created and its identifier will be returned in the response.
The projectId in the request body is an identifier of the project to create the document in.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
Payload for processing the given file


fileId
required
string
 
projectId
required
string
 
externalId
string
External id of the file. Can be used if you want to link the file with an identifier in your system.


 
object (DocumentsUpdateExternalDataRequest) 
External data to be associated with the document. The data are provided as a flat JSON object. The properties of that object are case-insensitive. The maximum amount of properties is limited to 20.


 
Responses 
202
Processing accepted


400
Error occured while processing request


404
Error occured while processing request


429
Rate limit exceeded


post/documents/process-file
Request samples 
application/json
{
  • "fileId": "5349b4ddd2781d08c09890f4",
  • "projectId": "00000020f51bb4362eee2a4d",
  • "externalId": "doc-0001",
  • "externalData": {
    }
}
Response samples 
application/json
{
  • "documentId": "6040dc9680b782b365ea77d5",
  • "fileId": "5349b4ddd2781d08c09890f4",
  • "projectId": "00000020f51bb4362eee2a4d"
}
Retrieve a document by id
Retrieve a document by id


SecurityOAuth2 
Request 
path Parameters
id
required
string
Id of the document to get.


 
Responses 
200
Document retrieved.


404
Error occured while processing request


429
Rate limit exceeded


get/documents/{id}
Request samples 
Response samples 
application/json
{
  • "id": "6040dc9680b782b365ea77d5",
  • "completedAt": "1990-12-31T15:59:60-08:00",
  • "completedBy": "string",
  • "createdAt": "1990-12-31T15:59:60-08:00",
  • "createdBy": "string",
  • "fileId": "5349b4ddd2781d08c09890f4",
  • "entities": {
    },
  • "externalId": "doc-0001",
  • "externalData": {
    },
  • "projectId": "6040dc9680b782b365ea77d5",
  • "state": "done",
  • "title": "scan-doc-1.jpg",
  • "updatedAt": "1990-12-31T15:59:60-08:00",
  • "updatedBy": "string"
}
Provide information about a transfer of a document to the target system
Update information about the transfer for the given document


SecurityOAuth2 
Request 
path Parameters
id
required
string
Id of of the document to update.


 
Request Body schema: application/json
required
Payload about the transfer


successful
required
boolean
Indicates if the transfer was successful or not


 
message
string
May be used to provide additional details about the transfer. Especially in the erroneous case this field is valueable.


 
Responses 
202
Document transfer infor accepted


400
Error occured while processing request


404
Error occured while processing request


429
Rate limit exceeded


post/documents/{id}/transfer
Request samples 
application/json
{
  • "successful": true
}
Response samples 
application/json
{
  • "detail": "The document with given identifier does not exist",
  • "status": 404,
  • "title": "Document does not exist"
}
Provide external data for a document with given id
Update the external data for a document with given identifier. The external data are provided as a flat JSON object. The payload of this requests completley overrides the existing external data of a document. To remove the data, justsend empty JSON object {} in the payload.


Please note that the maximum lenght of an key is 50 characters. Any value with a longer key will be omitted. The maximum amount of key-value pairs is limited to 20.


SecurityOAuth2 
Request 
path Parameters
id
required
string
Id of the document to update.


 
Request Body schema: application/json
required
Payload containing the external data.


key1
string
 
key2
string
 
Responses 
202
External data provided for the document accepted.


400
Error occured while processing request


404
Error occured while processing request


429
Rate limit exceeded


post/documents/{id}/external-data
Request samples 
application/json
{
  • "key1": "value1",
  • "key2": "value2"
}
Response samples 
application/json
{
  • "detail": "The document with given identifier does not exist",
  • "status": 404,
  • "title": "Document does not exist"
}
Provide an external identifier for a document with given id
Provide an external identifier for a document with given id


SecurityOAuth2 
Request 
path Parameters
id
required
string
Id of the document to update.


 
Request Body schema: text/plain
required
Update external id for a given document.


string (DocumentsUpdateExternalIdRequest) 
External ID


 
Responses 
202
External ID provided for the document accepted.


400
Error occured while processing request


404
Error occured while processing request


429
Rate limit exceeded


post/documents/{id}/external-id
Request samples 
Response samples 
application/json
{
  • "detail": "The document with given identifier does not exist",
  • "status": 404,
  • "title": "Document does not exist"
}
Provide a title for a document with given id
Provide a title for a document with given id.


SecurityOAuth2 
Request 
path Parameters
id
required
string
Id of the document to update.


 
Request Body schema: text/plain
required
Title for a given document.


string (DocumentsUpdateTitleRequest)   <= 256 characters 
New Title


 
Responses 
202
Document title provided for the document accepted.


400
Error occured while processing request


404
Error occured while processing request


429
Rate limit exceeded


post/documents/{id}/title
Request samples 
Response samples 
application/json
{
  • "detail": "The document with given identifier does not exist",
  • "status": 404,
  • "title": "Document does not exist"
}
Retrieve a document states
Provides a list of states the given document passed through. If the document is still in processing, the number of states returend must not be considered as final. Subsequent calls to this endpoint might get more states as the document is progressing the processing pipeline.


SecurityOAuth2 
Request 
path Parameters
id
required
string
Id of the document to get states of.


 
Responses 
200
Document states.


404
Error occured while processing request


429
Rate limit exceeded


get/documents/{id}/states
Request samples 
Response samples 
application/json
[
  • {
    }
]
➔ Next to Enrichment