Skip to navigation
API referenceUploads

Read an upload session

One of your upload sessions: pending until the person’s photo is stored, then stored with its asset_id, or expired. upload_url is always null here. Another account’s session, and one that does not exist, both answer 404 UPLOAD_NOT_FOUND. Requires the digitisation.read scope.

Authentication

X-API-Keystring

API key for one environment of your account. Keep server-side; never expose in browser clients.

Path parameters

upload_idstringRequired

Response

The session
asset_idstring or null
content_typeslist of enums
Allowed values:
expires_atdatetime
idstring
max_bytesinteger
statusenum
Allowed values:
upload_urlstring or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
503
Service Unavailable Error