Langsung ke konten utama
POST
curl

Cantumkan nama merek Anda dalam SMS

Kode SMS membawa nama pengirim SMS aplikasi Anda, yang diatur di Business Console, tanpa biaya tambahan:
123456 adalah kode verifikasi Anda untuk Acme Bank
Untuk mengirim satu kode dengan nama yang berbeda, kirimkan options.sms_sender_name (1 sampai 30 karakter: hanya huruf, angka, spasi, serta karakter ’ & - !, dan tidak boleh hanya angka):
Nama yang tidak memenuhi aturan ini akan mengembalikan 400 dan kode tidak dikirim. Kode WhatsApp menggunakan pesan tetap dan tidak diberi merek. Untuk mengirimkannya dengan nama bisnis Anda, hubungkan nomor WhatsApp Business Anda sendiri di Business Console. Lihat Kirim kode WhatsApp dari nomor Anda sendiri. Lihat Pesan verifikasi bermerek untuk mengetahui nama yang tercantum pada sebuah kode dan batas harian untuk nama baru.

Tangani gangguan penyedia

Jika penyedia telepon sedang tidak tersedia untuk sementara, endpoint ini mengembalikan 502 dengan kode yang stabil dan dapat dibaca mesin:
Anggap respons ini dapat dicoba lagi. Gunakan jeda singkat (backoff) dan tampilkan pesan layanan sementara kepada pengguna, alih-alih meminta mereka mengubah nomor telepon atau kode yang sudah valid.

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
phone_number
string
wajib

Nomor telepon penerima dalam format E.164 — diawali tanda + dan kode negara (misalnya, +14155552671). Nomor divalidasi dan dinormalisasi ke E.164; nomor yang tidak dapat diuraikan atau tidak valid mengembalikan 400 dengan kesalahan kolom phone_number.

Maximum string length: 20
Contoh:

"+14155552671"

options
object

Opsi pengiriman OTP. Semua kolom bersifat opsional.

signals
object

Sinyal perangkat dan jaringan opsional mengenai pengguna akhir, yang diteruskan ke lapisan anti-fraud untuk meningkatkan deteksi lalu lintas yang menyalahgunakan sistem atau dihasilkan secara otomatis. Semua kolom bersifat opsional.

vendor_data
string

Pengidentifikasi opsional yang dikontrol pemanggil (id pengguna internal Anda, email, UUID, dll.) yang disimpan pada sesi dan dikembalikan dalam respons pengiriman, respons pemeriksaan kecocokan, webhook, dan Business Console. Gunakan ini untuk menghubungkan request_id Didit dengan data pengguna Anda.

metadata
object | null

Objek JSON bentuk bebas opsional yang disimpan pada sesi dan dikembalikan dalam respons pengiriman, respons pemeriksaan pencocokan, webhook, dan Business Console.

Respons

Pengiriman dikonfirmasi. Periksa status: Success dan Retry berarti kode sedang dikirim; Blocked berarti lapisan antipenipuan menolak dan verifikasi telah difinalisasi sebagai Declined. request_id adalah id sesi yang disimpan (id yang sama pada Retry).

request_id
string<uuid>

ID sesi verifikasi. Pengiriman Retry mengembalikan request_id yang sama dengan pengiriman asli. ID ini muncul di Business Console, dikembalikan lagi oleh POST /v3/phone/check/ yang telah selesai diproses, dan dapat diteruskan ke GET /v3/session/{sessionId}/decision/.

status
enum<string>

Success — OTP dikirim ke verifikasi baru. Retry — OTP dikirim ulang untuk verifikasi tertunda yang dibuat oleh pengiriman sebelumnya. Blocked — lapisan anti-fraud menolak pengiriman; verifikasi langsung diselesaikan sebagai Declined dan tidak ada biaya yang ditagih.

Opsi yang tersedia:
Success,
Retry,
Blocked
reason
string | null

Alasan pengiriman berstatus Blocked (misalnya, repeated_attempts, suspicious, spam). Bernilai null pada Success dan Retry.

vendor_data
string | null

Salinan vendor_data yang disimpan pada sesi (dari pengiriman pertama).

metadata
object | null

Salinan metadata yang disimpan pada sesi (dari pengiriman pertama).

Terakhir diubah pada 7 November 2026