ZapSMTP / Docs / DomainsResponse
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 403not_foundHTTP 404- domain not found
curl 'https://zapsmtp.xyz/v1/domains/019a1e9b-41c2-7a0e-b5d1-3f6c2e8a9d47/brand' \
-H "Authorization: Bearer $ZAP_API_KEY"const res = await fetch('https://zapsmtp.xyz/v1/domains/019a1e9b-41c2-7a0e-b5d1-3f6c2e8a9d47/brand', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.ZAP_API_KEY}`,
},
});
// 204 No Content (e.g. a delete) has no body
const data = res.status === 204 ? null : await res.json();
if (!res.ok) throw new Error(`${data.name}: ${data.message}`);
console.log(data);import os
import requests
res = requests.get(
"https://zapsmtp.xyz/v1/domains/019a1e9b-41c2-7a0e-b5d1-3f6c2e8a9d47/brand",
headers={"Authorization": f"Bearer {os.environ['ZAP_API_KEY']}"},
timeout=30,
)
res.raise_for_status()
print(res.json() if res.status_code != 204 else "deleted")<?php
$ch = curl_init('https://zapsmtp.xyz/v1/domains/019a1e9b-41c2-7a0e-b5d1-3f6c2e8a9d47/brand');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('ZAP_API_KEY'),
],
]);
$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($status >= 400) {
throw new RuntimeException($data['message']);
}
print_r($data);package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest(
"GET",
"https://zapsmtp.xyz/v1/domains/019a1e9b-41c2-7a0e-b5d1-3f6c2e8a9d47/brand",
nil,
)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("ZAP_API_KEY"))
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(res.Status, string(out))
}require 'net/http'
require 'json'
uri = URI('https://zapsmtp.xyz/v1/domains/019a1e9b-41c2-7a0e-b5d1-3f6c2e8a9d47/brand')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = "Bearer #{ENV.fetch('ZAP_API_KEY')}"
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
puts res.code, (JSON.parse(res.body) unless res.body.to_s.empty?)import java.net.URI;
import java.net.http.*;
public class ZapRequest {
public static void main(String[] args) throws Exception {
var request = HttpRequest.newBuilder(URI.create("https://zapsmtp.xyz/v1/domains/019a1e9b-41c2-7a0e-b5d1-3f6c2e8a9d47/brand"))
.header("Authorization", "Bearer " + System.getenv("ZAP_API_KEY"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
var response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System.Net.Http.Headers;
using System.Text;
using var http = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://zapsmtp.xyz/v1/domains/019a1e9b-41c2-7a0e-b5d1-3f6c2e8a9d47/brand");
request.Headers.Authorization = new AuthenticationHeaderValue(
"Bearer", Environment.GetEnvironmentVariable("ZAP_API_KEY"));
var response = await http.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");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"
}
}