प्रक्रिया प्राप्त करेंGET

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

MarkdownChatGPTClaude

चेतावनी

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

Endpoint

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

अनुरोध

Headers

Header	मान
Authorization	Bearer <access_token>
APIKEY	प्रावधानित API key।

Path parameters

पैरामीटर	प्रकार	आवश्यक	विवरण
processId	string (UUID)	हाँ	प्रक्रिया बनाएं द्वारा लौटाया गया प्रक्रिया पहचानकर्ता।

उदाहरण

cURL

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

Node.js

import fetch from 'node-fetch';

const res = await fetch(
  `https://api.id.unico.app/processes/v1/${processId}`,
  {
    headers: {
      Authorization: `Bearer ${accessToken}`,
      APIKEY: apiKey
    }
  }
);
const result = await res.json();

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

200 OK

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

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

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "idCloud": {
    "result": "approved"
  }
}

फ़ील्ड	प्रकार	विवरण
id	string (UUID)	प्रक्रिया पहचानकर्ता।
status	integer	1 (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 जो परिणाम मान लौटा सकती है, उसके लिए प्रवाह देखें।

ब्राज़ील में क्लाइंट प्रति-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.result	string	yes, no, inconclusive — पहचान सत्यापन देखें।
riskLevel.result	string	not_approved, critical_risk, high_risk, inconclusive — धोखाधड़ी जोखिम वर्गीकरण देखें।
idFace.result	string	FOUND — फेस आइडेंटिफायर देखें।
idFace.personId	string	चेहरे के लिए स्थिर अपारदर्शी पहचानकर्ता, जो idFace.result = FOUND के साथ लौटाया जाता है। जब छवि में किसी चेहरे की पहचान नहीं की जा सकती, तो process idFace block के बजाय error 20532 लौटाता है।
identityFraudsters.result	string	बहिष्कृत। इसके बजाय riskLevel का उपयोग करें। जारी integrations वाले ग्राहक अपनी project team के साथ माइग्रेशन का समन्वय करते हुए इसका उपयोग जारी रख सकते हैं।
government.serpro	integer	Serpro समानता स्कोर (0–100, -1, -2)। केवल ब्राज़ील में उपलब्ध। सेर्प्रो समानता रिटर्न देखें।
liveness	integer	1 (passed), 2 (failed) — लाइवनेस देखें।
idAge.result	string	yes, no, inconclusive — आयु सत्यापन देखें। केवल ब्राज़ील में उपलब्ध।
score	integer	संभाव्यता जोखिम स्कोर। तब मौजूद जब unicoId.result = inconclusive और जोखिम स्कोर ऑर्केस्ट्रेशन सक्रिय हो। सकारात्मक मान धारक होने की उच्च संभावना दर्शाते हैं; नकारात्मक मान उच्च जोखिम दर्शाते हैं। केवल ब्राज़ील में उपलब्ध।
cardholderVerification.result	string	approved, unsure — Cardholder Verification देखें। जब तक status समाप्त (3) न हो, तब तक अनुपस्थित। केवल ब्राज़ील में उपलब्ध।

मेक्सिको में क्लाइंट 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": ""
  }
}

Field	Type	विवरण
idGov	object	CURP के लिए RENAPO रिकॉर्ड। capability सक्षम न होने पर अनुपस्थित। RENAPO के उत्तर न देने पर {}। केवल मेक्सिको में। RENAPO Verification देखें।

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

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

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

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

400 Bad Request

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

404 Not Found

कोड	संदेश	विवरण
50001	O processo informado não foi encontrado.	प्रक्रिया डेटाबेस में मौजूद नहीं है।

403 Forbidden

कोड	संदेश	विवरण
30017	User does not have permission to perform this action.	अविधिमान्य JWT या इस ऑपरेशन को करने की अनुमति के बिना उपयोगकर्ता।
10502	O token informado está expirado.	उपयोग किया गया access-token समाप्त हो गया है।
10501	O token informado é inválido.	authentication token अमान्य है।
10201	O AppKey informado é inválido.	APIKEY पैरामीटर दर्ज नहीं किया गया या मौजूद नहीं है।

410 Gone

प्रक्रिया मौजूद है लेकिन त्रुटि में समाप्त हुई। केवल id और status: 5 लौटाती है।

429 Too Many Requests

रेट लिमिट पूरी हो गई। जब आपका सिस्टम HTTP 429 त्रुटि प्राप्त करता है, तो आपको कैस्केडिंग विफलताओं को रोकने और प्रतिबंध को बढ़ने से बचाने के लिए तंत्र लागू करने होंगे।

सर्वोत्तम प्रथाएं:

• कूल-डाउन अवधि (backoff): अपने सिस्टम से आने वाले बाद के अनुरोधों को तुरंत रोकें या कम करें। विफल अनुरोधों को लगातार एक तंग लूप में पुनः प्रयास न करें।
• कतार और थ्रॉटलिंग (Queueing & throttling): ट्रैफ़िक प्रवाह को नियंत्रित करने के लिए अपनी तरफ से आउटगोइंग अनुरोधों को बफ़र या कतार में रखें और फिर उन्हें पुनः भेजें।
• एक्सपोनेंशियल बैकऑफ़ विद जिटर (Exponential backoff with jitter): पुनः प्रयास करते समय, प्रयासों के बीच प्रतीक्षा समय को तेजी से बढ़ाएं (उदा., 1 s, 2 s, 4 s, 8 s) और एक छोटा यादृच्छिक विलंब ("jitter") जोड़ें ताकि हर्ड इफ़ेक्ट से बचा जा सके जहां सभी कतार में रखे गए अनुरोध ठीक उसी मिलीसेकंड पर पुनः प्रयास करते हैं।

चेतावनी

बैकऑफ़ लागू किए बिना रेट-लिमिटेड एंडपॉइंट को लगातार हिट करना प्रतिबंध अवधि को बढ़ा सकता है और आपके सिस्टम के परिचालन थ्रूपुट को गंभीर रूप से प्रभावित कर सकता है। अपनी तरफ से अनुरोधों को ठीक से थ्रॉटल करना एक सहज और अधिक लचीला एकीकरण सुनिश्चित करता है।

डिफ़ॉल्ट सीमाओं, अनुरोध बढ़ाने और अतिरिक्त विवरण के लिए, देखें रेट लिमिट।

500 Internal Server Error

कोड	संदेश	विवरण
99999	Internal failure! Try again later	आंतरिक त्रुटि होने पर।

प्रवाह

एक 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 प्रोजेक्ट संपर्क से बात करें।