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' \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
-F "file"="@/Users/Desktop/finix_file.png" \
| Example response
{
"id":"FILE_bJecqoRPasStEPVpvKHtgA",
"status":"PENDING",
"created_at":"2022-02-25T16:11:33.382399-08:00",
"updated_at":"2022-02-25T17:22:18.199541-08:00",
"linked_type":"MERCHANT",
"linked_to":"MU2n7BSovtwYsWYZF6rBnnzk",
"extension":"png",
"display_name":"My Drivers License",
"type":"DRIVERS_LICENSE_FRONT",
"platform_id":"PLpYsNorjuJN6MqZJ85nEsGi",
"application_id":"AP2VmytpTeQ9ScWXaY4R73s",
"tags":{"key_1":"value_1"}
}
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. |
status |
string | The status of the file. |
created_at |
string | Timestamp of when the File was created. |
updated_at |
string | Timestamp of when the File was last 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 object. If you don't provide a name, Finix will name the File ID object 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) |