Skip to main content
POST
/
api
/
ext
/
generic
/
email
/
email-health-check
Comprehensive email health check
curl --request POST \
  --url https://app.spotzee.com/api/ext/generic/email/email-health-check \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'email_domain=<string>'
{
  "status": "success",
  "data": {
    "totalCritereaScore": 290,
    "obtainedScore": 220,
    "finalScorePercentage": 76,
    "dataCompleteness": {
      "percentage": 100,
      "missingChecks": [
        "TLS-RPT"
      ],
      "failureReason": "technical"
    },
    "mx": {
      "score": 123,
      "maxScore": 123,
      "value": [
        {
          "priority": "<string>",
          "hostname": "<string>"
        }
      ],
      "isExists": {
        "result": true,
        "points": 123
      },
      "emailServiceProvider": {
        "result": true,
        "points": 123,
        "value": [
          {
            "hostname": "<string>",
            "provider": "<string>"
          }
        ]
      },
      "hasMultipleProviders": {
        "result": true,
        "isProblematic": true,
        "points": 123
      },
      "backupServers": {
        "result": true,
        "points": 123,
        "value": [
          null
        ]
      },
      "isAnyBackUpServerDown": {
        "result": true,
        "isProblematic": true,
        "points": 123
      },
      "isAnyIpBlacklisted": {
        "result": true,
        "isProblematic": true,
        "points": 123,
        "value": {}
      },
      "isReverseDNSMatches": {
        "result": true,
        "points": 123,
        "value": {}
      },
      "isAnyHostnameBlacklisted": {
        "result": true,
        "isProblematic": true,
        "points": 123,
        "value": [
          null
        ]
      },
      "info": [
        "<string>"
      ],
      "warnings": [
        "<string>"
      ]
    },
    "spf": {
      "score": 123,
      "maxScore": 123,
      "isExists": {
        "result": true,
        "points": 123
      },
      "isDuplicate": {
        "result": true,
        "isProblematic": true,
        "points": 123
      },
      "isValid": {
        "result": true,
        "points": 123
      },
      "isMechanismUsed": {
        "result": true,
        "points": 123,
        "value": {}
      },
      "isModifiersUsed": {
        "result": true,
        "points": 123,
        "value": {}
      },
      "isRecursiveIncluded": {
        "result": true,
        "points": 123,
        "value": [
          "<string>"
        ]
      },
      "isTooManyVoidLookup": {
        "result": true,
        "isProblematic": true,
        "points": 123,
        "value": 123
      },
      "hasStrictAll": {
        "result": true,
        "points": 123
      },
      "value": [
        "<string>"
      ],
      "dnsLookupCount": {
        "value": 123,
        "points": 123
      }
    },
    "dmarc": {
      "score": 123,
      "maxScore": 123,
      "isExists": {
        "result": true,
        "points": 123
      },
      "isValid": {
        "result": true,
        "points": 123
      },
      "policy": {
        "result": true,
        "points": 123,
        "value": "<string>"
      },
      "subDomainPolicy": {
        "result": true,
        "points": 123,
        "value": "<string>"
      },
      "isRuaExists": {
        "result": true,
        "points": 123,
        "value": [
          "<string>"
        ]
      },
      "ruaEmails": {
        "result": true,
        "points": 123,
        "value": [
          {
            "email": "<string>",
            "result": "<string>"
          }
        ]
      },
      "isRufExists": {
        "result": true,
        "points": 123,
        "value": [
          null
        ]
      },
      "rufEmails": {
        "result": true,
        "points": 123,
        "value": [
          null
        ]
      },
      "isPctExists": {
        "result": true,
        "points": 123,
        "value": "<string>"
      },
      "isAspfExists": {
        "result": true,
        "points": 123,
        "value": "<string>"
      },
      "isAdkimExists": {
        "result": true,
        "points": 123,
        "value": "<string>"
      },
      "value": [
        "<string>"
      ]
    },
    "domain": {
      "score": 123,
      "maxScore": 123,
      "isBlackListed": {
        "result": true,
        "isProblematic": true,
        "points": 123
      },
      "ageInMonths": {
        "points": 123,
        "value": 123
      },
      "expiryDate": {
        "points": 123,
        "value": "<string>"
      },
      "isDomainAgeMoreThan3Months": {
        "result": true,
        "points": 123,
        "value": 123
      },
      "dnsProvider": {
        "points": 123,
        "value": [
          "<string>"
        ]
      },
      "isTrustworthy": {
        "result": true,
        "points": 123,
        "value": "<string>"
      },
      "isCommon": {
        "result": true,
        "points": 123,
        "value": "<string>"
      },
      "isMXRecordExists": {
        "result": true,
        "points": 123,
        "value": [
          {
            "priority": "<string>",
            "hostname": "<string>"
          }
        ]
      },
      "isUsingTLSA": {
        "result": true,
        "points": 123,
        "value": [
          null
        ]
      },
      "isUsingDNSKEY": {
        "result": true,
        "points": 123,
        "value": [
          null
        ]
      },
      "isDomainUrlBroken": {
        "result": true,
        "points": 123,
        "value": "<string>"
      },
      "isSafeUrl": {
        "result": true,
        "points": 123,
        "value": "<string>"
      },
      "isParkedDomain": {
        "result": true,
        "isProblematic": true,
        "points": 123
      },
      "value": "<string>",
      "info": [
        "<string>"
      ]
    },
    "bimi": {
      "score": 123,
      "maxScore": 123,
      "value": "<string>",
      "isExists": {
        "result": true,
        "points": 123
      },
      "isValid": {
        "result": true,
        "points": 123
      },
      "isAllImageUrlWorks": {
        "result": true,
        "points": 123,
        "value": [
          null
        ]
      }
    },
    "mtaSts": {
      "score": 123,
      "maxScore": 123,
      "isExists": {
        "result": true,
        "points": 123,
        "value": "<string>"
      },
      "policy": {
        "mode": {
          "result": true,
          "points": 123,
          "value": "<string>"
        },
        "maxAge": {
          "result": true,
          "points": 123,
          "value": 123
        },
        "mxHosts": {
          "value": [
            "<string>"
          ],
          "result": true
        }
      },
      "isPolicyFileValid": {
        "result": true,
        "points": 123
      },
      "policyFileUrl": {
        "value": "<string>"
      },
      "policyFileContent": {
        "value": "<string>"
      },
      "errors": [
        null
      ]
    },
    "tlsRpt": {
      "score": 123,
      "maxScore": 123,
      "isExists": {
        "result": true,
        "points": 123
      },
      "rua": {
        "result": true,
        "points": 123,
        "value": [
          null
        ]
      },
      "record": {
        "value": "<string>"
      },
      "errors": [
        null
      ]
    },
    "dkim": {
      "score": 123,
      "maxScore": 123,
      "records": [
        null
      ],
      "info": [
        "<string>"
      ]
    },
    "caa": {
      "score": 10,
      "maxScore": 10,
      "isExists": {
        "result": true,
        "points": 10
      },
      "records": [
        {
          "raw": "0 issue \"letsencrypt.org\"",
          "flags": 0,
          "tag": "issue",
          "value": "letsencrypt.org",
          "isCritical": false,
          "type": "issue",
          "description": "Authorizes letsencrypt.org to issue certificates"
        },
        {
          "raw": "0 iodef \"mailto:security@example.com\"",
          "flags": 0,
          "tag": "iodef",
          "value": "mailto:security@example.com",
          "isCritical": false,
          "type": "iodef",
          "description": "Incident reporting configured",
          "reportingMethod": "email",
          "reportingAddress": "security@example.com"
        },
        {
          "raw": "0 contactemail \"caa-notifications@example.com\"",
          "flags": 0,
          "tag": "contactemail",
          "value": "caa-notifications@example.com",
          "isCritical": false,
          "type": "contactemail",
          "description": "CAA contact email: caa-notifications@example.com",
          "contactMethod": "email",
          "contactValue": "caa-notifications@example.com"
        }
      ],
      "analysis": {
        "hasIssueTag": true,
        "hasIssuewildTag": false,
        "hasIncidentReporting": true,
        "isRestrictive": false,
        "authorizedCAs": [
          {
            "ca": "letsencrypt.org",
            "type": "issue",
            "provider": "Let's Encrypt"
          }
        ],
        "hasContactInfo": true,
        "contactRecords": [
          {
            "type": "contactemail",
            "value": "caa-notifications@example.com",
            "method": "email"
          }
        ],
        "hasCriticalRecords": false,
        "hasMultipleCAs": false,
        "hasWildcardRestriction": false,
        "totalRecords": 3,
        "unparsedRecords": 0
      }
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer token authentication. Use format: Bearer YOUR_API_KEY

Body

application/x-www-form-urlencoded
email_domain
required

Email address

dkim_test_type
enum<string>

DKIM test scope: quick (popular selectors) or full (comprehensive)

Available options:
quick,
full
Example:

"quick"

Response

Successfully completed health check

status
enum<string>
required
Available options:
success
data
object
required