API Documentation
Transactional
API Keys
Verify a Domain
Copy
curl --request POST \
--url https://api.thepurplebox.io/v1/domains/verify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: <content-type>'Copy
{
"status": 200,
"message": "verification triggered successfully.",
"data": {
"id": "xxxxx",
"value": "yourdomain.com",
"team_id": "xxxxx",
"status": "success",
"identity_type": "domain",
"created_at": "2025-11-21T10:23:14.737725Z",
"verified_at": "2025-11-21T10:30:45.123456Z",
"attributes": {
"dkim_attributes": {
"name": "thepurplebox._domainkey.yourdomain",
"record_type": "TXT",
"value": "v=DKIM1; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsBL1UV+VVUqIlNrkhBBC...xxxxx",
"ttl": "auto",
"status": "success"
},
"mail_from_attributes": [
{
"name": "send.yourdomain",
"record_type": "TXT",
"value": "xxxxx",
"ttl": "60",
"status": "success"
},
{
"name": "bounce.yourdomain",
"record_type": "CNAME",
"value": "xxxx",
"ttl": "60",
"status": "success"
}
],
"dmarc_attributes": {
"name": "_dmarc",
"record_type": "TXT",
"value": "v=DMARC1;p=none;",
"ttl": "auto",
"status": "success"
},
"verification_status": "success",
"verified_for_sending_status": true,
"error_type": ""
},
"last_status_checked_at": "2025-11-21T10:30:45.123456Z"
}
}
Domains
Verify a Domain
Trigger verification of DNS records for a domain identity.
POST
https://api.thepurplebox.io
/
v1
/
domains
/
verify
Verify a Domain
Copy
curl --request POST \
--url https://api.thepurplebox.io/v1/domains/verify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: <content-type>'Copy
{
"status": 200,
"message": "verification triggered successfully.",
"data": {
"id": "xxxxx",
"value": "yourdomain.com",
"team_id": "xxxxx",
"status": "success",
"identity_type": "domain",
"created_at": "2025-11-21T10:23:14.737725Z",
"verified_at": "2025-11-21T10:30:45.123456Z",
"attributes": {
"dkim_attributes": {
"name": "thepurplebox._domainkey.yourdomain",
"record_type": "TXT",
"value": "v=DKIM1; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsBL1UV+VVUqIlNrkhBBC...xxxxx",
"ttl": "auto",
"status": "success"
},
"mail_from_attributes": [
{
"name": "send.yourdomain",
"record_type": "TXT",
"value": "xxxxx",
"ttl": "60",
"status": "success"
},
{
"name": "bounce.yourdomain",
"record_type": "CNAME",
"value": "xxxx",
"ttl": "60",
"status": "success"
}
],
"dmarc_attributes": {
"name": "_dmarc",
"record_type": "TXT",
"value": "v=DMARC1;p=none;",
"ttl": "auto",
"status": "success"
},
"verification_status": "success",
"verified_for_sending_status": true,
"error_type": ""
},
"last_status_checked_at": "2025-11-21T10:30:45.123456Z"
}
}
Headers
application/jsonQuery Parameters
The domain name to verify (e.g.,
yourdomain.com).Response
HTTP status code. Returns
200 when the verification check is triggered successfully.A human-readable message describing the result of the verification check.
Contains the updated domain verification status after the check.
Show properties
Show properties
Unique identifier for the domain identity.
The domain name that was verified.
The team ID that owns this domain identity.
Updated status of the domain after verification. Possible values:
not_started, pending, success, failed, temporary_failure.Type of identity. Always
domain for domain identities.ISO 8601 timestamp when the domain identity was created.
ISO 8601 timestamp when the domain was verified. Null if not yet verified.
DNS configuration attributes with updated verification statuses.
Show properties
Show properties
DKIM record configuration with updated verification status.
Show properties
Show properties
Overall verification status after the check. Possible values:
not_started, pending, success, failed, temporary_failure.Indicates whether the domain is verified and ready to send emails. Returns
true when all DNS records are verified.Error type if verification fails. Empty string when no errors are present.
ISO 8601 timestamp of the verification check (updated to current time).
Copy
{
"status": 200,
"message": "verification triggered successfully.",
"data": {
"id": "xxxxx",
"value": "yourdomain.com",
"team_id": "xxxxx",
"status": "success",
"identity_type": "domain",
"created_at": "2025-11-21T10:23:14.737725Z",
"verified_at": "2025-11-21T10:30:45.123456Z",
"attributes": {
"dkim_attributes": {
"name": "thepurplebox._domainkey.yourdomain",
"record_type": "TXT",
"value": "v=DKIM1; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsBL1UV+VVUqIlNrkhBBC...xxxxx",
"ttl": "auto",
"status": "success"
},
"mail_from_attributes": [
{
"name": "send.yourdomain",
"record_type": "TXT",
"value": "xxxxx",
"ttl": "60",
"status": "success"
},
{
"name": "bounce.yourdomain",
"record_type": "CNAME",
"value": "xxxx",
"ttl": "60",
"status": "success"
}
],
"dmarc_attributes": {
"name": "_dmarc",
"record_type": "TXT",
"value": "v=DMARC1;p=none;",
"ttl": "auto",
"status": "success"
},
"verification_status": "success",
"verified_for_sending_status": true,
"error_type": ""
},
"last_status_checked_at": "2025-11-21T10:30:45.123456Z"
}
}
⌘I