signdoc/convert
Overview
URL | https://<signdoc-baseurl>/signdoc/convert |
---|---|
Authorization | Access Token as Bearer Token in Authorization Header |
Get supported PDF conversions
GET [signdoc-baseurl]/signdoc/convert/pdf/specs
Request
Headers
Key | Value |
---|---|
Content-Type | application/json |
Example request
GET [signdoc-baseurl]/signdoc/convert/pdf/specs |
Response
Code | Description | Example JSON response content |
---|---|---|
200 OK | List of currently supported PDF conversions. | { "pdfSpecs": [ "PDFA_2B" ] } |
Convert PDF documents
POST [signdoc-baseurl]/signdoc/convert/pdf
Request
Headers
Key | Value |
---|---|
Authorization | Bearer |
Content-Type | application/json |
Request body
Key | Type / Description | Example JSON | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| JSON array of documents to be signed (minimum one). The document to be signed is represented as a JSON object:
| "documents": [ "pdfSpec:" "PDFA_2B", |
Example request
POST [signdoc-baseurl]/signdoc/convert/pdf { |
Response
Content-Type: application/json
Code | Description | Example JSON response content |
---|---|---|
200 OK | Successfully uploaded and converted document conversionWarnings contains an array of warnings that occurred during the conversion. Possible values are:
In CURRENT the response will always be DISABLED("PDF conversion is disabled") and "converted" = false | { |
400 Bad request | Could not convert order due to error in request. Documents that could not be converted will have a list of errors in conversionErrors. Possible conversionErrors are:
| { |
403 Forbidden | Access token is invalid. | AccessToken is invalid - Please provide reference: AbcDEf if reporting the problem. |