Jenis event

Payload webhook mendeskripsikan transisi status suatu proses. Halaman ini mendokumentasikan skema payload dan enumerasi lengkap nilai lastEvent.

Skema payload

Field	Type	Deskripsi
processId	string (UUID)	ID transaksi.
state	string	Status terkini transaksi. Saat ini: PROCESS_STATE_FINISHED.
result	string	Hasil dari proses yang telah selesai. Muncul ketika state=PROCESS_STATE_FINISHED. Nilai yang mungkin: ok, expired, invalid_identity.
flow	string	Flow yang dieksekusi untuk transaksi ini (misalnya, id, idtoken).
lastEvent	string	Event terakhir dari transaksi. Hanya dikembalikan ketika result=expired.
lastEventDescription	string	Deskripsi lastEvent yang dapat dibaca manusia. Hanya dikembalikan ketika result=expired.

Kosakata status

Field state dalam payload webhook menggunakan prefiks PROCESS_STATE_*. Ini adalah kosakata yang berbeda dari field result dan status yang dikembalikan oleh endpoint GetProcess, yang menggunakan PROCESS_RESULT_*. Jangan memperlakukan keduanya sebagai hal yang dapat dipertukarkan.

Contoh payload

Selesai — berhasil

{
  "processId": "8263a268-5388-492a-bca2-28e1ff4a69f0",
  "state": "PROCESS_STATE_FINISHED",
  "flow": "id",
  "result": "ok"
}

Selesai — kedaluwarsa

{
  "processId": "8263a268-5388-492a-bca2-28e1ff4a69f0",
  "state": "PROCESS_STATE_FINISHED",
  "flow": "id",
  "result": "expired",
  "lastEvent": "EVENT_TYPE_SESSION_ENDED",
  "lastEventDescription": "Session ended by timeout or by new session created"
}

Enumerasi lastEvent

Daftar lengkap nilai yang dapat muncul di lastEvent:

Event	Deskripsi
EVENT_TYPE_PROCESS_CREATED	Proses dibuat
EVENT_TYPE_QR_CODE_READ	QR code telah dibaca
EVENT_TYPE_PROCESS_STARTED_BY_USER	Proses dimulai oleh pengguna
EVENT_TYPE_IDENTITY_VALIDATION_STEP_FINISHED	Langkah validasi identitas selesai
EVENT_TYPE_DOCUMENT_STEP_STARTED	Langkah dokumen telah dimulai
EVENT_TYPE_DOCUMENT_PHOTO_CAPTURED	Foto dokumen diambil
EVENT_TYPE_DOCUMENT_UPLOADED_FROM_GALLERY	Dokumen diunggah dari galeri
EVENT_TYPE_DOCUMENT_STEP_FINISHED	Langkah dokumen selesai
EVENT_TYPE_SESSION_ENDED	Sesi berakhir karena timeout atau karena sesi baru dibuat
EVENT_TYPE_ERROR_ON_DOCUMENT_STEP	Terjadi kesalahan pada langkah dokumen

Penanganan yang dapat dikonfigurasi

Kumpulan event dapat berkembang. Perlakukan event yang direspons oleh endpoint Anda sebagai konfigurasi, bukan konstanta yang di-hardcode — dengan begitu event baru dapat diaktifkan tanpa perlu melakukan deploy.

Membaca hasil proses lengkap

Payload webhook menandakan bahwa proses telah selesai dan menyertakan hasil tingkat tinggi di field result. Untuk mengambil detail lengkap — data tangkapan, skor biometrik, field dokumen, dll. — panggil endpoint GetProcess yang sesuai:

• Untuk flow visual / Web & Native: lihat Referensi API > Web & Native > GET /v1/process/{id}.
• Untuk flow non-visual / API: lihat Referensi API > API > GET /processes/v1/{id}.