Didit Email Verification API

Overview

Two-step email verification via one-time code:

1. 1. Send a verification code to an email address
2. Check the code the user provides

Key constraints:

• - Code expires after 5 minutes
• Maximum 3 verification attempts per code (then must resend)
• Maximum 2 resend requests within 24 hours
• You must call Send before Check — Check returns "Expired or Not Found" otherwise

Capabilities: Detects breached emails (via known data breaches), disposable/temporary email providers, and undeliverable addresses. Supports fraud signals for risk scoring.

API Reference: Send Code | Check Code
Feature Guide: https://docs.didit.me/core-technology/email-verification/overview

---

Authentication

All requests require an API key via the x-api-key header.

How to obtain: Didit Business Console → API & Webhooks → Copy API key, or via programmatic registration (see below).

CODEBLOCK0

INLINECODE2 = API key missing or invalid. 403 = key lacks permissions or insufficient credits.

Getting Started (No Account Yet?)

If you don't have a Didit API key, create one in 2 API calls:

1. 1. Register: POST https://apx.didit.me/auth/v2/programmatic/register/ with INLINECODE5
2. Check email for a 6-character OTP code
3. Verify: POST https://apx.didit.me/auth/v2/programmatic/verify-email/ with {"email": "you@gmail.com", "code": "A3K9F2"} → response includes INLINECODE8

To add credits: GET /v3/billing/balance/ to check, POST /v3/billing/top-up/ with {"amount_in_dollars": 50} for a Stripe checkout link.

See the didit-verification-management skill for full platform management (workflows, sessions, users, billing).

---

Step 1: Send Email Code

Sends a one-time verification code to the specified email address.

Request

CODEBLOCK1

Headers

Header	Value	Required
INLINECODE12	Your API key	Yes
INLINECODE13

application/json | Yes |

Body (JSON)

Parameter	Type	Required	Default	Constraints	Description
INLINECODE15	string	Yes	—	Valid email	Email address to send code to
INLINECODE16

integer | No | 6 | Min: 4, Max: 8 | Length of the verification code | | options.alphanumeric_code | boolean | No | false | — | true = A-Z + 0-9 (case-insensitive) | | options.locale | string | No | — | Max 5 chars | Locale for email template. e.g. en-US | | signals.ip | string | No | — | IPv4 or IPv6 | User's IP for fraud detection | | signals.device_id | string | No | — | Max 255 chars | Unique device identifier | | signals.user_agent | string | No | — | Max 512 chars | Browser/client user agent | | vendor_data | string | No | — | — | Your identifier for session tracking |

Example

CODEBLOCK2

CODEBLOCK3

Response (200 OK)

CODEBLOCK4

Status Values & Handling

Status	Meaning	Action
INLINECODE27	Code sent	Proceed — wait for user to provide code, then call Check
INLINECODE28

Temporary delivery issue | Wait a few seconds and retry Send (max 2 retries) | | "Undeliverable" | Email cannot receive mail | Inform user the email is invalid or cannot receive messages |

Error Responses

Code	Meaning	Action
INLINECODE30	Invalid request body or email	Check email format and parameter constraints
INLINECODE31

Invalid or missing API key | Verify x-api-key header | | 403 | Insufficient credits/permissions | Check credits in Business Console | | 429 | Rate limited | Back off and retry after indicated period |

---

Step 2: Check Email Code

Verifies the code the user received. Must be called after a successful Send. Optionally auto-declines risky emails.

Request

CODEBLOCK5

Headers

Header	Value	Required
INLINECODE35	Your API key	Yes
INLINECODE36

application/json | Yes |

Body (JSON)

Parameter	Type	Required	Default	Values	Description
INLINECODE38	string	Yes	—	Valid email	Same email used in Step 1
INLINECODE39

string | Yes | — | 4-8 chars | The code the user received | | duplicated_email_action | string | No | "NO_ACTION" | "NO_ACTION" / "DECLINE" | Decline if email already verified by another user | | breached_email_action | string | No | "NO_ACTION" | "NO_ACTION" / "DECLINE" | Decline if email found in data breaches | | disposable_email_action | string | No | "NO_ACTION" | "NO_ACTION" / "DECLINE" | Decline if email is disposable/temporary | | undeliverable_email_action | string | No | "NO_ACTION" | "NO_ACTION" / "DECLINE" | Decline if email is undeliverable |

Policy note: When an action is "DECLINE", verification is rejected even if the code is correct. The email.* fields are still populated so you can inspect why.

Example

CODEBLOCK6

CODEBLOCK7

Response (200 OK)

CODEBLOCK8

Status Values & Handling

Status	Meaning	Action
INLINECODE58	Code correct, no policy violations	Email verified — proceed with your flow
INLINECODE59

Code incorrect | Ask user to re-enter. After 3 failures, resend a new code | | "Declined" | Code correct but policy violation | Inform user. Check email.warnings for reason | | "Expired or Not Found" | No pending code | Code expired (>5 min) or Send was never called. Resend |

Error Responses

Code	Meaning	Action
INLINECODE63	Invalid request body	Check email and code format
INLINECODE64

Invalid or missing API key | Verify x-api-key header | | 403 | Insufficient credits/permissions | Check credits in Business Console | | 404 | Code expired or not found | Resend a new code via Step 1 |

---

Response Field Reference

email Object

Field	Type	Description
INLINECODE69	string	INLINECODE70, "Failed", INLINECODE72
INLINECODE73

string | The email address verified | | is_breached | boolean | Found in known data breaches | | breaches | array | Breach details: {name, domain, breach_date, data_classes, breach_emails_count} | | is_disposable | boolean | From a disposable/temporary provider | | is_undeliverable | boolean | Cannot receive email | | verification_attempts | integer | Number of check attempts (max 3) | | verified_at | string | ISO 8601 timestamp when verified (null if not) | | warnings | array | Risk warnings: {risk, log_type, short_description, long_description} | | lifecycle | array | Event log: {type, timestamp, fee} |

---

Warning Tags

Tag	Description	Auto-Decline
INLINECODE86	Max code entry attempts exceeded	Yes
INLINECODE87

Email is in blocklist | Yes | | UNDELIVERABLE_EMAIL_DETECTED | Email cannot be delivered | Yes | | BREACHED_EMAIL_DETECTED | Found in known data breaches | Configurable | | DISPOSABLE_EMAIL_DETECTED | Disposable/temporary provider | Configurable | | DUPLICATED_EMAIL | Already verified by another user | Configurable |

Warning severity levels: error (critical), warning (requires attention), information (informational).

---

Common Workflows

Basic Email Verification

CODEBLOCK9

Strict Security Verification

CODEBLOCK10

---

Utility Scripts

verify_email.py: Send and check email verification codes from the command line.

CODEBLOCK11

Can also be imported as a library:

CODEBLOCK12