Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

url
string

If the file is already hosted publicly, you can provide a URL and have the documents service fetch it for you.

Example:

"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"

file
string<byte>

Alternatively, instead of the URL you can provide the Base64 encoded contents of the file you are uploading.

Example:

"ZXhhbXBsZSBvZiBlbmNvZGVkIGNvbnRlbnQ="

filename
string

The filename of the document.

Example:

"test-document.pdf"

customer_reference
string

A customer reference string for customer look ups.

Example:

"MY REF 001"

Response

Successful response

data
object