Deprecated API Reference
This API Reference is being deprecated. Please use the New API Reference.
Upload files Directly
Upload files directly with a multipart/form-data
request. For more info see, Uploading files to Finix.
curl 'https://finix.sandbox-payments-api.com/files/FILE_bJecqoRPasStEPVpvKHtgA/upload' \
-H 'Content-Type: multipart/form-data' \
-H 'Finix-Version:2022-02-01' \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
-F "file"="@/Users/Desktop/finix_file.png"
| 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",
"type": "DRIVERS_LICENSE_FRONT",
"platform_id": "PLm5E6FbtCZ5vjpCaKhq5PwN",
"application_id": "APgPDQrLD52TYvqazjHJJchM",
"tags": {
"key_1": "value_1"
},
"identity_id": null
}
HTTP Request
POST https://finix.sandbox-payments-api.com/files/:FILE_ID:/upload
URL Parameters
Parameter |
Description |
---|---|
:FILE_ID: | The File ID that was created to upload the file. |
Request Arguments
Field | Type | Description |
---|---|---|
file |
string, required | The location of the file on your local system. |
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 last updated. |
display_name |
string | The name of the File object. If you don't provide a name, Finix will name the File ID object with the convention: FILE(fileid). |
extension |
string | The extension of the file. |
linked_to |
string | The resource ID the file is linked to. |
linked_type |
string | Autofills to Merchant. |
status |
string | The status of the file. |
tags |
object | A custom value you can include to annotate the File object's metadata. (e.g. file number) |
type |
string | The type of document. |