# Documents

Endpoints for document management

## Retrieve a list of documents

 - [GET /documents](https://hypatos.redocly.app/openapi/documents/documentslist.md): Retrieve a list of documents.

## Request processing of a file

 - [POST /documents/process-file](https://hypatos.redocly.app/openapi/documents/processfileintodocument.md): 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.

## Retrieve a document by id

 - [GET /documents/{id}](https://hypatos.redocly.app/openapi/documents/documentsgetbyid.md): Retrieve a document by id

## Provide information about a transfer of a document to the target system

 - [POST /documents/{id}/transfer](https://hypatos.redocly.app/openapi/documents/documentsupdatetransfer.md): Update information about the transfer for the given document

## Provide information about the rejection of a document in the target system

 - [POST /documents/{id}/reject](https://hypatos.redocly.app/openapi/documents/documentsupdatereject.md): Update information about the rejection for the given document

## Provide external data for a document with given id

 - [POST /documents/{id}/external-data](https://hypatos.redocly.app/openapi/documents/documentupdateexternaldata.md): 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.

## Provide an external identifier for a document with given id

 - [POST /documents/{id}/external-id](https://hypatos.redocly.app/openapi/documents/documentsupdateexternalid.md): Provide an external identifier for a document with given id

## Provide a title for a document with given id

 - [POST /documents/{id}/title](https://hypatos.redocly.app/openapi/documents/documentsupdatetitle.md): Provide a title for a document with given id.

## Retrieve Document States

 - [GET /documents/{id}/states](https://hypatos.redocly.app/openapi/documents/retrievedocumentstates.md): Provides a list of states that the specified document has passed through. If the document is still being processed, the number of returned states should not be considered final. Subsequent calls to this endpoint may return additional states as the document continues to progress through the processing pipeline.