Deprecated API Reference

This API Reference is being deprecated. Please use the New API Reference.

Fetch a File

Fetch a previously created File resource. For more info see Uploading files to Finix.

curl \
  -H 'Content-Type: application/json' \
  -H 'Finix-Version: 2022-02-01' \
  -u  USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
  -X GET

Example Response:

  "id" : "FILE_bJecqoRPasStEPVpvKHtgA",
  "status" : "UPLOADED",
  "created_at" : "2022-03-22T00:38:06.037998Z",
  "updated_at" : "2022-06-09T21:05:57.505494Z",
  "linked_type" : "MERCHANT",
  "linked_to" : "MU2n7BSovtwYsWYZF6rBnnzk",
  "extension" : "png",
  "display_name" : "my drivers license",
  "platform_id" : "PLm5E6FbtCZ5vjpCaKhq5PwN",
  "application_id" : "APgPDQrLD52TYvqazjHJJchM",
  "tags" : {
    "key_1" : "value_1"
  "identity_id" : null

HTTP Request



Field Type Description
id string Your File ID.
status string The status of the file's review. The statuses available includes:
  • REQUIRES_UPLOAD: A file still needs to be uploaded to the File object.
  • PENDING: Finix is reviewing the uploaded file for viruses and malware. In a few minutes, the status of the File should move to INVALID or UPLOADED.
  • INVALID: This file was not accepted by Finix. Please upload a new file.
  • UPLOADED: The file has been uploaded to the resource.
  • created_at string Timestamp of when the File was created.
    updated_at string Timestamp of when the File was updated.
    linked_type string Autofills to Merchant.
    linked_to string The resource ID the File is linked to.
    extension string The extension of the file.
    display_name string The name of the File resource. If you don't provide a name, Finix will name the resource with the convention: FILE(fileid).
    type string The type of document.
    tags object A custom value you can include to annotate the File object's metadata. (e.g. file number).