Everything you need to integrate
REST API reference, MCP server for AI agents, and a ready-to-run Postman collection covering every endpoint — all in one place.
REST API Reference
Full OpenAPI 3.1 reference with interactive Try-it, request examples, and response schemas for every endpoint.
MCP Server
Connect Claude, Cursor, VS Code, and any MCP-compatible AI agent to ValidPeak's tools via Model Context Protocol.
Postman Collection
Ready-to-run collection covering all 7 API modules — email validation, blacklist, campaign, DMARC, warmup, webhooks, and automation.
Postman Collection
One collection with all 7 modules, plus two environment files — Production and Local. Import once, set your API key, and start testing immediately.
How to import
Open Postman → Import → select ValidPeak_API.postman_collection.json
Import one of the environment files from postman/environments/
Set apiKey in the active environment to your VP-Api-Key
Start with the List requests to retrieve real IDs, then update the collection variables
Folders & scopes
Collection variables
| Variable | Description |
|---|---|
baseUrl | Set automatically in environment file |
apiKey | Your VP-Api-Key — set in the active environment, not in the collection |
bulkValidationId | ID returned by bulk validation submit |
campaignDomainId | ID from GET /campaign/domains |
blacklistMonitorId | ID from GET /blacklist/monitors |
dmarcDomainId | ID from GET /dmarc/monitors |
warmupDomainId | ID from GET /warmup/domains |
webhookSubscriptionId | ID from POST /webhooks/subscriptions |
integrationId | ID from integrations settings |
Adding new modules
Keep the collection in a single file to simplify maintenance. When a new API module ships:
Add a new top-level folder inside item[] in the collection JSON
Keep one collection file — avoid splitting by module (harder to maintain)
Update the scope table in developers/README.md
developers/
postman/
ValidPeak_API.postman_collection.json ← main collection (all modules)
environments/
Production.postman_environment.json
Local.postman_environment.json
MCP.md ← MCP server reference
README.md ← this index