Upload File

post/api/file-uploads

Upload a file. Note that the file must always be the last parameter in the request body.

Request

Body multipart/form-data

purposestringrequired
Allowed values:kyc-doc-upload
The purpose this document is being uploaded for.
accountIdstringrequired
Id of the account owning the file upload.
filestring<binary>required
The file being uploaded.

Response

File successfully uploaded.

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.

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

FILE_TOO_LARGE The uploaded file exceeds the maximum size of 10mb.

FILE_TYPE_INVALID The uploaded file does not match the acceptable MIME types.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl https://api.immersve.com/api/file-uploads \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --form 'purpose=kyc-doc-upload' \
  --form 'accountId=string' \
  --form 'file=@/path/to/file'

curl https://api.immersve.com/api/file-uploads \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --form 'purpose=kyc-doc-upload' \
  --form 'accountId=string' \
  --form 'file=@/path/to/file'

curl https://api.immersve.com/api/file-uploads \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --form 'purpose=kyc-doc-upload' \
  --form 'accountId=string' \
  --form 'file=@/path/to/file'

curl https://api.immersve.com/api/file-uploads \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --form 'purpose=kyc-doc-upload' \
  --form 'accountId=string' \
  --form 'file=@/path/to/file'

curl https://test.immersve.com/api/file-uploads \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --form 'purpose=kyc-doc-upload' \
  --form 'accountId=string' \
  --form 'file=@/path/to/file'

curl https://test.immersve.com/api/file-uploads \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --form 'purpose=kyc-doc-upload' \
  --form 'accountId=string' \
  --form 'file=@/path/to/file'

curl https://test.immersve.com/api/file-uploads \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --form 'purpose=kyc-doc-upload' \
  --form 'accountId=string' \
  --form 'file=@/path/to/file'

curl https://test.immersve.com/api/file-uploads \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --form 'purpose=kyc-doc-upload' \
  --form 'accountId=string' \
  --form 'file=@/path/to/file'

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