Get a verification's results

GET/api/v1/verifications/{verification}/results
Requires anorganization API keywith the scopeverification:read

One answer per address. result is what to do: send to valid, risky and unknown; mail to invalid is refused. reason says what was found, never how — an address known not to exist reads the same however we learned it.

Add format=csv to download the whole verification as a CSV file instead.

Parameters

NameInTypeDescription
verificationrequiredpathstringThe verification identifier.
offsetqueryintegerSkip this many answers. Default 0.
limitqueryintegerAnswers to return, 1–5,000. Default 1,000.
formatquerystring`csv` for the whole verification as a download.

Request

GET/api/v1/verifications/{verification}/results
curl -X GET 'https://app.mailyte.com/api/v1/verifications/01JBT8XQ2M9WYC3K4F6R7S8T9V/results' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'
The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

  • dataarray<object>
    • objectstringverification_result
    • emailstring
    • resultstringvalid | invalid | risky | unknown | pending

      Mail to `invalid` is refused. `risky` and `unknown` are sent as normal. `pending`: still being checked.

    • reasonstringmailbox_exists | mailbox_does_not_exist | domain_cannot_receive_mail | misspelt_domain | invalid_syntax | disposable_address | accepts_all_addresses | role_address | provider_does_not_confirm | could_not_confirm | checking
    • flagsarray<string>

      `role`: info@, sales@ and the like. `disposable`: a throwaway inbox (marketing to it is not sent). `catch_all`: the domain accepts any address.

Returned inside the standard envelope.

Errors

StatusWhen
401The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
403The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys.
404No such resource in this organization.
422The request was understood but the values were not acceptable.
429Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait.

Every status, with what causes it and what to do, is on the error reference.