Dokumen API Validasi Email

Status API

Memulai

Semua permintaan API memerlukan autentikasi menggunakan kunci API. Anda dapat menemukan kunci API di dasbor.

Header: "x-api-key: kunci-api Anda"

Verifikasi Tunggal

Verifikasi satu alamat email atau domain untuk validitas, status sekali pakai, layanan privasi, dan pengiriman.

Titik akhir

GET /v1/verify

Parameter

NamaJenisDiperlukanDeskripsi
inputstringYa.Alamat email atau domain untuk memverifikasi (misalnya, [email protected] atau example.com)

Bidang Respons

BidangDeskripsi
validMenunjukkan apakah format email sudah benar
blockMenunjukkan apakah email harus diblokir (benar jika disposable, privacy, applePrivateEmail, deliverable, atau catch_all benar)
disposableMenentukan apakah alamat email adalah alamat email sementara atau sekali pakai
privacyMenentukan apakah server email menggunakan email alias atau forwarder
applePrivateEmailMenunjukkan apakah email tersebut merupakan alamat email Pribadi Apple
deliverableMemeriksa apakah kotak surat ada dan dapat menerima email
domainBagian domain dari alamat email
email_addressAlamat email
catch_allMenunjukkan apakah domain memiliki konfigurasi email semua yang menerima semua email masuk tanpa memandang alamat penerima
mx_foundMenunjukkan apakah domain memiliki server email yang valid (catatan MX)
remaining_creditsJumlah kredit API yang tersisa di akun Anda

Daftar Hitam / Daftar Putih: Hanya bidang blokir yang mencerminkan keanggotaan daftar. Daftar hitam โ†’ blokir: benar; daftar putih โ†’ blokir: salah; tidak ada dalam daftar putih (bila diaktifkan) โ†’ blokir: benar. Jangan gunakan valid untuk memutuskan apakah akan memblokir berdasarkan daftar.

Contoh Tanggapan

{
  "valid": true,
  "block": false,
  "disposable": false,
  "privacy": false,
  "applePrivateEmail": false,
  "deliverable": true,
  "domain": "example.com",
  "email_address": "[email protected]",
  "catch_all": false,
  "mx_found": true,
  "error": null,
  "remaining_credits": 99
}

Contoh Kode

curl "https://api.verify-email.app/v1/[email protected]" \
  -H "X-API-Key: your-api-key"

Cobalah

Anda memerlukan kunci API untuk menguji titik akhir.

Coba dengan:

Verifikasi Batch

Verifikasi beberapa alamat email atau domain dalam satu permintaan (maksimal 100 item).

Titik akhir

POST /v1/verify/batch

Parameter

NamaJenisDiperlukanDeskripsi
inputsarray of stringsYa.Array alamat email atau domain untuk diverifikasi

Contoh Kode

curl -X POST "https://api.verify-email.app/v1/verify/batch" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key" \
  -d '{
    "inputs": [
      "[email protected]",
      "[email protected]"
    ]
  }'

Cobalah

Anda memerlukan kunci API untuk menguji titik akhir.

Coba dengan domain yang berbeda:

Pemeriksaan Khusus Kiriman

Pemeriksaan keterkiriman email yang cepat menggunakan verifikasi MX dan SMTP tanpa panggilan API eksternal. Hanya mengembalikan bidang yang terkait dengan keterkiriman untuk waktu respons yang lebih cepat.

Titik akhir

GET /v1/verify/deliverable

Parameter

NamaJenisDiperlukanDeskripsi
inputstringYa.Alamat email untuk memeriksa keterkiriman (misalnya, [email protected]). Masukan khusus domain tidak didukung untuk titik akhir ini.

Bidang Respons

BidangDeskripsi
validMenunjukkan apakah format email sudah benar
deliverableMemeriksa apakah kotak surat ada dan dapat menerima email
mx_foundMenunjukkan apakah domain memiliki server email yang valid (catatan MX)
catch_allMenunjukkan apakah domain memiliki konfigurasi email semua yang menerima semua email masuk tanpa memandang alamat penerima
email_addressAlamat email
remaining_creditsJumlah kredit API yang tersisa di akun Anda

Contoh Tanggapan

{
  "valid": true,
  "deliverable": true,
  "mx_found": true,
  "catch_all": false,
  "email_address": "[email protected]",
  "remaining_credits": 99
}

