Skip to content

Email Analysis API (1)

This API provides services to analyze email addresses.

Download OpenAPI description
api-v1.json
api-v1.yaml
Languages
Servers
Mock server

https://developer.cdq.com/_mock/apis/email-analysis-api/api-v1/

Production

https://api.cdq.com/email-analysis/rest/

Email Verification

Operations

Verify Email Address

Request

The Email Domain Guard consists of multiple checkers and a risk scoring feature. Each of the checkers analyzes a specific aspect of the given email address, the assessment via the checkers is then combined in terms of a multifactor analysis to a risk score. Available checkers:

  • Email Component Extractor: Accurately separates an email address into its local part and domain, and then attempt to derive the base domain from it.
  • Email Format Checker: Validates the structure and syntax of email addresses to ensure they follow standard conventions.
  • Domain Existence Checker: Verifies the existence and accessibility of domain names, ensuring communications are directed to functional domains.
  • Disposable Mail Checker: Detects disposable or temporary email addresses, ensuring the quality and authenticity of user-provided email addresses.
  • Freemail Checker: Identifies freemail addresses, helping to assess the quality and legitimacy of user-provided email addresses.
  • Role Category Checker: Identifies role-based email addresses, enhancing personalization and optimizing resource allocation.
  • Whois Checker: Retrieves and analyzes whois information for domains, providing valuable details such as registration date and domain age.
  • DNSBL Checker: Checks if email domain IP addresses are listed on DNS-based Blackhole Lists (DNSBLs), identifying potential sources of spam or malicious activity.
  • Data Breach Checker: Analyzes email accounts and domains for potential data breaches using the “Have I Been Pwned” API.
  • Shared Email Checker: Identifies shared email addresses among community members while ensuring privacy through anonymous data sharing and secure hashing.
  • Fraud Case Checker: Identifies email addresses involved in any reported and confirmed fraud cases via CDQ's Fraud Guard.
Security
apiKey
Bodyapplication/jsonrequired
emailstring(Email)required

An email address as defined by IETF.

Example: "john.doe@gmail.com"
configurationIdstring(ConfigurationId)

Uniquely identifies a configuration.

Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
curl -i -X POST \
  https://developer.cdq.com/_mock/apis/email-analysis-api/api-v1/emails/verify \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "email": "developer-portal@cdq.com"
  }'

Responses

OK

Bodyapplication/json
emailstring(Email)

An email address as defined by IETF.

Example: "john.doe@gmail.com"
summaryobject(EmailVerificationSummary)

Summary of the email verification result.yaml.

statusobject(Status)

Details about status or error of a service

riskobject(EmailRiskVerification)

Details about the risk score and classification.

formatobject(EmailFormatVerification)

Details about the email format.

domainobject(EmailDomainVerification)

Details about the domain verification.

sharingobject(SharedEmailVerification)

Details about the shared email verification.

roleobject(EmailRoleVerification)

Details about the shared email verification.

freemailobject(FreemailVerification)

Details about the freemail verification.

disposableobject(EmailDisposableVerification)

Details about the disposable email verification.

whoisobject(WhoisVerification)

Details about the WHOIS verification.

dnsBlacklistobject(DnsBlacklistVerification)

Details about the DNS blacklist verification.

breachesobject(EmailBreachesVerification)

Details about the data breaches the email address has been associated with. The data originates from the website haveibeenpwned.com

fraudCasesobject(EmailFraudCaseVerification)

Details about the fraud case verification.

debugInfoobject(EmailVerificationDebugInfo)

Debug information about the email verification.

Response
application/json
{
  "email": "developer-portal@cdq.com",
  "summary": {
    "isBreachedDomain": false,
    "isBreachedEmail": false,
    "isDisposable": false,
    "isBlacklisted": false,
    "isPublicWhois": true,
    "isSharedEmail": false,
    "isValidFormat": true,
    "isFreemail": false,
    "isRoleBased": false,
    "isFraudCaseDetected": false
  },
  "status": {
    "code": 200,
    "technicalKey": "OK",
    "details": [ … ]
  },
  "risk": {
    "score": 0,
    "classification": { … }
  },
  "format": {
    "isValidFormat": true,
    "parts": { … }
  },
  "domain": {
    "isValidDomain": true
  },
  "sharing": {
    "isSharedEmail": false,
    "subscribers": 0
  },
  "role": {
    "isRoleBased": false
  },
  "freemail": {
    "isFreemail": false
  },
  "disposable": {
    "isDisposable": false
  },
  "whois": {
    "isPublicWhois": true,
    "entry": { … }
  },
  "dnsBlacklist": {
    "isDnsBlacklisted": false,
    "dnsBlacklists": []
  },
  "breaches": {
    "isBreachedEmail": false,
    "isBreachedDomain": false
  },
  "fraudCases": {
    "isFraudCaseDetected": false,
    "fraudCasesCount": 0
  }
}

Configuration

Operations