Deprecated API Reference
This API Reference is being deprecated. Please use the New API Reference.
List All Files
List all the File
resources you've created. For more info, see Uploading files to Finix.
curl https://finix.sandbox-payments-api.com/files \
-H 'Content-Type: application/vnd.api+json' \
-H 'Finix-Version:2022-02-01' \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
-X GET
| Example response
{
"_embedded" : {
"files" : [ {
"id" : "FILE_3w2uQdszR5gfsfQu2ir7wB",
"status" : "REQUIRES_UPLOAD",
"created_at" : "2022-10-07T19:48:56.539733Z",
"updated_at" : "2022-10-07T19:48:56.559901Z",
"linked_type" : "MERCHANT",
"linked_to" : "MU2n7BSovtwYsWYZF6rBnnzk",
"extension" : null,
"display_name" : "My Drivers License",
"type" : "DRIVERS_LICENSE_FRONT",
"platform_id" : "PLm5E6FbtCZ5vjpCaKhq5PwN",
"application_id" : "APgPDQrLD52TYvqazjHJJchM",
"tags" : {
"key_1" : "value_1"
},
"identity_id" : null
}, {
"id" : "FILE_xtkA6djsKveaoYnrVnSNNn",
"status" : "UPLOADED",
"created_at" : "2022-09-28T21:03:26.309928Z",
"updated_at" : "2022-09-28T21:03:58.466207Z",
"linked_type" : "MERCHANT",
"linked_to" : "MU2n7BSovtwYsWYZF6rBnnzk",
"extension" : "png",
"display_name" : "My Drivers License",
"type" : "DRIVERS_LICENSE_FRONT",
"platform_id" : "PLm5E6FbtCZ5vjpCaKhq5PwN",
"application_id" : "APgPDQrLD52TYvqazjHJJchM",
"tags" : {
"key_1" : "value_1"
},
"identity_id" : null
} ]
},
"page" : {
"limit" : 10,
"next_cursor" : "FILE_xtkA6djsKveaoYnrVnSNNn"
}
}
HTTP Request
GET https://finix.sandbox-payments-api.com/files
Response
Field | Type | Description |
---|---|---|
id |
string | Your File ID. |
created_at |
string | Timestamp of when the File was created. |
updated_at |
string | Timestamp of when the File was updated. |
display_name |
string | The name of the File object. If you don't provide a name, Finix will name the object with the convention: FILE(fileid). |
extension |
string | The extension of the file. |
linked_to |
string | The resource ID to link the file to. |
linked_type |
string | Autofills to Merchant. |
status |
string | The status of the file. |
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) |