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
purposemust 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, orterminal_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
Update a file link
POST / v1 / file_links /:id
Updates an existing file link object. Expired links can no longer be updated.
Parameters
- expires _ at string, value is "now" | timestamp A future timestamp after which the link will no longer be usable, or
nowto expire the link immediately. - 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
Retrieve a file link
GET / v1 / file_links /:id
Retrieves the file link with the given ID.
Parameters
No parameters.
Returns
If the identifier you provide is valid, a file link object returns. If not, Stripe raises an error.
Response
