API Reference
API v1 - currentGetting started with the API
Every step on verifiedinbox.ai is backed by our REST API. Free checks and anonymous drafts work without an account; signed-in accounts and API keys unlock paid verification, DNS checks, and certificate management.
Base URL & conventions
All version 1 REST endpoints are served over HTTPS from a single base URL:
- JSON everywhere: Send request bodies with
Content-Type: application/json(UTF-8). - Timestamps & money: All dates and timestamps use RFC 3339 in UTC (for example
2026-10-31T12:00:00Z). Monetary amounts are integer USD cents (for example149900is $1,499.00). - Backward compatibility: Within
v1, changes are strictly additive. Your client should ignore unfamiliar fields and tolerate new enum values. - Idempotency: Checkout and certificate mutations require an
Idempotency-Keyheader (up to 255 characters) so network retries never charge or submit an order twice. - Machine-readable OpenAPI 3.1 contract: https://verifiedinbox.ai/openapi.json
Security & authentication
Each endpoint declares its required access level. Inaccessible resources always return 404 Not Found (never 403) so private domain applications cannot be enumerated.
| Credential | Header | Used for |
|---|---|---|
| Public | None | Public domain & email security checks, starting a new application, glossary, and metadata. |
| Guest token | VI-Guest-Token: vi_guest_… | Continuing an anonymous verification through the 5 free check steps (valid 30 days, sliding). |
| API key | Authorization: Bearer vi_live_… | Server and agent integrations bound to one organization and environment (vi_live_… or vi_test_…). |
| OAuth token | Authorization: Bearer <JWT> | MCP clients signed in as a user via WorkOS AuthKit. |
Top 3 most important sections
Most integrations only need these three groups of endpoints to take a domain from initial check to an active certificate:
1. Domain & Email Checks
Run free, repeatable domain and SPF/DKIM/DMARC/BIMI checks for any domain without an account.
2. Applications & Wizard Steps
Start a verification, inspect the 11 wizard steps and separate outcomes, and advance steps as requirements are met.
- Create ApplicationPOST /v1/applications
- Get ApplicationGET /v1/applications/{application_id}
- List ApplicationsGET /v1/applications
- Get Next StepsGET /v1/applications/{application_id}/next-steps
- Complete StepPOST /v1/applications/{application_id}/steps/{step}/complete
- Update ApplicationPATCH /v1/applications/{application_id}
3. Certificates & Renewals
Check order prerequisites, run the comprehensive pre-order re-check, and order, renew, reissue, or revoke certificates.
- Get CertificateGET /v1/applications/{application_id}/certificate
- Run Final CheckPOST /v1/applications/{application_id}/certificate/check
- Order CertificatePOST /v1/applications/{application_id}/certificate/order
- Renew CertificatePOST /v1/applications/{application_id}/certificate/renew
- Reissue CertificatePOST /v1/applications/{application_id}/certificate/reissue
- Revoke CertificatePOST /v1/applications/{application_id}/certificate/revoke
Browse all API sections
Free, repeatable public checks of any domain.
The server-side state of one domain's journey.
SPF, DKIM, DMARC and BIMI for an application.
Logo intake, SVG Tiny P/S conversion and approval.
USPTO trademark search and verification.
VMC / CMC / not-yet-eligible outcome and price estimate.
Anonymous credentials and resume links.
Contact a human, feedback and feature requests.
Plain-English definitions of every term we use.
Public logo and certificate files referenced by BIMI records.
Stripe hosted checkout (agents create links; people pay).
Legal company verification.
The DNS records to add, with live status.
Certificate order, status, reissue, renewal and revocation.
Authentication results on a real email.
BIMI publication and display confirmation.
Profile, organizations, environment, API keys, orders.
Sandbox helpers (no real payments).
Service metadata, health and this contract.
Model Context Protocol endpoint and OAuth discovery.