Langsung ke konten utama
GET
curl

Filter jenis sesi

Gunakan parameter query session_kind untuk memilih jenis sesi yang dikembalikan: Setiap baris dalam respons menyertakan session_kind: "user" | "business" agar klien Anda dapat menentukan bentuk data per baris.

Filter umum

Filter ini berlaku untuk kedua jenis (filter khusus pengguna diabaikan saat session_kind=business, dan sebaliknya):

Contoh

Respons (terpotong):

Bentuk baris berbeda menurut jenis

Baris Verifikasi Pengguna (KYC) mencakup: portrait_image, document_type, full_name, country (negara penerbit), phone_number, email_address, dan beberapa kolom peninjauan: assignee (peninjau Console yang memegang sesi, atau null), waiting_since dan sla_due_at (hanya diisi saat sesi berstatus In Review), top_warnings (peringatan paling penting, masing-masing dengan risk, feature, log_type, dan short_description), serta warnings_count. Baris Verifikasi Bisnis (KYB) mencakup: workflow_type, workflow_label, company_name, registration_number, country (negara pendirian). Keduanya memuat: session_id, session_kind, session_number, status, vendor_data, created_at. Lihat Ikhtisar sesi untuk matriks fitur lengkap.

Paginasi

Paginasi menggunakan limit (bawaan 50) dan offset (bawaan 0), dengan URL absolut next dan previous dalam respons. Kedua parameter menerima nilai hingga 1000000; nilai yang lebih besar mengembalikan 400. count akurat hingga 100 dan tetap 100 di atas angka itu, sehingga jangan menggunakannya sebagai total. Terus minta URL next hingga bernilai null. Dengan session_kind=all, count adalah jumlah kedua jenis, masing-masing dibatasi 100.

Terkait

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.

Parameter Query

session_kind
enum<string>
default:user

Jenis sesi mana yang akan dicantumkan: user (khusus KYC, default), business (khusus KYB), atau all (keduanya, digabungkan - lihat deskripsi untuk semantik paginasi gabungan). Pencocokan bersifat tidak peka huruf besar/kecil (BUSINESS berfungsi); nilai apa pun selain variasi huruf dari user/business/all akan mengembalikan 400.

Opsi yang tersedia:
user,
business,
all
limit
integer
default:50

Jumlah baris maksimum per halaman (per jenis saat session_kind=all). Defaultnya 50.

Rentang yang diperlukan: 1 <= x <= 1000000
offset
integer
default:0

Jumlah baris yang dilewati sebelum baris pertama yang dikembalikan. Default-nya 0. Disarankan mengikuti URL next/previous dari respons.

Rentang yang diperlukan: 0 <= x <= 1000000
status
string

Daftar status sesi yang dipisahkan dengan koma untuk disertakan, misalnya Approved,In Review. Nilai bersifat case-sensitive; lihat Status Verifikasi. Nilai yang tidak dikenal tidak akan cocok dengan apa pun.

vendor_data
string

Filter kecocokan persis pada vendor_data yang Anda kirim saat pembuatan sesi (pengenal pengguna/bisnis Anda sendiri). Untuk kecocokan sebagian, gunakan search sebagai gantinya.

Referensi lengkap yang ditampilkan seperti S-0001 (pengguna) atau B-0001 (bisnis) hanya cocok dengan nomor dan jenis sesi tersebut; angka nol di awal dan huruf besar/kecil tidak memengaruhi pencocokan. Pencarian teks bebas pintar. UUID lengkap cocok dengan session_id; input numerik cocok dengan awalan nomor sesi, nomor dokumen/identitas pribadi, awalan telepon, atau vendor_data; input yang memuat @ cocok dengan awalan email; teks lainnya cocok dengan nama (tidak sensitif aksen) dan vendor_data. Teks bebas yang memuat digit juga cocok dengan kolom pencarian nomor dokumen/identitas pribadi dan awalan nomor sesi.

workflow_id
string

UUID alur kerja yang dipisahkan koma (temukan di halaman Alur Kerja di Konsol). UUID yang salah format dalam daftar akan diabaikan; jika tidak ada yang valid, hasilnya kosong.

date_from
string<date>

Hanya sesi yang dibuat pada atau setelah tanggal ini (UTC), format YYYY-MM-DD. Format tanggal yang salah akan mengembalikan 400.

date_to
string<date>

Hanya sesi yang dibuat hingga tanggal ini (UTC), format YYYY-MM-DD. Untuk baris KYC, seluruh hari disertakan; untuk baris KYB, perbandingannya adalah created_at <= date_to (tengah malam), jadi gunakan tanggal hari berikutnya untuk menyertakan sesi KYB satu hari penuh.

tags
string

ID tag yang dipisahkan dengan koma (tags dari aplikasi Anda). Mengembalikan sesi yang memuat salah satu di antaranya. ID yang bukan UUID valid akan diabaikan, dan jika tidak ada yang valid, daftarnya kosong.

decided_from
string<date-time>

Tanggal dan waktu ISO 8601. Mengembalikan sesi yang statusnya terakhir berubah pada atau setelah waktu tersebut. Filter ini menyaring berdasarkan waktu perubahan status terakhir, bukan waktu pembuatan.

decided_to
string<date-time>

Datetime ISO 8601. Mengembalikan sesi yang statusnya terakhir berubah sebelum waktu tersebut. Gabungkan dengan decided_from untuk jendela setengah terbuka.

country
string

Filter negara yang dipisahkan koma. Untuk baris KYC: kode ISO 3166-1 alpha-3 dari negara penerbit dokumen identitas (misalnya ESP,USA), yang mungkin berbeda dari kewarganegaraan. Untuk baris KYB: kode negara dari registri perusahaan.

