Retrieve a file

Changed on

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

get/v1/files/{file}

Request

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

Path parameters

filestring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

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

  • e24a26de4188Revision changes
    • breaking

      removed the required property //////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    This list may be incomplete.

Some revisions have not been checked yet.