इवेंट प्रकार

Webhook पेलोड एक प्रक्रिया की स्थिति परिवर्तन का वर्णन करते हैं। यह पृष्ठ पेलोड स्कीमा और lastEvent मानों की पूर्ण सूची को दस्तावेज़ करता है।

पेलोड स्कीमा

फ़ील्ड	प्रकार	विवरण
`processId`	`string` (UUID)	लेनदेन की ID।
`state`	`string`	लेनदेन की वर्तमान स्थिति। वर्तमान में: `PROCESS_STATE_FINISHED`।
`result`	`string`	समाप्त प्रक्रिया का परिणाम। `state=PROCESS_STATE_FINISHED` होने पर उपस्थित। संभावित मान: `ok`, `expired`, `invalid_identity`।
`flow`	`string`	इस लेनदेन के लिए निष्पादित किया गया फ़्लो (जैसे, `id`, `idtoken`)।
`lastEvent`	`string`	लेनदेन का अंतिम इवेंट। केवल तब लौटाया जाता है जब `result=expired` हो।
`lastEventDescription`	`string`	`lastEvent` का मानव-पठनीय विवरण। केवल तब लौटाया जाता है जब `result=expired` हो।

स्थिति शब्दावली

Webhook पेलोड में state फ़ील्ड PROCESS_STATE_* उपसर्ग का उपयोग करती है। यह GetProcess एंडपॉइंट द्वारा लौटाए गए result और status फ़ील्ड से एक अलग शब्दावली है, जो PROCESS_RESULT_* का उपयोग करते हैं। इन्हें परस्पर विनिमेय न मानें।

उदाहरण पेलोड

समाप्त — सफल

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

समाप्त — समय-सीमा समाप्त

{
  "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"
}

lastEvent की गणना

lastEvent में दिखाई दे सकने वाले मानों की पूरी सूची:

इवेंट	विवरण
`EVENT_TYPE_PROCESS_CREATED`	प्रक्रिया बनाई गई
`EVENT_TYPE_QR_CODE_READ`	QR कोड पढ़ा गया
`EVENT_TYPE_PROCESS_STARTED_BY_USER`	प्रक्रिया उपयोगकर्ता द्वारा शुरू की गई
`EVENT_TYPE_IDENTITY_VALIDATION_STEP_FINISHED`	पहचान सत्यापन चरण समाप्त हुआ
`EVENT_TYPE_DOCUMENT_STEP_STARTED`	दस्तावेज़ चरण शुरू हुआ
`EVENT_TYPE_DOCUMENT_PHOTO_CAPTURED`	दस्तावेज़ की फ़ोटो ली गई
`EVENT_TYPE_DOCUMENT_UPLOADED_FROM_GALLERY`	दस्तावेज़ गैलरी से अपलोड किया गया
`EVENT_TYPE_DOCUMENT_STEP_FINISHED`	दस्तावेज़ चरण समाप्त हुआ
`EVENT_TYPE_SESSION_ENDED`	सत्र टाइमआउट या नया सत्र बनाए जाने के कारण समाप्त हुआ
`EVENT_TYPE_ERROR_ON_DOCUMENT_STEP`	दस्तावेज़ चरण में त्रुटि

कॉन्फ़िगर करने योग्य हैंडलिंग

इवेंट का समूह विकसित हो सकता है। जिन इवेंट पर आपका एंडपॉइंट प्रतिक्रिया करता है, उन्हें कॉन्फ़िगरेशन के रूप में मानें, न कि हार्ड-कोडेड स्थिरांक के रूप में — इस तरह नए इवेंट को बिना डिप्लॉय के सक्षम किया जा सकता है।

पूर्ण प्रक्रिया परिणाम पढ़ना

Webhook पेलोड संकेत देता है कि एक प्रक्रिया समाप्त हो गई है और result फ़ील्ड में उच्च-स्तरीय परिणाम शामिल है। पूरे विवरण प्राप्त करने के लिए — कैप्चर डेटा, बायोमेट्रिक स्कोर, दस्तावेज़ फ़ील्ड आदि — उचित GetProcess एंडपॉइंट को कॉल करें:

Visual / Web और नेटिव फ़्लो के लिए: API संदर्भ > Web और नेटिव > GET /v1/process/{id} देखें।
Non-visual / API फ़्लो के लिए: API संदर्भ > API > GET /processes/v1/{id} देखें।

पेलोड स्कीमा​

उदाहरण पेलोड​

समाप्त — सफल​

समाप्त — समय-सीमा समाप्त​

lastEvent की गणना​

पूर्ण प्रक्रिया परिणाम पढ़ना​