Email Authentication Check
Grades a domain's MX, SPF (counting the 10-lookup limit), DMARC, DKIM and BIMI records, says whether the domain can be spoofed and lists fixes.
- Price per call
- 1 credit
- per successful call
- Price ceiling
- 1 credit
- every call, same price
- Failed calls
- Free
- retried automatically
- Billed
- Per call
- only on success
Endpoint
api.primaryapi.com/ v1/ run/ email. auth_checkAuth: API key with run or full access, or a dashboard session
Send the input below as a JSON body. The call is routed to a healthy upstream; if an attempt fails, it is retried automatically inside the same request and you pay only for the answer you get. To check an input and see the exact price without running anything, call POST /v1/quote/email.auth_check with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/email.auth_check" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"domain":"github.com"}'const res = await fetch('https://api.primaryapi.com/v1/run/email.auth_check', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
domain: 'github.com',
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.code}: ${body.error}`);
// found:false is a successful answer ("does not exist"), not an error
console.log(body.output.found ? body.output.data : body.output.reason, body.credits);import os
import requests
res = requests.post(
"https://api.primaryapi.com/v1/run/email.auth_check",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"domain": "github.com",
},
timeout=60,
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['code']}: {body['error']}")
# found=False is a successful answer ("does not exist"), not an error
print(body["output"]["data"] if body["output"]["found"] else body["output"]["reason"], body["credits"]){
"name": "run_api",
"arguments": {
"sku": "email.auth_check",
"input": {
"domain": "github.com"
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/email.auth_check" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"domain":"github.com"}'Returns credits (what the call is expected to cost) and maxCredits (the most it can cost, which is set aside while it runs). Invalid input fails here the same way it would on run.
Input
JSON body fields. Unknown fields are rejected with 400 invalid_input (never silently ignored). You may add the routing controls preferLatencyUnderMs and maxCredits to the same object.
domainstringrequired- Domain to check, for example "stripe.com". An email address or URL is reduced to its domain; a subdomain is checked as written.max 2048 chars
dkimSelectorsstring[]- Extra DKIM selectors to probe beyond the built-in list of about 20 common ones (a custom selector cannot be discovered).max 20 items · items max 63 chars
Output
When output.found is true, output.data has these fields.
domainstring- Domain that was checked (an email address or URL is reduced to its domain).
domainExistsboolean- false only for NXDOMAIN, which is returned as a free miss instead.
acceptsMailboolean- MX records (or the implicit A/AAAA fallback) exist and there is no null MX.
mailProviderstring | null- Mail host family (Google, Microsoft, …) from the MX host names.
gradeinteger- 0-100 from our own rubric: DMARC 35, SPF 25, DKIM 25, MX 10, BIMI 5.0–100
gradeLetterenum- one of: A, B, C, D, F
canBeSpoofedboolean- true until DMARC is published with p=quarantine or p=reject for all mail (pct=100).
mxobjectmx.recordsobject[]mx.records[].priorityintegermx.records[].hoststringmx.providerstring | nullmx.nullMxboolean- RFC 7505 null MX ("0 ."): the domain accepts no mail.
mx.implicitboolean- No MX records, mail relies on the A/AAAA fallback.
spfobjectspf.recordstring | nullspf.validbooleanspf.allQualifierenum | null- one of: +, -, ~, ?
spf.dnsLookupCountinteger- DNS-querying terms counted through include:/redirect= chains.
spf.exceedsLookupLimitboolean- More than the RFC 7208 limit of 10 DNS lookups.
spf.includesstring[]spf.errorsstring[]dmarcobjectdmarc.recordstring | nulldmarc.validbooleandmarc.policyenum | null- one of: none, quarantine, reject
dmarc.subdomainPolicyenum | null- one of: none, quarantine, reject
dmarc.pctinteger | null- 0–100
dmarc.ruastring[]dmarc.rufstring[]dmarc.alignmentDkimenum | null- one of: relaxed, strict
dmarc.alignmentSpfenum | null- one of: relaxed, strict
dmarc.inheritedFromstring | null- Organisational domain whose record applies to a subdomain without one.
dkimobjectdkim.foundboolean- A live key was found at one of the probed selectors; a miss does not prove DKIM is absent.
dkim.selectorsCheckedstring[]dkim.selectorsobject[]dkim.selectors[].selectorstringdkim.selectors[].keyTypestringdkim.selectors[].keyBitsinteger | nulldkim.selectors[].testingbooleandkim.selectors[].revokedbooleanbimiobjectbimi.recordstring | nullbimi.logostring | nullbimi.authoritystring | nullfixesstring[]- Plain-language fixes, most important first.
TypeScript type
/** output.data when output.found is true */
type EmailAuthCheck = {
/** Domain that was checked (an email address or URL is reduced to its domain). */
domain: string;
/** false only for NXDOMAIN, which is returned as a free miss instead. */
domainExists: boolean;
/** MX records (or the implicit A/AAAA fallback) exist and there is no null MX. */
acceptsMail: boolean;
/** Mail host family (Google, Microsoft, …) from the MX host names. */
mailProvider: string | null;
/** 0-100 from our own rubric: DMARC 35, SPF 25, DKIM 25, MX 10, BIMI 5. */
grade: number;
gradeLetter: "A" | "B" | "C" | "D" | "F";
/** true until DMARC is published with p=quarantine or p=reject for all mail (pct=100). */
canBeSpoofed: boolean;
mx: {
records: {
priority: number;
host: string;
}[];
provider: string | null;
/** RFC 7505 null MX ("0 ."): the domain accepts no mail. */
nullMx: boolean;
/** No MX records, mail relies on the A/AAAA fallback. */
implicit: boolean;
};
spf: {
record: string | null;
valid: boolean;
allQualifier: "+" | "-" | "~" | "?" | null;
/** DNS-querying terms counted through include:/redirect= chains. */
dnsLookupCount: number;
/** More than the RFC 7208 limit of 10 DNS lookups. */
exceedsLookupLimit: boolean;
includes: string[];
errors: string[];
};
dmarc: {
record: string | null;
valid: boolean;
policy: "none" | "quarantine" | "reject" | null;
subdomainPolicy: "none" | "quarantine" | "reject" | null;
pct: number | null;
rua: string[];
ruf: string[];
alignmentDkim: "relaxed" | "strict" | null;
alignmentSpf: "relaxed" | "strict" | null;
/** Organisational domain whose record applies to a subdomain without one. */
inheritedFrom: string | null;
};
dkim: {
/** A live key was found at one of the probed selectors; a miss does not prove DKIM is absent. */
found: boolean;
selectorsChecked: string[];
selectors: {
selector: string;
keyType: string;
keyBits: number | null;
testing: boolean;
revoked: boolean;
}[];
};
bimi: {
record: string | null;
logo: string | null;
authority: string | null;
};
/** Plain-language fixes, most important first. */
fixes: string[];
};If what you asked about does not exist, is private, or a search matches nothing, the call still succeeds: output.found is false, output.data is null and output.reason says why. Such misses are free unless the notes below say misses are billed, in which case a miss costs the price of one call.
Example response
Values are placeholders that follow the output schema (strings as "string", numbers as 0); credits shows what this call would cost at the usual price.
{
"output": {
"found": true,
"data": {
"domain": "github.com",
"domainExists": true,
"acceptsMail": true,
"mailProvider": "string",
"grade": 0,
"gradeLetter": "A",
"canBeSpoofed": true,
"mx": {
"records": [
{
"priority": 0,
"host": "string"
}
],
"provider": "string",
"nullMx": true,
"implicit": true
},
"spf": {
"record": "string",
"valid": true,
"allQualifier": "+",
"dnsLookupCount": 0,
"exceedsLookupLimit": true,
"includes": [
"string"
],
"errors": [
"string"
]
},
"dmarc": {
"record": "string",
"valid": true,
"policy": "none",
"subdomainPolicy": "none",
"pct": 0,
"rua": [
"string"
],
"ruf": [
"string"
],
"alignmentDkim": "relaxed",
"alignmentSpf": "relaxed",
"inheritedFrom": "string"
},
"dkim": {
"found": true,
"selectorsChecked": [
"string"
],
"selectors": [
{
"selector": "string",
"keyType": "string",
"keyBits": 0,
"testing": true,
"revoked": true
}
]
},
"bimi": {
"record": "string",
"logo": "string",
"authority": "string"
},
"fixes": [
"string"
]
}
},
"provider": "PrimaryAPI",
"credits": 1,
"items": 1,
"requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}Pricing and reliability
Calls go only to upstreams that are healthy right now. If an attempt fails, the call is retried automatically inside the same request; a failed attempt costs nothing, and a call never costs more than its quote’s maxCredits. Live figures below are measured on real traffic.
Success rate, uptime, latency and call counts are measured live from real traffic over 30 days and show “—” until there is data.
Errors
Errors are JSON { code, error, requestId } and are never charged. The ones to handle for this endpoint:
- invalid_inputThe request failed validation before anything ran.
- unauthorizedNo valid API key or session was presented.
- insufficient_balanceThe balance cannot cover the most this call could cost.
- key_limit_reachedThe key’s own spend limit is used up for the current window.
- trial_cap_reachedAn agent trial key has used its whole trial budget.
- forbiddenThe credential is valid but may not do this.
- not_foundThe thing addressed by the URL does not exist for you.
- idempotency_conflictThe
Idempotency-Keyis already bound to a different request. - rate_limitedToo many requests in the current window.
- all_sources_failedThe call could not be answered, even after automatic retries.
- service_unavailableThis API cannot run in this deployment right now.
- timeoutThe request passed its deadline before it finished.
Notes
A non-existent domain (NXDOMAIN) is a free miss (reason domain_not_found). DNS failures are retried over DNS-over-HTTPS and are never charged.
More Email endpoints
Generated from the PrimaryAPI catalog. Machine-readable contract: GET https://api.primaryapi.com/v1/apis/email.auth_check.