Upload a file

post https://api.sandbox.ownli.app/api/file/upload

Upload a file to the Ownli cloud. All files used for check-ins need to be uploaded to the Ownli cloud first.

Body Params

userId

string

required

name

string

required

User defined file name of the file. You can give a name that makes it easier the URL easier to identify. Also it will be helpful to provide a suffix so tools like a Browser, Finder or explorer can display it automatically.

file

string

required

Base64 encoded string representation of the file.

deviceIdentifier

string

Unique identifier of the device on which the document was uploaded or photo taken.

deviceManufacturer

string

The manufacturer of the device on which the document was uploaded or photo was taken. e.g. Apple, Xiaomi, Samsung, OPPO, OnePlus etc.

deviceModel

string

The model of the device on which the document was uploaded or photo was taken. e.g. LM-G900, motorola edge, IPad, IPhone 14

deviceOS

string

The OS of the device on which the document was uploaded or photo was taken. Android 9, iOS 13.2.3 etc.

takenOn

string

[takenOn] The timestamp at which the document was uploaded or photo was taken. (The date should be in the ISO8601 UTC format YYY-MM-DDThh:mm:ss.SSSZ; eg: 2024-01-01T00:00:00.000Z

latitude

double

Latitude at which photo was taken.

longitude

double

Longitude at which photo was taken.

Headers

partnerId

string

required

Partner Id

clientId

string

required

Client Id

clientSecret

string

required

Client Secret

Responses

401

Authorization error e.g. due to an invalid or missing API keys.

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.sandbox.ownli.app/api/file/upload \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200File object created by the upload.

400Invalid parameters. Possible error codes ERROR_INVALID_PARAMETERS

403Forbidden. Possible error codes ERROR_NO_PERMISSIONS_TO_RESOURCE

404User not found. Possible error codes ERROR_USER_NOT_FOUND

500Internal error. Possible error codes INTERNAL_SERVER_ERROR ERROR_DECODING_FILE, ERROR_UPLOADING_FILE