Sign in
Files

Fetch a File

Retrieve the details of an existing File.

get/files/{file_id}

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Response

A single File

idstring

The ID of the resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

application_idstring

ID of the Application the resource was created under.

display_namestring

The human-readable name of the File. The file name format is <type>_<id> by default.

entity_idstring nullable

The ID of the underwriting note associated with the attached file.

entity_type'NOTE' nullable

The entity type assigned to the underwriting note.

extensionstring nullable

The extension of the file.

file_namestring nullable

The name of the uploaded File. It is null when the File resource is first created and is automatically updated to the uploaded file's name. You cannot change this field.

identity_idstring nullable

The ID of the Application that the File was created under.

linked_tostring

The ID of the resource the File is linked to. This can be either a Merchant ID or Identity ID.

linked_typestring

The type of the resource that the File is linked to.

platform_idstring

The ID of the Platform that the File was created under.

size_in_bytesinteger nullable

The size of the uploaded File in bytes. It is set to null when the File resource is first created and updates automatically after a File is uploaded.

status'REQUIRES_UPLOAD' | 'PENDING' | 'UPLOADED' | 'INVALID'

The file's upload status.

tagsTags nullable

Include up to 50 key: value pairs to annotate requests with custom metadata.

  • Maximum character length for individual keys is 40.
  • Maximum character length for individual values is 500. (For example, order_number: 25, item_type: produce, department: sales)
type'BANK_STATEMENT' | 'BANK_STATEMENT_ONE_MONTH' | 'BANK_STATEMENT_THREE_MONTHS' | 'BUSINESS_ADDRESS_DOCUMENT' | 'BUSINESS_ADDRESS_VERIFICATION' | 'BUSINESS_INCORPORATION_DOCUMENT' | 'BUSINESS_OWNERSHIP_STRUCTURE' | 'BUSINESS_REGISTRATION' | 'BUSINESS_REGISTRATION_DOCUMENT' | 'BUSINESS_TAX_EXEMPTION_STATUS_DOCUMENT' | 'BUSINESS_TAX_ID_DOCUMENT' | 'DEVICE_IDLE_IMAGE' | 'DIGITAL_SIGNATURE' | 'DRIVERS_LICENSE_BACK' | 'DRIVERS_LICENSE_FRONT' | 'ENHANCED_DUE_DILIGENCE_DOCUMENT' | 'IDENTIFICATION_CARD_BACK' | 'IDENTIFICATION_CARD_FRONT' | 'OTHER' | 'OWNER_GOVERNMENT_ISSUED_PHOTO_ID' | 'OWNER_TAX_ID_DOCUMENT' | 'PASSPORT' | 'PCI_DOCUMENT' | 'PROCESSING_STATEMENT' | 'SCREEN_RECORDING' | 'TAX_DOCUMENT' | 'VIDEO_DOCUMENT'

The type of document. Finix may return more enums than those provided. Ensure your code accepts additional enums returned by Finix.

Example response

{
  "extension": "png",
  "file_name": "bank_statement_01_2024.png",
  "linked_to": "MU2n7BSovtwYsWYZF6rBnnzk"
}

Changes