Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Files

Create an External Link

Create an External Link to share with users so they can upload files directly from their browser. For more info, see Uploading files to Finix.

post/files/{file_id}/external_links

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Content-Typestring
Example:application/json

The data type being sent in the request body must be application/json.

Request body

durationinteger

Set how long (in minutes) the external link is valid for. The link can be valid for up to 10080 minutes (7 days).

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)
type'DOWNLOAD' | 'UPLOAD' | 'VIEW' required

Set the type of external link to create.

  • UPLOAD - Create a link that can be used to upload files to Finix.
  • DOWNLOAD - Create a link where the uploaded file can be downloaded from.
  • VIEW - Create a link that displays the file in browser.

Response

A single External Link

idstring

The ID of the External Link resource.

created_atstring date-time

Timestamp of when the object was created.

durationinteger nullable

Details how long (in minutes) the url is valid for.

expiredboolean

Whether the external link has expired.

expires_atstring date-time

When the external link expires.

file_idstring

The File ID the External Link relates to.

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)
type'UPLOAD' | 'DOWNLOAD' | 'VIEW'

Sets whether the link uploads or downloads files from Finix.

urlstring

The URL that can be used to upload, download, or view the File.

user_idstring

The ID of the user that requested to create this link.