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

चेतावनी

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

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

Endpoint

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

अनुरोध (Request)

Headers

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

Path parameters

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

उदाहरण (Example)

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

{
  "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
}

प्रतिक्रिया फ़ील्ड आपकी APIKey पर निर्भर करते हैं

ऊपर दिया गया उदाहरण सभी संभावित capability फ़ील्ड दिखाता है। आपकी वास्तविक प्रतिक्रिया में केवल वे फ़ील्ड शामिल होंगे जो आपकी APIKey कॉन्फ़िगरेशन में सक्षम capabilities के लिए हैं — अक्षम capabilities के फ़ील्ड पूरी तरह से छोड़ दिए जाते हैं। capabilities को सक्षम करने या समायोजित करने के लिए अपने Unico प्रोजेक्ट मैनेजर से संपर्क करें।

फ़ील्ड	प्रकार	विवरण
id	string (UUID)	प्रक्रिया पहचानकर्ता।
status	integer	1 (processing), 2 (divergence), 3 (finished with success), 4 (canceled), 5 (error).
unicoId.result	string	yes, no, inconclusive — पहचान सत्यापन देखें।
riskLevel.result	string	not_approved, critical_risk, high_risk, inconclusive — धोखाधड़ी जोखिम वर्गीकरण देखें।
idFace.result	string	FOUND, NOT_FOUND — Face Identifier देखें।
idFace.personId	string	चेहरे के लिए स्थिर अपारदर्शी पहचानकर्ता। केवल तभी मौजूद होता है जब idFace.result = FOUND।
identityFraudsters.result	string	बहिष्कृत. इसके बजाय riskLevel का उपयोग करें। जारी एकीकरण वाले ग्राहक प्रोजेक्ट टीम के साथ माइग्रेशन का समन्वय करते हुए इसका उपयोग जारी रख सकते हैं।
government.serpro	integer	Serpro समानता स्कोर (0–100, -1, -2)। केवल ब्राज़ील में उपलब्ध। सेर्प्रो समानता रिटर्न देखें।
liveness	integer	1 (passed), 2 (failed) — लाइवनेस देखें।
score	integer	संभाव्यता जोखिम स्कोर। तब मौजूद जब 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)

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 लौटाती है।

500 Internal Server Error

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