List all scanboxes on the account (GET /scanboxes). Read-only.

List mailings in a scanbox (GET /scanboxes/{id}/mailings). Read-only.

Args: scanbox_id: Scanbox id (e.g. "12345"). current_status: Optional status filter. One of: received, scan_requested, scanned, destroy_requested, destroyed, forward_requested, forwarded. older_than: Optional mailing UUID cursor for pagination; returns mailings older than the given one.

Get one mailing with its details/extracted content. Read-only.

GET /scanboxes/{scanbox_id}/mailings/{uuid}

Download a mailing's scanned PDF and save it to disk. Read-only.

GET /scanboxes/{scanbox_id}/mailings/{uuid}/pdf

Args: save_path: Absolute path to write the PDF to. Defaults to ~/Downloads/dropscan-.pdf (or DROPSCAN_DOWNLOAD_DIR).

Download a mailing's ZIP (individual PDFs) and save it. Read-only.

GET /scanboxes/{scanbox_id}/mailings/{uuid}/zip

Download a mailing's envelope image (JPEG) and save it. Read-only.

GET /scanboxes/{scanbox_id}/mailings/{uuid}/envelope

Get OCR plaintext of a mailing (first 5 documents). Read-only.

GET /scanboxes/{scanbox_id}/mailings/{uuid}/plaintext

List recipients configured for a scanbox. Read-only.

GET /scanboxes/{scanbox_id}/recipients

Get one recipient of a scanbox. Read-only.

GET /scanboxes/{scanbox_id}/recipients/{id}

Get a forwarding address by id. Read-only.

GET /forwarding_addresses/{id}

Get a shipment (physical forwarding batch) by id. Read-only.

GET /shipments/{id}

List all webhook rules on the account. Read-only.

GET /webhook_rules

Get one webhook rule by id. Read-only.

GET /webhook_rules/{id}

Request a physical action on a mailing (scan / forward / destroy).

⚠️ AFFECTS THE REAL PRODUCTION ACCOUNT AND CANNOT BE UNDONE. "destroy" physically shreds the letter, it is gone for good. "forward" physically mails the letter to an address and incurs cost. Double-gated: requires DROPSCAN_ALLOW_WRITES=1 AND confirm=true.

POST /scanboxes/{scanbox_id}/mailings/{mailing_uuid}/action_requests

Args: action_type: One of "scan", "forward", "destroy". forwarding_address_id: Required when action_type="forward"; the id of a forwarding address (see create_forwarding_address / get_forwarding_address). forwarding_date: Required when action_type="forward"; ISO date (YYYY-MM-DD). confirm: Must be True to proceed.

Cancel a pending action request on a mailing.

⚠️ Changes the real production account. Cancellation windows apply (scan: 10 min, destroy: 60 min, forward: before the requested date, Berlin time). Double-gated: requires DROPSCAN_ALLOW_WRITES=1 AND confirm=true.

DELETE /scanboxes/{scanbox_id}/mailings/{mailing_uuid}/action_requests/{id}

Assign a recipient to a mailing.

⚠️ Changes the real production account. Double-gated: requires DROPSCAN_ALLOW_WRITES=1 AND confirm=true.

PUT /scanboxes/{scanbox_id}/mailings/{mailing_uuid}/recipient

Create a recipient on a scanbox.

⚠️ Changes the real production account. Double-gated: requires DROPSCAN_ALLOW_WRITES=1 AND confirm=true.

POST /scanboxes/{scanbox_id}/recipients

Args: type: "Person" or "Company". firstname, lastname: Required when type="Person". name: Required when type="Company".

Create a forwarding address (used as a forward target).

⚠️ Changes the real production account. Double-gated: requires DROPSCAN_ALLOW_WRITES=1 AND confirm=true.

POST /forwarding_addresses

Args: country_code: 2-3 char ISO country code (e.g. "DE"). zip_code: Postal code (sent as "zip" in the request body).

Create a webhook rule.

⚠️ Changes the real production account. Double-gated: requires DROPSCAN_ALLOW_WRITES=1 AND confirm=true.

POST /webhook_rules

Args: events: One or more of: mailing_received, scan_requested, mailing_scanned, mailing_archived, mailing_trashed, mailing_shredded, mailing_added_to_shipment, mailing_removed_from_shipment, shipment_sent, package_tracking_updated.

Update a webhook rule.

⚠️ Changes the real production account. Double-gated: requires DROPSCAN_ALLOW_WRITES=1 AND confirm=true.

PATCH /webhook_rules/{id}

Delete a webhook rule.

⚠️ Changes the real production account and cannot be undone. Double-gated: requires DROPSCAN_ALLOW_WRITES=1 AND confirm=true.

DELETE /webhook_rules/{id}