मुख्य सामग्री पर जाएं
प्रक्रिया प्राप्त करेंGET

अपने पहचानकर्ता द्वारा किसी मौजूदा प्रक्रिया को पुनः प्राप्त करें। API contract के अनुसार, परिणाम प्रक्रिया के निर्माण पर ही समकालिक रूप से लौटा दिया जाता है — पुनः-क्वेरी, ऑडिटिंग और सहायता के लिए इस endpoint का उपयोग करें।

MarkdownChatGPTClaude
चेतावनी

प्रक्रिया प्राप्त करने से पहले, हमारी webhook कॉन्फ़िगरेशन और fallback रणनीतियों की समीक्षा करें — यहाँ क्लिक करें.

Endpoint​

वातावरणURL
ProductionGET https://api.id.unico.app/processes/v1/{processId}
SandboxGET https://api.id.uat.unico.app/processes/v1/{processId}

अनुरोध​

Headers
Headerमान
AuthorizationBearer <access_token>
APIKEYप्रावधानित API key।
Path parameters
पैरामीटरप्रकारआवश्यकविवरण
processIdstring (UUID)हाँप्रक्रिया बनाएं द्वारा लौटाया गया प्रक्रिया पहचानकर्ता।

उदाहरण​

curl -X GET https://api.id.unico.app/processes/v1/$PROCESS_ID \
  -H "Authorization: Bearer $TOKEN" \
  -H "APIKEY: $API_KEY"

प्रतिक्रियाएं​

200 OK

Contract अद्वितीय है — idCloud.result फ़ील्ड में उपयोग की गई capabilities का समेकित निर्णय होता है।

Unico निष्पादित capabilities के परिणामों को एकल idCloud.result में समेकित करता है, जो आपके flow के अगले चरण को तय करने के लिए तैयार होता है — व्यक्तिगत परिणामों को व्यवस्थित करने की आवश्यकता के बिना।

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "idCloud": {
    "result": "approved"
  }
}
फ़ील्डप्रकारविवरण
idstring (UUID)प्रक्रिया पहचानकर्ता।
statusinteger1 (processing), 2 (divergence), 3 (finished with success), 4 (canceled), 5 (error).
Possible result values
idCloud.resultअर्थअनुशंसित कार्रवाई
approvedवास्तविक व्यक्ति और सत्यापित पहचान।flow के साथ आगे बढ़ें।
deniedपहचान सत्यापित नहीं हुई, लाइवनेस जाँच विफल रही, या अत्यधिक जोखिम की पहचान हुई।flow समाप्त करें या किसी वैकल्पिक flow पर रीडायरेक्ट करें।
critical-riskगंभीर जोखिम स्तर की पहचान हुई।flow समाप्त करें या मैन्युअल समीक्षा पर भेजें।
high-riskउच्च जोखिम स्तर की पहचान हुई।मैन्युअल समीक्षा या किसी वैकल्पिक flow पर भेजें।
retryमूल्यांकन के लिए अपर्याप्त कैप्चर या स्कोर।उपयोगकर्ता से नया कैप्चर माँगें।
inconclusiveनिर्णय के लिए पर्याप्त साक्ष्य नहीं।मैन्युअल समीक्षा या किसी वैकल्पिक flow पर भेजें।

लौटाए गए मान आपकी APIKey में configured recipe पर निर्भर करते हैं। प्रत्येक recipe जो परिणाम मान लौटा सकती है, उसके लिए प्रवाह देखें।

Brazilब्राज़ील में क्लाइंट प्रति-capability प्रतिक्रिया प्राप्त कर सकते हैं

समग्र प्रतिक्रिया संरचना वही रहती है — एकल परिणाम डिफ़ॉल्ट है।

