Skip to main content

Upload File

POST 
/api/file-uploads

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

Example request using curl:

curl 'https://test.immersve.com/api/file-uploads' \
  -H 'Content-Type: multipart/form-data' \
  -H 'Authorization: Bearer <TOKEN>' \
  -F 'purpose="kyc-doc-upload"' \
  -F 'accountId="accountId"' \
  -F 'file=@"/path/to/file"'

Request​

Body

    purpose required

    Possible values: [kyc-doc-upload]

    The purpose this document is being uploaded for.

    accountId stringrequired

    Id of the account owning the file upload.

    file binaryrequired

    The file being uploaded.

Responses​

File successfully uploaded.

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.

Loading...