- एचटीटीपी अनुरोध
- अनुरोध का मुख्य हिस्सा
- जवाब का मुख्य हिस्सा
- ProofingStatus
- मंज़ूरी मिलना बाकी है
- स्वीकार किया गया
- अस्वीकार किया गया
- आवेदन अस्वीकार होना
- EvidenceMismatch
- EvidenceIncomplete
- LowRiskScore
- RecordNotFound
- RecordInvalid
- MaxProvisioningsReached
- RiskCheckFailure
- LivenessCheckFailure
- चैलेंज किया गया
- PhysicalLocationVisit
- IssuerUrlVisit
- AdditionalTimeRequired
- रद्द किया गया
- रद्द किया गया
- समयसीमा खत्म हो गई है
यह एंडपॉइंट, किसी दस्तावेज़ की वर्तनी और व्याकरण की जांच की मौजूदा स्थिति को वापस पाने के लिए होता है.
एचटीटीपी अनुरोध
POST https://example.issuer.com/api/v1/vdc/getProofingStatus
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में, इस स्ट्रक्चर का डेटा शामिल होता है:
| JSON के काेड में दिखाना |
|---|
{
"requestMetadata": {
object ( |
| फ़ील्ड | |
|---|---|
requestMetadata |
अनुरोध के बारे में मेटाडेटा. यह सभी अनुरोधों में ज़रूरी होता है. |
deviceReferenceId |
यह आईडी, डिवाइस और उससे जुड़ी आइडेंटिटी कुंजी से मेल खाता है. यह डिवाइस आईडी नहीं है. इसका मतलब है कि अगर उपयोगकर्ता के पास एक ही डिवाइस पर दो अलग-अलग क्रेडेंशियल हैं, तो यह आईडी दोनों के लिए अलग-अलग होगा. यह आईडी सभी अनुरोधों में दिया जाता है. इसका इस्तेमाल अनुरोधों को आपस में जोड़ने के लिए किया जा सकता है. |
proofingId |
यह एक ओपेक आइडेंटिफ़ायर है. यह किसी डिवाइस के लिए, सबूतों के किसी बंडल के साथ पुष्टि करने की प्रोसेस को दिखाता है. उदाहरण: यूयूआईडी |
जवाब का मुख्य भाग
जवाब में, किसी सबूत की मौजूदा स्थिति के बारे में जानकारी होती है.
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
| JSON फ़ॉर्मैट में दिखाया गया है |
|---|
{ "responseMetadata": { object ( |
| फ़ील्ड | |
|---|---|
responseMetadata |
जवाब के बारे में मेटाडेटा. यह सभी जवाबों में ज़रूरी होता है. |
proofingStatus |
प्रूफिंग की मौजूदा स्थिति. |
ProofingStatus
यह ऑब्जेक्ट, अलग-अलग स्टेटस दिखाता है.
| JSON के काेड में दिखाना |
|---|
{ // Union field |
| फ़ील्ड | |
|---|---|
यूनियन फ़ील्ड status. यह एक ऐसा oneof है जिसमें किसी सबूत की पुष्टि के लिए अलग-अलग स्थितियां शामिल होती हैं. status इनमें से सिर्फ़ एक हो सकता है: |
|
pending |
'कार्रवाई ज़रूरी है' स्टेटस, इससे पता चलता है कि कार्ड जारी करने वाली कंपनी ने अब तक कोई फ़ैसला नहीं लिया है. |
accepted |
स्वीकार किया गया स्टेटस, यह दिखाता है कि जारी करने वाले ने पुष्टि स्वीकार कर ली है. |
rejected |
'अस्वीकार कर दिया गया' स्थिति, इससे पता चलता है कि जारी करने वाले ने पुष्टि करने की प्रोसेस को अस्वीकार कर दिया है. |
challenged |
चैलेंज किया गया स्टेटस. इससे पता चलता है कि जारी करने वाला व्यक्ति या कंपनी, उपयोगकर्ता से कोई चुनौती पूरी करने के लिए कहेगी. इसके बाद ही, वह पहचान की पुष्टि करने के बारे में फ़ैसला लेगी. |
canceled |
रद्द किया गया स्टेटस. इससे पता चलता है कि उपयोगकर्ता ने प्रूफिंग की सुविधा रद्द कर दी है. |
revoked |
'रद्द कर दिया गया' स्थिति, इससे पता चलता है कि जारी करने वाले ने पुष्टि करने की प्रोसेस को रद्द कर दिया है. |
expired |
यह स्थिति तब दिखती है, जब पुष्टि करने वाले व्यक्ति ने तय समयसीमा के अंदर पुष्टि नहीं की हो. ऐसा इसलिए हो सकता है, क्योंकि वह चुनौती को पूरा नहीं कर पाया. यह समयसीमा, पुष्टि करने वाले व्यक्ति ने तय की होती है. |
मंज़ूरी बाकी है
इस टाइप के लिए कोई फ़ील्ड नहीं है.
यह ऑब्जेक्ट, 'समीक्षा में है' स्थिति को दिखाता है. फ़िलहाल, इस मैसेज में कोई जानकारी नहीं है. आने वाले समय में, नए फ़ील्ड जोड़े जा सकते हैं.
स्वीकार किया गया
इस टाइप के लिए कोई फ़ील्ड नहीं है.
यह एक ऑब्जेक्ट है, जो पुष्टि किए जाने की स्थिति को दिखाता है.
नामंजूर
यह एक ऐसा ऑब्जेक्ट है जो अस्वीकार की गई प्रूफिंग की स्थिति को दिखाता है.
| JSON के काेड में दिखाना |
|---|
{ "primaryRejection": { object ( |
| फ़ील्ड | |
|---|---|
primaryRejection |
इस सबूत को अस्वीकार किए जाने की मुख्य वजह. |
additionalRejections[] |
अगर कोई और वजह है, तो उसकी जानकारी दें कि पुष्टि की स्थिति को 'अस्वीकार किया गया' के तौर पर क्यों सेट किया गया है. |
आवेदन अस्वीकार होना
यह एक ऐसा ऑब्जेक्ट होता है जिसमें किसी दावे के अस्वीकार होने की वजह के बारे में जानकारी होती है. इस वजह से, दावे की पुष्टि करने की स्थिति 'अस्वीकार किया गया' के तौर पर सेट हो जाती है.
| JSON के काेड में दिखाना |
|---|
{ "rejectionDescription": string, "issuerRejectionIdentifier": string, // Union field |
| फ़ील्ड | |
|---|---|
rejectionDescription |
सहायता टीम के सदस्यों के लिए, अस्वीकार किए जाने की वजह के बारे में जानकारी, ताकि वे समस्या को ठीक कर सकें. ध्यान दें कि यह जानकारी लोगों को कभी नहीं दिखाई जाती. इसमें ब्यौरे वाला ऐसा टेक्स्ट शामिल हो सकता है जिसमें संवेदनशील जानकारी न हो. इसका इस्तेमाल डीबग करने के लिए किया जाता है. चेतावनी: इस मैसेज में, व्यक्तिगत पहचान से जुड़ी कोई जानकारी शामिल न करें. |
issuerRejectionIdentifier |
यह आइडेंटिफ़ायर, पास जारी करने वाले के लिए खास होता है और इसे पास जारी करने वाला जनरेट करता है. इसका इस्तेमाल सिर्फ़ डीबग करने के लिए किया जाता है, ताकि अस्वीकार किए जाने की वजह का पता लगाया जा सके. यह वह आइडेंटिफ़ायर है जिससे कार्ड जारी करने वाली कंपनी को इस अस्वीकृति के बारे में पता चलता है. |
यूनियन फ़ील्ड reason. यह एक ऐसा फ़ील्ड है जिसमें कई वजहों में से कोई एक वजह दी जाती है कि स्पेलिंग और व्याकरण की जांच करने की सुविधा को क्यों अस्वीकार किया गया. reason इनमें से सिर्फ़ एक हो सकता है: |
|
evidenceMismatch |
इससे पता चलता है कि सबूत के मेल न खाने की वजह से, पुष्टि करने की प्रोसेस को अस्वीकार कर दिया गया है. इस्तेमाल के उदाहरण: - ऐप्लिकेशन में कैप्चर की गई सेल्फ़ी और जारी करने वाले के सिस्टम में मौजूद इमेज का मेल न खाना. - ऐप्लिकेशन कैप्चर करने वाले दस्तावेज़ की इमेज और जारी करने वाले के सिस्टम में मौजूद इमेज का मेल न खाना. |
evidenceIncomplete |
इससे पता चलता है कि सबूत के तौर पर दिए गए दस्तावेज़ों के अधूरे होने की वजह से, पुष्टि करने की प्रोसेस को अस्वीकार कर दिया गया है. इस्तेमाल के उदाहरण: - जारी करने वाले व्यक्ति या कंपनी को ज़रूरी सबूत नहीं मिले. |
lowRiskScore |
(DEPRECATED: use riskCheckFailure or livenessCheckFailure accordingly) इससे पता चलता है कि जोखिम का स्कोर कम होने की वजह से, पुष्टि करने की प्रोसेस को अस्वीकार कर दिया गया है. इस्तेमाल के उदाहरण: - वॉलेट से मिला जोखिम का स्कोर कम है. - बार-बार लॉगिन करने की कोशिशें पूरी न होने की वजह से, जारी करने वाले ने इस उपयोगकर्ता को लॉक कर दिया है. |
recordNotFound |
इससे पता चलता है कि पुष्टि करने वाले व्यक्ति के सिस्टम में रिकॉर्ड मौजूद न होने की वजह से, पुष्टि करने की प्रोसेस को अस्वीकार कर दिया गया है. इस्तेमाल के उदाहरण: - रिकॉर्ड, जारी करने वाले के सिस्टम में नहीं मिला. - किसी खास रिकॉर्ड के लिए ऑप्ट आउट किया गया है. |
recordInvalid |
इससे पता चलता है कि जारी करने वाली कंपनी के सिस्टम में मौजूद रिकॉर्ड अमान्य होने की वजह से, पुष्टि करने का अनुरोध अस्वीकार कर दिया गया है. इस्तेमाल के उदाहरण: - रिकॉर्ड रद्द कर दिया गया है. - रिकॉर्ड की समयसीमा खत्म हो गई है. |
maxProvisioningsReached |
इससे पता चलता है कि दस्तावेज़ को तय सीमा से ज़्यादा डिवाइसों पर उपलब्ध कराने की वजह से, दस्तावेज़ की पुष्टि करने का अनुरोध अस्वीकार कर दिया गया है. |
riskCheckFailure |
इससे पता चलता है कि जोखिम के स्कोर की जांच में गड़बड़ी की वजह से, पुष्टि करने की प्रोसेस को अस्वीकार कर दिया गया है. इस्तेमाल के उदाहरण: - वॉलेट से मिले जोखिम के स्कोर से पता चलता है कि धोखाधड़ी का जोखिम ज़्यादा है. - कार्ड जारी करने वाली कंपनी को लगता है कि अनुरोध में धोखाधड़ी का जोखिम ज़्यादा है. |
livenessCheckFailure |
इससे पता चलता है कि लाइवनेस चेक पूरा न होने की वजह से, पुष्टि करने की प्रोसेस को अस्वीकार कर दिया गया है. इस्तेमाल के उदाहरण: - वॉलेट से मिला लाइवनेस स्कोर कम है. |
EvidenceMismatch
यह ऑब्जेक्ट, सबूत के मेल न खाने की वजह से अस्वीकार किए जाने की जानकारी देता है.
| JSON के काेड में दिखाना |
|---|
{ "evidenceType": string } |
| फ़ील्ड | |
|---|---|
evidenceType |
उस सबूत के बारे में जानकारी जो मेल नहीं खाती. इसका इस्तेमाल सिर्फ़ डीबग करने के लिए किया जाता है. |
EvidenceIncomplete
यह ऑब्जेक्ट, सबूत के तौर पर दिए गए दस्तावेज़ को अस्वीकार किए जाने की वजह बताता है.
| JSON के काेड में दिखाना |
|---|
{ "evidenceType": string } |
| फ़ील्ड | |
|---|---|
evidenceType |
सबूत के बारे में दी गई जानकारी अधूरी थी. इसका इस्तेमाल सिर्फ़ डीबग करने के लिए किया जाता है. |
LowRiskScore
इस टाइप के लिए कोई फ़ील्ड नहीं है.
कम जोखिम वाले स्कोर के आधार पर अस्वीकार किए जाने की जानकारी देने वाला ऑब्जेक्ट. फ़िलहाल, इस मैसेज में कोई जानकारी नहीं है. आने वाले समय में, नए फ़ील्ड जोड़े जा सकते हैं.
RecordNotFound
इस टाइप के लिए कोई फ़ील्ड नहीं है.
यह ऑब्जेक्ट, रिकॉर्ड नहीं मिलने की वजह से अस्वीकार किए जाने की जानकारी देता है. फ़िलहाल, इस मैसेज में कोई जानकारी नहीं है. आने वाले समय में, नए फ़ील्ड जोड़े जा सकते हैं.
RecordInvalid
यह ऑब्जेक्ट, अमान्य रिकॉर्ड अस्वीकार किए जाने की जानकारी देता है.
| JSON के काेड में दिखाना |
|---|
{ "invalidityReason": string } |
| फ़ील्ड | |
|---|---|
invalidityReason |
यह जानकारी कि रिकॉर्ड अमान्य क्यों है. |
MaxProvisioningsReached
यह ऑब्जेक्ट, ज़्यादा से ज़्यादा संख्या में डिवाइसों को उपलब्ध कराने की सुविधा के लिए किए गए अनुरोध के अस्वीकार होने की जानकारी देता है.
| JSON के काेड में दिखाना |
|---|
{ "maxNumberOfProvisioningsAllowed": integer } |
| फ़ील्ड | |
|---|---|
maxNumberOfProvisioningsAllowed |
कार्ड को ज़्यादा से ज़्यादा कितनी बार इस्तेमाल किया जा सकता है. यह कार्ड जारी करने वाले की नीति के मुताबिक तय किया जाता है. |
RiskCheckFailure
इस टाइप के लिए कोई फ़ील्ड नहीं है.
यह ऑब्जेक्ट, जोखिम की जांच पूरी न होने की वजह से अस्वीकार किए जाने की जानकारी देता है. फ़िलहाल, इस मैसेज में कोई जानकारी नहीं है. आने वाले समय में, नए फ़ील्ड जोड़े जा सकते हैं.
LivenessCheckFailure
इस टाइप के लिए कोई फ़ील्ड नहीं है.
यह ऑब्जेक्ट, लाइवनेस की जांच में फ़ेल होने की वजह से अस्वीकार किए जाने की जानकारी देता है. फ़िलहाल, इस मैसेज में कोई जानकारी नहीं है. आने वाले समय में, नए फ़ील्ड जोड़े जा सकते हैं.
चुनौती भरा
यह एक ऐसा ऑब्जेक्ट है जो चुनौती दी गई पुष्टि की स्थिति को दिखाता है.
| JSON के काेड में दिखाना |
|---|
{ "challengeDescription": string, // Union field |
| फ़ील्ड | |
|---|---|
challengeDescription |
सहायता टीम के सदस्यों के लिए, समस्या के बारे में जानकारी, ताकि वे समस्या को डीबग कर सकें. ध्यान दें कि यह जानकारी लोगों को कभी नहीं दिखाई जाती. इसमें ब्यौरे वाला ऐसा टेक्स्ट शामिल हो सकता है जिसमें संवेदनशील जानकारी न हो. इसका इस्तेमाल डीबग करने के लिए किया जाता है. चेतावनी: इस मैसेज में, व्यक्तिगत पहचान से जुड़ी कोई जानकारी शामिल न करें. |
यूनियन फ़ील्ड challenge. यह एक ऐसा विकल्प है जिसमें उपयोगकर्ता को कई तरह की चुनौतियों में से किसी एक को पूरा करना होता है. challenge इनमें से सिर्फ़ एक हो सकता है: |
|
physicalLocationVisit |
ऐसा चैलेंज जिसमें किसी व्यक्ति को चैलेंज पूरा करने के लिए, किसी जगह पर जाना होता है. जैसे, कार्ड जारी करने वाली कंपनी के ऑफ़िस. |
issuerUrlVisit |
यह एक चुनौती वाला विकल्प है. इसमें उपयोगकर्ता को, जारी करने वाले व्यक्ति या कंपनी की ओर से दिए गए यूआरएल पर जाना होता है. साथ ही, उस यूआरएल पर चुनौती पूरी करनी होती है. |
additionalTimeRequired |
चैलेंज का विकल्प, जिसमें इस सबूत की समीक्षा करने के लिए कुछ और समय की ज़रूरत होती है. |
PhysicalLocationVisit
इस टाइप के लिए कोई फ़ील्ड नहीं है.
यह ऑब्जेक्ट, चैलेंज के विकल्प को दिखाता है. इसमें किसी व्यक्ति को चैलेंज पूरा करने के लिए, किसी जगह पर जाना होता है. जैसे, कार्ड जारी करने वाली कंपनी का ऑफ़िस. यह चैलेंज, Google के दायरे से बाहर है. सुरक्षा की वजह से, अगर जारी करने वाला व्यक्ति या कंपनी इस तरह के चैलेंज को स्वीकार करती है, तो उसे Google को ऑनबोर्डिंग के दौरान लोकेशन की जानकारी देनी होगी.
IssuerUrlVisit
इस टाइप के लिए कोई फ़ील्ड नहीं है.
यह ऑब्जेक्ट, चुनौती के विकल्प को दिखाता है. इसमें उपयोगकर्ता को जारी करने वाले व्यक्ति या कंपनी की ओर से दिए गए यूआरएल पर जाना होता है. साथ ही, उस यूआरएल पर चुनौती पूरी करनी होती है. यह चैलेंज, Google के दायरे से बाहर है. सुरक्षा की वजह से, अगर जारी करने वाली कंपनी इस तरह के चैलेंज का इस्तेमाल करती है, तो उसे शामिल होने के दौरान Google को यूआरएल देना होगा.
AdditionalTimeRequired
यह एक ऑब्जेक्ट है, जो चुनौती के विकल्प को दिखाता है. इसमें पुष्टि करने के लिए ज़्यादा समय की ज़रूरत होती है. पूरा होने का अनुमानित समय बताना ज़रूरी नहीं है.
| JSON के काेड में दिखाना |
|---|
{ "estimatedCompletion": string } |
| फ़ील्ड | |
|---|---|
estimatedCompletion |
अनुमानित समय, जब प्रूफिंग पूरी हो जाएगी. अगर उपलब्ध हो, तो समीक्षा करें. यह टाइमस्टैंप फ़ॉर्मैट में होता है. इसे यूनिक्स टाइमस्टैंप के बाद से मिलीसेकंड की संख्या के तौर पर दिखाया जाता है. |
रद्द किया गया
इस टाइप के लिए कोई फ़ील्ड नहीं है.
यह ऑब्जेक्ट, रद्द की गई प्रूफिंग की स्थिति को दिखाता है. फ़िलहाल, इस मैसेज में कोई जानकारी नहीं है. आने वाले समय में, नए फ़ील्ड जोड़े जा सकते हैं.
रद्द की गई
इस टाइप के लिए कोई फ़ील्ड नहीं है.
यह एक ऐसा ऑब्जेक्ट है जो पुष्टि की स्थिति को रद्द किए जाने की जानकारी देता है. फ़िलहाल, इस मैसेज में कोई जानकारी नहीं है. आने वाले समय में, नए फ़ील्ड जोड़े जा सकते हैं.
समयसीमा खत्म हो गई है
इस टाइप के लिए कोई फ़ील्ड नहीं है.
यह एक ऐसा ऑब्जेक्ट है जो पुष्टि करने की समयसीमा खत्म होने की स्थिति को दिखाता है. फ़िलहाल, इस मैसेज में कोई जानकारी नहीं है. आने वाले समय में, नए फ़ील्ड जोड़े जा सकते हैं.