Verify a Domain

curl --request POST \
  --url https://api.thepurplebox.io/v1/domains/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>'

{
    "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"
    }
}

POST

domains

verify

Verify a Domain

curl --request POST \
  --url https://api.thepurplebox.io/v1/domains/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>'

{
    "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

Content-Type

string

required

application/json

Query Parameters

value

string

required

The domain name to verify (e.g., yourdomain.com).

Response

status

number

HTTP status code. Returns 200 when the verification check is triggered successfully.

message

string

A human-readable message describing the result of the verification check.

data

object

Contains the updated domain verification status after the check.

Show properties

string

Unique identifier for the domain identity.

value

string

The domain name that was verified.

team_id

string

The team ID that owns this domain identity.

status

string

Updated status of the domain after verification. Possible values: not_started, pending, success, failed, temporary_failure.

identity_type

string

Type of identity. Always domain for domain identities.

created_at

string

ISO 8601 timestamp when the domain identity was created.

verified_at

string | null

ISO 8601 timestamp when the domain was verified. Null if not yet verified.

attributes

object

DNS configuration attributes with updated verification statuses.

Show properties

dkim_attributes

object

DKIM record configuration with updated verification status.

Show properties

name

string

The DNS record name for the DKIM selector.

record_type

string

The DNS record type. Always TXT for DKIM records.

value

string

The DKIM public key value.

ttl

string

Time to Live for the DNS record.

status

string

Updated verification status. Possible values: not_started, pending, success, failed.

mail_from_attributes

array

Array of DNS records with updated verification statuses.

Show properties

name

string

The subdomain name for the mail record.

record_type

string

The DNS record type.

value

string

The DNS record value.

ttl

string

Time to Live for the DNS record.

status

string

Updated verification status.

dmarc_attributes

object

DMARC record configuration with updated verification status.

Show properties

name

string

The DNS record name for DMARC.

record_type

string

The DNS record type.

value

string

The DMARC policy value.

ttl

string

Time to Live for the DNS record.

status

string

Updated verification status.

verification_status

string

Overall verification status after the check. Possible values: not_started, pending, success, failed, temporary_failure.

verified_for_sending_status

boolean

Indicates whether the domain is verified and ready to send emails. Returns true when all DNS records are verified.

error_type

string

Error type if verification fails. Empty string when no errors are present.

last_status_checked_at

string

ISO 8601 timestamp of the verification check (updated to current time).

{
    "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"
    }
}

Delete a Domain API Key Logs

​Headers

​Query Parameters

​Response

Headers

Query Parameters

Response