API Referencescans

Cancel

Authentication

AuthorizationBearer

Your API key, sent as Authorization: Bearer usgmk_live_....

Path parameters

idstringRequiredformat: "uuid"

Response

idstring

Scan id (UUID).

mail_idstring

Id of the scanned mail item (numeric string).

typestring

SCAN_REQUEST (scan the item) or UNBOXING_REQUEST (open it and scan the contents).

statusstring

SUBMITTED, IN_PROCESS, COMPLETED, CANCELLED, REJECTED, DELETED or RESTORING.

is_expeditedboolean
created_atdatetime
updated_atdatetime

Last change of any kind — use status_updated_at for status timing.

instructionstring or null
reject_reasonstring or null

Why the request was rejected. Null unless status is REJECTED.

labelstring or null

Short AI-generated label of the scanned document (e.g. “Insurance”). Null until generated; requires a plan that includes scan labeling.

status_updated_atdatetime or null

When the current status was reached — for completed scans, the completion time.

auto_delete_ondatetime or null

When the scan file is permanently deleted — download it before this date. Null when no deletion is scheduled.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error