Endpoint /documentprocessing/document/convert

POST https://example.com/documentprocessing/document/convert

POST

Converts a document to another supported format.

Examples

The following sample converts a document to a PDF document.

HTTP

# Request:
curl --location --request POST 'https://trial.dsserver.io/documentprocessing/document/convert?returnFormat=PDF' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer GphAd1R0npJM9OuX2y9mUa4cfqPMOg6p' \
    --data-raw '"0M8R4KGxGuEAAAAA[..]="'

# Result:
"UEsDBBQAAAAIAAACAAC5EQAAAAADKSKHJHDuHDJJSHHD[..]="

Authorization

This endpoint supports the OAuth authorization method:

OAuth

DS Server implements OAuth as the authorization method. Two flows are supported:

Authorization Code
Client Credentials

In order to use the Client Credentials flow, this method must be explicitly enabled in the admin portal of DS Server.

In both cases, a valid access token returned from the OAuth endpoints must be passed in a Bearer Authorization Header or as a Query Parameter.

Authorization Header

Header Field	Description
Authorization	A Bearer authorization header (also called token authentication) contains the OAuth access token. The authorization method and a space i.e. "Bearer " is then put before your valid access token. For example: Authorization: Bearer 4796E23054E64BC773CACBCAF24AD179DE9A3

Query Parameter

Query Parameter	Description
access_token	The access token is passed directly in the endpoint URL as a query string. For example: ?access_token=4796E23054E64BC773CACBCAF24AD179DE9A3

Request Parameters

Name	Type	Value	Optional
returnFormat	String	A string that specifies the format of the created document. Possible values are: "PDF", "PDFA", "RTF", "DOC", "DOCX", "HTML" and "TX". Default value is "PDF".	yes
flattenFormFields	Boolean	A boolean value that specifies whether form fields in the document should be replaced by their current content / value. Default value is false.	yes

Request Payload

Type	Value
String	The source document encoded as a Base64 string. Possible document formats are .rtf, .doc, .docx, .html, .pdf and .tx.

Success Response

Status	Description
200	On success, the HTTP status code in the response header is 200 (OK). The response body contains the converted document encoded as a Base64 encoded string.

Error Response

Status	Description
401	A 401 (Unauthorized) is returned, if the user is not authorized.
400	A 400 (Bad Request) is returned, if no data is found in the MergeBody object or no template is uploaded.
400	A 400 (Bad Request) is returned, if DS Server is not licensed or the license is invalid.
400	A 400 (Bad Request) is returned, if the uploaded document is not valid.