Lewati ke konten utama
Buat ProsesPOST

Buat proses Human Token dari back-end Anda dan dapatkan humanToken di data.humanToken.

Markdown

Human Token berjalan di endpoint Human API POST /client/v1/process. Dengan alur API Only (api+humantoken, api+liveness+humantoken, dan api+liveness+humantoken+revalidation), proses dibuat dan diselesaikan dalam satu panggilan: respons sudah membawa hasilnya di data.humanToken. Dengan alur Human Token Journey (humantoken dan humantoken+revalidation), respons membawa id proses, sebuah token, dan link perjalanan, dan hasilnya tersedia setelah pengguna menyelesaikan perjalanan. Alur +revalidation memerlukan array references berisi humanToken yang diperoleh sebelumnya untuk revalidasi.

Alur​

Human Token berjalan dalam dua model integrasi:

  • API Only — back-end Anda mengirim selfie di imageBase64.
  • Human Token Journey — pengguna menjalani perjalanan Unico di Web dan kembali ke callbackUri Anda.
FlowCapabilitiesPossible resultIntegration components
required
Example
api+humantokenHuman TokenPROCESS_STATE_FINISHEDPROCESS_STATE_FAILEDAPI
api+liveness+humantokenLivenessHuman TokenPROCESS_STATE_FINISHEDPROCESS_STATE_FAILEDAPI
api+liveness+humantoken+revalidationLivenessHuman TokenRevalidationPROCESS_STATE_FINISHEDPROCESS_STATE_FAILEDAPI
humantokenLivenessHuman TokenPROCESS_STATE_CREATEDPROCESS_STATE_FINISHEDPROCESS_STATE_FAILEDPROCESS_STATE_CANCELEDAPIWeb
humantoken+revalidationLivenessHuman TokenRevalidationPROCESS_STATE_CREATEDPROCESS_STATE_FINISHEDPROCESS_STATE_FAILEDPROCESS_STATE_CANCELEDAPIWeb

Endpoint​

LingkunganURL
ProduksiPOST https://humantoken.unico.app/client/v1/process

Permintaan​

Headers
HeaderNilai
x-unico-accesskey<your_access_key> (lihat Autentikasi)
Content-Typeapplication/json
Parameter body
FieldTipeWajibDeskripsi
flowstringyaAlur Human Token: api+humantoken, api+liveness+humantoken, api+liveness+humantoken+revalidation (API Only) atau humantoken, humantoken+revalidation (Human Token Journey). Lihat Alur.
imageBase64stringAPI OnlySelfie, diambil oleh front-end Anda dan dikirim secara langsung, dalam base64. PNG, JPEG, atau WebP, hingga 800 KB. Ikuti Capture Standard.
callbackUristringHuman Token JourneyURL tempat pengguna diarahkan setelah perjalanan berakhir.
companyBranchIdstringtidakPengenal branch. Jika disediakan, proses menggunakan konfigurasi branch yang ditentukan.
referencesarrayAlur revalidasiArray objek referensi. Wajib untuk alur +revalidation. Setiap objek memiliki referenceType (REFERENCE_TYPE_HUMAN_TOKEN) dan referenceContent (nilai humanToken yang diperoleh sebelumnya).

Respons​

200 OK
FieldTipeDeskripsi
idstring (UUID)Pengenal proses. Gunakan untuk mengambil proses kembali melalui Dapatkan Proses.
statestringStatus proses — lihat Menafsirkan hasil. Hanya pada alur API Only.
tokenstringToken dari proses yang dibuat, Anda dapat menggunakannya untuk membuka pengalaman Journey SDK. Hanya dalam alur Human Token Journey (humantoken, humantoken+revalidation).
linkstringURL Human Token Journey: arahkan pengguna ke URL ini. Hanya pada alur Human Token Journey (humantoken, humantoken+revalidation).
data.​humanToken.​valuestringPengenal wajah yang stabil dan buram (hingga 100 karakter). Orang yang sama selalu menghasilkan nilai yang sama. Hanya pada alur API Only (non-revalidasi).
data.​humanTokenMatchstring"true" jika selfie cocok dengan humanToken yang direferensikan, "false" jika tidak. Hanya pada alur +revalidation API Only.
Menafsirkan hasil
stateMaknaYang harus dilakukan
PROCESS_STATE_FINISHEDdata.humanToken.value terisi: orang nyata, dengan Human Token.Cari value di catatan Anda: jika ada, itu adalah pengguna yang kembali atau kemungkinan duplikat; jika tidak, itu adalah orang baru.
PROCESS_STATE_FINISHEDTidak ada data.humanToken, atau value kosong: tidak meyakinkan.Anggap hasilnya tidak meyakinkan. Jangan pernah menyimpan atau mencocokkan value yang kosong; ulangi proses atau tolak, sesuai aturan bisnis Anda.
PROCESS_STATE_FAILEDProses identifikasi gagal.Ulangi proses atau tolak, sesuai aturan bisnis Anda.
PROCESS_STATE_CREATEDProses dibuat.Tunggu. Ambil hasilnya nanti dengan Dapatkan Proses.
PROCESS_STATE_CANCELEDProses dibatalkan.Buat proses baru, jika pengguna masih perlu diverifikasi.
peringatan

Selalu pastikan data.humanToken.value tidak kosong sebelum menggunakannya.

Kode Error​

catatan

Status HTTP yang dikembalikan saat access key di header x-unico-accesskey tidak ada atau tidak valid masih dikonfirmasi. Lihat Autentikasi.

KodePesanDeskripsi
3invalid flowKetika alur yang ditentukan tidak ada.
3INVALID_IMAGEKetika gambar bukan base64 yang valid, atau tampak seperti upaya injeksi.
3IMAGE_TOO_LARGEKetika gambar melebihi ukuran maksimum 800 KB.
3UNSUPPORTED_IMAGE_FORMATKetika format gambar bukan PNG, JPEG, atau WebP.
3MISSING_IMAGEKetika gambar diperlukan untuk alur ini dan tidak dikirim.
3INVALID_REQUESTKetika body permintaan bernilai null atau tidak dapat diinterpretasikan.
9monthly process limit of <monthly_limit> reached for this tenantKetika batas penggunaan bulanan telah tercapai.
9PROCESS_FAILEDKetika proses mencapai kegagalan terminal saat sedang dibuat.

Untuk daftar lengkap kode endpoint ini, lihat referensi Buat Proses Human API.

Selanjutnya​

  • Simpan nilai humanToken bersama catatan pengguna Anda untuk mengenali orang yang sama pada panggilan Human Token berikutnya.
  • Untuk mengambil proses kembali, untuk audit atau dukungan, gunakan Dapatkan Proses.