List verifications

GET/api/v1/verifications
Requires anorganization API keywith the scopeverification:read

Parameters

NameInTypeDescription
per_pagequeryintegerPage size, 1–100. Default 25.

Request

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

Response

Success.

  • dataobject
    • dataarray<object>
      • objectstringverification
      • idstring
      • statusstringrunning | finished | expired | failed

        `running` until every address has an answer, then `finished`. `expired`: the checker could not answer some addresses within a day; they stay `pending` and their credits were refunded.

      • sourcestringlist | contacts | import | campaign

        `list`: addresses you sent (10 send credits each). `contacts`: your never-checked contacts (free). `import` and `campaign`: checks we run automatically when you import contacts or start a campaign (free).

      • labelstringnull
      • totalinteger

        Unique addresses in the run.

      • countsobject

        Always sums to `total`.

        • validinteger

          The mailbox exists.

        • invalidinteger

          Does not exist, cannot receive mail, or is not an address. Mail to these is refused.

        • riskyinteger

          Throwaway, catch-all or role address: may not reach a person.

        • unknowninteger

          The provider would not confirm either way (Yahoo and AOL never do). Sent as normal.

        • pendinginteger

          Still being checked.

      • credits_chargedinteger

        Send credits this run cost: 10 per address for a `list`, 0 otherwise.

      • credits_refundedinteger

        Credits given back for addresses the checker could not answer.

      • created_atstring
      • finished_atstringnull
    • pagination_metaany

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.