File upload guide

Use the File Upload API to securely send files to Stripe, such as dispute evidence, identification documents, and so on.

When you upload a file to Stripe using the API, it returns a file token and other information about the file. You can then use the token in other API calls. This guide describes this process.

Upload a file

To upload a file, send a multipart/form-data request to https://files.stripe.com/v1/files. The subdomain files.stripe.com is different than most Stripe API endpoints. Specify a purpose and a file in the request. The following example uploads a file located at /the relevant part of the product on your local file system with the purpose dispute_evidence:

Command Line

Select a language

curl

Ruby

Python

PHP

Java

Node.js

Go

.NET

No results

The following example uploads a file using our Android SDK with the purpose dispute_evidence:

CheckoutActivity.kt

Select a language

Kotlin

Java

No results

class CheckoutActivity : AppCompatActivity() {
 private val stripe: Stripe by lazy {
 Stripe(this, "pk_test_TYooMQauvdEDq54NiTphI7jx")
 }

 private fun uploadFile(file: File) {
 stripe.createFile(
 StripeFileParams(
 file,
 StripeFilePurpose.DisputeEvidence
 ),
 callback = object : ApiResultCallback<StripeFile> {
 override fun onSuccess(result: StripeFile) {
 // File upload succeeded
 }

 override fun onError(e: Exception) {
 // File upload failed
 }

 }
 )
 }
}

There are several valid purpose values, each with file format and size requirements.

Caution

identity_document images also need to be smaller than 8,000px by 8,000px.

The the related setting type of the file you want to upload must correspond to its file format.

Caution

Any Microsoft Office documents containing VBA macros will be rejected because of security concerns.

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:

Command Line

Select a language

curl

Ruby

Python

PHP

Java

Node.js

Go

.NET

No results

When using restricted API keys, you must receive prior access to the Files resource.

Download the 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.

Command Line

If you want unauthenticated access to a file whose purpose allows downloading, then you can produce anonymous download links by creating a file_link.

Command Line

Select a language

curl

Ruby

Python

PHP

Java

Node.js

Go

.NET

No results

The file_link resource has a url field that allows unauthenticated access to the contents of the file.

Using a file

After you upload a file, you can use the file upload ID in other API requests. For example, to attach an uploaded file to a particular dispute as evidence:

Command Line

Select a language

curl

Ruby

Python

PHP

Java

Node.js

Go

.NET

No results

You can only use an uploaded file in a single API request.

Handle 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’s 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:

• Remove annotations or additional media you added to the document.
• If you can’t remove your annotations or media, or if you combined several PDFs into one, try using your computer’s “Print to PDF” function to create a fresh document.
• Print to PDF with macOS
• Print to PDF with Adobe Acrobat