Get File Upload

GET 
/api/file-uploads/:fileUploadId

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

Request

Path Parameters

fileUploadId stringrequired

Primary identifier of the file upload to fetch.

Responses

200

application/json

Schema

Schema

id stringrequired

Id of the file.

purpose required

Possible values: [kyc-doc-upload]

The purpose the file is related to.

liveness stringrequired

Possible values: [live, test]

The resource liveness mode.

accountId stringrequired

Id of the account owning the file upload.

fileName stringrequired

Name of file.

fileSize numberrequired

Size of the file in bytes.

mimeType stringrequired

The type of file.

status stringrequired

Possible values: [created, deleting, deleted]

The current status of the file upload.

expiresAt string

Date when the file will be considered expired and subsequently deleted.

Example (from schema)

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

403

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

FORBIDDEN Insufficient permissions to perform the action.

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

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

Loading...