Qanday ishlaydi
- Serveringiz arizachi va sessiya yaratadi (
POST /applicants/{id}/sessions) hamda sessiyatokenini sahifaga beradi. - Sahifa
kyc.jsni yuklaydi va token bilanKYC.init()ni chaqiradi. Jarayon konteyneringiz ichida iframe da ochiladi. - Arizachi hujjatni va selfini suratga oladi. Kamerasi yoʻq kompyuterda jarayon telefonda davom ettirish uchun QR kod taklif qiladi.
- Brauzerda
onCompleteishga tushadi, serveringiz esa qaror bilan webhook oladi.
Maxfiy kalit serveringizda qoladi. Sahifa faqat sessiya token ini oladi — u bitta sessiya uchun ishlaydi va sessiya bilan birga muddati tugaydi.
Tez boshlash
Sessiyani serveringizda yarating (Tez boshlash bobiga qarang) va uning token ini sahifaga chiqaring:
<div id="kyc"></div>
<script src="https://kyc.goxost.net/sdk/kyc.js"></script>
<script>
const flow = KYC.init({
token: 'eyJ…', // session token from your server
container: '#kyc',
locale: 'en', // uz | ru | en
onReady() {
console.log('Flow loaded');
},
onComplete(result) {
// UX only: show a "thank you" screen, then ask your server for the status
showThankYou(result.decision);
},
onError(error) {
if (error.code === 'session_expired' || error.code === 'link_invalid') {
restartWithNewSession(); // ask your server for a new session
}
},
});
</script>
iframe ni olib tashlash va tinglashni toʻxtatish uchun flow.destroy() ni chaqiring — masalan, foydalanuvchi modal oynangizni yopganda yoki bir sahifali ilovada boshqa sahifaga oʻtganda.
Sozlamalar
KYC.init(options) { destroy() } qaytaradi.
| Sozlama | Turi | Tavsif |
|---|---|---|
token |
string, majburiy | POST /applicants/{id}/sessions dan olingan sessiya token i |
container |
CSS selektor yoki HTMLElement, majburiy |
iframe joylanadigan element; undagi joriy mazmun almashtiriladi |
locale |
uz, ru, en |
Jarayon tili. Berilmasa: arizachining locale i, keyin brauzer tili |
onReady() |
funksiya | Jarayon yuklandi |
onComplete(result) |
funksiya | Arizachi yakunladi. result — { decision, decision_type, reject_labels } |
onError(error) |
funksiya | Jarayonni davom ettirib boʻlmaydi. error — { code } |
onEvent(event) |
funksiya | Quyidagi barcha hodisalar, jumladan ready, complete va error |
Token boʻsh yoki notoʻgʻri boʻlsa KYC.init KYC: invalid token xatosini, selektor hech narsa topmasa KYC: container not found xatosini tashlaydi.
iframe konteynerning butun kengligini egallaydi. Balandligi 640 px dan boshlanadi, keyin mazmunga moslashadi (kamida 320 px), shuning uchun konteynerga qatʼiy balandlik bermang.
Hodisalar
type |
Maydonlar | Qachon |
|---|---|---|
ready |
— | Jarayon yuklandi |
step |
step: handoff, consent, document, liveness, processing |
Arizachi yangi qadamga oʻtdi (handoff — «telefonda davom etish» ekrani) |
complete |
decision (GREEN, RED, ON_HOLD), decision_type (final, retry yoki null), reject_labels |
Natija tayyor |
error |
code |
Jarayon toʻxtadi |
resize |
height |
Mazmun balandligi oʻzgardi (SDK iframe oʻlchamini oʻzi moslaydi) |
Qayta ishlashingiz kerak boʻlgan xato kodlari:
code |
Maʼnosi | Nima qilish kerak |
|---|---|---|
link_invalid |
Sessiya nomaʼlum, ishlatilgan yoki yopilgan | Yangi sessiya yarating |
session_expired |
Jarayon davomida sessiya muddati tugadi | Yangi sessiya yarating |
session_reset |
Jarayon ochiq turganda arizachi qayta tiklandi | Yangi sessiya yarating |
network |
Ulanish muammosi | Foydalanuvchidan ulanishni tekshirib, qayta urinishni soʻrang |
unknown |
Boshqa har qanday xato | Qayta urinib koʻring; takrorlansa, yangi sessiya yarating |
Jarayondan boshqa API xato kodlari ham kelishi mumkin — nomaʼlum kodlarni unknown kabi qabul qiling.
Xavfsizlik
onCompletefaqat interfeys uchun. iframe dan keladigan xabarlarni brauzerda soxtalashtirish mumkin. Biror narsani ochishdan oldin yakuniy qarorni serveringizda oling — webhookdan yokiGET /verifications/{id}dan.- Hodisalarda faqat kodlar va qaror boʻladi — hech qachon ism, hujjat maʼlumoti yoki rasm emas.
- Agar
kyc.jsoʻrniga iframe ni oʻzingiz joylasangiz, xabarni faqatevent.originhttps://kyc.goxost.net,event.sourceiframe ingizningcontentWindowi vaevent.data.sourcekyc-flowboʻlgandagina qabul qiling.kyc.jsbu tekshiruvlarni siz uchun bajaradi.
Content Security Policy va kamera
Saytingiz Content Security Policy yuborsa, GOXOST KYC ga ruxsat bering:
Content-Security-Policy: script-src 'self' https://kyc.goxost.net; frame-src https://kyc.goxost.net
Saytingiz Permissions-Policy sarlavhasini yuborsa, u iframe ga kameradan foydalanishga ruxsat berishi kerak:
Permissions-Policy: camera=(self "https://kyc.goxost.net")
Sahifa HTTPS orqali ochilishi shart — oddiy HTTP da brauzerlar kamerani bloklaydi. Jarayon sahifasining oʻzi istalgan saytga joylashga ruxsat beradi; uni sessiya tokeni himoya qiladi.
Joylash oʻrniga hosted havola
kyc.js siz ham ishlash mumkin: arizachini sessiya url iga (https://kyc.goxost.net/v/Xk7mQ2pL9aR4wTb8) yuboring — yoʻnaltirish orqali, yangi tabda, SMS yoki email orqali.
- Sessiya yaratishda
redirect_url(faqat HTTPS) bering: oxirida jarayon uni ochadigan Xizmatga qaytish tugmasini koʻrsatadi. Joylangan (embed) rejimda bu tugma koʻrsatilmaydi. expires_inhavolaning amal qilish vaqtini belgilaydi: 60–1800 soniya, standart 1800.- Arizachining bitta faol sessiyasi boʻladi. Yangisini yaratish oldingisini yopadi; yopilgan havola
410qaytaradi va sahifa foydalanuvchiga havola endi yaroqsizligini aytadi. - Yoʻnaltirish ham natijaning isboti emas — qarorni serveringizda oʻqing.
Jarayonning har bir sahifasida kichik «GOXOST KYC asosida ishlaydi» (Powered by GOXOST KYC) belgisi boʻladi.