AM/TA/Inv - Upload Document

Details

/external/v1/file/upload

Synopsis

Upload Document

post

This route is used to upload a document. The maximum file size is 100 Megabytes. The minimum file size is 100 bytes. The following file extensions are supported: doc,docx,odt,rtf,txt,pdf,xps,html,epub,djvu,xlsx,xlxm,xls,xml,csv,pptx,pptm,ppt,png,jpeg,jpg bytes. A file can be uploaded via multipart/form-data with the file key "file". This endpoint can be called by applications with access to scope "manageReferenceData".

Required scopes

This endpoint requires the following scopes:

• : manageReferenceData

Authorizations

oauth2oauth2

OAuth2clientCredentialsRequired

Token URL:

Query parameters

fileTypestring · enumRequired

The type of file

Possible values:

bookedFileIdstringRequired

The booked id of file. Should not exceed 12 characters.

Example: USS3JKS01I00

Body

multipart/form-data

filestring · binaryOptional

Represents the uploaded file via multipart/form-data. This endpoint supports chunked transfer encoding.

Responses

201

Successfully uploaded file

application/json

400

The following error codes can be returned: - GN0002 - FL0021 - FL0022 - FL0023 - FL0024 - FL0016 Please refer to the error code dictionary for the details of each error code.

application/json

401

Invalid session or expired

403

The following error codes can be returned: - AU0002 Please refer to the error code dictionary for the details of each error code.

application/json

412

The following error codes can be returned: - GN0015 Please refer to the error code dictionary for the details of each error code.

application/json

post

/external/v1/file/upload

HTTPcURLJavaScriptPython

POST /external/v1/file/upload?fileType=PrivatePersonID&bookedFileId=USS3JKS01I00 HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

{
  "fileId": "US9QIFILE1"
}