Create
Authentication
Your API key, sent as Authorization: Bearer usgmk_live_....
Request
scan scans the item as-is; open opens it and scans the contents.
Expedited handling — may incur an extra charge.
Response
Scan id (UUID).
Id of the scanned mail item (numeric string).
SCAN_REQUEST (scan the item) or UNBOXING_REQUEST (open it and scan the contents).
SUBMITTED, IN_PROCESS, COMPLETED, CANCELLED, REJECTED, DELETED or RESTORING.
Last change of any kind — use status_updated_at for status timing.
Why the request was rejected. Null unless status is REJECTED.
Short AI-generated label of the scanned document (e.g. “Insurance”). Null until generated; requires a plan that includes scan labeling.
When the current status was reached — for completed scans, the completion time.
When the scan file is permanently deleted — download it before this date. Null when no deletion is scheduled.