Langsung ke konten utama
POST
curl
Gunakan POST /v3/email/risk/ saat Anda memerlukan intelijen email tanpa meminta pengguna memasukkan kode sekali pakai. Permintaan ini tidak mengirim email. Permintaan ini membuat sesi API, memperkaya alamat tersebut, menerapkan aturan risiko email Anda, lalu mengembalikan blok email yang dinormalisasi, yang sama dengan blok yang digunakan oleh Verifikasi Email, dalam satu respons sinkron. Saat permintaan disimpan, Didit juga dapat menggunakan email yang telah diberi skor sebagai bukti agregat di Jaringan. Grafik jaringan dapat menampilkan intelijen email berisiko tinggi, konteks pelanggaran data, dan cakupan profil sosial pada sinyal email yang dibagikan, tetapi grafik tersebut tidak mengungkapkan alamat email mentah kepada organisasi lain.

Interpretasi respons

  • status adalah keputusan akhir untuk sesi API ini. Biasanya bernilai Approved; evaluasi risiko dapat menghasilkan In Review atau Declined.
  • email.is_breached, email.is_disposable, dan email.is_undeliverable adalah sinyal ya/tidak yang stabil untuk logika aplikasi Anda.
  • email.breaches mencantumkan pelanggaran data terbaru yang diketahui dan memuat alamat tersebut, jika cakupannya tersedia, beserta tanggal pelanggaran dan kelas data yang terekspos.
  • email.email_intelligence.score menggunakan skala risiko 0-100, di mana angka yang lebih tinggi berarti risiko yang lebih tinggi. breach_risk_level (Low, Medium, High) dan no_of_breaches adalah tampilan turunan.
  • email.email_intelligence.reason_codes menjelaskan sinyal yang dinormalisasi mana yang berkontribusi pada hasil. Nilainya dapat bertambah seiring waktu, jadi jangan menolak kode yang belum dikenal.
  • email.email_intelligence dan email.enrichment adalah alias kompatibilitas dengan objek ternormalisasi yang sama. Integrasi baru dapat membaca email.enrichment.
  • email.matches mencantumkan sesi lain dari aplikasi Anda tempat alamat yang sama digunakan oleh pengguna lain. Gunakan kolom ini untuk deteksi akun duplikat.
  • request_id adalah ID sesi API. Simpan bersama vendor_data jika Anda perlu mengorelasikan hasil dengan webhook atau aktivitas konsol yang muncul kemudian.
email.email_intelligence dan email.enrichment bersifat upaya terbaik. Pencarian yang sudah selesai dapat tidak menyertakan keduanya jika tidak ada data intelijen yang dapat digunakan untuk alamat, domain, atau paket tersebut. Bangun aturan terutama berdasarkan is_breached, is_disposable, dan is_undeliverable, dan perlakukan intelijen yang tidak ada sebagai “tidak diketahui”, bukan “aman”.

Ekstensi jejak sosial

Atur enable_social ke true untuk menambahkan blok email_social ke respons di bawah email: platform online tempat alamat email ini terdaftar, dikelompokkan berdasarkan kategori, dengan jumlah ringkasan dan detail profil apa pun yang dikembalikan oleh mitra data kami.
  • email.email_social.profiles_registered dan email.email_social.profiles_checked adalah angka utamanya: platform tempat alamat email dikonfirmasi terdaftar, dibandingkan dengan jumlah platform yang dievaluasi.
  • email.email_social.registered_platforms dan email.email_social.not_registered_platforms mencantumkan setiap platform beserta category dan scope-nya (global, atau local untuk platform khusus wilayah).
  • email.email_social.categories memberikan jumlah terdaftar dan rasio per kategori, dan email.email_social.profiles memuat detail profil per platform jika platform tersebut menampilkannya (nama, URL foto, teks deskripsi, status privasi, dan tanda akun bisnis).
  • Indeks ringkasan (digital_footprint_diversity, digital_sophistication_index, engagement_depth_index, subscription_affordability_index) adalah komposit 0-10. Setiap jumlah dapat bernilai null jika pemeriksaan tidak mengembalikan data untuknya.
profiles_registered: 0 adalah jawaban yang sah, bukan kegagalan: platform telah diperiksa dan alamat email tidak ditemukan di satu pun dari platform tersebut, yang merupakan sinyal identitas sintetis yang umum. Endpoint ini tidak mengambil tindakan atas hal tersebut dengan sendirinya. Gunakan email_no_social_presence_action dalam alur kerja untuk mengubahnya menjadi keputusan Peninjauan atau Penolakan. Blok ini tidak ada jika enable_social tidak diatur, dan juga jika pemeriksaan jejak sosial tidak dapat diselesaikan. Dalam kasus terakhir, pemeriksaan tersebut tidak ditagih.

