Skip to main content
Uploads one or more files to the cloud. A list of all valid input formats can be found in the Specification section. The method returns the file’s identifier and token in the response. The identifier and token will be used in all subsequent requests concerning the file.
The project settings for document assembly will be ignored when uploading a file via REST API. A separate document will be created for each file.
HTTP request
POST https://api-{location-id}.flexicapture.com/v2/file where {location-id} is the supported location.
Path parameters

Parameters

file

file, formdata

Required. File body.

Response
If successful, the response body contains an instance of FileInfoModel.
{“id”: “string”,“token”: “string”,“name”: “string”,“extension”: “string”,“hash”: “string”,“size”: 0,“mime”: “string”,“is_recognizable”: true,“account”: “string”,“application”: “string”,“email”: “string”,“created”: “YYYY-MM-DDT00:00:00.000”,“expiring”: “YYYY-MM-DDT00:00:00.000”}

FileInfoModel

id

string

Required. File ID. ID is used in all subsequent requests concerning the file.

token

string

Required. File access token. The token is used in all subsequent requests concerning the file.

name

string

Required. File name.

extension

string

Required. File extension.

hash

string

Required. File SHA512 hash.

size

integer

Required. File size in bytes.

mime

string

Required. File MIME type.

is_recognizable

boolean

Required. Specifies whether the file is recognizable or not.

account

string

Required. Account ID.

application

string

Optional. Application ID.

email

string

Required. The e-mail address of the user who uploaded the file.

created

string($date-time)

Required. File upload date.

expiring

string($date-time)

Required. File expiration date.