Retrieve a verification

GET/api/v1/verifications/{verification}

Requires anorganization API keywith the scopeverification:read

Parameters

Name	In	Type	Description
`verification`required	path	string	The verification identifier.

Request

GET/api/v1/verifications/{verification}

curl -X GET 'https://app.mailyte.com/api/v1/verifications/01JBT8XQ2M9WYC3K4F6R7S8T9V' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'

const response = await fetch('https://app.mailyte.com/api/v1/verifications/01JBT8XQ2M9WYC3K4F6R7S8T9V', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
  },
});
const { data } = await response.json();

import requests
response = requests.get(
    "https://app.mailyte.com/api/v1/verifications/01JBT8XQ2M9WYC3K4F6R7S8T9V",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->get('https://app.mailyte.com/api/v1/verifications/01JBT8XQ2M9WYC3K4F6R7S8T9V');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/verifications/01JBT8XQ2M9WYC3K4F6R7S8T9V")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

dataobject
- 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

Returned inside the standard envelope.

Errors

Status	When
`401`	The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
`403`	The 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.
`404`	No such resource in this organization.
`422`	The request was understood but the values were not acceptable.
`429`	Too 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.