API Verifikasi Telepon: Validasi Kode OTP SMS

curl

curl -X POST https://verification.didit.me/v3/phone/check/ \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "phone_number": "+14155552671",
    "code": "123456",
    "voip_number_action": "DECLINE"
  }'

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.phone.checkCode({
  phone_number: "+14155552671",
  code: "123456",
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Phone.CheckCode(ctx, didit.PhoneCheckCodeParams{
	PhoneNumber: "+14155552671",
	Code:        "123456",
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.PhoneCheckCodeParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.phone().checkCode(PhoneCheckCodeParams.builder()
        .phoneNumber("+14155552671")
        .code("123456")
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->phone->checkCode([
    'phone_number' => '+14155552671',
    'code' => '123456',
]);
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Phone.CheckCodeAsync(new PhoneCheckCodeParams
{
    PhoneNumber = "+14155552671",
    Code = "123456",
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24",
  "status": "Approved",
  "message": "The verification code is correct.",
  "phone": {
    "status": "Approved",
    "phone_number_prefix": "+1",
    "phone_number": "4155552671",
    "full_number": "+14155552671",
    "country_code": "US",
    "country_name": "United States",
    "carrier": {
      "name": "AT&T",
      "type": "mobile"
    },
    "is_disposable": false,
    "is_virtual": false,
    "verification_method": "whatsapp",
    "verification_attempts": 1,
    "verified_at": "2026-06-12T01:24:47.311323Z",
    "warnings": [],
    "lifecycle": [
      {
        "type": "PHONE_VERIFICATION_MESSAGE_SENT",
        "timestamp": "2026-06-12T01:23:39.580554+00:00",
        "details": {
          "status": "Success",
          "reason": null,
          "channel": "whatsapp",
          "actual_channel": "whatsapp"
        },
        "fee": 0.0509
      },
      {
        "type": "PHONE_DELIVERY_DELIVERED",
        "timestamp": "2026-06-12T01:23:43.118220+00:00",
        "details": {
          "channel": "whatsapp",
          "status": "delivered"
        },
        "fee": 0
      },
      {
        "type": "VALID_CODE_ENTERED",
        "timestamp": "2026-06-12T01:24:47.311201+00:00",
        "details": {
          "code_tried": "123456",
          "status": "Approved"
        },
        "fee": 0
      },
      {
        "type": "PHONE_VERIFICATION_APPROVED",
        "timestamp": "2026-06-12T01:24:47.384292+00:00",
        "details": null,
        "fee": 0
      }
    ],
    "matches": []
  },
  "vendor_data": "user-1234",
  "metadata": null,
  "created_at": "2026-06-12T01:24:47.401719+00:00"
}

POST

phone

check

curl

curl -X POST https://verification.didit.me/v3/phone/check/ \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "phone_number": "+14155552671",
    "code": "123456",
    "voip_number_action": "DECLINE"
  }'

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.phone.checkCode({
  phone_number: "+14155552671",
  code: "123456",
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Phone.CheckCode(ctx, didit.PhoneCheckCodeParams{
	PhoneNumber: "+14155552671",
	Code:        "123456",
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.PhoneCheckCodeParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.phone().checkCode(PhoneCheckCodeParams.builder()
        .phoneNumber("+14155552671")
        .code("123456")
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->phone->checkCode([
    'phone_number' => '+14155552671',
    'code' => '123456',
]);
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Phone.CheckCodeAsync(new PhoneCheckCodeParams
{
    PhoneNumber = "+14155552671",
    Code = "123456",
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "request_id": "e39cb057-92fc-4b59-b84e-02fec29a0f24",
  "status": "Approved",
  "message": "The verification code is correct.",
  "phone": {
    "status": "Approved",
    "phone_number_prefix": "+1",
    "phone_number": "4155552671",
    "full_number": "+14155552671",
    "country_code": "US",
    "country_name": "United States",
    "carrier": {
      "name": "AT&T",
      "type": "mobile"
    },
    "is_disposable": false,
    "is_virtual": false,
    "verification_method": "whatsapp",
    "verification_attempts": 1,
    "verified_at": "2026-06-12T01:24:47.311323Z",
    "warnings": [],
    "lifecycle": [
      {
        "type": "PHONE_VERIFICATION_MESSAGE_SENT",
        "timestamp": "2026-06-12T01:23:39.580554+00:00",
        "details": {
          "status": "Success",
          "reason": null,
          "channel": "whatsapp",
          "actual_channel": "whatsapp"
        },
        "fee": 0.0509
      },
      {
        "type": "PHONE_DELIVERY_DELIVERED",
        "timestamp": "2026-06-12T01:23:43.118220+00:00",
        "details": {
          "channel": "whatsapp",
          "status": "delivered"
        },
        "fee": 0
      },
      {
        "type": "VALID_CODE_ENTERED",
        "timestamp": "2026-06-12T01:24:47.311201+00:00",
        "details": {
          "code_tried": "123456",
          "status": "Approved"
        },
        "fee": 0
      },
      {
        "type": "PHONE_VERIFICATION_APPROVED",
        "timestamp": "2026-06-12T01:24:47.384292+00:00",
        "details": null,
        "fee": 0
      }
    ],
    "matches": []
  },
  "vendor_data": "user-1234",
  "metadata": null,
  "created_at": "2026-06-12T01:24:47.401719+00:00"
}

Menangani gangguan penyedia

Jika penyedia telepon sedang tidak tersedia untuk sementara, endpoint ini mengembalikan 502 dengan kode yang stabil dan dapat dibaca mesin:

{
  "detail": "The phone verification provider is temporarily unavailable.",
  "code": "phone_provider_unavailable"
}

Perlakukan respons ini sebagai respons yang dapat dicoba lagi. Gunakan jeda singkat (backoff), lalu tampilkan pesan layanan sementara kepada pengguna alih-alih meminta mereka mengubah nomor telepon atau kode yang sudah valid.

Tambahan intelijen

Atur enable_enrichment ke true untuk juga menjalankan intelijen nomor telepon tersebut: skor risiko, jenis saluran, apakah nomor baru-baru ini dipindahkan, dan indeks kepercayaan. Tambahan ini ditagih $0.05 per permintaan dengan harga daftar, di luar harga pemeriksaan. Permintaan mengembalikan 403 jika saldo Anda tidak cukup untuk menutupinya. Empat kolom menentukan tindakan sinyal. Masing-masing bernilai NO_ACTION (default) atau DECLINE, dan masing-masing hanya berlaku jika enable_enrichment bernilai true.

Kolom	Ditolak ketika
`phone_intelligence_score_action`	Skor risiko berada di atas ambang batas.
`phone_type_risk_action`	Nomor termasuk jenis saluran berisiko tinggi.
`recent_port_action`	Nomor baru-baru ini dipindahkan ke operator lain.
`low_phone_trust_action`	Indeks kepercayaan berada pada atau di bawah ambang batas.

Dengan NO_ACTION, sinyal tetap dikembalikan di phone.phone_intelligence, sehingga Anda dapat menerapkan aturan Anda sendiri.

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 yang sama dengan yang digunakan dalam panggilan POST /v3/phone/send/ yang cocok, dalam format E.164. Ini yang menautkan pemeriksaan ke pengiriman.

Maximum string length: 20

Contoh:

"+14155552671"

code

string

wajib

OTP yang diterima pengguna akhir. Harus terdiri dari 4–8 digit angka — selain itu akan mengembalikan 400 tanpa menghabiskan percobaan. Kode yang formatnya benar tetapi salah akan mengembalikan 200 dengan status: "Failed" dan menghabiskan salah satu dari 3 percobaan.

Required string length: 4 - 8

Pattern: ^[0-9]{4,8}$

Contoh:

"123456"

duplicated_phone_number_action

enum<string>

default:NO_ACTION

Tindakan yang harus diambil ketika nomor yang sama telah digunakan oleh pengguna yang berbeda (vendor_data berbeda) dari aplikasi Anda. DECLINE mengubah status akhir menjadi Declined; NO_ACTION mencatat risiko dalam phone.warnings dan mengisi phone.matches.

Opsi yang tersedia:

NO_ACTION,

DECLINE

disposable_number_action

enum<string>

default:NO_ACTION

Tindakan yang diambil saat pemeriksaan operator menandai nomor tersebut sebagai nomor sementara/sekali pakai (phone.is_disposable). DECLINE mengubah status akhir menjadi Declined; NO_ACTION mencatat risiko tersebut dalam phone.warnings.

Opsi yang tersedia:

NO_ACTION,

DECLINE

voip_number_action

enum<string>

default:NO_ACTION

Tindakan yang diambil saat pencarian operator melaporkan jenis nomor virtual — voip, isp, atau vpn (phone.is_virtual). DECLINE mengubah status akhir menjadi Declined; NO_ACTION mencatat risiko tersebut dalam phone.warnings.

Opsi yang tersedia:

NO_ACTION,

DECLINE

enable_enrichment

boolean

default:false

Jika true, jalankan juga intelijen telepon pada nomor tersebut: skor risiko, jenis saluran, apakah nomor baru saja di-porting, dan indeks kepercayaan. Ditagihkan sebagai satu unit phone_intelligence_api per permintaan ($0.05 pada harga terdaftar) di luar harga endpoint ini sendiri. Permintaan mengembalikan 403 jika saldo Anda tidak mencukupi.

Contoh:

false

phone_intelligence_score_action

enum<string>

default:NO_ACTION

Tindakan saat skor risiko intelijen telepon berada di atas ambang batas. DECLINE mengubah status akhir menjadi Declined; NO_ACTION mencatat sinyal tanpa menolak. Hanya berlaku saat enable_enrichment bernilai true.

Opsi yang tersedia:

NO_ACTION,

DECLINE

phone_type_risk_action

enum<string>

default:NO_ACTION

Tindakan saat nomor telepon merupakan jenis saluran berisiko tinggi. DECLINE mengubah status akhir menjadi Declined; NO_ACTION mencatat sinyal tanpa menolak. Hanya berlaku saat enable_enrichment bernilai true.

Opsi yang tersedia:

NO_ACTION,

DECLINE

recent_port_action

enum<string>

default:NO_ACTION

Tindakan saat nomor baru saja di-porting ke operator lain. DECLINE mengubah status akhir menjadi Declined; NO_ACTION mencatat sinyal tanpa menolak. Hanya berlaku saat enable_enrichment bernilai true.

Opsi yang tersedia:

NO_ACTION,

DECLINE

low_phone_trust_action

enum<string>

default:NO_ACTION

Tindakan saat indeks kepercayaan intelijen telepon berada pada atau di bawah ambang batas. DECLINE mengubah status akhir menjadi Declined; NO_ACTION mencatat sinyal tanpa menolak. Hanya berlaku saat enable_enrichment bernilai true.

Opsi yang tersedia:

NO_ACTION,

DECLINE

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

Contoh:

true

Tindakan saat pemeriksaan jejak sosial mendapati nomor tidak terdaftar di platform mana pun yang dicakup. Hanya NO_ACTION dan DECLINE yang diterima pada endpoint ini; REVIEW tersedia pada kunci konfigurasi alur kerja dengan nama yang sama.

Opsi yang tersedia:

NO_ACTION,

DECLINE

Respons

Pemeriksaan selesai — kode yang salah dan verifikasi yang tidak ditemukan juga mengembalikan 200; periksa status, bukan kode HTTP. phone hanya diisi pada hasil akhir (Approved/Declined), null pada Failed, dan tidak ada pada Expired or Not Found.

request_id

string<uuid>

Pada Approved/Declined: ID sesi verifikasi yang cocok — identik dengan request_id yang dikembalikan oleh POST /v3/phone/send/. Pada Failed dan Expired or Not Found: UUID acak sekali pakai yang tidak dapat dicari kemudian.

status

enum<string>

Approved — kode benar, tidak ada risiko penolakan. Declined — terminal: risiko penolakan cocok atau batas percobaan (3) telah habis. Failed — kode salah, percobaan masih tersisa. Expired or Not Found — tidak ada verifikasi tertunda untuk nomor ini dalam 5 menit terakhir.

Opsi yang tersedia:

Approved,

Declined,

Failed,

Expired or Not Found

message

string

Penjelasan hasil yang mudah dibaca manusia, termasuk jumlah percobaan yang tersisa setelah kode yang salah.

phone

object | null

Laporan telepon lengkap. Ada (non-null) hanya pada hasil akhir (Approved/Declined); bernilai null pada Failed dan tidak ada pada Expired or Not Found.

Show child attributes

vendor_data

string | null

vendor_data dari sesi verifikasi yang cocok. null pada Expired or Not Found.

metadata

object | null

metadata dari sesi verifikasi yang cocok. null pada Expired or Not Found.

created_at

string<date-time>

Cap waktu respons pemeriksaan ini.

Terakhir diubah pada 7 November 2026

​Menangani gangguan penyedia

​Tambahan intelijen

Otorisasi

Body

Respons

Menangani gangguan penyedia

Tambahan intelijen