मुख्य सामग्री पर जाएं

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

चेतावनी

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

API contract में, POST /processes/v1 का रिस्पॉन्स पहले से ही अंतिम परिणाम है। यह endpoint पुनः-क्वेरी के लिए मौजूद है — उदाहरण के लिए, जब आपको किसी पहले सहेजी गई प्रक्रिया का निरीक्षण करना हो, या किसी पिछले लेनदेन का ऑडिट करना हो।

Endpoint

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

अनुरोध (Request)

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

उदाहरण (Example)

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

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

200 OK
{
"id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
"status": 3,
"unicoId": { "result": "yes" },
"identityFraudsters": { "result": "inconclusive" },
"government": { "serpro": 87 },
"liveness": 1
}
फ़ील्डप्रकारविवरण
idstring (UUID)प्रक्रिया पहचानकर्ता।
statusinteger1 (processing), 2 (divergence), 3 (finished with success), 4 (canceled), 5 (error).
unicoId.resultstringyes, no, inconclusiveपहचान सत्यापन देखें।
identityFraudsters.resultstringyes, inconclusiveजोखिम धोखाधड़ी वर्गीकरण देखें।
government.serprointegerSerpro समानता स्कोर (0–100, -1, -2)। Serpro समानता देखें।
livenessinteger1 (passed), 2 (failed) — Liveness देखें।
scoreintegerसंभाव्यता जोखिम स्कोर। तब मौजूद जब unicoId.result = inconclusive और जोखिम स्कोर ऑर्केस्ट्रेशन सक्रिय हो। सकारात्मक मान धारक होने की उच्च संभावना दर्शाते हैं; नकारात्मक मान उच्च जोखिम दर्शाते हैं।
400 Bad Request

processId path पैरामीटर अनुपस्थित या अमान्य है। नीचे त्रुटि कोड देखें।

403 Forbidden

Bearer token या APIKEY अनुपस्थित, समाप्त या अमान्य।

404 Not Found

processId मौजूद नहीं है या प्रमाणित tenant से संबंधित नहीं है।

410 Gone

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

429 Too Many Requests

दर सीमा पहुँच गई। Rate limits देखें।

500 Internal Server Error

अप्रत्याशित सर्वर त्रुटि।

इस 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 से अनुपस्थित है।