Skip to the documentation
API

Check the BIMI logo of a domain

Whether inboxes can draw the logo a domain publishes, and what stops them.

GET/tools/bimi

Runs the real call on your workspace.

GET /tools/bimi

Whether inboxes can draw the logo a domain publishes, and what stops them.

Example

Needs no scope. It reads the BIMI record at default._bimi, fetches the logo it names and checks the DMARC policy beside it. status is present, partial when the record is there but something stops inboxes showing the logo, absent or invalid.

curl
curl "$OE/tools/bimi?domain=acme.com" -H "$AUTH"
Response
{  "object": "bimi_report",  "domain": "acme.com",  "record": "v=BIMI1; l=https://acme.com/logo.svg",  "version": "BIMI1",  "logoUrl": "https://acme.com/logo.svg",  "authorityUrl": null,  "logoSvg": "<svg …>",  "logoReachable": true,  "dmarcPolicy": "quarantine",  "dmarcEnforced": true,  "status": "partial",  "issues": [    "The record publishes no a= authority. Gmail and Apple Mail only draw a logo backed by a Verified Mark Certificate, so most inboxes will show nothing."  ]}

Inboxes draw a logo only when the DMARC policy is quarantine or reject, and dmarcEnforced says whether it is.

Reference