प्रोसेस बनाएं
यह हर Unico API इंटीग्रेशन का एंट्री पॉइंट है। आपका बैकएंड इसे कॉल करक े एक प्रोसेस बनाता है; आपका फ्रंटएंड लौटाए गए टोकन का उपयोग iFrame को रेंडर करने, यूज़र को रीडायरेक्ट करने, या किसी नेटिव SDK को इनिशियलाइज़ करने के लिए करता है।
पूरे इंटीग्रेशन फ़्लो के लिए, देखें Flows।
Endpoint
| Environment | URL |
|---|---|
| Production | POST https://api.idcloud.unico.app/client/v1/process |
| Sandbox | POST https://api.idcloud.uat.unico.app/client/v1/process |
Request
| Header | Value |
|---|---|
Authorization | Bearer <access_token> (देखें Authentication) |
Content-Type | application/json |
कोई field ज़रूरी है, वैकल्पिक है, या लागू नहीं होती — यह उस flow पर निर्भर करता है जिसे आप इंटीग्रेट कर रहे हैं — केवल इस टेबल से किसी field की आवश्यकता मानने से पहले, आपके इस्तेमाल की जा रही विशेष रेसिपी के लिए Flows देखें।
| Field | Type | Description |
|---|---|---|
callbackUri | string | वह URL जिस पर जर्नी खत्म होने के बाद यूज़र को रीडायरेक्ट किया जाता है। नेटिव SDK फ़्लो के लिए / इस्तेमाल करें, जहाँ कॉलबैक ऐप के भीतर हैंडल होता है। |
flow | string | Flow आइडेंटिफ़ायर — यह तय करता है कि कौन-सी क्षमताएँ चलती हैं। उदाहरण: idunicodocs, idunicosign, idchecktrust, idtoken, idsmart। देखें Available flows। |
purpose | string | बिज़नेस उद्देश्य। स्वीकृत वैल्यू: creditprocess, biometryonboarding, carpurchase, ageverification। |
person.duiType | enum | दस्तावेज़ प्रकार। नीचे duiType values देखें। |
person.duiValue | string | दस्तावेज़ नंबर, बिना फ़ॉर्मेटिंग के। |
person.friendlyName | string | जर्नी UI में दिखाया जाने वाला यूज़र का डिस्प्ले नाम। अधिकतम 50 वर्ण। |
person.phone | string | DDI + DDD + नंबर फ़ॉर्मेट में फ़ोन नंबर, बिना सेपरेटर के। SMS या WhatsApp के ज़रिए नोटिफ़िकेशन भेजने पर ज़रूरी। |
person.email | string | ईमेल पता। Electronic Signature वाले फ़्लो के लिए ज़रूरी। |
person.notifications | array | जर्नी लिंक भेजने के लिए नोटिफ़िकेशन चैनल। हर आइटम में notificationChannel होता है: NOTIFICATION_CHANNEL_WHATSAPP, NOTIFICATION_CHANNEL_SMS, या NOTIFICATION_CHANNEL_EMAIL। |
references | array | 1:1 सत्यापन और स्मार्ट पुनर्सत्यापन फ़्लो के लिए रेफ़रेंस इनपुट। हर आइटम में referenceType (REFERENCE_TYPE_IMAGE_BASE64, REFERENCE_TYPE_PROCESS_ID या REFERENCE_TYPE_HUMAN_TOKEN) और referenceContent (base64-एन्कोडेड इमेज, प्रोसेस UUID या humanToken वैल्यू) होता है। REFERENCE_TYPE_HUMAN_TOKEN उसी अकाउंट के लिए Human Token द्वारा लौटाया गया humanToken लेता है। अज्ञात humanToken, या किसी दूसरे अकाउंट को जारी किया गया humanToken, त्रुटि के बजाय नकारात्मक 1:1 सत्यापन परिणाम लौटाता है। अधिकतम एक ही आइटम भेजें — इससे लंबे array को 400 के साथ रिजेक्ट कर दिया जाता है, और referenceContent खाली नहीं होना चाहिए। |
useCase | string | स्मार्ट पुनर्सत्यापन सिनैरियो। 🇧🇷 idsmart, idsmart_r2, idsmart_tp1 के लिए ज़रूरी। उदाहरण: USE_CASE_LOGIN, USE_CASE_FIN_TRANSACTIONS। |
clientReference | string | आपके सिस्टम में यूज़र का यूनीक आइडेंटिफ़ायर। Multi Accounts क्षमता के लिए ज़रूरी। आपके बेस में यूनीक, अधिकतम 256 वर्ण, कोई स्पेस नहीं। |
companyBranchId | string (UUID) | Branch ID। केवल तब ज़रूरी है जब सर्विस अकाउंट से एक से ज़्यादा branch जुड़ी हों। |
expiresIn | string | बनने के बाद प्रोसेस की वैलिडिटी विंडो। फ़ॉर्मेट: "3600s"। छोड़ने पर डिफ़ॉल्ट रूप से 7 दिन। |
flowConfig | object | Per-flow कॉन्फ़िगरेशन ओवरराइड। |
flowConfig.biometryCapture.enabledBackCamera | boolean | डिवाइस के रियर कैमरे का उपयोग करें। दस्तावेज़ कैप्चर या Electronic Signature फ़्लो के साथ कम्पैटिबल नहीं है। |
contextualization | object | जर्नी के दौरान यूज़र को दिखाया जाने वाला ट्रांज़ैक्शन संदर्भ, जो कैप्चर को समझाता है। किसी भी क्षेत्र के क्लाइंट्स के लिए उपलब्ध — किसी विशिष्ट देश तक सीमित नहीं। |
contextualization.company_name | string | जर्नी के दौरान दिखाया जाने वाला कंपनी का नाम। अधिकतम 20 वर्ण। |
contextualization.currency | string | यूज़र को दिखाया जाने वाला करेंसी कोड। स्वीकृत वैल्यू: BRL, MXN, USD। |
contextualization.price | number | यूज़र को दिखाई जाने वाली ट्रांज़ैक्शन राशि। |
contextualization.locale | object | जर्नी के दौरान दिखाया जाने वाला लोकलाइज़्ड टेक्स्ट। Key: ptBr, enUs, esMx — ये टेक्स्ट के लिए समर्थित एकमात्र भाषाएं हैं, चाहे क्लाइंट का क्षेत्र कोई भी हो। |
contextualization.locale.{ptBr|enUs|esMx}.reason | string | जर्नी के दौरान दिखाया जाने वाला कैप्चर का संक्षिप्त कारण। अधिकतम 50 वर्ण। |
contextualization.locale.{ptBr|enUs|esMx}.title | string | जर्नी के दौरान दिखाई जाने वाली कस्टमर नोटिस का टाइटल। अधिकतम 100 वर्ण। text के साथ मिलकर देना ज़रूरी है। HTML टैग हटा दिए जाते हैं। |
contextualization.locale.{ptBr|enUs|esMx}.text | string | जर्नी के दौरान दिखाई जाने वाली कस्टमर नोटिस का मुख्य टेक्स्ट। अधिकतम 210 वर्ण। title के साथ मिलकर देना ज़रूरी है। HTML टैग हटा दिए जाते हैं। |
imageBase64 | string | सेल्फी, सीधे भेजी गई। SDK के कैप्चर JWT को स्वीकार करता है। |
document.purpose | enum | दस्तावेज़ किसलिए है। फ़िक्स्ड वोकैबुलरी: DOCUMENT_PURPOSE_ONBOARDING, DOCUMENT_PURPOSE_CREDIT_PROCESS, DOCUMENT_PURPOSE_CAR_PURCHASE, DOCUMENT_PURPOSE_PAY_BY_PAYCHECK, DOCUMENT_PURPOSE_FGTS। केवल Face Document Match फ़्लो के साथ इस्तेमाल होता है। |
document.files[].data | bytes | नया दस्तावेज़ कैप्चर: दस्तावेज़ के प्रत्येक पक्ष या पेज के लिए एक base64-एन्कोडेड फ़ाइल, इमेज या PDF के रूप में, प्रत्येक अधिकतम 16 MB। पहले फ़्रंट भेजें; पहली फ़ाइल को फ़्रंट माना जाता है। वैश्विक स्तर पर उपलब्ध, ब्राज़ील तक सीमित नहीं। document.documentId के साथ म्यूचुअली एक्सक्लूसिव है। |
document.documentId | string (UUID) | नए कैप्चर के बजाय, उसी व्यक्ति द्वारा पहले कैप्चर किए गए दस्तावेज़ को रीयूज़ करता है। document.files[] के साथ म्यूचुअली एक्सक्लूसिव है। |
expectedResult | object | टेस्ट/sandbox एनवायरनमेंट में किसी क्षमता के रिज़ल्ट को मॉक करता है और रिस्पॉन्स को simulated: true के साथ चिह्नित करता है। देखें Simulating Results (Test Mock)। |
duiType मान
| देश | मान | विवरण |
|---|---|---|
| AR | DUI_TYPE_AR_PASSPORT | अर्जेंटीना पासपोर्ट |
| AR | DUI_TYPE_AR_DNI | अर्जेंटीना DNI |
| AR | DUI_TYPE_AR_LNC | अर्जेंटीना ड्राइविंग लाइसेंस (Licencia Nacional de Conducir) |
| AT | DUI_TYPE_AT_STNR | ऑस्ट्रियाई टैक्स नंबर (STNR) |
| BE | DUI_TYPE_BE_NN | बेल्जियन नेशनल नंबर (NN) |
| BR | DUI_TYPE_BR_CPF | ब्राज़ीलियाई CPF |
| BR | DUI_TYPE_BR_PASSPORT | ब्राज़ीलियाई पासपोर्ट |
| BR | DUI_TYPE_BR_CNPJ | ब्राज़ीलियाई CNPJ |
| CA | DUI_TYPE_CA_SIN | कनाडाई SIN |
| CH | DUI_TYPE_CH_AHV | स्विस AHV/AVS नंबर |
| CL | DUI_TYPE_CL_RUN | चिली RUN |
| CL | DUI_TYPE_CL_PASSPORT | चिली पासपोर्ट |
| CL | DUI_TYPE_CL_LICENCIA_CONDUCIR | चिली ड्राइविंग लाइसेंस (Licencia de Conducir) |
| CO | DUI_TYPE_CO_NIT | कोलंबियाई NIT |
| CO | DUI_TYPE_CO_PASSPORT | कोलंबियाई पासपोर्ट |
| CO | DUI_TYPE_CO_LICENCIA_CONDUCCION | कोलंबियाई ड्राइविंग लाइसेंस (Licencia de Conducción) |
| CO | DUI_TYPE_CO_CC | कोलंबियाई सिटिज़नशिप कार्ड (Cédula de Ciudadanía) |
| DE | DUI_TYPE_DE_IDNR | जर्मन टैक्स आइडेंटिफिकेशन नंबर (IdNr) |
| DK | DUI_TYPE_DK_CPR | डेनिश CPR |
| EC | DUI_TYPE_EC_NI | इक्वाडोर NI |
| ES | DUI_TYPE_ES_NIE | स्पैनिश फ़ॉरेनर आइडेंटिटी नंबर (NIE) |
| ES | DUI_TYPE_ES_DNI | स्पैनिश नेशनल आइडेंटिटी डॉक्यूमेंट (DNI) |
| FI | DUI_TYPE_FI_HETU | फ़िनिश पर्सनल आइडेंटिटी कोड (HETU) |
| FR | DUI_TYPE_FR_SPI | फ़्रेंच टैक्स रेफ़रेंस नंबर (SPI) |
| GB | DUI_TYPE_GB_NINO | ब्रिटिश नेशनल इंश्योरेंस नंबर (NINO) |
| GT | DUI_TYPE_GT_CUI | ग्वाटेमाला CUI |
| ID | DUI_TYPE_ID_NIK | इंडोनेशियाई NIK |
| IE | DUI_TYPE_IE_PPSN | आयरिश पर्सनल पब्लिक सर्व िस नंबर (PPSN) |
| IT | DUI_TYPE_IT_CF | इटालियन Codice Fiscale (CF) |
| LK | DUI_TYPE_LK_NIC | श्रीलंका NIC |
| LU | DUI_TYPE_LU_MATRICULE | लक्ज़मबर्ग नेशनल आइडेंटिफिकेशन नंबर (Matricule) |
| MX | DUI_TYPE_MX_CURP | मैक्सिकन CURP |
| MX | DUI_TYPE_MX_RFC_PERSONA_FISICA | मैक्सिकन RFC (Persona Física) |
| MX | DUI_TYPE_MX_LICENCIA_CONDUCIR | मैक्सिकन ड्राइविंग लाइसेंस (Licencia de Conducir) |
| NG | DUI_TYPE_NG_NIN | नाइजीरियाई NIN |
| NG | DUI_TYPE_NG_BVN | नाइजीरियाई बैंक सत्यापन संख्या (BVN) |
| NG | DUI_TYPE_NG_BVN_TOKEN | नाइजीरियाई BVN टोकन (hashed) |
| NG | DUI_TYPE_NG_NIN_TOKEN | नाइजीरियाई NIN टो कन (hashed) |
| NL | DUI_TYPE_NL_BSN | डच सिटीज़न सर्विस नंबर (BSN) |
| NO | DUI_TYPE_NO_FNR | नॉर्वेजियन नेशनल आइडेंटिटी नंबर (Fødselsnummer) |
| PE | DUI_TYPE_PE_RUC | पेरू RUC |
| PE | DUI_TYPE_PE_DNI | पेरू DNI |
| PE | DUI_TYPE_PE_PASSPORT | पेरू पासपोर्ट |
| PL | DUI_TYPE_PL_PESEL | पोलिश PESEL |
| PT | DUI_TYPE_PT_NIF | पुर्तगाली टैक्स आइडेंटिफिकेशन नंबर (NIF) |
| SE | DUI_TYPE_SE_PNR | स्वीडिश पर्सनल नंबर (PNR) |
| SE | DUI_TYPE_SE_SAMORDNINGSNUMMER | स्वीडिश कोऑर्डिनेशन नंबर (Samordningsnummer) |
| TR | DUI_TYPE_TR_TCKN | तुर्की पहचान संख्या (TCKN) |
| US | DUI_TYPE_US_SSN | संयुक्त राज्य अमेरिका SSN |
| US | DUI_TYPE_US_PASSPORT | संयुक्त राज्य अमेरिका पासपोर्ट |
| US | DUI_TYPE_US_DRIVER_LICENSE | संयुक्त राज्य अमेरिका ड्राइविंग लाइसेंस |
| US | DUI_TYPE_US_PASSPORT_CARD | संयुक्त राज्य अमेरिका पासपोर्ट कार्ड |
| US | DUI_TYPE_US_POLYCARBONATE_PASSPORT | संयुक्त राज्य अमेरिका पॉलीकार्बोनेट पासपोर्ट |
| US | DUI_TYPE_US_ID_CARD | संयुक्त राज्य अमेरिका आईडी कार्ड |
| UY | DUI_TYPE_UY_CI | उरुग्वे CI |
| ZZ | DUI_TYPE_ZZ_EMAIL | ईमेल पता |
| ZZ | DUI_TYPE_ZZ_PHONE_NUMBER | फ़ोन नंबर |
जब flow वैकल्पिक दस्तावेज़ की अनुमति देता है, तो आप person.duiType और person.duiValue को छोड़ सकते हैं। कैप्चर के बाद, प्रोसेस PROCESS_STATE_AWAITING_FOR_DOCUMENT में तब तक प्रतीक्षा करती है जब तक आपका बैकएंड प्रोसेस दस्तावेज़ सेट करें के ज़रिए दस्तावेज़ नहीं भेज देता।
Example
- cURL
- Node.js
curl -X POST https://api.idcloud.unico.app/client/v1/process \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"flow": "idunicodocs_r2",
"purpose": "biometryonboarding",
"clientReference": "pedido-88216",
"callbackUri": "https://your-app.example.com/onboarding/callback",
"person": {
"duiType": "DUI_TYPE_BR_CPF",
"duiValue": "12345678909"
}
}'
import fetch from 'node-fetch';
const res = await fetch('https://api.idcloud.unico.app/client/v1/process', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.UNICO_ACCESS_TOKEN}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
flow: 'idunicodocs_r2',
purpose: 'biometryonboarding',
clientReference: 'pedido-88216',
callbackUri: 'https://your-app.example.com/onboarding/callback',
person: {
duiType: 'DUI_TYPE_BR_CPF',
duiValue: '12345678909',
},
}),
});
const { process: proc } = await res.json();
// proc.userRedirectUrl, proc.token, proc.webAppToken
Responses
{
"process": {
"id": "b7c1f0a2-63d4-4f3e-9a17-2c8e5d41b0aa",
"flow": "idunicodocs_r2",
"state": "PROCESS_STATE_CREATED",
"result": "PROCESS_RESULT_UNSPECIFIED",
"purpose": "biometryonboarding",
"clientReference": "pedido-88216",
"person": {
"duiType": "DUI_TYPE_BR_CPF",
"duiValue": "12345678909"
},
"capacities": [
"PROCESS_CAPACITY_IDLIVE",
"PROCESS_CAPACITY_IDUNICO",
"PROCESS_CAPACITY_IDDOCS"
],
"authenticationInfo": {
"authenticationId": ""
},
"companyData": {
"branchId": "",
"countryCode": "BRA"
},
"callbackUri": "https://your-app.example.com/onboarding/callback",
"userRedirectUrl": "https://cadastro.unico.app/flow?id=b7c1f0a2-63d4-4f3e-9a17-2c8e5d41b0aa",
"token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…",
"webAppToken": "eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiZGlyIn0…",
"simulated": false
}
}
| Field | Type | Description |
|---|---|---|
process.id | string (UUID) | प्रोसेस आइडेंटिफ़ायर। प्रोसेस प्राप्त करें के ज़रिए रिज़ल्ट प्राप्त करने के लिए इसका उपयोग करें। |
process.state | enum | PROCESS_STATE_CREATED — प्रोसेस बन गई है, जर्नी अभी शुरू नहीं हुई। PROCESS_STATE_FAILED — प्रोसेस बनाना असफल हुआ। |
process.result | enum | सत्यापन का परिणाम। केवल तब मौजूद होता है जब state = PROCESS_STATE_FINISHED हो — किसी दिए गए flow द्वारा लौटाए जा सकने वाले रिज़ल्ट वैल्यू के लिए Flows देखें। |
process.flow | string | बनते समय भेजा गया flow आइडेंटिफ़ायर। |
process.purpose | string | बनते समय भेजा गया बिज़नेस उद्देश्य। |
process.callbackUri | string | बनते समय भेजा गया कॉलबैक URI। |
process.clientReference | string | बनते समय भेजा गया आपका इंटरनल आइडेंटिफ़ायर। रिक्वेस्ट में दिए जाने पर ही मौजूद होता है। |
process.companyBranchId | string (UUID) | Branch ID। रिक्वेस्ट में दिए जाने पर ही मौजूद होता है। |
process.userRedirectUrl | string | यूज़र को रीडायरेक्ट करने के लिए URL (Web Redirect और iFrame इंटीग्रेशन)। इस URL में बदलाव न करें। |
process.token | string | Web SDK iFrame को इनिशियलाइज़ करने के लिए JWT। |
process.webAppToken | string | नेटिव SDK (Android, iOS, Flutter) को इनिशियलाइज़ करने के लिए JWT। |
process.createdAt | string (date-time) | प्रोसेस बनने का टाइमस्टैंप। |
process.expiresAt | string (date-time) | वह टाइमस्टैंप जिसके बाद प्रोसेस एक्सपायर हो जाती है और उसे पूरा नहीं किया जा सकता। |
process.capacities | array | इस प्रोसेस के लिए कॉन्फ़िगर की गई क्षमताएँ। |
process.authenticationInfo | object | प्रोसेस के लिए ऑथेंटिकेशन जानकारी (बनने के समय खाली)। |
process.person | object | बनते समय भेजे गए person ऑब्जेक्ट की प्रतिध्वनि (echo)। |
process.companyData.branchId | string (UUID) | प्रोसेस से जुड़ी Branch ID। |
process.companyData.countryCode | string | branch से जुड़ा country code (उदाहरण: BR, MX)। |
त्रुटि को ड
- 400 Bad Request
- 401 Unauthorized
- 403 Forbidden
- 404 Not Found
- 429 Too Many Requests
- 500 Internal Server Error
| Code | Message | Description |
|---|---|---|
3 | invalid flow | जब दिया गया flow मौजूद नहीं है। |
3 | invalid person: friendly name exceeds 50 characters. | जब friendly name 50 वर्ण से अधिक हो। |
3 | invalid purpose | जब दिया गया purpose अमान्य हो। |
3 | invalid callbackUri: unable to parse callbackUri: parse "": empty url, invalid callbackUri: url: | जब दिया गया callbackUri अमान्य हो। |
3 | invalid person: email required for notification channel NOTIFICATION_CHANNEL_EMAIL, invalid email address for notification channel NOTIFICATION_CHANNEL_EMAIL | जब दि या गया ईमेल अमान्य हो और email नोटिफ़िकेशन कॉन्फ़िगर हो। |
3 | invalid person: phone number required for notification channel NOTIFICATION_CHANNEL_WHATSAPP, phone number does not contain 13 chars for notification channel NOTIFICATION_CHANNEL_WHATSAPP | जब दिया गया फ़ोन नंबर अमान्य हो और SMS या WhatsApp नोटिफ़िकेशन कॉन्फ़िगर हो। |
3 | idnsv2/GetPublicID request error: rpc error: code = InvalidArgument desc = invalid dui value | जब दिया गया आइडेंटिफ़ायर (duiValue) अमान्य हो। |
3 | invalid expiresIn argument | जब expiresIn वैल्यू अमान्य हो। |
3 | invalid company_name argument in process contextualization, max length is 20 | जब contextualization.company_name 20 वर्ण से अधिक हो। |
3 | title and text must be provided together in process contexts | जब किसी locale में title या text में से केवल एक दिया गया हो। |
3 | invalid title argument in process contexts, max length is 100 | जब किसी locale का title 100 वर्ण से अधिक हो। |
3 | invalid text argument in process contexts, max length is 210 | जब किसी locale का text 210 वर्ण से अधिक हो। |
3 | invalid reason argument in process contexts, max length is 50 | जब किसी locale का reason 50 वर्ण से अधिक हो। |
3 | The references array must contain at most one element. | जब references में एक से ज़्यादा आइटम भेजे गए हों। |
3 | The references[].referenceContent field is missing. | जब referenceContent खाली हो। |
3 | The references[].referenceType field must be IMAGE_BASE64, PROCESS_ID, PERSON_ID or HUMAN_TOKEN. | जब referenceType सपोर्टेड वैल्यू में से कोई एक न हो। PERSON_ID, HUMAN_TOKEN का आंतरिक उपनाम है: HUMAN_TOKEN भेजें। |
3 | A reference is required for this flow. | जब flow को reference चाहिए और कोई नहीं भेजा गया। referenceType PROCESS_ID, IMAGE_BASE64 या HUMAN_TOKEN के साथ references[0] भेजें। |
9 | The referenceProcessId field is invalid. | जब reference प्रोसेस मौजूद नहीं है या रीयूज़ नहीं की जा सकती। आपके द्वारा भेजी गई field का नाम बताता है — अगर आपने वह भेजा है तो bioTokenId। |
3 | INVALID_IMAGE | जब इमेज वैध base64 न हो, या इंजेक्शन प्रयास जैसी लगे। |
3 | INVALID_DUI | जब दस्तावेज़ नंबर नॉन-स्टैंडर्ड हो या मौजूद न हो। |
3 | IMAGE_TOO_LARGE |