Runs examples for real against your account. Test keys only; kept in this tab, never stored on our side. Get a key
ZapSMTP / Docs / Domains

Retrieve brand settings

GET/v1/domains/{id}/brand

Brand-in-the-inbox status: sender name, BIMI logo/certificate, DMARC enforcement and per-provider readiness.

Requires a full-access key.

Path parameters

idstringrequired
Domain id

Errors

restricted_api_keyHTTP 403
not_foundHTTP 404
domain not found
GET/v1/domains/{id}/brand
curl 'https://zapsmtp.xyz/v1/domains/019a1e9b-41c2-7a0e-b5d1-3f6c2e8a9d47/brand' \
  -H "Authorization: Bearer $ZAP_API_KEY"
Set ZAP_API_KEY in your environment.
Response 200 OK
{
  "from_name": "Acme",
  "logo_url": "https://zapsmtp.xyz/bimi/acme.com/logo.svg",
  "cert_url": "",
  "has_logo": true,
  "has_cert": false,
  "bimi_record": {
    "record": "BIMI",
    "type": "TXT",
    "name": "default._bimi.acme.com",
    "value": "v=BIMI1; l=https://zapsmtp.xyz/bimi/acme.com/logo.svg; a=;",
    "required": false,
    "status": "verified"
  },
  "dmarc_record": {
    "record": "DMARC",
    "type": "TXT",
    "name": "_dmarc.acme.com",
    "value": "v=DMARC1; p=quarantine; pct=100;",
    "required": false,
    "status": "verified"
  },
  "dmarc": {
    "record": "v=DMARC1; p=quarantine; pct=100; rua=mailto:dmarc@acme.com",
    "domain": "acme.com",
    "p": "quarantine",
    "sp": "",
    "pct": 100,
    "enforced": true
  },
  "published_bimi": "v=BIMI1; l=https://zapsmtp.xyz/bimi/acme.com/logo.svg; a=;",
  "checks": [
    {
      "id": "auth",
      "label": "SPF, DKIM and DMARC pass",
      "ok": true,
      "detail": "Domain verified; ZapSMTP signs every message with DKIM."
    },
    {
      "id": "dmarc",
      "label": "DMARC at enforcement",
      "ok": true,
      "detail": "Found on acme.com: v=DMARC1; p=quarantine; pct=100; rua=mailto:dmarc@acme.com"
    },
    {
      "id": "logo",
      "label": "Logo in SVG Tiny PS, hosted over HTTPS",
      "ok": true,
      "detail": "Square, ≤ 32 KB, solid background. Upload it below; we fix the profile automatically."
    },
    {
      "id": "bimi",
      "label": "BIMI record published",
      "ok": true,
      "detail": "default._bimi.acme.com points to the hosted logo. Mailbox providers may take up to 48 hours to show it."
    },
    {
      "id": "cert",
      "label": "Verified Mark Certificate (VMC) or Common Mark Certificate (CMC)",
      "ok": false,
      "detail": "Required by Gmail and Apple Mail (Gmail does not support a standalone SVG). VMC needs a registered trademark and adds the blue checkmark. Upload the PEM chain in order: certificate, intermediate, root."
    },
    {
      "id": "name",
      "label": "Sender name",
      "ok": true,
      "detail": "Used when an email's from has no display name, e.g. hello@ → \"Acme <hello@…>\"."
    }
  ],
  "providers": {
    "gmail": "needs_certificate",
    "apple": "needs_certificate",
    "yahoo": "ready"
  }
}