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 checks or credits were given back.

      • sourcestringlist | contacts | import | campaign | automatic | single

        Where the addresses came from: - list: addresses you sent (1 check each; older runs used send credits). - contacts: your contacts that were never checked (free). - import, campaign: checks we run when you import contacts or start a campaign (free). - automatic: the day's checks of new contacts while Bounce protection is on. - single: the day's one-address checks.

      • labelstring or null
      • 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 (older runs, or checks paid from credits bought or granted before launch, at 10 credits a check).

      • credits_refundedinteger

        Send credits given back.

      • checks_chargedinteger

        Checks drawn for this run.

      • checks_refundedinteger

        Checks given back (couldn't confirm, or never answered).

      • charge_unitstring or null

        checks, or null for a run paid in send credits.

      • by_mailyteboolean

        True for a free check Mailyte ran on your contacts, such as the one-time check of existing contacts at launch.

      • created_atstring
      • finished_atstring or null
    • 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.