# Check Document Status

**POST /v2/document/{document_id}**

Retrieve the current status of a document translation process.
If the translation is still in progress, the estimated time remaining is also included in the response.


## Servers
- DeepL API Pro: https://api.deepl.com (DeepL API Pro)
- DeepL API Free: https://api-free.deepl.com (DeepL API Free)


## Authentication methods
- Auth header


## Parameters

### Path parameters

- **document_id** (string)
  The document ID that was sent to the client when the document was uploaded to the API.



### Body: application/json (object)

- **document_key** (string)
  The document encryption key that was sent to the client when the document was uploaded to the API.



## Responses
### 200
The document status request returns a JSON object containing the document ID that was used in the request as well as string indicating the current status of the translation process. While the translation is running, the estimated number of seconds remaining until the process is done is also included in the response.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.


#### Body: application/json (object)
- **document_id** (string)
  A unique ID assigned to the uploaded document and the requested translation process. The same ID that was used when requesting the translation status.

- **status** (string)
  A short description of the state the document translation process is currently in. Possible values are:
   * `queued` - the translation job is waiting in line to be processed
   * `translating` - the translation is currently ongoing
   * `done` - the translation is done and the translated document is ready for download
   * `error` - an irrecoverable error occurred while translating the document

- **seconds_remaining** (integer)
  Estimated number of seconds until the translation is done.
  This parameter is only included while `status` is `"translating"`.

- **billed_characters** (integer)
  The number of characters billed to your account. The characters will only be billed after a successful download request.

- **error_message** (string)
  A short description of the error, if available.
  Note that the content is subject to change.
  This parameter may be included if an error occurred during translation.


### 400
Bad request. Please check error message and your parameters.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.


### 403
Authorization failed. Please supply a valid `DeepL-Auth-Key` via the `Authorization` header.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.


### 404
The requested resource could not be found.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.


### 413
The request size exceeds the limit.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.


### 429
Too many requests. Please wait and resend your request.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.


### 456
Quota exceeded. The character limit has been reached.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.


### 500
Internal error.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.


### 504
Resource currently unavailable. Try again later.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.


### 529
Too many requests. Please wait and resend your request.
#### Headers

- **X-Trace-ID** ()
  A unique identifier for the request that can be included in bug reports to DeepL support.



[Powered by Bump.sh](https://bump.sh)