Create a file

Changed on

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.

post/v1/files

Request

  • Base URL: https://files.stripe.com
  • URL: https://files.stripe.com/v1/files
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Request body multipart/form-data

expandstring[]

Specifies which fields in the response should be expanded.

filestring binary required

A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the multipart/form-data protocol.

purpose'account_requirement' | 'additional_verification' | 'business_icon' | 'business_logo' | 'customer_signature' | 'dispute_evidence' | 'identity_document' | 'issuing_regulatory_reporting' | 'pci_document' | 'platform_terms_of_service' | 'tax_document_user_upload' | 'terminal_android_apk' | 'terminal_reader_splashscreen' | 'terminal_wifi_certificate' | 'terminal_wifi_private_key' required

The purpose of the uploaded file.

Response

Successful response.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

expires_atinteger nullable

The file expires and isn't available at this time in epoch seconds.

filenamestring nullable

The suitable name for saving the file to a filesystem.

idstring required

Unique identifier for the object.

object'file' required

String representing the object's type. Objects of the same type share the same value.

purpose'account_requirement' | 'additional_verification' | 'business_icon' | 'business_logo' | 'customer_signature' | 'dispute_evidence' | 'document_provider_identity_document' | 'finance_report_run' | 'financial_account_statement' | 'identity_document' | 'identity_document_downloadable' | 'issuing_regulatory_reporting' | 'pci_document' | 'platform_terms_of_service' | 'selfie' | 'sigma_scheduled_query' | 'tax_document_user_upload' | 'terminal_android_apk' | 'terminal_reader_splashscreen' | 'terminal_wifi_certificate' | 'terminal_wifi_private_key' required

The purpose of the uploaded file.

sizeinteger required

The size of the file object in bytes.

titlestring nullable

A suitable title for the document.

typestring nullable

The returned file type (for example, csv, pdf, jpg, or png).

urlstring nullable

Use your live secret API key to download the file from this URL.

Changes

  • b22313c11340Revision changes
    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    This list may be incomplete.

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

Some revisions have not been checked yet.