When you upload a file to Stripe using the API, a file token and other information about the file is returned. The token can then be used in other API calls. This guide provides a detailed walk-through of this process.
Uploading a file
To upload a file, send a
multipart/form-data request to https://files.stripe.com/v1/files. Note that the subdomain files.stripe.com is different than most of Stripe’s API endpoints. The request should specify a
purpose and a
file. The following example uploads a file located at /path/to/a/file.jpg on your local file system with the purpose
The following example uploads a file using our Android SDK with the purpose
There are several valid purpose values, each with file format and size requirements.
|Purpose||Description||Supported mimetypes||Max size||Expiry||Downloadable|
|Additional documentation requirements that can be requested for an account||PDF|
|A business icon.||JPEG|
|A business logo.||JPEG|
|Customer signature image||JPEG|
|Evidence to submit with a dispute response.||PDF|
|A document to verify the identity of an account owner during account provisioning.||PDF|
|A self-assessment PCI questionnaire.||PDF||16MB||NEVER||true|
|A user-uploaded tax document.||PDF|
|Additional verification for custom accounts||PDF|
The MIME type of the file you wish to upload must correspond to its file format.
|File format||MIME type|
A successful request returns a file object.
Retrieving a File API resource
To retrieve the API resource for a File, make a GET request to the /v1/files endpoint of the files.stripe.com subdomain providing the file upload ID:
Downloading File Contents
If the file purpose allows downloading the file contents, then the file includes a non-null
url field indicating how to access the contents. This url requires authentication with your Stripe API keys.
If you want unauthenticated access to a file whose purpose allows downloading, then you can produce anonymous download links by creating a file_link.
The file_link resource has a
url field that will allow unauthenticated access to the contents of the file.
Using a file
After a file is uploaded, the file upload ID can be used in other API requests. For example, to attach an uploaded file to a particular dispute as evidence:
Note that you can only use an uploaded file in a single API request.
Handling Upload Errors
When you use the File API to upload a PDF document, we run it through a series of checks to validate that it is correctly formatted and meets PDF specifications. We return an error for uploads that fail any of our checks.
Try the following to fix errors that we detect: