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

प्रक्रिया बनाएं

यह endpoint दो use case को संभालता है जो एक ही path साझा करते हैं लेकिन body पैरामीटर, क्षमताओं और प्रतिक्रिया फ़ील्ड में भिन्न हैं:

  • ऑनबोर्डिंग — Unico के पहचान आधार के विरुद्ध उनका चेहरा तुलना करके यह सत्यापित करता है कि उपयोगकर्ता कौन है (subject.code आवश्यक)।
  • Transactional — पिछली प्रक्रिया से चेहरे की तुलना करके यह सत्यापित करता है कि यह वही व्यक्ति है (referenceProcessId OR selfie / process id के साथ references array आवश्यक)।

सक्रिय use case request header में भेजी गई APIKEY द्वारा निर्धारित होता है।

संपूर्ण एकीकरण प्रवाह के लिए, API अवलोकन देखें।

Endpoint​

वातावरणURL
ProductionPOST https://api.id.unico.app/processes/v1
SandboxPOST https://api.id.uat.unico.app/processes/v1

अनुरोध​

Headers
HeaderValue
AuthorizationBearer <access_token> (Authentication देखें)
APIKEYप्रावधानित API key — सक्रिय use case और सक्षम capabilities को परिभाषित करता है।
Content-Typeapplication/json
Body parameters
FieldTypeRequiredविवरण
subject.codestringyesCPF (BR) या CURP (MX)।
subject.namestringyesपूरा नाम।
subject.genderstringnoM या F।
subject.birthDatestring (ISO 8601)noजन्म तिथि (YYYY-MM-DD)।
subject.emailstringnoईमेल पता।
subject.phonestringnoE.164 phone number।
useCasestringnoOperation context, जैसे Onboarding।
imageBase64stringyesआपके front-end द्वारा capture की गई selfie, base64 में।
इमेज आवश्यकताएं
  • न्यूनतम resolution: 640 × 480 (HD standard)
  • अधिकतम फ़ाइल आकार: 800 KB (JPEG92 compression अनुशंसित)
  • स्वीकृत formats: PNG, JPEG, WebP
  • SDK के JWT token 10 मिनट के बाद expire हो जाते हैं और केवल एक बार उपयोग किए जा सकते हैं

उदाहरण​

curl -X POST https://api.id.unico.app/processes/v1 \
  -H "Authorization: Bearer $TOKEN" \
  -H "APIKEY: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": {
      "code": "12345678909",
      "name": "Luke Skywalker",
      "gender": "M",
      "birthDate": "2000-05-20",
      "email": "[email protected]",
      "phone": "5519725570707"
    },
    "useCase": "Onboarding",
    "imageBase64": "/9j/4AAQSkZJR..."
  }'

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

200 OK
{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": { "result": "yes" },
  "identityFraudsters": { "result": "inconclusive" },
  "government": { "serpro": 87 },
  "liveness": 1
}
FieldTypeविवरण
idstring (UUID)Process identifier। पुनः-क्वेरी के लिए Get Process के साथ उपयोग करें।
statusinteger1 (processing), 3 (सफलतापूर्वक समाप्त), 5 (त्रुटि)। सभी संभावित values के लिए, Get Process देखें।
unicoId.resultstringyes, no, inconclusive — पहचान सत्यापन देखें।
identityFraudsters.resultstringyes, inconclusive — धोखाधड़ी जोखिम वर्गीकरण देखें।
government.serprointegerSerpro similarity score (0–100, -1, -2)। सेर्प्रो समानता रिटर्न देखें।
livenessinteger1 (passed), 2 (failed) — लाइवनेस देखें।
जानकारी

जब unicoId.result = inconclusive और धोखाधड़ी जोखिम वर्गीकरण orchestration सक्रिय हो, तो प्रक्रिया status: 1 (processing) लौटा सकती है। अंतिम परिणाम प्राप्त करने के लिए Get Process को poll करें या webhooks का उपयोग करें।

400 Bad Request

Payload विकृत है, image अमान्य है, या आवश्यक fields अनुपस्थित हैं। नीचे त्रुटि कोड देखें।

403 Forbidden

Bearer token या APIKEY अनुपस्थित, expired, या अमान्य है। Authentication देखें।

409 Conflict

प्रदान किया गया processId इस टेनेंट के लिए पहले से मौजूद है। नीचे त्रुटि कोड देखें।

429 Too Many Requests

Rate limit पहुंच गई। Retry-After response header में दर्शाए गए अंतराल के बाद पुनः प्रयास करें। Rate limits देखें।

त्रुटि कोड​

कोडसंदेशविवरण
20900O base64 informado não é válido.base64 पैरामीटर अमान्य है। संभावित कारण: यह छवि नहीं है या injection का प्रयास है।
20807A imagem precisa estar no padrão HD ou possuir uma resolução superior a 640 x 480.अपलोड की गई छवि का रिज़ॉल्यूशन बहुत कम है।
20513The referenced process was not found.referenceProcessId एक ऐसी प्रक्रिया की ओर इंगित करता है जो मौजूद नहीं है या अब उपलब्ध नहीं है।
20512The referenced process is not available for reuse.संदर्भित प्रक्रिया मौजूद है लेकिन पुन:उपयोग के लिए उपलब्ध नहीं है।
20509The subject.name field is invalid.subject.name में अमान्य वर्ण हैं।
20508The subject.gender field is invalid.subject.gender का मान M या F होना चाहिए।
20507O parâmetro subject.code é inválido.गैर-मानक या अस्तित्वहीन CPF।
20506O base64 informado é muito grande. O tamanho máximo suportado é até 800kb.छवि आकार 800 KB से अधिक है; JPEG92 में संपीड़ित करें।
20505O base64 informado não é suportado. Os formatos aceitos são png, jpeg e webp.base64 प्रारूप अमान्य या असमर्थित है।
20065The referenceProcessId field is invalid.referenceProcessId वैध UUID नहीं है।
20062The useCase field is invalid.useCase फ़ील्ड में अपरिचित मान।
20024The referenceProcessId field is missing.referenceProcessId पैरामीटर प्रदान नहीं किया गया और references को विकल्प के रूप में नहीं भेजा गया।
20021The subject.phone field is invalid.subject.phone प्रारूप अमान्य (IDD + area code + number, 13 वर्ण)।
20019The subject.birthDate field is invalid.subject.birthDate ISO 8601 प्रारूप (YYYY-MM-DD) से बाहर है।
20009O parâmetro imagebase64 não foi informado.selfie छवि पैरामीटर अनुपस्थित।
20008The subject.email field is invalid.subject.email में अमान्य ईमेल प्रारूप।
20006O parâmetro subject.name não foi informado.subject.name पैरामीटर अनुपस्थित।
20005O parâmetro subject.code não foi informado.subject.code पैरामीटर अनुपस्थित।
20004O parâmetro subject não foi informado.subject पैरामीटर अनुपस्थित।
20003The request body is missing or invalid.Null या अमान्य payload।
20002O parâmetro APIKey não foi informado.APIKEY पैरामीटर अनुरोध header से अनुपस्थित।
20001O parâmetro authtoken não foi informado.integration token पैरामीटर अनुरोध header से अनुपस्थित।
10508The JWT with the captured face has already been used.JWT केवल एक बार उपयोग किया जा सकता है।
10507The JWT with the captured face is expired.JWT समाप्त हो गया; 10 मिनट के भीतर भेजना होगा।
10506The imageBase64 field is not a valid JWT from SDK.imageBase64 SDK द्वारा उत्पन्न वैध JWT नहीं है।

आगे क्या है​

  • किसी ऑनबोर्डिंग प्रक्रिया के परिणाम को query करने के लिए, Get Process देखें।
  • Document और आयु सत्यापन operations के लिए, इस अनुभाग के संबंधित पृष्ठ देखें।
अंतिम अपडेट को