# Email Analysis API

This API provides services to analyze email addresses.


Version: 1

## Servers

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

## Security

### apiKey

Type: apiKey
In: header
Name: X-API-KEY

## Download OpenAPI description

[Email Analysis API](https://developer.cdq.com/_bundle/apis/email-analysis-api/@email-analysis-api-v1/api-v1.yaml)

## Email Verification

### Verify Email Address

 - [POST /emails/verify](https://developer.cdq.com/apis/email-analysis-api/api-v1/email-verification/paths/~1emails~1verify/post.md): 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.

## Configuration

### List Configurations

 - [GET /configurations/emailverification](https://developer.cdq.com/apis/email-analysis-api/api-v1/configuration/paths/~1configurations~1emailverification/get.md): List all email verification configurations.

### Create Configuration

 - [POST /configurations/emailverification](https://developer.cdq.com/apis/email-analysis-api/api-v1/configuration/paths/~1configurations~1emailverification/post.md): Create a new email verification configuration.

### Read Configuration

 - [GET /configurations/emailverification/{configurationId}](https://developer.cdq.com/apis/email-analysis-api/api-v1/configuration/paths/~1configurations~1emailverification~1%7Bconfigurationid%7D/get.md): Read email verification configuration by id.

### Update Configuration

 - [PUT /configurations/emailverification/{configurationId}](https://developer.cdq.com/apis/email-analysis-api/api-v1/configuration/paths/~1configurations~1emailverification~1%7Bconfigurationid%7D/put.md): Update an existing email verification configuration.

### Delete Configuration

 - [DELETE /configurations/emailverification/{configurationId}](https://developer.cdq.com/apis/email-analysis-api/api-v1/configuration/paths/~1configurations~1emailverification~1%7Bconfigurationid%7D/delete.md): Delete an email verification configuration.

### Read Email Verification Configuration Version

 - [GET /configurations/emailverification/{configurationId}/versions/{version}](https://developer.cdq.com/apis/email-analysis-api/api-v1/configuration/paths/~1configurations~1emailverification~1%7Bconfigurationid%7D~1versions~1%7Bversion%7D/get.md): Read a specific version of an email verification configuration by id and version number.