File upload guide

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 dispute_evidence:

curl https://files.stripe.com/v1/files \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -F "file"="@/path/to/a/file.jpg" \
  -F "purpose"="dispute_evidence"

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

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.

The MIME type of the file you wish to upload must correspond to its file format.

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:

curl https://files.stripe.com/v1/files/
{{FILE_ID}} \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2

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

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.

curl https://files.stripe.com/v1/files/
{{FILE_ID}}
/contents
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2

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

curl https://api.stripe.com/v1/file_links \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
  -d file=
{{FILE_ID}}

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:

curl https://api.stripe.com/v1/disputes/
{{DISPUTE_ID}}
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
  -d "evidence[receipt]"=
{{FILE_ID}}

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:

• 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