Contoh Kode

curl "https://api.verify-email.app/v1/verify/[email protected]" \
  -H "X-API-Key: your-api-key"

Cobalah

Anda memerlukan kunci API untuk menguji titik akhir.

Coba dengan:

Daftar putih & daftar hitam

Kendalikan email dan domain mana yang diblokir dengan aturan daftar hitam dan putih per pengguna. Daftar ini mengatur field block di setiap respons verifikasi.

{}

Field block

Setiap respons verifikasi berisi field block. Gunakan field ini untuk memutuskan apakah email/domain harus diblokir berdasarkan daftar Anda:

trueEmail atau domainnya ada di daftar hitam โ†’ block: true. Menambah domain memblokir semua email pada domain itu.
trueDaftar putih aktif tapi email/domain tidak ada di dalamnya โ†’ block: true.
falseDaftar putih aktif dan email atau domainnya ada di dalamnya โ†’ block: false.
โ€”Tidak ada daftar yang berlaku โ†’ block mengikuti hasil verifikasi normal.

Ikhtisar

โœ˜

Daftar hitam

Selalu blokir email atau domain tertentu. Misalnya menambah example.com ke daftar hitam berarti email @example.com mana pun akan mengembalikan block: true โ€” apa pun hasil verifikasinya.

โœ”

Daftar putih

Hanya izinkan email atau domain tertentu. Saat daftar putih aktif, hanya entri yang terdaftar yang dapat block: false โ€” sisanya block: true. Misalnya menambah gmail.com mengizinkan @gmail.com mana pun, tapi [email protected] akan diblokir. Saat dinonaktifkan, daftar putih tidak berpengaruh.

Anda bisa menambah email lengkap ([email protected]) atau domain (example.com). Menambah domain berlaku untuk setiap email pada domain itu. Nilai tidak membedakan huruf besar/kecil.

Cara kerja

Urutan evaluasi

1
Daftar hitam dulu โ€” Jika alamat email atau domainnya ada di daftar hitam, hasilnya block: true. Logika daftar lain tidak diterapkan.
2
Daftar putih (jika aktif) โ€” Jika email/domain ada di daftar putih โ†’ block: false. Jika tidak โ†’ block: true.
3
Daftar putih nonaktif โ€” Hanya daftar hitam dan verifikasi normal yang berlaku.

Daftar hitam selalu menang: alamat di daftar hitam tetap diblokir meski juga ada di daftar putih.

Yang dicocokkan

Verifikasi email โ€” API memeriksa alamat lengkap dan domain terhadap kedua daftar. Kecocokan menerapkan aturan daftar.
Verifikasi domain โ€” hanya domain yang diperiksa terhadap daftar hitam dan (jika aktif) daftar putih.

Referensi singkat

Daftar putih aktifDi daftar hitamDi daftar putihnilai block
TidakYaโ€”true
TidakTidakโ€”Normal
YaYaApa sajatrue
YaTidakYafalse
YaTidakTidaktrue

Endpoint daftar API

Semua endpoint daftar memerlukan header: X-API-Key: your-api-key

Daftar hitam

GET/v1/blacklist
Daftar semua entri daftar hitam
POST/v1/blacklist
Tambah email atau domain ยท { "value": "..." }
DELETE/v1/blacklist
Hapus entri ยท value=...

Daftar putih

GET/v1/whitelist
Daftar semua entri daftar putih
POST/v1/whitelist
Tambah email atau domain ยท { "value": "..." }
DELETE/v1/whitelist
Hapus entri ยท value=...
GET/v1/whitelist/enabled
Dapatkan status daftar putih ยท { "enabled": boolean }
PUT/v1/whitelist/enabled
Aktifkan/nonaktifkan daftar putih ยท { "enabled": true | false }

Contoh Kode (cURL)

โœ˜

Daftar hitam

GET/v1/blacklist

Daftar semua entri daftar hitam

curl "https://api.verify-email.app/v1/blacklist" \
  -H "X-API-Key: your-api-key"
POST/v1/blacklist

Tambah email atau domain

curl -X POST "https://api.verify-email.app/v1/blacklist" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key" \
  -d '{
    "value": "[email protected]"
  }'
DELETE/v1/blacklist

