List All Files
List all the File
resources you've created. For more info, see Uploading files to Finix.
curl -X GET \
https://finix.sandbox-payments-api.com/files \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
-H 'Content-Type: application/vnd.api+json' \
| Example response
"_embedded" : {
"files" : [
{
"id": "FILE_mfkpUwducGW5vNA8XrRWdm",
"status": "UPLOADED",
"created_at": "2022-04-25T20:23:59.96021Z",
"updated_at": "2022-04-25T20:24:55.512206Z",
"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"
}
},
{
"id": "FILE_7pBudxCneXRWsLbUegk2Db",
"status": "UPLOADED",
"created_at": "2022-04-25T20:20:51.921341Z",
"updated_at": "2022-04-25T20:24:17.664812Z",
"linked_type": "MERCHANT",
"linked_to": "MU2n7BSovtwYsWYZF6rBnnzk",
"extension": "png",
"display_name": "John Drivers License",
"type": "DRIVERS_LICENSE_BACK",
"platform_id": "PLm5E6FbtCZ5vjpCaKhq5PwN",
"application_id": "APgPDQrLD52TYvqazjHJJchM",
"tags": {
"key_1": "value_1"
}
},
}
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) |