BIMI Record Validator
BIMI Validator checks if a domain has a valid BIMI record published in DNS. BIMI enables domain owners to display verified logos in supported email clients.
This API provides reliable and fast access to bimi record validator data through a simple REST interface. Built for developers who need consistent, high-quality results with minimal setup time.
To use this API, you need an API key. You can get one by creating a free account and visiting your dashboard.
View API in DirectoryEndpoint
GET https://api.apiverve.com/v1/bimivalidator
Code Examples
Here are examples of how to call this API in different programming languages:
curl -X GET \
"https://api.apiverve.com/v1/bimivalidator?domain=ebay.com" \
-H "X-API-Key: your_api_key_here"
const response = await fetch('https://api.apiverve.com/v1/bimivalidator', {
method: 'GET',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
});
const data = await response.json();
console.log(data);
import requests
headers = {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
response = requests.get('https://api.apiverve.com/v1/bimivalidator', headers=headers)
data = response.json()
print(data)
const https = require('https');
const url = require('url');
const options = {
method: 'GET',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
};
const req = https.request('https://api.apiverve.com/v1/bimivalidator', options, (res) => {
let data = '';
res.on('data', (chunk) => data += chunk);
res.on('end', () => console.log(JSON.parse(data)));
});
req.end();
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apiverve.com/v1/bimivalidator');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'X-API-Key: your_api_key_here',
'Content-Type: application/json'
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/bimivalidator", nil)
req.Header.Set("X-API-Key", "your_api_key_here")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
require 'net/http'
require 'json'
uri = URI('https://api.apiverve.com/v1/bimivalidator')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['X-API-Key'] = 'your_api_key_here'
request['Content-Type'] = 'application/json'
response = http.request(request)
puts JSON.pretty_generate(JSON.parse(response.body))
Authentication
This API requires authentication via API key. Include your API key in the request header:
X-API-Key: your_api_key_here
Parameters
The following parameters are available for this API endpoint:
Parameter | Type | Required | Location | Description | Example |
---|---|---|---|---|---|
domain | string | Yes | query | The domain to validate the BIMI record for | ebay.com |
Response
The API returns responses in JSON, XML, and YAML formats:
Example Responses
{
"status": "ok",
"error": null,
"data": {
"bimi_host": "default._bimi.ebay.com",
"bimi_record": "v=BIMI1;l=https://bimi.entrust.net/ebay.com/logo.svg;a=https://bimi.entrust.net/ebay.com/certchain.pem",
"bimi_records_count": 1,
"has_bimi_record": true,
"host": "ebay.com",
"svg_logo": {
"file_size_bytes": 1633,
"status_code": 200,
"url": "https://bimi.entrust.net/ebay.com/logo.svg",
"valid": true
},
"valid": true,
"version": "BIMI1",
"vmc_certificate": {
"status_code": 200,
"url": "https://bimi.entrust.net/ebay.com/certchain.pem",
"valid": true
}
}
}
<Root>
<status>ok</status>
<error />
<data>
<bimi_host>default._bimi.ebay.com</bimi_host>
<bimi_record>v=BIMI1;l=https://bimi.entrust.net/ebay.com/logo.svg;a=https://bimi.entrust.net/ebay.com/certchain.pem</bimi_record>
<bimi_records_count>1</bimi_records_count>
<has_bimi_record>true</has_bimi_record>
<host>ebay.com</host>
<svg_logo>
<file_size_bytes>1633</file_size_bytes>
<status_code>200</status_code>
<url>https://bimi.entrust.net/ebay.com/logo.svg</url>
<valid>true</valid>
</svg_logo>
<valid>true</valid>
<version>BIMI1</version>
<vmc_certificate>
<status_code>200</status_code>
<url>https://bimi.entrust.net/ebay.com/certchain.pem</url>
<valid>true</valid>
</vmc_certificate>
</data>
</Root>
status: ok
error:
data:
bimi_host: default._bimi.ebay.com
bimi_record: v=BIMI1;l=https://bimi.entrust.net/ebay.com/logo.svg;a=https://bimi.entrust.net/ebay.com/certchain.pem
bimi_records_count: 1
has_bimi_record: true
host: ebay.com
svg_logo:
file_size_bytes: 1633
status_code: 200
url: https://bimi.entrust.net/ebay.com/logo.svg
valid: true
valid: true
version: BIMI1
vmc_certificate:
status_code: 200
url: https://bimi.entrust.net/ebay.com/certchain.pem
valid: true
Response Structure
All API responses follow a consistent structure with the following fields:
Field | Type | Description | Example |
---|---|---|---|
status | string | Indicates whether the request was successful ("ok") or failed ("error") | ok |
error | string | null | Contains error message if status is "error", otherwise null | null |
data | object | null | Contains the API response data if successful, otherwise null | {...} |
Response Data Fields
When the request is successful, the data
object contains the following fields:
Field | Type | Sample Value |
---|---|---|
bimi_host | string | "default._bimi.ebay.com" |
bimi_record | string | "v=BIMI1;l=https://bimi.entrust.net/ebay.com/logo.svg;a=https://bimi.entrust.net/ebay.com/certchain.pem" |
bimi_records_count | number | 1 |
has_bimi_record | boolean | true |
host | string | "ebay.com" |
svg_logo | object | {...} |
svg_logo.file_size_bytes | number | 1633 |
svg_logo.status_code | number | 200 |
svg_logo.url | string | "https://bimi.entrust.net/ebay.com/logo.svg" |
svg_logo.valid | boolean | true |
valid | boolean | true |
version | string | "BIMI1" |
vmc_certificate | object | {...} |
vmc_certificate.status_code | number | 200 |
vmc_certificate.url | string | "https://bimi.entrust.net/ebay.com/certchain.pem" |
vmc_certificate.valid | boolean | true |
Headers
Required and optional headers for API requests:
Header Name | Required | Example Value | Description |
---|---|---|---|
X-API-Key | Yes | your_api_key_here | Your APIVerve API key. Found in your dashboard under API Keys. |
Accept | No | application/json | Specify response format: application/json (default), application/xml, or application/yaml |
User-Agent | No | MyApp/1.0 | Identifies your application for analytics and debugging purposes |
X-Request-ID | No | req_123456789 | Custom request identifier for tracking and debugging requests |
Cache-Control | No | no-cache | Control caching behavior for the request and response |
Client Libraries
To get started with minimal code, most of our APIs are available through client libraries and clients:
Error Codes
The API uses standard HTTP status codes to indicate success or failure:
Status Code | Message | Description |
---|---|---|
200 | OK | Request successful, data returned |
400 | Bad Request | Invalid request parameters or malformed request |
401 | Unauthorized | Missing or invalid API key |
403 | Forbidden | API key does not have permission for this endpoint |
429 | Too Many Requests | Rate limit exceeded, please slow down requests |
500 | Internal Server Error | Server error, please try again later |
Was this page helpful?
Help us improve our documentation