Mitra dapat memeriksa status verifikasi melalui endpoint API status verifikasi kami (GET /api/partner/v2/verify/requests/{id}). Endpoint ini mengembalikan hasil verifikasi dan informasi kredensial untuk permintaan verifikasi tertentu.
Autentikasi memerlukan token JWT dari endpoint token OAuth kami, dan API membutuhkan ID permintaan yang dibuat saat permintaan verifikasi asli diajukan.
Status
Status
Deskripsi
incomplete
Verifikasi sedang berlangsung. Tidak ada hasil yang tersedia pada tahap ini.
canceled
Verifikasi tidak lagi dilanjutkan dan tidak ada hasil yang tersedia.
verified
Verifikasi berhasil diselesaikan dan hasil tersedia.
revoked
Hasil verifikasi tidak valid. Semua salinan hasil harus dihapus.
unshared
Hasil verifikasi tidak tersedia. Ini terjadi ketika pengguna meminta pembagian diakhiri, atau belum menyetujui untuk membagikan kredensial yang diperbarui.
Silakan merujuk ke Spesifikasi OpenAPI V2 kami untuk detail lebih lanjut tentang format permintaan dan respons.
API status massal juga tersedia untuk menanyakan status beberapa permintaan verifikasi secara bersamaan. Hingga 30 ID permintaan dapat disertakan dalam satu kueri.
Karena batasan ukuran kueri maksimum, bergantung pada panjang ID yang diberikan, Anda mungkin menerima respons 403 Forbidden jika string kueri Anda lebih panjang dari 2048 byte. Jika Anda mencapai batas ini, silakan kurangi jumlah ID kueri yang diteruskan dalam permintaan Anda dan coba lagi.
Mitra dengan pengujian yang diaktifkan dapat menguji alur verifikasi di lingkungan staging menggunakan hasil yang telah ditentukan sebelumnya. Atur display_options.partner_name ke salah satu nilai tes yang didukung di bawah ini. Nilai NZDL yang ditampilkan adalah contoh.
Skenario tes
Contoh nilai partner_name
Hasil yang diharapkan
Terverifikasi
Partner.Verified.NZDL
Untuk contoh ini, API status mengembalikan incomplete saat wizard verifikasi sedang berlangsung. Setelah wizard selesai, API mengembalikan verified.
Dibatalkan
Partner.Canceled.NZDL
Untuk contoh ini, permintaan segera dibatalkan. API status mengembalikan canceled, dan SEEK Pass mengirimkan event webhook yang dibatalkan.
Permintaan berikut menggunakan nilai NZDL yang telah diverifikasi sebagai contoh:
# POST /api/partner/v2/verify/requests/digital_identity.json
{
"display_options": {
"partner_name": "Partner.Verified.NZDL"
}
}
Untuk hasil yang telah diverifikasi, buka redirect_uri yang dikembalikan dalam respons dan selesaikan wizard. Kemudian gunakan ID permintaan untuk memeriksa hasilnya:
GET /api/partner/v2/verify/requests/{id}
SEEK Pass juga mengirimkan event webhook ketika hasil tes sudah siap. Untuk informasi lebih lanjut, lihat Hasil verifikasi melalui Webhook.