---
title: "List Files"
method: GET
path: "/files"
tags: ["Files"]
---

# List Files

`GET /files`

Retrieve a list of `File` resources.

## Query parameters

- `after_cursor` string
- `before_cursor` string
- `created_at.gte` string, date-time
- `created_at.lte` string, date-time
- `limit` integer
- `tags.key` string
- `tags.value` string
- `updated_at.gte` string, date-time
- `updated_at.lte` string, date-time

## Headers

- `Finix-Version` string

## Response `200`

List of `File` resources

- object
  - `page` Page — Details the page that's returned.
    - `limit` integer — The number of entries to return.
    - `next_cursor` string, nullable — The cursor to use for the next page of results.
  - `_embedded` object
    - `files` File[]
      - `id` string — The ID of the resource.
      - `created_at` string, date-time — Timestamp of when the object was created.
      - `updated_at` string, date-time — Timestamp of when the object was last updated.
      - `application` string — ID of the `Application` the resource was created under.
      - `display_name` string — The human-readable name of the `File`. The file name format is `<type>_<id>` by default.
      - `extension` string, nullable — The extension of the file.
      - `file_name` string, 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_id` string, nullable — The ID of the `Application` that the `File` was created under.
      - `linked_to` string — The ID of the resource the `File` is linked to. This can be either a Merchant ID or Identity ID.
      - `linked_type` string — The type of the resource that the `File` is linked to.
      - `platform_id` string — The ID of the `Platform` that the `File` was created under.
      - `size_in_bytes` integer, 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.
      - `tags` Tags, 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.
  - `_links` object
    - `self` Self — Link to the resource that was used in the request.
      - `href` string
    - `next` Next — Link to the next page of entries.
      - `href` string

## Other responses

- `401` — Unauthorized. Authentication is required and has failed or has not been provided.
- `403` — Forbidden. The client is authenticated but does not have permission to access the resource.
- `406` — Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.
- `422` — Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.

---

[API](https://skmtc.net/finix/apis/finix-api-reference.md) · [All operations](https://skmtc.net/finix/apis/finix-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/finix/finix-api-reference/versions/5426f6f99c52/schema)