अवलोकन
Contract चुनना
Contract का चुनाव इस बात का परिणाम है कि biometric capture कहाँ होती है — एक स्वतंत्र निर्णय नहीं। मार्गदर्शन के रूप में नीचे दी गई table का उपयोग करें।
| Contract | कब उपयोग करें… | Capture | Flow |
|---|---|---|---|
| Web & SDK | Capture journey Unico द्वारा host की जाती है (Web iFrame, Redirect, या native SDK) | Unico नियंत्रित | Process capture से पहले बनाई जाती है → उपयोगकर्ता journey से गुज़रता है → callback या polling के माध्यम से परिणाम लौटता है |
| API | आपकी application capture नियंत्रित करती है (Unico SDK के साथ या बिना) और call में सीधे छवि भेजती है | Client नियंत्रित | छवि process creation के साथ भेजी जाती है → परिणाम synchronously लौटता है |
Hosts और वातावरण
| Contract | Sandbox host | Production host |
|---|---|---|
| Web & SDK | https://api.idcloud.uat.unico.app | https://api.idcloud.unico.app |
| API | https://api.id.uat.unico.app | https://api.id.unico.app |
| OAuth2 / Token | https://identityhomolog.acesso.io | https://identity.acesso.io |
पूर्ण विवरण Environments में।
प्रमाणीकरण
सभी Unico contracts urn:ietf:params:oauth:grant-type:jwt-bearer के साथ OAuth2 के माध्यम से प्राप्त Bearer token (JWT) का उपयोग करते हैं।
पूर्ण विवरण Authentication में।
Contracts में Payload अंतर
एक ही conceptual operation ("identity verification process बनाएं") प्रत्येक contract में अलग दिखती है। Integrations के बीच migrate करते समय quick reference के रूप में नीचे दी गई tables का उपयोग करें।
Process creation
| पहलू | Web & SDK | API |
|---|---|---|
| Endpoint | POST /client/v1/process | POST /processes/v1 |
| Auth | Authorization: Bearer <jwt> | Authorization: Bearer <jwt> + APIKEY |
| छवि | नहीं भेजी (Unico की journey द्वारा capture) | imageBase64 के रूप में भेजी |
| उपयोगकर्ता पहचान | person.duiType + person.duiValue | subject.code (CPF / CURP) |
| दस्तावेज़ प्रकार | CPF, CURP, SSN, NIN, DNI, NIK | केवल CPF, CURP |
| Pipeline परिभाषा | flow (enum, 30+ मान) | APIKEY में implicit (capabilities) |
| Callback | callbackUri (user redirect) | कोई नहीं (synchronous) |
| Webhook | Webhook v1 (अंतिम परिणाम) | Webhook v1 (वैकल्पिक) |
| Journey URL लौटाता है | हाँ (userRedirectUrl) | नहीं |
| परिणाम | Async (GET poll या webhook) | Synchronous (प्रतिक्रिया में) |
| SDK token | हाँ (token, webAppToken) | नहीं |
Result retrieval
| पहलू | Web & SDK | API |
|---|---|---|
| Endpoint | GET /client/v1/process/\{id\} | GET /processes/v1/\{id\} (creation प्रतिक्रिया में भी) |
| Status | state + result (prefixed enums) | status (1, 3, 5) |
| परिणाम संरचना | process.authenticationInfo.{capability}Result के अंतर्गत nested | Flat: unicoId, liveness, government, identityFraudsters |
| दस्तावेज़ | services[].documents[] (OCR के साथ RG/CNH) | अलग endpoint (GET /processes/v1/\{id\}/document) |
आगे क्या
- Authentication — OAuth2 flow और JWT generation
- Environments — sandbox बनाम production
- Postman Collection — उपयोग के लिए तैयार collections
- Webhooks and Events — async result delivery
- SDKs and Tools — Web SDK, Android, iOS, Flutter