docs: Add plus address check to /v1/verify

This commit is contained in:
Dries Augustyns
2025-12-24 12:18:53 +01:00
parent afc405ec02
commit 0d54b1a631
+8 -1
View File
@@ -668,6 +668,10 @@
"type": "boolean", "type": "boolean",
"description": "Whether a potential typo was detected in the email address" "description": "Whether a potential typo was detected in the email address"
}, },
"isPlusAddressed": {
"type": "boolean",
"description": "Whether the email uses plus addressing (contains a + in the local part)"
},
"domainExists": { "domainExists": {
"type": "boolean", "type": "boolean",
"description": "Whether the domain exists (has DNS A or AAAA records)" "description": "Whether the domain exists (has DNS A or AAAA records)"
@@ -690,7 +694,7 @@
"description": "Array of human-readable reasons describing the verification results" "description": "Array of human-readable reasons describing the verification results"
} }
}, },
"required": ["email", "valid", "isDisposable", "isTypo", "domainExists", "hasMxRecords", "reasons"] "required": ["email", "valid", "isDisposable", "isTypo", "isPlusAddressed", "domainExists", "hasMxRecords", "reasons"]
} }
} }
}, },
@@ -704,6 +708,7 @@
"valid": true, "valid": true,
"isDisposable": false, "isDisposable": false,
"isTypo": false, "isTypo": false,
"isPlusAddressed": false,
"domainExists": true, "domainExists": true,
"hasMxRecords": true, "hasMxRecords": true,
"reasons": [ "reasons": [
@@ -721,6 +726,7 @@
"valid": false, "valid": false,
"isDisposable": false, "isDisposable": false,
"isTypo": true, "isTypo": true,
"isPlusAddressed": false,
"domainExists": false, "domainExists": false,
"hasMxRecords": false, "hasMxRecords": false,
"suggestedEmail": "[email protected]", "suggestedEmail": "[email protected]",
@@ -740,6 +746,7 @@
"valid": true, "valid": true,
"isDisposable": true, "isDisposable": true,
"isTypo": false, "isTypo": false,
"isPlusAddressed": false,
"domainExists": true, "domainExists": true,
"hasMxRecords": true, "hasMxRecords": true,
"reasons": [ "reasons": [