Skip to content

Widget API

The widget API powers real-time validation in the browser — the same endpoint the drop-in widget uses. It’s authenticated with your publishable key (pk_), which is safe to expose in client-side code.

GET /v1/widget/verify
Parameter In Required Description
email query Yes The address being typed/submitted.
key query Yes Your publishable pk_ key.
const res = await fetch(
`https://api.verifymaill.com/v1/widget/verify?email=${encodeURIComponent(email)}&key=pk_your_widget_key`,
);
const { status, did_you_mean } = await res.json();

A trimmed result suitable for inline form feedback:

{
"email": "jane@exmaple.com",
"status": "undeliverable",
"did_you_mean": "jane@example.com",
"disposable": false
}

Most teams use the pre-built widget rather than calling this endpoint directly — it handles debouncing, typo suggestions, and UI for you.