ब्राज़ील में integrations प्रति-capability खुले परिणाम प्राप्त कर सकती हैं। APIKey में सक्षम प्रत्येक capability प्रतिक्रिया में अपना स्वयं का ब्लॉक जोड़ती है — अक्षम capabilities के फ़ील्ड पूरी तरह छोड़ दिए जाते हैं।

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": {
    "result": "yes"
  },
  "riskLevel": {
    "result": "inconclusive"
  },
  "idFace": {
    "personId": "a1b2c3d4e5f67890a1b2c3d4e5f67890a1b2c3d4e5f67890a1b2c3d4e5f67890",
    "result": "FOUND"
  },
  "identityFraudsters": {
    "result": "inconclusive"
  },
  "government": {
    "serpro": 87
  },
  "liveness": 1,
  "idAge": {
    "result": "yes"
  },
  "cardholderVerification": {
    "result": "approved"
  }
}
फ़ील्डप्रकारविवरण
unicoId.resultstringyes, no, inconclusive — पहचान सत्यापन देखें।
riskLevel.resultstringnot_approved, critical_risk, high_risk, inconclusive — धोखाधड़ी जोखिम वर्गीकरण देखें।
idFace.resultstringFOUND — फेस आइडेंटिफायर देखें।
idFace.personIdstringचेहरे के लिए स्थिर अपारदर्शी पहचानकर्ता, जो idFace.result = FOUND के साथ लौटाया जाता है। जब छवि में किसी चेहरे की पहचान नहीं की जा सकती, तो process idFace block के बजाय error 20532 लौटाता है।
identityFraudsters.resultstringबहिष्कृत। इसके बजाय riskLevel का उपयोग करें। जारी integrations वाले ग्राहक अपनी project team के साथ माइग्रेशन का समन्वय करते हुए इसका उपयोग जारी रख सकते हैं।
government.serprointegerSerpro समानता स्कोर (0–100, -1, -2)। केवल ब्राज़ील में उपलब्ध। सेर्प्रो समानता रिटर्न देखें।
livenessinteger1 (passed), 2 (failed) — लाइवनेस देखें।
idAge.resultstringyes, no, inconclusive — आयु सत्यापन देखें। केवल ब्राज़ील में उपलब्ध।
scoreintegerसंभाव्यता जोखिम स्कोर। तब मौजूद जब unicoId.result = inconclusive और जोखिम स्कोर ऑर्केस्ट्रेशन सक्रिय हो। सकारात्मक मान धारक होने की उच्च संभावना दर्शाते हैं; नकारात्मक मान उच्च जोखिम दर्शाते हैं। केवल ब्राज़ील में उपलब्ध।
cardholderVerification.resultstringapproved, unsure — Cardholder Verification देखें। जब तक status समाप्त (3) न हो, तब तक अनुपस्थित। केवल ब्राज़ील में उपलब्ध।
Mexicoमेक्सिको में क्लाइंट RENAPO Verification block प्राप्त कर सकते हैं

प्रतिक्रिया की संरचना वही रहती है और उसमें idGov block जुड़ जाता है।

RENAPO Verification सक्षम होने पर मेक्सिको में integrations को एक अतिरिक्त idGov block मिलता है, जिसमें उपयोगकर्ता के CURP के लिए RENAPO के पास मौजूद रिकॉर्ड होता है। यह पहचान परिणाम से एक अलग उत्तर है।

{
  "id": "11111111-2222-3333-4444-555555555555",
  "status": 3,
  "idCloud": { "result": "approved" },
  "idGov": {
    "government_valid": true,
    "curp": "PUEA880304MDFRJN04",
    "government_name": "ANA PRUEBA EJEMPLO",
    "date_of_birth": "1988-03-04",
    "age": 38,
    "gender": "F",
    "deceased": false,
    "is_mexican": true,
    "citizenship": "MEXICO",
    "state_of_birth": "Ciudad de México",
    "state_iso": "MX-CMX",
    "issuing_entity_code": "DF",
    "municipality_registration": ""
  }
}
FieldTypeविवरण
idGovobjectCURP के लिए RENAPO रिकॉर्ड। capability सक्षम न होने पर अनुपस्थित। RENAPO के उत्तर न देने पर {}। केवल मेक्सिको में। RENAPO Verification देखें।

इस endpoint का उपयोग कब करें​

API contract परिणाम समकालिक रूप से लौटाता है, इसलिए अधिकांश integrations को इस endpoint की आवश्यकता नहीं होती। इसका उपयोग करें जब:

  • आपने केवल processId सहेजा हो और बाद में पूरा परिणाम प्राप्त करना हो (ऑडिट, सहायता)।
  • आपको संदेह हो कि मूल प्रतिक्रिया ट्रांसमिशन में खो गई थी (प्लेटफ़ॉर्म का काम पूरा होने के बाद नेटवर्क त्रुटि)।
  • आप एक back-office टूल बना रहे हैं जो ऐतिहासिक प्रक्रियाओं की समीक्षा करता है।

त्रुटि कोड (Error Codes)​

कोडसंदेशविवरण
20023O parâmetro processId não foi informado.process id पैरामीटर अनुपस्थित है।
20002O parâmetro APIKey não foi informado.APIKEY पैरामीटर अनुरोध header से अनुपस्थित है।
20001O parâmetro authtoken não foi informado.integration token पैरामीटर अनुरोध header से अनुपस्थित है।

प्रवाह​

एक recipe capabilities (लाइवनेस, पहचान सत्यापन, जोखिम संकेत, दस्तावेज़...) का वह combination है जो आपके प्रोजेक्ट की APIKey में configured है। यह परिभाषित करता है कि Unico प्रत्येक प्रक्रिया में क्या निष्पादित करता है और परिणामों को एकल result में कैसे समेकित किया जाता है — आपको अपनी ओर से कुछ भी व्यवस्थित करने की आवश्यकता नहीं है।

Unico पूर्व-स्थापित recipes का एक catalog बनाए रखता है, जिनका नामकरण और version निर्धारण किया गया है (जैसे byunico-idlive-idunico-oneresponse-std)। कुछ केवल ब्राज़ील के लिए विशिष्ट हैं, जैसे कि वे जिनमें Score, Serpro, या आयु सत्यापन शामिल है।

आपकी प्रक्रिया कौन-सी capabilities चलाती है?

capabilities का combination — आपके प्रोजेक्ट का flow — आपकी APIKey configuration में परिभाषित है। पूर्व-स्थापित recipes जाँचें या इसे अनुकूलित करने के लिए अपने Unico प्रोजेक्ट संपर्क से बात करें।

अंतिम अपडेट को