Fetch a File

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

curl -X GET \
  https://finix.sandbox-payments-api.com/files/FILE_bJecqoRPasStEPVpvKHtgA \
  -u  USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
  -H 'Content-Type: application/vnd.api+json' \

Example Response:

    "id": "FILE_bJecqoRPasStEPVpvKHtgA",
    "status": "UPLOADED",
    "created_at": "2022-02-25T16:11:33.382399-08:00",
    "updated_at": "2022-02-25T16:11:33.435191-08:00",
    "linked_type": "MERCHANT",
    "linked_to": "MU2n7BSovtwYsWYZF6rBnnzk",
    "extension": null,
    "display_name": "My Drivers License",
    "platform_id": "PLqGYwxrZE6m9336CAjEoC9E",
    "application_id": "APxgfXGA3fKjA6yzKUBSm7rf",
    "tags": {
        "key_1": "value_1"

HTTP Request

GET https://finix.sandbox-payments-api.com/files/:FILE_ID:


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).