Verification a sender

GET/api/v1/senders/{sender}/verification
Requires anorganization API keywith the scopesenders:read

Parameters

NameInTypeDescription
senderrequiredpathstringThe sender identifier.

Request

GET/api/v1/senders/{sender}/verification
curl -X GET 'https://app.mailyte.com/api/v1/senders/01JBT8XQ2M9WYC3K4F6R7S8T9V/verification' \
  -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

    The live verification check for one sender: what DNS shows now and what is missing.

    • objectstringsender_verification
    • sender_idstring

      The sender this check is for.

    • statestringpending | verified | failed

      Whether the sender is verified, with the same values as verification.state on GET /senders/{sender}.

    • errorstring

      Why the last check failed. Null when state is not failed.

    • checksobject

      The live DNS checks, each true or false.

      • spfboolean
      • dkimboolean
      • dmarcboolean

        Reported, but never required — see requires.

    • requiresarray<string>

      Which of checks must pass for the sender to verify. DMARC is checked and shown, but does not block.

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.