document_type
string

Kode jenis dokumen identitas yang dipisahkan koma yang diverifikasi dalam sesi (hanya baris KYC): P (Paspor), ID (Kartu Identitas), DL (Surat Izin Mengemudi), RP (Izin Tinggal), SSC (Kartu Jaminan Sosial), HIC (Kartu Asuransi Kesehatan), WP (Izin Kerja), TC (Kartu Pajak), VISA, PSC (Kartu Layanan Publik), BC (Akta Kelahiran), OTHER. Perhatikan bahwa kolom respons document_type berisi nama tampilan, bukan kodenya.

document_name
string

Nama dokumen persis; beberapa nama dapat diteruskan dipisahkan dengan koma, tetapi nilainya hanya dipisahkan dengan koma jika berisi lebih dari satu pemisah - (nama tunggal dengan koma di dalamnya dicocokkan secara utuh). Nama sesuai dengan yang dikenali oleh verifikasi dokumen (sisi depan atau belakang), misalnya Spain - Id Card (2021). Baris KYC saja.

region
string

Nilai wilayah/negara bagian dokumen yang dipisahkan koma (untuk dokumen yang diterbitkan per wilayah, seperti surat izin mengemudi AS). Hanya baris KYC.

didit_internal_id
string<uuid>

Filter berdasarkan pengidentifikasi pengguna internal Didit (kolom respons didit_internal_id) untuk mencantumkan semua sesi dari satu pengguna terverifikasi. Harus berupa UUID yang valid; nilai yang salah format mengembalikan 400. Hanya baris KYC.

session_type
string

Saluran pembuatan sesi yang dipisahkan dengan koma: API, HOSTED, MIGRATED. Nilai khusus ALL (atau tidak menyertakan parameter) menonaktifkan filter. Hanya baris KYC.

api_service
enum<string>

Filter sesi API mandiri berdasarkan layanan. Nilai yang tidak valid mengembalikan 400. Hanya baris KYC.

Opsi yang tersedia:
ID_VERIFICATION,
FACE_MATCH,
AGE_ESTIMATION,
FACE_SEARCH,
POA,
AML,
KYB_REGISTRY,
PASSIVE_LIVENESS,
DATABASE_VALIDATION,
PHONE_VERIFICATION,
EMAIL_VERIFICATION
screened_full_name
string

Pencarian nama tidak peka aksen di dalam data yang diskrining pada Skrining AML dan Validasi Database. Jika digabungkan dengan api_service=AML atau api_service=DATABASE_VALIDATION, pencarian dibatasi pada data yang diskrining fitur tersebut. Hanya baris KYC.

warning
string

Kode risiko peringatan yang dipisahkan dengan koma; mengembalikan sesi yang memicu salah satu di antaranya (misalnya POSSIBLE_FRAUD). Kode risiko dicantumkan per fitur dalam dokumentasi peringatan. Berlaku untuk baris KYC dan, dengan kode peringatan bisnis, untuk baris KYB.

status_initialized_as_in_review
boolean

Jika true, hanya sesi yang keputusannya awalnya berstatus In Review (berguna untuk mengaudit volume peninjauan manual). Baris KYC saja.

is_kyc_to_be_reviewed
boolean

true mengembalikan sesi yang verifikasi dokumennya ditandai untuk peninjauan manual; false mengembalikan sesi dengan verifikasi dokumen yang secara eksplisit tidak ditandai. Jangan sertakan untuk menonaktifkan. Hanya baris KYC.

euuid
string<uuid>

Filter berdasarkan euuid pengguna akhir (UUID yang ditetapkan untuk pengguna yang melakukan verifikasi, digunakan oleh deep link Console). Harus berupa UUID yang valid; nilai yang salah format mengembalikan kesalahan kolom 400. Hanya baris KYC.

organization_name
string

Nama organisasi yang dipisahkan dengan koma. Berorientasi konsol; dengan kunci API (sudah dibatasi pada satu aplikasi), ini hanya cocok dengan nama organisasi Anda sendiri.

Respons

Daftar sesi terpaginasi. Item results berupa baris KYC, baris KYB, atau keduanya tergantung pada session_kind; bedakan dengan kolom session_kind di setiap baris.

count
integer
wajib

Jumlah sesi yang cocok dengan filter: tepat hingga 100 dan dibatasi maksimal 100 setelahnya, sehingga jangan gunakan sebagai total keseluruhan. Gunakan next untuk mengetahui apakah halaman berikutnya masih ada. Untuk session_kind=all, ini adalah jumlah kedua jenis, masing-masing dibatasi maksimal 100.

Contoh:

2

next
string<uri> | null
wajib

URL absolut halaman berikutnya, atau null di halaman terakhir.

Contoh:

"https://verification.didit.me/v3/sessions/?limit=20&offset=20"

previous
string<uri> | null
wajib

URL absolut halaman sebelumnya, atau null di halaman pertama.

Contoh:

null

results
(KYC session row (session_kind: user) · object | KYB session row (session_kind: business) · object)[]
wajib

Baris sesi, terbaru terlebih dahulu. Dengan session_kind=all, baris KYC muncul lebih dulu, kemudian baris KYB.

Baris ringkasan untuk sesi Verifikasi Pengguna (KYC). Kolom identitas (full_name, country, document_type, portrait_image, kolom kontak) diisi secara bertahap saat pengguna menyelesaikan langkah verifikasi, dan bernilai null hingga langkah terkait selesai. Kolom yang dibatasi oleh konfigurasi atribut respons alur kerja juga dikembalikan sebagai null.

Terakhir diubah pada 7 November 2026