Get a download URL for a file document

GET

/api/v1/documents/{canonicalId}/download-url

const url = 'https://app.avera.io/api/v1/documents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/download-url?expirationSeconds=3600';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://app.avera.io/api/v1/documents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/download-url?expirationSeconds=3600'

Returns a short-lived signed URL for the document’s file. Expiration is clamped between 60 seconds and 24 hours, and a file the malware scan has not cleared is refused.

Parameters

Path Parameters

canonicalId

required

string format: uuid

Query Parameters

expirationSeconds

integer format: int32

default: 3600

Responses

200

*/*

object

downloadUrl

required

string

fileName

required

string

contentType

required

string

fileSize

required

integer format: int64

expiresAt

required

string