Deprecated API Reference

This API Reference is being deprecated. Please use the New API Reference.

Create a File

Before uploading a file, you need to create a File resource.

Once created, you can upload your file to the new File resource. For more info, see Uploading files to Finix.

Copy

Copied

curl https://finix.sandbox-payments-api.com/files \
  -u  USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
  -H 'Content-Type: application/vnd.api+json' \
  -H 'Finix-Version:2022-02-01' \
  -X POST \
  -d '{
    "display_name": "My Drivers License",
    "linked_to": "MU2n7BSovtwYsWYZF6rBnnzk",
	"tags": {
        "key_1": "value_1"
     },
    "type": "DRIVERS_LICENSE_FRONT"
}'

Example Response:

Copy

Copied

{
  "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
}

HTTP Request

POST https://finix.sandbox-payments-api.com/files

Request Arguments

Field	Type	Description	Enum values (if relevant)
`display_name`	string, optional	The name of the `File` you'll create.
`linked_to`	string, required	The resource ID that you want linked to the `File`. e.g. Merchant ID
`type`	ENUM value, required	The type of document.	Available values include: Identity Verification DRIVERS_LICENSE_FRONT DRIVERS_LICENSE_BACK IDENTIFICATION_CARD_FRONT IDENTIFICATION_CARD_BACK Bank account validation BANK_STATEMENT Business Verification TAX_DOCUMENT BUSINESS_REGISTRATION BUSINESS_ADDRESS_VERIFICATION Additional OTHER PCI_DOCUMENT PASSPORT
`tags`	object, optional	A custom value you can include to annotate the `File` object's metadata (e.g. file number)

Response

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's underwriting team is still reviewing the uploaded files. INVALID: The file couldn't be read. 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` object. If you don't provide a name, Finix will name the 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)