Skip to main content
POST
curl

Authorizations

Authorization
string
header
required

Partner API key sent as Authorization: Bearer . Test keys and live keys are separate.

Headers

Idempotency-Key
string

Accepted but not used for replay on this operation. Only POST /v1/partner/consultations stores and replays responses by Idempotency-Key.

Pattern: ^[A-Za-z0-9_-]{8,128}$

Body

multipart/form-data
file
file
required

JPEG, PNG or PDF, at most 10 MB. The type is detected from the bytes.

purpose
enum<string>
default:photo

photo or document.

Available options:
photo,
document
sha256
string

Optional hex digest; a mismatch is refused.

Response

The stored upload.

upload_id
string<uuid>
required

The upload id; use it as the answer to an upload question.

object
enum<string>
required

Always upload.

Available options:
upload
purpose
enum<string>
required

photo or document.

Available options:
photo,
document
content_type
string
required

Detected content type of the file.

bytes
integer
required

File size in bytes.

sha256
string
required

SHA-256 hex digest of the file.

width
integer | null
required

Image width in pixels; null for documents.

height
integer | null
required

Image height in pixels; null for documents.

status
enum<string>
required

pending until a consultation or information request answer uses it (attached). An upload never used before expires_at is expired: it no longer counts towards the storage quota, cannot be used, and is deleted with its file by a periodic cleanup.

Available options:
pending,
attached,
expired
expires_at
string<date-time> | null
required

When the upload expires if it is still unused.