Domain authentication and validation

You can authenticate and validate your domains after creating and managing them. You need a domain name which is valid so that it can be authenticated. To check out the public endpoints, you can go to API reference > Domains.

1. Validate domain configuration

You can use the endpoint https://api.brevo.com/v3/senders/domains/{domainName} with the GET method to validate your domain. You can use the cURL request below to send a request to the endpoint.

1
curl --request GET \
2
     --url https://api.brevo.com/v3/senders/domains/mycompany.com \
3
     --header 'accept: application/json' \
4
     --header 'api-key: '

This endpoint shows the configurations of a specific domain. There is only one attribute for this endpoint domainName which you have to append with the URL in the cURL request. It is defined below in the table:

Response

A sample response for the request would be something like:

1
{
2
  "domain": "mycompany.com",
3
  "verified": false,
4
  "authenticated": false,
5
  "dns_records": {
6
    "dkim_record": {
7
      "type": "TXT",
8
      "value": "k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDeMVIzrCa3T14JsNY0IRv5/2V1/v2itlviLQBwXsa7shBD6TrBkswsFUToPyMRWC9tbR/5ey0nRBH0ZVxp+lsmTxid2Y2z+FApQ6ra2VsXfbJP3HE6wAO0YTVEJt1TmeczhEd2Jiz/fcabIISgXEdSpTYJhb0ct0VJRxcg4c8c7wIDAQAB",
9
      "host_name": "mail._domainkey.",
10
      "status": false
11
    },
12
    "brevo_code": {
13
      "type": "TXT",
14
      "value": "brevo-code:e760f020e6d438149540cfc757e99b5a",
15
      "host_name": "",
16
      "status": false
17
    }
18
  }
19
}

In the JSON format, the domains configurations are shown and if the domain is verified and authenticated. You can find some response codes below and their description.

2. Authenticate a domain

You can use the endpoint https://api.brevo.com/v3/senders/domains/{domainName}/authenticate with the PUT method to authenticate a domain. The cURL request below can be utilised to send a request to the endpoint.

1
curl --request PUT \
2
     --url https://api.brevo.com/v3/senders/domains/mycompany.com/authenticate \
3
     --header 'accept: application/json' \
4
     --header 'api-key: '

You can put the attribute domainName in the url of the cURL request as mentioned here https://api.brevo.com/v3/senders/domains/{domainName}/authenticate. The attribute is mentioned in the table below:

Response

A sample response would be something like:

1
{
2
  "domain_name": "mycompany.com",
3
  "message": "Domain has been authenticated successfully."
4
}

A few response codes and their descriptions are mentioned below in the table: