Welcome to Xendit’s latest documentation. For legacy content, access the previous documentation here or the previous API reference here.

Get file status by ID

Prev Next
Get
/files/{file_id}

Make a GET request to this endpoint to get file details

Security
HTTP
Type Basic
Path parameters
file_id
stringRequired

Unique ID generated by Xendit for the particular file

Responses
200

Successful operation

getFile
{
  "id": "file-ec700c1c-db17-4496-b1fb-04ebe551b412",
  "business_id": "ec700c1c-db17-4496-b1fb-04ebe551b412",
  "purpose": "CHARGEBACK_EVIDENCE",
  "created": "2020-10-08T06:38:33.479Z",
  "updated": "2020-10-08T06:38:33.479Z",
  "type": "image/png",
  "size": 10000,
  "url": "https://files.xendit.co/file-ec700c1c-db17-4496-b1fb-04ebe551b412"
}
object
id
string

Unique ID generated by Xendit for the particular file

business_id
string

Unique ID generated by Xendit for the particular file

purpose
string

Purpose of the file

created
string

UTC Timestamp of file upload in ISO format

updated
string

UTC Timestamp of last file update in ISO format

type
string

Type of the file

size
integer

Size of the file in bytes

URL
string

URL to download the file

404

The provided id does not exist. Please review the id and try again

object
error_code
string
Valid values[ "RATE_LIMIT_EXCEEDED" ]
message
string
errors
Array
OneOf
string
string
object
object