Files

This object represents files hosted on Stripe’s servers. You can upload files with the create file request (for example, when uploading dispute evidence). Stripe also creates files independently (for example, the results of a Sigma scheduled query).

Related guide: File upload guide

Was this section helpful? Yes No

Create a file

POST / v1 / files

Retrieve a file

GET / v1 / files /:id

List all files

GET / v1 / files

The File object

Attributes

• id string Unique identifier for the object.
• purpose enum The purpose of the uploaded file. Possible enum values account_requirement Additional documentation requirements that can be requested for an account. additional_verification Additional verification for custom accounts. business_icon A business icon. business_logo A business logo. customer_signature Customer signature image. dispute_evidence Evidence to submit with a dispute response. finance_report_run User-accessible copies of query results from the Reporting dataset. financial_account_statement Financial account statements. identity_document A document to verify the identity of an account owner during account provisioning. identity_document_downloadable Image of a document collected by Stripe Identity. Show 10 more
• type nullable string The returned file type (for example, csv, pdf, jpg, or png).

More attributes

• object string, value is "file"
• created timestamp
• expires _ at nullable timestamp
• filename nullable string
• links nullable object
• size integer
• title nullable string
• url nullable string

The File object

Create a file

POST / v1 / files

To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.

All of Stripe’s officially supported Client libraries support sending multipart/form-data.

Parameters

• file map Required A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the multipart/form-data protocol.
• purpose enum Required The purpose of the uploaded file. Possible enum values account_requirement Additional documentation requirements that can be requested for an account. additional_verification Additional verification for custom accounts. business_icon A business icon. business_logo A business logo. customer_signature Customer signature image. dispute_evidence Evidence to submit with a dispute response. identity_document A document to verify the identity of an account owner during account provisioning. issuing_regulatory_reporting Additional regulatory reporting requirements for Issuing. pci_document A self-assessment PCI questionnaire. platform_terms_of_service A copy of the platform’s Terms of Service. Show 5 more

More parameters

• file _ link _ data object

Returns

Returns the file object.

Response