The File Record resource represents a specific file that has been uploaded to the platform, typically associated with a child account for documentation purposes.To learn how to handle required files during the onboarding process, check the Onboarding API guide .

A FileRecord Resource

{
    "data": {
        "id": "file_DTQiMB3fJwNu5xeitZ1Kg2S1",
        "type": "file_record",
        "attributes": {
            "file_size": "71290",
            "file_type": "jpeg",
            "merchant_id": "org_xxxxxxxxxxxxxxxxxxxxxxx",
            "original_filename": "my_test_filename.jpeg",
            "purpose": "government_id",
            "created_at": 1718002988,
            "updated_at": 1718002988
        }
    }
}

id string
Unique ID of the resource.

type string
Represents the resource type. Value is always file_record.

file_size string
The size of the file in bytes.

file_type string
The type of the file. Allowed file types are doc , docx , jpeg , jpg , pdf , png .

merchant_id string
The ID of the merchant associated with the file record.

original_filename string
The original name of the uploaded file.

purpose string
The purpose of the file, indicating why it was uploaded.

created_at timestamp
The date when the FileRecord has been created.

updated_at timestamp
The date when the FileRecord has been updated.