Perilaku sandbox

Kunci sandbox memvalidasi permintaan dan mengembalikan data yang disetujui secara deterministik. Kunci tersebut tidak mengirim email, tidak menggunakan kredit, tidak membuat sesi, dan tidak berkontribusi ke Jaringan. Jika enable_social diatur, kunci tersebut juga mengembalikan blok email_social yang deterministik.

Penagihan

Panggilan Email Risk API berharga $0.04 pada harga daftar, lebih murah daripada Verifikasi Email penuh karena tidak ada email yang dikirim. Permintaan di lingkungan produksi dikenai biaya setelah pencarian dimulai, meskipun sebagian kolom yang diisi dengan upaya terbaik tidak tersedia. Ekstensi jejak sosial ditagih secara terpisah: satu unit email_social per permintaan di atas harga Email Risk API, setiap kali pemeriksaan selesai. Pemeriksaan kredit sebelum pencarian mencakup keduanya.

Otorisasi

x-api-key
string
header
wajib

Kunci API aplikasi Anda, dari Developers -> API keys di Business Console. Kunci utama memiliki akses penuh. Kunci bernama dapat diberi cakupan: none, read, atau write per sumber daya, dibatasi pada beberapa alur kerja atau pada sesi yang disetujui, pada daftar alamat IP, dan pada tanggal kedaluwarsa. 401 berarti kuncinya salah, dicabut, atau kedaluwarsa; 403 berarti tidak ada kunci yang dikirimkan, kunci tidak memiliki akses ke sumber daya atau tindakan ini, atau permintaan datang dari alamat di luar daftar IP-nya; 404 pada rute sesi berarti sesi berada di luar alur kerja atau status kunci tersebut. Kunci tanpa akses media menerima URL gambar, video, dan PDF sebagai null, dan kunci tanpa izin tulis sesi menerima tautan sesi dan token sebagai null. Lihat https://docs.didit.me/console/api-keys.

Body

application/json
email
string<email>
wajib

Alamat email yang akan diberi skor.

Contoh:

"alice@example.com"

country_code
string

Petunjuk negara ISO 3166-1 alpha-2 atau alpha-3 opsional untuk cakupan intelijen.

Maximum string length: 3
Contoh:

"US"

signals
object

Konteks perangkat dan jaringan opsional yang diamati oleh aplikasi Anda. Semua kolom bersifat opsional. Meneruskannya akan menyediakan data untuk deteksi kecocokan lintas sesi di Networks.

vendor_data
string

Referensi stabil Anda untuk permintaan ini. Disimpan pada sesi API dan ditampilkan kembali dalam respons.

metadata
object | null

Metadata JSON non-sensitif Anda. Disimpan pada sesi API dan dikembalikan dalam respons.

enable_social
boolean
default:false

Jika true, cari juga jejak sosial alamat tersebut - platform email, sosial, profesional, e-commerce, dan hiburan tempat alamat tersebut terdaftar. Ditagih sebagai satu unit email_social per permintaan selain harga endpoint ini sendiri.

Contoh:

true

Respons

Evaluasi risiko selesai. Periksa status untuk melihat keputusannya; HTTP selalu 200 untuk pencarian yang selesai.

request_id
string<uuid>
wajib

Id dari sesi API yang dibuat untuk permintaan ini. Simpan bersama vendor_data jika Anda perlu mengorelasikan hasilnya dengan webhook atau aktivitas konsol berikutnya.

status
enum<string>
wajib

Keputusan akhir untuk sesi API ini. Biasanya Approved; evaluasi risiko dapat menghasilkan In Review atau Declined.

Opsi yang tersedia:
Approved,
In Review,
Declined
created_at
string<date-time>
wajib

Cap waktu respons ini.

vendor_data
string | null

Salinan vendor_data yang Anda kirimkan, atau null jika Anda tidak mengirimkannya.

metadata
object | null

Salinan metadata yang Anda kirimkan, atau null jika Anda tidak mengirimkannya.

email
object

Laporan email yang dinormalisasi, blok yang sama yang digunakan oleh respons Verifikasi Email.

Terakhir diubah pada 7 November 2026