{"openapi":"3.1.0","info":{"title":"API Reference","version":"1.0.0"},"paths":{"/v1/mails":{"get":{"operationId":"mails_list","summary":"List mail items","description":"List your mail items with filtering, search, sorting and cursor pagination","tags":["Mails"],"parameters":[{"name":"limit","in":"query","description":"Page size, capped at 100.","required":false,"schema":{"type":"integer","maximum":9007199254740991,"exclusiveMinimum":0,"default":25}},{"name":"cursor","in":"query","description":"Opaque page cursor — the `next_cursor` of the previous response. Omit for the first page.","required":false,"schema":{"type":"string","minLength":1}},{"name":"status","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/V1MailsGetParametersStatusSchemaItems"}}},{"name":"mail_type","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/V1MailsGetParametersMailTypeSchemaItems"}}},{"name":"folder_id","in":"query","required":false,"schema":{"type":"integer","maximum":9007199254740991,"exclusiveMinimum":0}},{"name":"search","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"scan_status","in":"query","description":"Filter by the item’s scan state; `none` selects items with no scan.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/V1MailsGetParametersScanStatusSchemaItems"}}},{"name":"sort","in":"query","required":false,"schema":{"$ref":"#/components/schemas/V1MailsGetParametersSort"}},{"name":"arrived","in":"query","required":false,"schema":{"$ref":"#/components/schemas/V1MailsGetParametersArrived"}},{"name":"is_read","in":"query","required":false,"schema":{"$ref":"#/components/schemas/V1MailsGetParametersIsRead"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailPageDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]}},"/v1/mails/{id}":{"get":{"operationId":"mails_get","summary":"Get single mail","description":"Retrieve full detail for one mail item, including dimensions, weight and folder","tags":["Mails"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailDetailDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]},"patch":{"operationId":"mails_update","summary":"Update mail item","description":"Mark the item read/unread and/or move it into a folder","tags":["Mails"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailDetailDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMailDto"}}}},"security":[{"bearer":[]}]}},"/v1/mails/{id}/archive":{"post":{"operationId":"mails_archive","summary":"Archive mail item","description":"Move the item out of your active inbox into the archive","tags":["Mails"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailDetailDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]}},"/v1/mails/{id}/unarchive":{"post":{"operationId":"mails_unarchive","summary":"Unarchive mail item","description":"Restore an archived item back to its previous inbox status","tags":["Mails"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailDetailDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]}},"/v1/mails/{id}/discard":{"post":{"operationId":"mails_discard","summary":"Discard mail item","description":"Request the mailroom to discard the physical item; destructive, reverse with undiscard within 7 days after the discard request. After 7 days the mail item will be permanently and securely shredded and discarded","tags":["Mails"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailDetailDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]}},"/v1/mails/{id}/undiscard":{"post":{"operationId":"mails_undiscard","summary":"Undiscard mail item","description":"Cancel a pending discard request and keep the item","tags":["Mails"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailDetailDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]}},"/v1/scans":{"get":{"operationId":"scans_list","summary":"List scans","description":"List your scan and open-and-scan requests, with filtering, search and pagination","tags":["Scans"],"parameters":[{"name":"limit","in":"query","description":"Page size, capped at 100.","required":false,"schema":{"type":"integer","maximum":9007199254740991,"exclusiveMinimum":0,"default":25}},{"name":"cursor","in":"query","description":"Opaque page cursor — the `next_cursor` of the previous response. Omit for the first page.","required":false,"schema":{"type":"string","minLength":1}},{"name":"status","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/V1ScansGetParametersStatusSchemaItems"}}},{"name":"type","in":"query","description":"`scan` (scan the item) or `open` (open it and scan the contents).","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/V1ScansGetParametersTypeSchemaItems"}}},{"name":"mail_id","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d+$"}},{"name":"search","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100}},{"name":"sort","in":"query","required":false,"schema":{"$ref":"#/components/schemas/V1ScansGetParametersSort"}},{"name":"scanned","in":"query","required":false,"schema":{"$ref":"#/components/schemas/V1ScansGetParametersScanned"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanPageDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]},"post":{"operationId":"scans_create","summary":"Create scan request","description":"Request a scan or open-and-scan of a mail item; this is a billable action","tags":["Scans"],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateScanDto"}}}},"security":[{"bearer":[]}]}},"/v1/scans/{id}":{"get":{"operationId":"scans_get","summary":"Get single scan","description":"Retrieve one scan request by its id, including status and AI label","tags":["Scans"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]},"delete":{"operationId":"scans_delete","summary":"Delete scan","description":"Permanently delete a scan and remove its stored file; this cannot be undone","tags":["Scans"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]}},"/v1/scans/{id}/file":{"get":{"operationId":"scans_file","summary":"Get scan file","description":"Return a short-lived signed URL to download the scanned document; fetch it promptly","tags":["Scans"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanFileDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]}},"/v1/scans/{id}/summary":{"get":{"operationId":"scans_summary","summary":"Get scan summary","description":"Return the AI-generated label and bullet summary of the scanned document","tags":["Scans"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanSummaryDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]}},"/v1/scans/{id}/cancel":{"post":{"operationId":"scans_cancel","summary":"Cancel scan request","description":"Cancel a scan request you no longer need. Valid only for scan requests in in_process status","tags":["Scans"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]}},"/v1/shipments":{"get":{"operationId":"shipments_list","summary":"List shipments","description":"Read-only list of your shipment requests, filterable by type and status","tags":["Shipments"],"parameters":[{"name":"limit","in":"query","description":"Page size, capped at 100.","required":false,"schema":{"type":"integer","maximum":9007199254740991,"exclusiveMinimum":0,"default":25}},{"name":"cursor","in":"query","description":"Opaque page cursor — the `next_cursor` of the previous response. Omit for the first page.","required":false,"schema":{"type":"string","minLength":1}},{"name":"type","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/V1ShipmentsGetParametersTypeSchemaItems"}}},{"name":"status","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/V1ShipmentsGetParametersStatusSchemaItems"}}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentPageDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]}},"/v1/shipments/{id}":{"get":{"operationId":"shipments_get","summary":"Get single shipment","description":"Read-only details of one shipment, including its packed mail items","tags":["Shipments"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentDetailDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]}},"/v1/folders":{"get":{"operationId":"folders_list","summary":"List folders","description":"All your mail folders, returned unpaginated","tags":["Folders"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderListDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]},"post":{"operationId":"folders_create","summary":"Create folder","description":"Create a new mail folder with a name and optional color","tags":["Folders"],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFolderDto"}}}},"security":[{"bearer":[]}]}},"/v1/folders/{id}":{"get":{"operationId":"folders_get","summary":"Get single folder","description":"Retrieve one mail folder by its id","tags":["Folders"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]},"delete":{"operationId":"folders_delete","summary":"Delete folder","description":"Delete a folder and unfile its mail, which is not deleted","tags":["Folders"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]},"patch":{"operationId":"folders_update","summary":"Update folder","description":"Rename a folder or change its color","tags":["Folders"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFolderDto"}}}},"security":[{"bearer":[]}]}},"/v1/addresses":{"get":{"operationId":"addresses_list","summary":"List addresses","description":"List your shipping and deposit addresses, optionally filtered by type","tags":["Addresses"],"parameters":[{"name":"limit","in":"query","description":"Page size, capped at 100.","required":false,"schema":{"type":"integer","maximum":9007199254740991,"exclusiveMinimum":0,"default":25}},{"name":"cursor","in":"query","description":"Opaque page cursor — the `next_cursor` of the previous response. Omit for the first page.","required":false,"schema":{"type":"string","minLength":1}},{"name":"type","in":"query","description":"`shipping` = a shipment destination; `deposit` = where check deposits are sent.","required":false,"schema":{"$ref":"#/components/schemas/V1AddressesGetParametersType"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressPageDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]},"post":{"operationId":"addresses_create","summary":"Add address","description":"Add a new shipping or check-deposit address to your account","tags":["Addresses"],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAddressDto"}}}},"security":[{"bearer":[]}]}},"/v1/addresses/default":{"get":{"operationId":"addresses_getdefault","summary":"Get default","description":"Get your default address for a given type, shipping or deposit","tags":["Addresses"],"parameters":[{"name":"type","in":"query","description":"`shipping` = a shipment destination; `deposit` = where check deposits are sent.","required":true,"schema":{"$ref":"#/components/schemas/V1AddressesDefaultGetParametersType"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]}},"/v1/addresses/{id}":{"get":{"operationId":"addresses_get","summary":"Get single address","description":"Retrieve one shipping or deposit address by its id","tags":["Addresses"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]},"delete":{"operationId":"addresses_delete","summary":"Delete address","description":"Permanently delete an address; this is destructive and cannot be undone","tags":["Addresses"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]},"patch":{"operationId":"addresses_update","summary":"Update address","description":"Update fields on an existing shipping or deposit address","tags":["Addresses"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAddressDto"}}}},"security":[{"bearer":[]}]}},"/v1/addresses/{id}/default":{"patch":{"operationId":"addresses_setdefault","summary":"Set default","description":"Make this address the default for its type, replacing the previous default","tags":["Addresses"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]}},"/v1/bank-accounts":{"get":{"operationId":"bankAccounts_bankAccounts_list","summary":"List bank accounts","description":"List your bank accounts used for check deposits","tags":["bankAccounts"],"parameters":[{"name":"limit","in":"query","description":"Page size, capped at 100.","required":false,"schema":{"type":"integer","maximum":9007199254740991,"exclusiveMinimum":0,"default":25}},{"name":"cursor","in":"query","description":"Opaque page cursor — the `next_cursor` of the previous response. Omit for the first page.","required":false,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountPageDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]},"post":{"operationId":"bankAccounts_bankAccounts_create","summary":"Add bank account","description":"Add a bank account for check deposits; account number is write-only","tags":["bankAccounts"],"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBankAccountDto"}}}},"security":[{"bearer":[]}]}},"/v1/bank-accounts/{id}":{"get":{"operationId":"bankAccounts_bankAccounts_get","summary":"Get single bank account","description":"Retrieve one bank account by id, returning only the last 4 digits","tags":["bankAccounts"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]},"delete":{"operationId":"bankAccounts_bankAccounts_delete","summary":"Delete bank account","description":"Permanently delete a bank account; this is destructive and cannot be undone","tags":["bankAccounts"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"204":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]},"patch":{"operationId":"bankAccounts_bankAccounts_update","summary":"Update bank account","description":"Update the bank name, state, or account number on a bank account","tags":["bankAccounts"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankAccountDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBankAccountDto"}}}},"security":[{"bearer":[]}]}},"/v1/account":{"get":{"operationId":"account_get","summary":"Get account","description":"Your account profile, including name, email, status, and PMB number","tags":["Account"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]}},"/v1/account/mailing-address":{"get":{"operationId":"account_mailingaddress","summary":"Mailing address","description":"Your current USGM address, including PMB number","tags":["Account"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailingAddressDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]}},"/v1/sandbox/seed":{"post":{"operationId":"sandbox_seed","summary":"Seed mailbox","description":"Populate your sandbox mailbox with sample mail items for testing","tags":["Sandbox"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeedResultDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"security":[{"bearer":[]}]}},"/v1/sandbox/seed/mail":{"post":{"operationId":"sandbox_seedmail","summary":"Seed mail","description":"Add one sample mail item to your sandbox mailbox, with optional overrides","tags":["Sandbox"],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeedMailResultDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeedSandboxMailDto"}}}},"security":[{"bearer":[]}]}},"/v1/sandbox/scans/{id}/complete":{"post":{"operationId":"sandbox_completescan","summary":"Complete scan","description":"Force a pending scan to completed in the sandbox for testing","tags":["Sandbox"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanDto"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"401":{"description":"Authentication is required or the API key is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"403":{"description":"You are not permitted to perform this action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"409":{"description":"The request conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"422":{"description":"Validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}},"500":{"description":"Internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsDto"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompleteSandboxScanDto"}}}},"security":[{"bearer":[]}]}}},"tags":[{"name":"Mails"},{"name":"Scans"},{"name":"Shipments"},{"name":"Folders"},{"name":"Addresses"},{"name":"bankAccounts"},{"name":"Account"},{"name":"Sandbox"}],"servers":[{"url":"https://api.usglobalmail.com","description":"Production"},{"url":"https://api-sandbox.usglobalmail.com","description":"Sandbox"}],"components":{"schemas":{"V1MailsGetParametersStatusSchemaItems":{"type":"string","enum":["inbox","archived","quarantine","discard_request"],"title":"V1MailsGetParametersStatusSchemaItems"},"V1MailsGetParametersMailTypeSchemaItems":{"type":"string","enum":["letter","large_letter","magazine","package","softpak","catalog","distribution","fulfillment","inventory"],"title":"V1MailsGetParametersMailTypeSchemaItems"},"V1MailsGetParametersScanStatusSchemaItems":{"type":"string","enum":["in_process","cancelled","rejected","completed","deleted","restoring","none"],"title":"V1MailsGetParametersScanStatusSchemaItems"},"V1MailsGetParametersSort":{"type":"string","enum":["newest","oldest"],"title":"V1MailsGetParametersSort"},"V1MailsGetParametersArrived":{"type":"string","enum":["week","month","half_year","year"],"title":"V1MailsGetParametersArrived"},"V1MailsGetParametersIsRead":{"type":"string","enum":["true","false"],"title":"V1MailsGetParametersIsRead"},"MailPageDtoDataItemsScan":{"type":"object","properties":{"uuid":{"type":"string","description":"Scan id — fetch it via `/v1/scans/{uuid}`."},"status":{"type":"string","description":"`IN_PROCESS`, `COMPLETED`, `CANCELLED`, `REJECTED`, `DELETED` or `RESTORING`."},"category":{"type":"string","description":"`SCAN_REQUEST` or `UNBOXING_REQUEST`."},"label":{"type":["string","null"],"description":"Short AI-generated label of the scanned document (e.g. \"Insurance\"). Null until generated; requires a plan that includes scan labeling."}},"required":["uuid","status","category"],"description":"The scan requested for this item, when one exists.","title":"MailPageDtoDataItemsScan"},"MailPageDtoDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Mail item id (numeric string)."},"folder_id":{"type":["string","null"],"description":"Id of the folder the item is filed in — see `/v1/folders`."},"is_read":{"type":"boolean"},"mail_status":{"type":"string","description":"Lifecycle status as reported by the mailroom."},"mail_type":{"type":"string"},"sender_name":{"type":["string","null"]},"recipient_name":{"type":["string","null"]},"arrival_date":{"type":["string","null"],"format":"date-time","description":"When the item arrived at the facility."},"envelope_image_url":{"type":["string","null"],"description":"Photo of the item/envelope."},"quarantine_reason":{"type":["string","null"]},"scan":{"oneOf":[{"$ref":"#/components/schemas/MailPageDtoDataItemsScan"},{"type":"null"}],"description":"The scan requested for this item, when one exists."}},"required":["id","is_read","mail_status","mail_type"],"title":"MailPageDtoDataItems"},"MailPageDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MailPageDtoDataItems"}},"next_cursor":{"type":["string","null"],"description":"Pass as `?cursor=` to fetch the next page. Null on the last page."},"total_count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Total number of items matching this query across all pages."}},"required":["data","next_cursor","total_count"],"title":"MailPageDto"},"ProblemDetailsDtoErrorsItems":{"type":"object","properties":{"field":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"}},"required":["field","message"],"title":"ProblemDetailsDtoErrorsItems"},"ProblemDetailsDto":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"code":{"type":"string"},"request_id":{"type":"string"},"detail":{"type":"string"},"instance":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ProblemDetailsDtoErrorsItems"}}},"required":["type","title","status","code","request_id"],"title":"ProblemDetailsDto"},"MailDetailDtoScan":{"type":"object","properties":{"uuid":{"type":"string","description":"Scan id — fetch it via `/v1/scans/{uuid}`."},"status":{"type":"string","description":"`IN_PROCESS`, `COMPLETED`, `CANCELLED`, `REJECTED`, `DELETED` or `RESTORING`."},"category":{"type":"string","description":"`SCAN_REQUEST` or `UNBOXING_REQUEST`."},"label":{"type":["string","null"],"description":"Short AI-generated label of the scanned document (e.g. \"Insurance\"). Null until generated; requires a plan that includes scan labeling."}},"required":["uuid","status","category"],"description":"The scan requested for this item, when one exists.","title":"MailDetailDtoScan"},"MailDetailDtoMeasurement":{"type":"object","properties":{"width":{"type":"number","format":"double","description":"Inches."},"height":{"type":"number","format":"double","description":"Inches."},"length":{"type":"number","format":"double","description":"Inches."}},"required":["width","height","length"],"description":"Item dimensions, in inches.","title":"MailDetailDtoMeasurement"},"MailDetailDtoFolder":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"color":{"type":["string","null"]}},"required":["id","name"],"title":"MailDetailDtoFolder"},"MailDetailDto":{"type":"object","properties":{"id":{"type":"string","description":"Mail item id (numeric string)."},"is_read":{"type":"boolean"},"mail_status":{"type":"string","description":"Lifecycle status as reported by the mailroom."},"mail_type":{"type":"string"},"sender_name":{"type":["string","null"]},"recipient_name":{"type":["string","null"]},"arrival_date":{"type":["string","null"],"format":"date-time","description":"When the item arrived at the facility."},"envelope_image_url":{"type":["string","null"],"description":"Photo of the item/envelope."},"quarantine_reason":{"type":["string","null"]},"scan":{"oneOf":[{"$ref":"#/components/schemas/MailDetailDtoScan"},{"type":"null"}],"description":"The scan requested for this item, when one exists."},"mail_type_label":{"type":"string","description":"Human-readable form of `mail_type` (e.g. \"Large Letter\")."},"measurement":{"$ref":"#/components/schemas/MailDetailDtoMeasurement","description":"Item dimensions, in inches."},"weight":{"type":"number","format":"double","description":"Item weight, in pounds."},"tracking_number":{"type":["string","null"],"description":"Inbound carrier tracking number, when one was captured."},"sender_address":{"type":["string","null"]},"has_storage_charges":{"type":"boolean","description":"Whether the item is currently accruing storage charges."},"folder":{"oneOf":[{"$ref":"#/components/schemas/MailDetailDtoFolder"},{"type":"null"}]}},"required":["id","is_read","mail_status","mail_type","mail_type_label","measurement","weight","has_storage_charges"],"title":"MailDetailDto"},"UpdateMailDto":{"type":"object","properties":{"is_read":{"type":"boolean"},"folder_id":{"type":["string","null"],"pattern":"^\\d+$","description":"Move the item to this folder. Pass null to remove it from its folder."}},"title":"UpdateMailDto"},"V1ScansGetParametersStatusSchemaItems":{"type":"string","enum":["in_process","cancelled","rejected","completed","deleted","restoring"],"title":"V1ScansGetParametersStatusSchemaItems"},"V1ScansGetParametersTypeSchemaItems":{"type":"string","enum":["scan","open"],"title":"V1ScansGetParametersTypeSchemaItems"},"V1ScansGetParametersSort":{"type":"string","enum":["newest","oldest"],"title":"V1ScansGetParametersSort"},"V1ScansGetParametersScanned":{"type":"string","enum":["week","month","half_year","year"],"title":"V1ScansGetParametersScanned"},"ScanPageDtoDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Scan id (UUID)."},"mail_id":{"type":"string","description":"Id of the scanned mail item (numeric string)."},"type":{"type":"string","description":"`SCAN_REQUEST` (scan the item) or `UNBOXING_REQUEST` (open it and scan the contents)."},"status":{"type":"string","description":"`IN_PROCESS`, `COMPLETED`, `CANCELLED`, `REJECTED`, `DELETED` or `RESTORING`."},"is_expedited":{"type":"boolean"},"instruction":{"type":["string","null"]},"reject_reason":{"type":["string","null"],"description":"Why the request was rejected. Null unless `status` is `REJECTED`."},"label":{"type":["string","null"],"description":"Short AI-generated label of the scanned document (e.g. \"Insurance\"). Null until generated; requires a plan that includes scan labeling."},"status_updated_at":{"type":["string","null"],"format":"date-time","description":"When the current `status` was reached — for completed scans, the completion time."},"auto_delete_on":{"type":["string","null"],"format":"date-time","description":"When the scan file is permanently deleted — download it before this date. Null when no deletion is scheduled."},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","description":"Last change of any kind — use `status_updated_at` for status timing."}},"required":["id","mail_id","type","status","is_expedited","created_at","updated_at"],"title":"ScanPageDtoDataItems"},"ScanPageDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ScanPageDtoDataItems"}},"next_cursor":{"type":["string","null"],"description":"Pass as `?cursor=` to fetch the next page. Null on the last page."},"total_count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Total number of items matching this query across all pages."}},"required":["data","next_cursor","total_count"],"title":"ScanPageDto"},"CreateScanDtoType":{"type":"string","enum":["scan","open"],"description":"`scan` scans the item as-is; `open` opens it and scans the contents.","title":"CreateScanDtoType"},"CreateScanDto":{"type":"object","properties":{"mail_id":{"type":"string","pattern":"^\\d+$"},"type":{"$ref":"#/components/schemas/CreateScanDtoType","description":"`scan` scans the item as-is; `open` opens it and scans the contents."},"instruction":{"type":"string","minLength":1,"maxLength":500},"is_expedited":{"type":"boolean","default":false,"description":"Expedited handling — may incur an extra charge."}},"required":["mail_id","type"],"title":"CreateScanDto"},"ScanDto":{"type":"object","properties":{"id":{"type":"string","description":"Scan id (UUID)."},"mail_id":{"type":"string","description":"Id of the scanned mail item (numeric string)."},"type":{"type":"string","description":"`SCAN_REQUEST` (scan the item) or `UNBOXING_REQUEST` (open it and scan the contents)."},"status":{"type":"string","description":"`IN_PROCESS`, `COMPLETED`, `CANCELLED`, `REJECTED`, `DELETED` or `RESTORING`."},"is_expedited":{"type":"boolean"},"instruction":{"type":["string","null"]},"reject_reason":{"type":["string","null"],"description":"Why the request was rejected. Null unless `status` is `REJECTED`."},"label":{"type":["string","null"],"description":"Short AI-generated label of the scanned document (e.g. \"Insurance\"). Null until generated; requires a plan that includes scan labeling."},"status_updated_at":{"type":["string","null"],"format":"date-time","description":"When the current `status` was reached — for completed scans, the completion time."},"auto_delete_on":{"type":["string","null"],"format":"date-time","description":"When the scan file is permanently deleted — download it before this date. Null when no deletion is scheduled."},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","description":"Last change of any kind — use `status_updated_at` for status timing."}},"required":["id","mail_id","type","status","is_expedited","created_at","updated_at"],"title":"ScanDto"},"ScanFileDto":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Short-lived signed download URL — fetch promptly, do not store it."},"expires_at":{"type":"string","format":"date-time"}},"required":["url","expires_at"],"title":"ScanFileDto"},"ScanSummaryDto":{"type":"object","properties":{"label":{"type":["string","null"],"description":"Short AI-generated label of the document (e.g. \"Insurance\")."},"summary":{"type":["array","null"],"items":{"type":"string"},"description":"AI-generated summary of the document contents, one bullet point per entry."}},"required":["label","summary"],"title":"ScanSummaryDto"},"V1ShipmentsGetParametersTypeSchemaItems":{"type":"string","enum":["shipment","return_to_sender","check_deposit","pickup"],"title":"V1ShipmentsGetParametersTypeSchemaItems"},"V1ShipmentsGetParametersStatusSchemaItems":{"type":"string","enum":["shipped","in_progress","payment_failed","rejected"],"title":"V1ShipmentsGetParametersStatusSchemaItems"},"ShipmentPageDtoDataItemsType":{"type":"string","enum":["shipment","return_to_sender","check_deposit","pickup"],"title":"ShipmentPageDtoDataItemsType"},"ShipmentPageDtoDataItemsStatus":{"type":"string","enum":["shipped","in_progress","payment_failed","rejected"],"description":"Customer-facing status group — `in_progress` covers every internal workflow state between request and shipment.","title":"ShipmentPageDtoDataItemsStatus"},"ShipmentPageDtoDataItemsDestination":{"type":"object","properties":{"name":{"type":["string","null"],"description":"Recipient name on the address."},"line1":{"type":["string","null"]},"line2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"postal_code":{"type":["string","null"]},"country":{"type":["string","null"]}},"description":"Where it ships to. Only present for `shipment` and `check_deposit` types — returns go back to the sender and pickups happen at the facility.","title":"ShipmentPageDtoDataItemsDestination"},"ShipmentPageDtoDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Shipment id (UUID)."},"type":{"$ref":"#/components/schemas/ShipmentPageDtoDataItemsType"},"status":{"$ref":"#/components/schemas/ShipmentPageDtoDataItemsStatus","description":"Customer-facing status group — `in_progress` covers every internal workflow state between request and shipment."},"tracking_number":{"type":["string","null"],"description":"Carrier tracking number, once the shipment is on its way."},"service_name":{"type":["string","null"],"description":"Carrier service used (e.g. \"FedEx International Priority\")."},"destination":{"oneOf":[{"$ref":"#/components/schemas/ShipmentPageDtoDataItemsDestination"},{"type":"null"}],"description":"Where it ships to. Only present for `shipment` and `check_deposit` types — returns go back to the sender and pickups happen at the facility."},"item_count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of mail items packed into the request."},"requested_ship_date":{"type":["string","null"],"format":"date-time","description":"The ship-out date the customer asked for."},"created_on":{"type":"string","format":"date-time","description":"When the request was made."},"deposit_check_slip_company_name":{"type":["string","null"],"description":"`check_deposit` only."}},"required":["id","type","status","item_count","created_on"],"title":"ShipmentPageDtoDataItems"},"ShipmentPageDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentPageDtoDataItems"}},"next_cursor":{"type":["string","null"],"description":"Pass as `?cursor=` to fetch the next page. Null on the last page."},"total_count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Total number of items matching this query across all pages."}},"required":["data","next_cursor","total_count"],"title":"ShipmentPageDto"},"ShipmentDetailDtoType":{"type":"string","enum":["shipment","return_to_sender","check_deposit","pickup"],"title":"ShipmentDetailDtoType"},"ShipmentDetailDtoStatus":{"type":"string","enum":["shipped","in_progress","payment_failed","rejected"],"description":"Customer-facing status group — `in_progress` covers every internal workflow state between request and shipment.","title":"ShipmentDetailDtoStatus"},"ShipmentDetailDtoDestination":{"type":"object","properties":{"name":{"type":["string","null"],"description":"Recipient name on the address."},"line1":{"type":["string","null"]},"line2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"postal_code":{"type":["string","null"]},"country":{"type":["string","null"]}},"description":"Where it ships to. Only present for `shipment` and `check_deposit` types — returns go back to the sender and pickups happen at the facility.","title":"ShipmentDetailDtoDestination"},"ShipmentDetailDtoMailItemsItems":{"type":"object","properties":{"id":{"type":"string","description":"Mail item id (numeric string)."},"mail_type":{"type":"string"},"sender_name":{"type":["string","null"]},"arrival_date":{"type":["string","null"],"format":"date-time","description":"When the item arrived at the facility."},"envelope_image_url":{"type":["string","null"],"description":"Photo of the item/envelope."}},"required":["id","mail_type"],"title":"ShipmentDetailDtoMailItemsItems"},"ShipmentDetailDto":{"type":"object","properties":{"id":{"type":"string","description":"Shipment id (UUID)."},"type":{"$ref":"#/components/schemas/ShipmentDetailDtoType"},"status":{"$ref":"#/components/schemas/ShipmentDetailDtoStatus","description":"Customer-facing status group — `in_progress` covers every internal workflow state between request and shipment."},"tracking_number":{"type":["string","null"],"description":"Carrier tracking number, once the shipment is on its way."},"service_name":{"type":["string","null"],"description":"Carrier service used (e.g. \"FedEx International Priority\")."},"destination":{"oneOf":[{"$ref":"#/components/schemas/ShipmentDetailDtoDestination"},{"type":"null"}],"description":"Where it ships to. Only present for `shipment` and `check_deposit` types — returns go back to the sender and pickups happen at the facility."},"item_count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Number of mail items packed into the request."},"requested_ship_date":{"type":["string","null"],"format":"date-time","description":"The ship-out date the customer asked for."},"created_on":{"type":"string","format":"date-time","description":"When the request was made."},"deposit_check_slip_company_name":{"type":["string","null"],"description":"`check_deposit` only."},"instructions":{"type":["string","null"],"description":"Packing instructions given when the request was made."},"is_expedited":{"type":"boolean"},"is_insured":{"type":"boolean"},"insured_amount":{"type":["number","null"],"format":"double","description":"Insured value in USD. Null when the shipment is not insured."},"declared_value":{"type":"number","format":"double","description":"Total declared customs value of the packed items, in USD."},"reject_reason":{"type":["string","null"],"description":"Why the request was rejected. Null unless `status` is `rejected`."},"mail_items":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentDetailDtoMailItemsItems"}}},"required":["id","type","status","item_count","created_on","is_expedited","is_insured","declared_value","mail_items"],"title":"ShipmentDetailDto"},"FolderListDtoDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Folder id (numeric string) — mail items reference it as `folder_id`."},"name":{"type":"string"},"color":{"type":["string","null"],"description":"Hex color like `#4BB94B`."},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"}},"required":["id","name","created_on","updated_on"],"title":"FolderListDtoDataItems"},"FolderListDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FolderListDtoDataItems"}}},"required":["data"],"title":"FolderListDto"},"CreateFolderDto":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"color":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"required":["name"],"title":"CreateFolderDto"},"FolderDto":{"type":"object","properties":{"id":{"type":"string","description":"Folder id (numeric string) — mail items reference it as `folder_id`."},"name":{"type":"string"},"color":{"type":["string","null"],"description":"Hex color like `#4BB94B`."},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"}},"required":["id","name","created_on","updated_on"],"title":"FolderDto"},"UpdateFolderDto":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255},"color":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"}},"title":"UpdateFolderDto"},"V1AddressesGetParametersType":{"type":"string","enum":["shipping","deposit"],"title":"V1AddressesGetParametersType"},"AddressPageDtoDataItemsType":{"type":"string","enum":["shipping","deposit"],"description":"`shipping` = a shipment destination; `deposit` = where check deposits are sent.","title":"AddressPageDtoDataItemsType"},"AddressPageDtoDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Address id (UUID)."},"type":{"$ref":"#/components/schemas/AddressPageDtoDataItemsType","description":"`shipping` = a shipment destination; `deposit` = where check deposits are sent."},"name":{"type":["string","null"],"description":"Recipient name on the address."},"line1":{"type":["string","null"]},"line2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"postal_code":{"type":["string","null"]},"country":{"type":["string","null"]},"line3":{"type":["string","null"]},"phone_number":{"type":["string","null"]},"tax_id":{"type":["string","null"]},"is_default":{"type":"boolean","description":"The default address of its `type` — one per type."}},"required":["id","type","is_default"],"title":"AddressPageDtoDataItems"},"AddressPageDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AddressPageDtoDataItems"}},"next_cursor":{"type":["string","null"],"description":"Pass as `?cursor=` to fetch the next page. Null on the last page."},"total_count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Total number of items matching this query across all pages."}},"required":["data","next_cursor","total_count"],"title":"AddressPageDto"},"CreateAddressDtoType":{"type":"string","enum":["shipping","deposit"],"description":"`shipping` = a shipment destination; `deposit` = where check deposits are sent.","title":"CreateAddressDtoType"},"CreateAddressDto":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/CreateAddressDtoType","description":"`shipping` = a shipment destination; `deposit` = where check deposits are sent."},"name":{"type":"string","minLength":1,"maxLength":255},"line1":{"type":"string","minLength":1,"maxLength":255},"line2":{"type":"string","maxLength":255},"line3":{"type":"string","maxLength":255},"city":{"type":"string","minLength":1,"maxLength":255},"state":{"type":"string","minLength":1,"maxLength":255},"postal_code":{"type":"string","minLength":1,"maxLength":32},"country":{"type":"string","minLength":1,"maxLength":255},"phone_number":{"type":"string","minLength":1,"maxLength":32},"tax_id":{"type":"string","maxLength":64}},"required":["type","name","line1","city","state","postal_code","country","phone_number"],"title":"CreateAddressDto"},"AddressDtoType":{"type":"string","enum":["shipping","deposit"],"description":"`shipping` = a shipment destination; `deposit` = where check deposits are sent.","title":"AddressDtoType"},"AddressDto":{"type":"object","properties":{"id":{"type":"string","description":"Address id (UUID)."},"type":{"$ref":"#/components/schemas/AddressDtoType","description":"`shipping` = a shipment destination; `deposit` = where check deposits are sent."},"name":{"type":["string","null"],"description":"Recipient name on the address."},"line1":{"type":["string","null"]},"line2":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"postal_code":{"type":["string","null"]},"country":{"type":["string","null"]},"line3":{"type":["string","null"]},"phone_number":{"type":["string","null"]},"tax_id":{"type":["string","null"]},"is_default":{"type":"boolean","description":"The default address of its `type` — one per type."}},"required":["id","type","is_default"],"title":"AddressDto"},"V1AddressesDefaultGetParametersType":{"type":"string","enum":["shipping","deposit"],"title":"V1AddressesDefaultGetParametersType"},"UpdateAddressDtoType":{"type":"string","enum":["shipping","deposit"],"description":"`shipping` = a shipment destination; `deposit` = where check deposits are sent.","title":"UpdateAddressDtoType"},"UpdateAddressDto":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/UpdateAddressDtoType","description":"`shipping` = a shipment destination; `deposit` = where check deposits are sent."},"name":{"type":"string","minLength":1,"maxLength":255},"line1":{"type":"string","minLength":1,"maxLength":255},"line2":{"type":"string","maxLength":255},"line3":{"type":"string","maxLength":255},"city":{"type":"string","minLength":1,"maxLength":255},"state":{"type":"string","minLength":1,"maxLength":255},"postal_code":{"type":"string","minLength":1,"maxLength":32},"country":{"type":"string","minLength":1,"maxLength":255},"phone_number":{"type":"string","minLength":1,"maxLength":32},"tax_id":{"type":"string","maxLength":64}},"title":"UpdateAddressDto"},"BankAccountPageDtoDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Bank account id (UUID)."},"bank_name":{"type":"string"},"bank_state":{"type":"string"},"account_number_last4":{"type":"string","description":"Last 4 characters of the account number. The full number is write-only and never returned."}},"required":["id","bank_name","bank_state","account_number_last4"],"title":"BankAccountPageDtoDataItems"},"BankAccountPageDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BankAccountPageDtoDataItems"}},"next_cursor":{"type":["string","null"],"description":"Pass as `?cursor=` to fetch the next page. Null on the last page."},"total_count":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Total number of items matching this query across all pages."}},"required":["data","next_cursor","total_count"],"title":"BankAccountPageDto"},"CreateBankAccountDto":{"type":"object","properties":{"bank_name":{"type":"string","minLength":1,"maxLength":255},"bank_state":{"type":"string","minLength":1,"maxLength":255},"account_number":{"type":"string","minLength":1,"maxLength":255,"description":"Full account number. Write-only — reads return `account_number_last4`."}},"required":["bank_name","bank_state","account_number"],"title":"CreateBankAccountDto"},"BankAccountDto":{"type":"object","properties":{"id":{"type":"string","description":"Bank account id (UUID)."},"bank_name":{"type":"string"},"bank_state":{"type":"string"},"account_number_last4":{"type":"string","description":"Last 4 characters of the account number. The full number is write-only and never returned."}},"required":["id","bank_name","bank_state","account_number_last4"],"title":"BankAccountDto"},"UpdateBankAccountDto":{"type":"object","properties":{"bank_name":{"type":"string","minLength":1,"maxLength":255},"bank_state":{"type":"string","minLength":1,"maxLength":255},"account_number":{"type":"string","minLength":1,"maxLength":255,"description":"Full account number. Write-only — reads return `account_number_last4`."}},"title":"UpdateBankAccountDto"},"AccountDto":{"type":"object","properties":{"id":{"type":"string","description":"Account id (UUID)."},"name":{"type":"string"},"email":{"type":"string"},"phone_number":{"type":["string","null"]},"status":{"type":["string","null"],"description":"Account status as reported by USGM (e.g. `APPROVED`, `SUSPENDED`)."},"box_number":{"type":["string","null"],"description":"The PMB (private mailbox) number. Null until a mailbox is assigned."},"created_at":{"type":"string","format":"date-time","description":"Registration date."}},"required":["id","name","email","created_at"],"title":"AccountDto"},"MailingAddressDto":{"type":"object","properties":{"box_number":{"type":"string","description":"The PMB (private mailbox) number — include it on every inbound mail piece."},"line1":{"type":["string","null"]},"line2":{"type":["string","null"]},"line3":{"type":["string","null"]},"city":{"type":["string","null"]},"state":{"type":["string","null"]},"postal_code":{"type":["string","null"]},"country":{"type":["string","null"]},"formatted":{"type":"string","description":"The complete address on one line, ready to hand out: \"<line1> PMB <box>, <city>, <state>, <postal_code>, <country>\"."}},"required":["box_number","formatted"],"title":"MailingAddressDto"},"SeedResultDto":{"type":"object","properties":{"mail_ids":{"type":"array","items":{"type":"string"},"description":"Ids of the seeded mail items (numeric strings)."}},"required":["mail_ids"],"title":"SeedResultDto"},"SeedSandboxMailDtoMailType":{"type":"string","enum":["LETTER","LARGELETTER","MAGAZINE","CATALOG","SOFTPAK","PACKAGE"],"description":"Type of the seeded item. `LETTER` and `LARGELETTER` accept a `SCAN_REQUEST`; the rest accept an `UNBOXING_REQUEST`.","title":"SeedSandboxMailDtoMailType"},"SeedSandboxMailDtoMeasurement":{"type":"object","properties":{"width":{"type":"number","format":"double","exclusiveMinimum":0,"description":"Inches."},"height":{"type":"number","format":"double","exclusiveMinimum":0,"description":"Inches."},"length":{"type":"number","format":"double","exclusiveMinimum":0,"description":"Inches."}},"required":["width","height","length"],"description":"Item dimensions, in inches.","title":"SeedSandboxMailDtoMeasurement"},"SeedSandboxMailDto":{"type":"object","properties":{"sender_name":{"type":"string","minLength":1,"maxLength":200},"mail_type":{"$ref":"#/components/schemas/SeedSandboxMailDtoMailType","description":"Type of the seeded item. `LETTER` and `LARGELETTER` accept a `SCAN_REQUEST`; the rest accept an `UNBOXING_REQUEST`."},"weight":{"type":"number","format":"double","exclusiveMinimum":0,"description":"Item weight, in pounds."},"measurement":{"$ref":"#/components/schemas/SeedSandboxMailDtoMeasurement","description":"Item dimensions, in inches."}},"title":"SeedSandboxMailDto"},"SeedMailResultDto":{"type":"object","properties":{"mail_id":{"type":"string","description":"Id of the seeded mail item (numeric string)."}},"required":["mail_id"],"title":"SeedMailResultDto"},"CompleteSandboxScanDto":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":200,"description":"Short document label the AI would produce, e.g. \"Insurance\". Set on the scan."},"summary":{"type":"array","items":{"type":"string","minLength":1,"maxLength":1000},"description":"Summary bullet points; retrievable via `GET /v1/scans/{id}/summary`."}},"title":"CompleteSandboxScanDto"}},"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your API key, sent as `Authorization: Bearer usgmk_live_…` in production or `usgmk_test_…` in the sandbox."}}}}