प्रोसेस बनाएं

MarkdownChatGPTClaude

यह हर 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

Headers

Header	Value
Authorization	Bearer <access_token> (देखें Authentication)
Content-Type	application/json

Body parameters

Field की आवश्यकताएँ flow पर निर्भर करती हैं

कोई 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) और referenceContent (base64-एन्कोडेड इमेज या प्रोसेस UUID) होता है। अधिकतम एक ही आइटम भेजें — इससे लंबे 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-एन्कोडेड। वैश्विक स्तर पर उपलब्ध, ब्राज़ील तक सीमित नहीं। 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 को छोड़ सकते हैं। कैप्चर के बाद, प्रोसेस AWAITING_FOR_DOCUMENT में तब तक प्रतीक्षा करती है जब तक आपका बैकएंड प्रोसेस दस्तावेज़ सेट करें के ज़रिए दस्तावेज़ नहीं भेज देता।

Example

cURL

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

Node.js

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

200 OK

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

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 or PROCESS_ID.	जब referenceType सपोर्टेड वैल्यू में से कोई एक न हो।
3	A reference is required for this flow.	जब flow को reference चाहिए और कोई नहीं भेजा गया। referenceType PROCESS_ID या IMAGE_BASE64 के साथ references[0] भेजें।
9	The referenceProcessId field is invalid.	जब reference प्रोसेस मौजूद नहीं है या रीयूज़ नहीं की जा सकती। आपके द्वारा भेजी गई field का नाम बताता है — अगर आपने वह भेजा है तो bioTokenId।
3	INVALID_IMAGE	जब इमेज वैध base64 न हो, या इंजेक्शन प्रयास जैसी लगे।
3	INVALID_DUI	जब दस्तावेज़ नंबर नॉन-स्टैंडर्ड हो या मौजूद न हो।
3	IMAGE_TOO_LARGE	जब इमेज अधिकतम साइज़ 800 KB से अधिक हो।
3	UNSUPPORTED_IMAGE_FORMAT	जब इमेज फ़ॉर्मेट PNG, JPEG या WebP न हो।
3	MISSING_IMAGE	जब इस flow के लिए इमेज ज़रूरी हो और भेजी न गई हो।
3	MISSING_NAME	जब इस flow के लिए नाम ज़रूरी हो और भेजा न गया हो।
3	MISSING_DUI	जब इस flow के लिए दस्तावेज़ नंबर ज़रूरी हो और भेजा न गया हो।
3	MISSING_PERSON	जब इस flow के लिए person ऑब्जेक्ट ज़रूरी हो और भेजा न गया हो।
3	INVALID_REQUEST	जब रिक्वेस्ट बॉडी null हो या समझी न जा सके।
3	TOKEN_ALREADY_USED	जब कैप्चर टोकन पहले ही इस्तेमाल हो चुका हो। यह सिंगल-यूज़ है।
3	TOKEN_EXPIRED	जब कैप्चर टोकन एक्सपायर हो गया हो। इसे 10 मिनट के भीतर इस्तेमाल करना ज़रूरी है।
3	INVALID_BUNDLE	जब रिक्वेस्ट सुरक्षा आवश्यकताओं को पूरा नहीं करती।
3	INVALID_NAME	जब नाम अनुमत अधिकतम सीमा से लंबा हो।
3	INVALID_EMAIL	जब ईमेल पता विकृत हो या बहुत लंबा हो।
3	INVALID_PHONE	जब फ़ोन नंबर 20 वर्ण से अधिक लंबा हो।
3	INVALID_DUI_TYPE	जब दस्तावेज़ प्रकार सपोर्टेड वैल्यू में से कोई एक न हो।
3	INVALID_CLIENT_REFERENCE	जब clientReference बहुत लंबा हो, या उसमें स्पेस या # हो।
3	INVALID_CONSENT_TYPE	जब consentType, NONE, DIRECT या INDIRECT न हो।
3	INVALID_USE_CASE	जब useCase पहचाना न जाए, या बहुत लंबा हो।
3	INVALID_DEVICE_TRUST_TOKEN	जब device-trust टोकन अमान्य हो या पहले ही इस्तेमाल हो चुका हो।
3	TOO_MANY_REFERENCES	जब references में एक से ज़्यादा आइटम भेजे गए हों।
3	INVALID_REFERENCE_TYPE	जब referenceType, IMAGE_BASE64 या PROCESS_ID न हो।
3	INVALID_REFERENCE_PROCESS	जब reference प्रोसेस ID एक वैध आइडेंटिफ़ायर न हो।
3	REFERENCE_PROCESS_NOT_FOUND	जब संदर्भित प्रोसेस मौजूद न हो।
3	REFERENCE_PROCESS_NOT_READY	जब संदर्भित प्रोसेस के पास कोई रीयूज़ेबल रिज़ल्ट न हो, या वह पहले ही इस्तेमाल हो चुकी हो।
3	REFERENCE_SELFIE_NOT_FOUND	जब संदर्भित प्रोसेस में रीयूज़ करने के लिए कोई सेल्फी न हो।
3	INVALID_CAPTURE_TOKEN	जब कैप्चर की गई इमेज किसी capture SDK द्वारा बनाया गया वैध टोकन न हो।
3	INVALID_CAPTURE_SIGNATURE	जब कैप्चर टोकन का सिग्नेचर वैलिडेट न हो।
3	PRIOR_CAPTURE_NOT_FOUND	जब इस रिक्वेस्ट के आधार वाला पहले का कैप्चर नहीं मिल सका। प्रोसेस को फिर से शुरू करें।
3	PRIOR_CAPTURE_IN_PROGRESS	जब पहले का कैप्चर अभी पूरा नहीं हुआ है। थोड़ी देर बाद फिर से कोशिश करें।
3	PRIOR_CAPTURE_FAILED	जब पहले का कैप्चर पूरा नहीं हो सका। प्रोसेस को फिर से शुरू करें।
3	INVALID_DOCUMENT	जब कोई दस्तावेज़ फ़ाइल पढ़ी न जा सके, पासवर्ड-प्रोटेक्टेड हो, या असमर्थित फ़ॉर्मेट में हो।
3	INVALID_AUTH_PROCESS	जब document.authProcessId अमान्य, एक्सपायर्ड हो, या किसी और व्यक्ति का हो।
3	INVALID_DOCUMENT_PURPOSE	जब document.purpose सपोर्टेड वैल्यू में से कोई एक न हो।
3	PROCESS_REUSE_NOT_ENABLED	जब flow बिना इमेज के पहले की प्रोसेस को रीयूज़ करने की अनुमति नहीं देता। इसके बजाय एक इमेज भेजें।
9	PROCESS_FAILED	जब प्रोसेस बनते समय किसी टर्मिनल फ़ेलियर पर पहुँच गई।
9	Tenant API key is not configured	जब API Key सही तरीके से कॉन्फ़िगर नहीं है।

