Get File Upload

get/api/file-uploads/{fileUploadId}

Retrieve the meta data of a file upload by a given id.

Request

Path Parameters

fileUploadIdstringrequired
Primary identifier of the file upload to fetch.

Response

Successful operation.

Body application/json

idstringrequired
Id of the file.
purposestringrequired
Allowed values:kyc-doc-upload
The purpose the file is related to.
livenessstringrequired
Allowed values:livetest
The resource liveness mode.
accountIdstringrequired
Id of the account owning the file upload.
fileNamestringrequired
Name of file.
fileSizenumberrequired
Size of the file in bytes.
mimeTypestringrequired
The type of file.
statusstringrequired
Allowed values:createddeletingdeleted
The current status of the file upload.
expiresAtstring
Date when the file will be considered expired and subsequently deleted.

User is not allowed to perform the action with the reason stated in the errorCode.

FORBIDDEN Insufficient permissions to perform the action.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl 'https://api.immersve.com/api/file-uploads/{fileUploadId}' \
  --header 'Authorization: Bearer <access-token>'

Example Response

{
  "id": "1234567890",
  "purpose": "kyc-doc-upload",
  "liveness": "live",
  "accountId": "057aa15913a57f50577234c8426534c0",
  "fileName": "passport_scan.jpg",
  "fileSize": 284573,
  "mimeType": "application/pdf",
  "status": "created",
  "expiresAt": "2025-04-30"
}

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}