File Links

To share the contents of a File object with non-Stripe users, you can create a FileLink. FileLink s contain a URL that you can use to retrieve the contents of the file without authentication.

Was this section helpful? Yes No

Create a file link

POST / v1 / file_links

Update a file link

POST / v1 / file_links /:id

Retrieve a file link

GET / v1 / file_links /:id

List all file links

GET / v1 / file_links

The File Link object

Attributes

• id string Unique identifier for the object.
• expires _ at nullable timestamp Time that the link expires.
• file string Expandable The file object this link points to.
• metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
• url nullable string The publicly accessible URL to download the file.

More attributes

• object string, value is "file_link"
• created timestamp
• expired boolean
• livemode boolean

The File Link object

Create a file link

POST / v1 / file_links

Creates a new file link object.

Parameters

• file string Required The ID of the file. The file’s purpose must be one of the following: business_icon, business_logo, customer_signature, dispute_evidence, finance_report_run, financial_account_statement, identity_document_downloadable, issuing_regulatory_reporting, pci_document, selfie, sigma_scheduled_query, tax_document_user_upload, terminal_android_apk, or terminal_reader_splashscreen.
• expires _ at timestamp The link isn’t usable after this future timestamp.
• metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Returns

Returns the file link object if successful and raises an error otherwise.

Response