- एचटीटीपी अनुरोध
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- ProofingEvidence
- सबूत
- ReverificationContext
यह एक ऐसा एंडपॉइंट है जो किसी उपयोगकर्ता की डिजिटल क्रेडेंशियल के लिए पुष्टि करता है. इसके लिए, यह जारी करने वाले व्यक्ति या कंपनी की ओर से उपलब्ध कराए गए सबूतों की सूची और किसी खास डिवाइस का इस्तेमाल करता है.
एचटीटीपी अनुरोध
POST https://example.issuer.com/api/v1/vdc/proofUser
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर का डेटा शामिल होता है:
| JSON के काेड में दिखाना |
|---|
{ "requestMetadata": { object ( |
| फ़ील्ड | |
|---|---|
requestMetadata |
अनुरोध के बारे में मेटाडेटा. यह सभी अनुरोधों में ज़रूरी होता है. |
deviceReferenceId |
यह आईडी, डिवाइस और उससे जुड़ी आइडेंटिटी कुंजी से मेल खाता है. यह डिवाइस आईडी नहीं है. इसका मतलब है कि अगर उपयोगकर्ता के पास एक ही डिवाइस पर दो अलग-अलग क्रेडेंशियल हैं, तो यह आईडी दोनों के लिए अलग-अलग होगा. यह आईडी सभी अनुरोधों में दिया जाता है. इसका इस्तेमाल अनुरोधों को आपस में जोड़ने के लिए किया जा सकता है. |
proofingId |
यह एक ओपेक आइडेंटिफ़ायर है. यह किसी डिवाइस के लिए, सबूतों के किसी बंडल के साथ पुष्टि करने की प्रोसेस को दिखाता है. उदाहरण: यूयूआईडी |
evidence[] |
डिजिटल क्रेडेंशियल के लिए, किसी उपयोगकर्ता की पहचान की पुष्टि करने के लिए ज़रूरी सबूतों की सूची. |
यूनियन फ़ील्ड proofing_context. प्रूफिंग का कॉन्टेक्स्ट. शुरुआती जांच के लिए खाली छोड़ें. proofing_context इनमें से सिर्फ़ एक हो सकता है: |
|
reverificationContext |
फिर से पुष्टि करने के सबूत का कॉन्टेक्स्ट. |
जवाब का मुख्य भाग
डिजिटल क्रेडेंशियल के लिए किसी उपयोगकर्ता की पुष्टि करने के अनुरोध को स्वीकार करने की सूचना. इससे पता चलता है कि पुष्टि करने की प्रोसेस अब शुरू हो गई है.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
| JSON फ़ॉर्मैट में दिखाया गया है |
|---|
{
"responseMetadata": {
object ( |
| फ़ील्ड | |
|---|---|
responseMetadata |
जवाब के बारे में मेटाडेटा. यह सभी जवाबों में ज़रूरी होता है. |
proofingId |
यह एक ओपेक आइडेंटिफ़ायर है. यह किसी डिवाइस के लिए, सबूतों के किसी बंडल के साथ पुष्टि करने की प्रोसेस को दिखाता है. यह वही आईडी है जिसे अनुरोध में भेजा गया था. |
ProofingEvidence
यह एक ऐसा ऑब्जेक्ट होता है जो सबूत के एक हिस्से को दिखाता है.
| JSON के काेड में दिखाना |
|---|
{ // Union field |
| फ़ील्ड | |
|---|---|
यूनियन फ़ील्ड evidence_type. यह एक ऐसा विकल्प है जिससे पता चलता है कि सबूत कैसे पेश किया जा रहा है. evidence_type इनमें से सिर्फ़ एक हो सकता है: |
|
preAuthorizationCode |
कार्ड जारी करने वाले बैंक से भेजा गया प्री-ऑथराइज़ेशन कोड. |
एविडेंस
यह एक ऐसा ऑब्जेक्ट होता है जो सबूत के एक हिस्से को दिखाता है.
| JSON के काेड में दिखाना |
|---|
{ // Union field |
| फ़ील्ड | |
|---|---|
यूनियन फ़ील्ड presencetype. यह एक ऐसा विकल्प है जिससे पता चलता है कि सबूत कैसे पेश किया जा रहा है. presencetype इनमें से सिर्फ़ एक हो सकता है: |
|
encryptedData |
एन्क्रिप्ट की गई वैल्यू और वैल्यू को डिक्रिप्ट करने के लिए ज़रूरी एन्क्रिप्शन मेटाडेटा. |
unencryptedValue |
सबूत की base64 कोड में बदली गई वैल्यू. |
unencryptedInteger |
सबूत की पूर्णांक वैल्यू. |
ReverificationContext
क्रेडेंशियल की फिर से पुष्टि करने के लिए ज़रूरी कॉन्टेक्स्ट.
| JSON के काेड में दिखाना |
|---|
{ "credentialId": string } |
| फ़ील्ड | |
|---|---|
credentialId |
वह क्रेडेंशियल आईडी जिस पर फिर से पुष्टि की जाती है. |