Skip to main content
GET
Get Document Download URL

Authorizations

Authorization
string
header
default:<BINDBEE_API_KEY>
required

Your Bindbee API key, sent as Authorization: Bearer <BINDBEE_API_KEY>. Required on every request.

X-Connector-Token
string
header
default:<CONNECTOR_TOKEN>
required

The connector token for one customer's connection. This is not your Bindbee API key. Required on requests that read or write a single customer's data.

Path Parameters

id
string<uuid>
required

Query Parameters

ttl_seconds
integer
default:300

How long the returned download URL stays valid, in seconds. Maximum is 3600.

Required range: 60 <= x <= 3600
Example:

300

Response

Successful Response

An expiring link to the document file, together with the metadata a consumer needs in order to download and store it.

url
string<uri> | null
required

A short-lived, signed URL from which the file can be downloaded. Fetch the file before expires_at; do not store or share the URL.

Required string length: 1 - 2083
Example:

"https://files.bindbee.dev/documents/018b18ef...?signature=..."

expires_at
string | null
required

The datetime at which the download URL stops working. Format: DateTime (ISO 8601)

Example:

"2026-08-07T12:05:00Z"

filename
string | null
required

The name of the document file in the third-party system.

Example:

"Charlotte_Danielle_Abbott_W-4.pdf"

content_type
string | null
required

The MIME type of the file behind the URL.

Example:

"application/pdf"

size_bytes
integer | null
required

The size of the file in bytes.

Example:

161484