Integration manual
Get started
Create a sandbox workspace, activate a product and make your first request.
1. Open your workspace
Sign in, open the Platform workspace, select a data region in the header and choose Sandbox. You can enable EU and US workspaces for the same organisation; each has its own keys, records and allowances. FedRAMP access requires a discussion with our team. Activate the product you want to test. Each sandbox product includes a bounded allowance and cannot create trusted production claims. Use synthetic data only.
2. Create an API key
Open Platform → API credentials and create a named key with the permissions you need and an expiry of 1–90 days. Save the key on your server; it is shown once and is scoped to your organisation, environment and region. Workload identity is an alternative for approved OIDC providers; see the Authentication & API access guide. Never put it in browser JavaScript, a mobile app or a public repository.
3. Select the region
Use eu.mimeprotect.com, us.mimeprotect.com or fedramp.mimeprotect.com to match the region encoded in your key. Each host selects its corresponding KV binding. A key sent to the wrong region is rejected; a missing regional binding never falls back to global storage.
4. Read your allowance
Use the bearer key on server requests. Choose your endpoint host explicitly; do not send a production key to an unrelated domain.
curl https://eu.mimeprotect.com/api/security/usage \
-H "Authorization: Bearer $MIMEPROTECT_API_KEY"5. Move to production
Select Production in Products, activate an eligible trial or subscribe to monthly capacity. Complete issuer and sender checks for documents and calls. Manage production subscriptions and usage in Billing. Issuer and sender approval are required for the corresponding production products. Sandbox credentials never grant production access.
Ready to connect it?
Open your regional workspace, create a sandbox key and test the complete flow with synthetic data. Keep the returned identifiers and inspect every result before moving to production.
Open the sandbox →Discuss your requirements →