Hapus entri

curl -X DELETE "https://api.verify-email.app/v1/[email protected]" \
  -H "X-API-Key: your-api-key"
โœ”

Daftar putih

GET/v1/whitelist

Daftar semua entri daftar putih

curl "https://api.verify-email.app/v1/whitelist" \
  -H "X-API-Key: your-api-key"
POST/v1/whitelist

Tambah email atau domain

curl -X POST "https://api.verify-email.app/v1/whitelist" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key" \
  -d '{
    "value": "[email protected]"
  }'
DELETE/v1/whitelist

Hapus entri

curl -X DELETE "https://api.verify-email.app/v1/[email protected]" \
  -H "X-API-Key: your-api-key"
GET/v1/whitelist/enabled

Dapatkan status daftar putih

curl "https://api.verify-email.app/v1/whitelist/enabled" \
  -H "X-API-Key: your-api-key"
PUT/v1/whitelist/enabled

Aktifkan/nonaktifkan daftar putih

curl -X PUT "https://api.verify-email.app/v1/whitelist/enabled" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key" \
  -d '{
    "enabled": true
  }'

Format nilai

Nilai tidak valid ditolak dengan 400. Entri disimpan ternormalisasi. Duplikat digabung jadi satu entri.

Di mana daftar diterapkan

Aturan daftar diterapkan setelah verifikasi. Respons verifikasi email (tunggal dan batch) dan domain sudah menyertakan daftar hitam dan putih pengguna di field block.

Server MCP (Integrasi Agen AI)

Integrasikan verifikasi email secara langsung ke dalam agen AI seperti Cursor dan Claude Desktop menggunakan Model Context Protocol (MCP). Asisten AI Anda dapat memverifikasi email, memeriksa domain, dan memvalidasi sintaks tanpa meninggalkan editor.

Docs endpoint for AI agents

The API exposes a machine-readable docs endpoint (no API key required) so AI agents and MCP clients can discover the server, available tools, and auth requirements. Use this URL in your agent or MCP configuration.

GET /v1/mcp/docs

Returns JSON with server name, description, serverUrl, docsEndpoint, authentication details, and full tool definitions.

curl "https://api.verify-email.app/v1/mcp/docs"

AI agents can GET this URL to receive server metadata, tool schemas, and integration instructions in JSON. No authentication is required for the docs endpoint.

Integration details

Authentication

All MCP tool calls require your API key in the X-API-Key header. Get your key from the dashboard.

MCP server URL: https://api.verify-email.app/mcp

Docs endpoint (for agents): https://api.verify-email.app/v1/mcp/docs

Cursor

Add the server in Cursor Settings โ†’ Tools & MCP, or add the config to .cursor/mcp.json in your project or home directory.

Claude Desktop

Add the server to your Claude Desktop config (mcpServers in claude_desktop_config.json). Use the server URL and X-API-Key header as shown below.

Response format

Tool results match the REST API response shape (valid, block, deliverable, remaining_credits, etc.). Use the block field for blacklist/whitelist decisions.

This MCP server is production-ready and uses the same API as the REST endpoints. Credits are consumed per verification as with the REST API.

Pengaturan

Tambahkan konfigurasi berikut ini ke .cursor/mcp.json atau file konfigurasi Claude Desktop:

{
  "mcpServers": {
    "email-checker": {
      "url": "https://api.verify-email.app/mcp",
      "headers": {
        "X-API-Key": "your-api-key"
      }
    }
  }
}

Alat yang Tersedia

AlatDeskripsiMasukanKredit
verify_emailVerifikasi email lengkap termasuk pemeriksaan sintaksis, MX, SMTP, sekali pakai, privasi, dan keterkiriman{ email: string }1
verify_domainVerifikasi domain lengkap termasuk catatan MX, sekali pakai, privasi, dan deteksi semua{ domain: string }1
check_deliverabilityPemeriksaan pengiriman cepat-hanya menggunakan verifikasi MX dan SMTP tanpa panggilan API eksternal{ email: string }1
verify_batchVerifikasi batch hingga 100 email atau domain dalam satu permintaan{ inputs: string[] }1 per item
validate_email_syntaxValidasi sintaksis lokal yang cepat terhadap RFC 5322 tanpa panggilan jaringan{ email: string }0 (free)