Skip to content

API overview

PricklyMails verifies email deliverability over a REST API: syntax, MX, SMTP, disposable and role detection, typo suggestions, and bulk verification, billed from a token wallet.

Base URL

https://api.pricklymails.com

Authentication

Two distinct credential types cover the API, depending on what you are calling:

  • API key (Authorization: Bearer pm_live_... or pm_test_...): authenticates the billable verification endpoints (/api/verify, /api/batches, ...). See Authentication.
  • JWT access token: authenticates the dashboard endpoints (API key management, wallet, subscription, webhooks) from your logged-in session. See API keys.

Conventions

  • Every request and response body is JSON.
  • Paginated list endpoints accept limit and offset query params and echo the effective (clamped) values back in the response.
  • Timestamps are RFC 3339 strings in UTC.
  • A resource UUID owned by someone else returns the same 404 as an unknown UUID, so ownership is never leaked.
  • Every error carries a stable translation key rather than localized text.

Where to go next