Skip to main content
POST
/
v3
/
email
/
check
Check Email Code
curl --request POST \
  --url https://verification.didit.me/v3/email/check/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "email": "<string>",
  "code": "<string>",
  "duplicated_email_action": "NO_ACTION",
  "breached_email_action": "NO_ACTION",
  "disposable_email_action": "NO_ACTION",
  "undeliverable_email_action": "NO_ACTION"
}
'
{
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "message": "<string>",
  "email": {
    "status": "<string>",
    "email": "<string>",
    "is_breached": true,
    "breaches": [
      {
        "name": "<string>",
        "domain": "<string>",
        "logo_path": "<string>",
        "breach_date": "2023-12-25",
        "description": "<string>",
        "is_verified": true,
        "data_classes": [
          "<string>"
        ],
        "breach_emails_count": 123
      }
    ],
    "is_disposable": true,
    "is_undeliverable": true,
    "verification_attempts": 123,
    "verified_at": "2023-11-07T05:31:56Z",
    "warnings": [
      {}
    ],
    "lifecycle": [
      {
        "type": "<string>",
        "timestamp": "2023-11-07T05:31:56Z",
        "details": {
          "status": "<string>",
          "reason": "<string>",
          "code_tried": "<string>"
        },
        "fee": 123
      }
    ]
  },
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
email
string
required

The email address to verify. e.g. [email protected]

​
code
string
required

The verification code sent to the email address. Must be between 4 and 8 characters in length.

Required string length: 4 - 8
​
duplicated_email_action
enum<string>
default:NO_ACTION

Action to take for duplicated email addresses

Available options:
NO_ACTION,
DECLINE
​
breached_email_action
enum<string>
default:NO_ACTION

Action to take for breached email addresses

Available options:
NO_ACTION,
DECLINE
​
disposable_email_action
enum<string>
default:NO_ACTION

Action to take for disposable email addresses

Available options:
NO_ACTION,
DECLINE
​
undeliverable_email_action
enum<string>
default:NO_ACTION

Action to take for undeliverable email addresses

Available options:
NO_ACTION,
DECLINE

Response

OK

​
request_id
string<uuid>

Unique identifier for the session/request.

​
status
string

Status of the check operation (e.g., 'Approved', 'Failed', 'Expired or Not Found').

​
message
string

A human-readable message about the check outcome.

​
email
object
​
created_at
string<date-time>

Timestamp when the email verification session was created.