401 Unauthorized

Bearer टोकन गायब, एक्सपायर्ड, या अमान्य है। देखें Authentication।

Message	Description
Jwt header is an invalid JSON	जब इस्तेमाल किए गए access token में गलत वर्ण मौजूद हों।
Jwt is expired	जब इस्तेमाल किया गया access token एक्सपायर हो गया हो।

403 Forbidden

Code	Message	Description
7	INVALID_API_KEY	जब API key अमान्य हो या गायब हो।
7	INVALID_AUTH_TOKEN	जब ऑथेंटिकेशन टोकन अमान्य हो।
7	PERMISSION_DENIED	जब क्रेडेंशियल वैध हों लेकिन इस कार्रवाई के लिए अधिकृत न हों।
7	TOKEN_TENANT_MISMATCH	जब कैप्चर टोकन किसी दूसरे tenant के लिए जारी किया गया हो।
7	MISSING_ACCESS_TOKEN	जब authorization हेडर गायब हो।

404 Not Found

Code	Message	Description
5	NO_RESULTS_FOUND	जब रिक्वेस्ट द्वारा संदर्भित कोई दस्तावेज़ न मिला हो।

429 Too Many Requests

रेट लिमिट पूरी हो गई। जब आपका सिस्टम HTTP 429 त्रुटि प्राप्त करता है, तो आपको कैस्केडिंग विफलताओं को रोकने और प्रतिबंध को बढ़ने से बचाने के लिए तंत्र लागू करने होंगे।

सर्वोत्तम प्रथाएं:

• कूल-डाउन अवधि (backoff): अपने सिस्टम से आने वाले बाद के अनुरोधों को तुरंत रोकें या कम करें। विफल अनुरोधों को लगातार एक तंग लूप में पुनः प्रयास न करें।
• कतार और थ्रॉटलिंग (Queueing & throttling): ट्रैफ़िक प्रवाह को नियंत्रित करने के लिए अपनी तरफ से आउटगोइंग अनुरोधों को बफ़र या कतार में रखें और फिर उन्हें पुनः भेजें।
• एक्सपोनेंशियल बैकऑफ़ विद जिटर (Exponential backoff with jitter): पुनः प्रयास करते समय, प्रयासों के बीच प्रतीक्षा समय को तेजी से बढ़ाएं (उदा., 1 s, 2 s, 4 s, 8 s) और एक छोटा यादृच्छिक विलंब ("jitter") जोड़ें ताकि हर्ड इफ़ेक्ट से बचा जा सके जहां सभी कतार में रखे गए अनुरोध ठीक उसी मिलीसेकंड पर पुनः प्रयास करते हैं।

चेतावनी

बैकऑफ़ लागू किए बिना रेट-लिमिटेड एंडपॉइंट को लगातार हिट करना प्रतिबंध अवधि को बढ़ा सकता है और आपके सिस्टम के परिचालन थ्रूपुट को गंभीर रूप से प्रभावित कर सकता है। अपनी तरफ से अनुरोधों को ठीक से थ्रॉटल करना एक सहज और अधिक लचीला एकीकरण सुनिश्चित करता है।

डिफ़ॉल्ट सीमाओं, अनुरोध बढ़ाने और अतिरिक्त विवरण के लिए, देखें रेट लिमिट।

500 Internal Server Error

Code	Message	Description
13	Internal failure! Try again later	जब कोई इंटरनल एरर होती है।

What's next

• यूज़र के जर्नी पूरी करने के बाद, रिज़ल्ट प्राप्त करने के लिए प्रोसेस प्राप्त करें को कॉल करें, या webhook की प्रतीक्षा करें।
• सभी रेसिपी कॉम्बिनेशन और उनके संभावित रिज़ल्ट वैल्यू देखने के लिए, देखें Flows।
• असली बायोमेट्रिक कैप्चर के बिना किसी रिज़ल्ट का टेस्ट करने के लिए, देखें Simulating Results (Test Mock)।