Developer API Overview
Programmatic access to your mail—at no additional cost.
The PostScan Mail Developer API provides secure, direct access to your mail data and automation controls within your PostScan Mail account. Build custom workflows, integrate mail handling into your internal systems, or sync mail activity with your existing tools and platforms.
The Developer API is included with every PostScan Mail account at no extra charge.
What You Can Do with the PostScan Mail API
Programmatically access and manage mail items received at your PostScan Mail account. The API allows you to retrieve structured mail data and securely integrate it into your internal systems, workflows, or third-party tools.
Sender Name
Identify who sent each mail item for routing, filtering, and automated processing.
Mail ID
A unique identifier for every mail item, enabling precise tracking and system-to-system references.
Received Date
Timestamp of when mail was received at the facility, supporting audit trails and time-based workflows.
Assigned User
See which user or recipient the mail item is associated with inside your organization.
Folder Status
Access the current mailbox folder or processing state to understand how the item has been handled.
Cover Image and Scanned Document Access
Secure access to envelope images and scanned mail content for viewing, download, or integration into downstream workflows.
Control Automations via API
Programmatically manage mail automation settings across your PostScan Mail account. The API allows you to enable or disable key automation rules without manual intervention, making it easy to align mail handling with your internal systems and business logic.
Auto Scan
Automatically open and scan incoming mail items as soon as they are received.
Auto Shred
Securely shred mail items after processing, reducing physical storage and handling.
Auto Discard
Discard unwanted mail items automatically based on predefined rules.
This enables organizations to dynamically control mail behavior based on internal policies, compliance requirements, or external system triggers.
Build Secure, Custom Integrations
Use the PostScan Mail API to connect your mail data directly into your systems and workflows, including:
-
Internal back-office systems
-
Accounting and finance platforms
-
Compliance and audit tools
-
CRM and document management systems
-
Custom enterprise workflows
No third-party middleware required.
Simple authentication
Authenticate all API requests using an API key:
x-api-key: YOUR_API_KEY
API keys can be generated, rotated, or revoked at any time directly from your PostScan Mail account dashboard.
Clear, Developer-Friendly Documentation
Access full API documentation directly within your PostScan Mail account, including:
-
Endpoint definitions
-
Request parameters
-
Sample payloads
-
Success responses
-
Detailed error handling
You can also download a Postman collection to start testing immediately.
Secure by Design
Security is built into every API interaction:
-
API keys are displayed only once at creation
-
Keys can be revoked instantly at any time
-
Revoked keys immediately lose access
-
All requests are authenticated and monitored
This ensures your mail data remains protected while giving you full control over access.
Rate limits built for real-world usage
The API includes sensible rate limits designed for production environments, with clear headers and retry guidance to support reliable scaling.
Who Is This For?
Startups and SaaS companies- Legal and compliance teams
- Finance and accounting teams
Startups and SaaS companies- Distributed and remote organizations
- Enterprises managing high mail volume
- Developers building internal tools and integrations
If mail is part of your workflow, the PostScan Mail API lets you automate it.
Get Started
Choose a mailbox location
Go to Account Settings → Developer API
Generate your API key
Review the documentation
