प्रोसेस प्राप्त करें

प्रोसेस प्राप्त करेंGET

अपने आइडेंटिफ़ायर से किसी मौजूदा प्रोसेस को प्राप्त करें। API कॉन्ट्रैक्ट के अनुसार, प्रोसेस बनते समय रिज़ल्ट पहले ही सिंक्रोनस रूप से लौटा दिया जाता है — इस एंडपॉइंट का उपयोग री-क्वेरी, ऑडिटिंग और सपोर्ट के लिए करें।

Markdown ChatGPT Claude

चेतावनी

प्रोसेस को प्राप्त करने से पहले, हमारे webhook कॉन्फ़िगरेशन और फ़ॉलबैक स्ट्रैटेजी की जानकारी लें — यहाँ क्लिक करें।

Endpoint

Environment	URL
Production	`GET https://api.idcloud.unico.app/client/v1/process/{processId}`
Sandbox	`GET https://api.idcloud.uat.unico.app/client/v1/process/{processId}`

Request

Headers

Header	Value
`Authorization`	`Bearer <access_token>`

Path parameters

Parameter	Type	Required	Description
`processId`	string (UUID)	yes	प्रोसेस बनाएं द्वारा लौटाया गया प्रोसेस आइडेंटिफ़ायर।

Example

cURL
Node.js

curl -X GET https://api.idcloud.unico.app/client/v1/process/$PROCESS_ID \
  -H "Authorization: Bearer $TOKEN"

import fetch from 'node-fetch';

const res = await fetch(
  `https://api.idcloud.unico.app/client/v1/process/${processId}`,
  { headers: { Authorization: `Bearer ${accessToken}` } }
);
const { process: proc } = await res.json();

Responses

200 OK

{
  "process": {
    "id": "226fd950-4b80-4da6-a476-ba9d397ddc91",
    "flow": "id_r2",
    "callbackUri": "/",
    "userRedirectUrl": "https://cadastro.uat.unico.app/flow?collect-data=true&dynamic-wrapper=true&id=226fd950-4b80-4da6-a476-ba9d397ddc91",
    "state": "PROCESS_STATE_FINISHED",
    "result": "PROCESS_RESULT_APPROVED",
    "createdAt": "2026-08-06T01:42:21.693615Z",
    "finishedAt": "2026-08-06T01:43:03.080508Z",
    "person": {
      "duiType": "DUI_TYPE_BR_CPF",
      "duiValue": "40*******50",
      "friendlyName": "teste",
      "email": "",
      "phone": "5511999999999",
      "notifications": [
        { "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP" }
      ],
      "phoneCountryCodeAlpha3": ""
    },
    "purpose": "personAuthentication",
    "services": [],
    "authenticationInfo": { "authenticationId": "55cba227-9828-49df-a16f-bcdaa7bdaa4d" },
    "capacities": ["PROCESS_CAPACITY_IDCLOUDONE"],
    "expiresAt": "2026-08-13T01:42:21.536500Z",
    "token": "",
    "companyData": { "branchId": "", "countryCode": "BRA" },
    "simulated": false
  }
}

Process fields

Field	Meaning
`id`	प्रोसेस UUID; फ़्लो को क्वेरी और ट्रैक करने के लिए इस्तेमाल की जाने वाली key।
`flow`	चलाई गई जर्नी का प्रकार (उदाहरण: `id_r2`, `idlivetrust_r2`, `idtrust_r2`, ...)।
`callbackUri`	वह कॉलबैक URI जिस पर फ़्लो के अंत में क्लाइंट ऐप को रीडायरेक्ट किया जाता है।
`userRedirectUrl`	CbU पेज का पूरा URL जिसे यूज़र जर्नी चलाने के लिए खोलता है (इसमें `id` और behavior flags शामिल होते हैं)।
`state`	प्रोसेस की लाइफ़साइकिल स्थिति। `PROCESS_STATE_*` वैल्यू (उदाहरण: `CREATED`, `FAILED`, `FINISHED`, `AWAITING_FOR_DOCUMENT`, `UNSPECIFIED`)।
`result`	मूल्यांकन का अंतिम फ़ैसला। `PROCESS_RESULT_*` वैल्यू (उदाहरण: `APPROVED`, `AUTHENTICATED`, `NOT_APPROVED`, ...)। यह केवल तब निर्णायक होता है जब `state = PROCESS_STATE_FINISHED` हो।
`createdAt`	प्रोसेस बनने का टाइमस्टैंप (UTC)।
`finishedAt`	प्रोसेस पूरा होने का टाइमस्टैंप (UTC)।
`person`	सत्यापित किए जा रहे व्यक्ति के डेटा वाला sub-object।
`purpose`	प्रोसेस का उद्देश्य (उदाहरण: `personAuthentication`, व्यक्ति रजिस्ट्रेशन)।
`services`	प्रोसेस से जुड़ी अतिरिक्त सेवाओं की सूची; कोई न होने पर खाली।
`authenticationInfo.authenticationId`	फ़्लो द्वारा जनरेट किए गए आइडेंटिटी ऑथेंटिकेशन इवेंट का ID।
`capacities`	उपयोग की गई क्षमताएँ/प्रोडक्ट। `PROCESS_CAPACITY_*` वैल्यू (उदाहरण: `IDCLOUDONE`)।
`expiresAt`	प्रोसेस/लिंक के एक्सपायर होने का टाइमस्टैंप (UTC)।
`token`	प्रोसेस से जुड़ा सेशन/एक्सेस टोकन (खाली हो सकता है)।
`companyData`	प्रोसेस के मालिक company/tenant के डेटा वाला sub-object।
`simulated`	Boolean; यह बताता है कि यह एक सिमुलेशन/sandbox प्रोसेस है (`true`) या असली (`false`)।

Person fields

Field	Meaning
`duiType`	यूनीक आइडेंटिफ़िकेशन दस्तावेज़ का प्रकार। `DUI_TYPE_*` वैल्यू (उदाहरण: `BR_CPF`)।
`duiValue`	दस्तावेज़ की वैल्यू (उदाहरण: CPF नंबर)।
`friendlyName`	व्यक्ति के लिए फ़्रेंडली नाम/निकनेम (फ़्री टेक्स्ट, वैलिडेट नहीं किया जाता)।
`email`	व्यक्ति का ईमेल; खाली हो सकता है।
`phone`	E.164 फ़ॉर्मेट में फ़ोन नंबर (country code + area code + number)।
`notifications`	नोटिफ़िकेशन चैनलों की सूची। हर आइटम में `NOTIFICATION_CHANNEL_*` वैल्यू (उदाहरण: `WHATSAPP`, `SMS`, `EMAIL`) के साथ `notificationChannel` होता है।
`phoneCountryCodeAlpha3`	फ़ोन नंबर का ISO alpha-3 country code (उदाहरण: `BRA`); खाली हो सकता है।

Company data fields

Field	Meaning
`branchId`	tenant की branch का आइडेंटिफ़ायर; branch के आधार पर सेगमेंट न होने पर खाली।
`countryCode`	ISO alpha-3 में company का देश (उदाहरण: `BRA`)।

Document types and OCR fields

जो दस्तावेज़ प्रकार यूनिफ़ाइड स्कीमा का उपयोग करते हैं — field reference में unified_schema — उन्हें कैप्चर के दौरान पहचाने गए प्रकार के अपरकेस आइडेंटिफ़ायर के रूप में रिपोर्ट किया जाता है: IDCARD, DRIVERLICENSE, PASSPORT या VOTERID। अमेरिकी पासपोर्ट अपने वेरिएंट को बनाए रखते हैं, PASSPORT में एक साथ नहीं आते, इसलिए POLYCARBONATEPASSPORT, PASSPORTCARD और PAPERPASSPORT जैसी वैल्यू भी लौटाई जाती हैं। उदाहरण के लिए, unico.moja.dictionary.ar.generic.v1.IdCard और unico.moja.dictionary.us.generic.v1.PolycarbonatePassport को क्रमशः IDCARD और POLYCARBONATEPASSPORT के रूप में रिपोर्ट किया जाता है।

process.services[].documents[].doc.code दस्तावेज़ प्रकार को एक छोटे अपरकेस कोड के रूप में रिपोर्ट करता है। unico.moja.dictionary.br.cnh.v2.Cnh बन जाता है CNH। इस कोड में न तो देश और न ही स्कीमा वर्शन शामिल होता है; वर्शन को अलग से doc.version में लौटाया जाता है।

Specific schemas

जो दस्तावेज़ प्रकार अपनी खुद की field स्कीमा का उपयोग करते हैं — field reference में specific_document_schemas के अंतर्गत सूचीबद्ध — उन्हें नीचे दी गई टेबल में दिखाया गया है। हर स्कीमा को उस फ़ाइल में देखने के लिए dictionary प्रकार का उपयोग करें।

Country	`doc.code`	Dictionary type	Document
BR	`RG`	`unico.moja.dictionary.br.rg.v2.Rg`	RG
BR	`CNH`	`unico.moja.dictionary.br.cnh.v2.Cnh`	CNH (ड्राइवर लाइसेंस)
BR	`CIN`	`unico.moja.dictionary.br.cin.v1.Cin`	CIN
BR	`PASSAPORTE`	`unico.moja.dictionary.br.passaporte.v1.Passaporte`	पासपोर्ट
MX	`INE`	`unico.moja.dictionary.mx.ine.v1.Ine`	INE वोटर क्रेडेंशियल
MX	`LPC`	`unico.moja.dictionary.mx.lpc.v1.Lpc`	Licencia para conducir (ड्राइवर लाइसेंस)
MX	`PASAPORTE`	`unico.moja.dictionary.mx.pasaporte.v1.Pasaporte`	पासपोर्ट
—	`UNKNOWN`	`unico.moja.dictionary.other.unknown.v1.Unknown`	प्रकार की पहचान नहीं हो सकी — `doc.data` खाली है

PASSAPORTE और PASAPORTE अलग-अलग दस्तावेज़ हैं

ब्राज़ीलियाई पासपोर्ट PASSAPORTE (डबल S) है और मैक्सिकन पासपोर्ट PASAPORTE (सिंगल S) है, जो अपनी-अपनी dictionary स्पेलिंग को दर्शाते हैं। यह कोई टाइपो नहीं है — इन दोनों वैल्यू को समान न मानें।

जब doc.code UNKNOWN हो, तो कोई OCR एक्सट्रैक्शन नहीं किया जाता और doc.data में कोई field रिपोर्ट नहीं किया जाता।

ब्राज़ील में क्लाइंट्स को पूरा प्रोसेस पेलोड मिल सकता है

समग्र रिस्पॉन्स संरचना वैसी ही रहती है — सिंगल रिज़ल्ट डिफ़ॉल्ट है।

ब्राज़ील में इंटीग्रेशन को नीचे दिया गया पूरा प्रोसेस ऑब्जेक्ट मिल सकता है, जिसमें per-capability रिज़ल्ट `authenticationInfo` में होते हैं।

{
  "process": {
    "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
    "flow": "iddocs_r2",
    "callbackUri": "https://example.com/callback",
    "userRedirectUrl": "https://example.com/redirect",
    "state": "PROCESS_STATE_FINISHED",
    "result": "PROCESS_RESULT_OK",
    "createdAt": "2024-01-01T10:00:00Z",
    "finishedAt": "2024-01-01T10:15:00Z",
    "expiresAt": "2024-01-08T10:00:00Z",
    "purpose": "VERIFICATION",
    "clientReference": "client-ref-abc",
    "useCase": "USE_CASE_LOGIN",
    "capacities": ["liveness", "face_match"],
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "person": {
      "duiType": "DUI_TYPE_BR_CPF",
      "duiValue": "12345678909",
      "friendlyName": "Luke Skywalker",
      "notifications": [
        {
          "notificationChannel": "email"
        }
      ]
    },
    "authenticationInfo": {
      "authenticationId": "auth-123",
      "livenessResult": "LIVENESS_RESULT_LIVE",
      "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
      "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED",
      "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
      "smartRevalidationResult": "SMART_REVALIDATION_RESULT_UNSPECIFIED",
      "idAgeResult": "ID_AGE_RESULT_UNSPECIFIED",
      "scoreEngineResult": {
        "scoreEnabled": "SCORE_ENABLED_TRUE",
        "score": 85.5
      }
    },
    "companyData": {
      "branchId": "branch-123",
      "countryCode": "BR"
    },
    "bioTokenData": {
      "referenceProcessId": "ref-proc-123",
      "authenticationId": "auth-ref-123"
    },
    "services": [
      {
        "envelopeId": "4d4f3d90-04a3-4259-b63b-930ab10d2e47",
        "documentIds": ["doc-abc-123"],
        "consent_granted": true,
        "documents": [
          {
            "doc_id": "doc-abc-123",
            "typified": true,
            "cpf_match": true,
            "face_match": true,
            "validate_doc": true,
            "reused_doc": false,
            "signed_url": "https://example.com/doc?token=xyz",
            "doc": {
              "version": 1,
              "code": "CNH",
              "data": {
                "numero": "044589731564",
                "cpfNumero": "12345678909",
                "nomeCivil": "Luke Skywalker",
                "dataNascimento": "1990-05-12T00:00:00Z",
                "dataExpiracao": "2027-12-07T00:00:00Z",
                "categoria": "B"
              }
            }
          }
        ]
      }
    ]
  }
}

Top-level fields

Field	Type	Description
`process.id`	string (UUID)	प्रोसेस आइडेंटिफ़ायर।
`process.flow`	string	बनते समय भेजा गया flow आइडेंटिफ़ायर।
`process.callbackUri`	string	प्रोसेस इवेंट के लिए कॉन्फ़िगर किया गया कॉलबैक URL।
`process.userRedirectUrl`	string	जर्नी पूरी होने के बाद यूज़र को रीडायरेक्ट करने का URL।
`process.state`	enum	प्रोसेस की मौजूदा स्थिति। नीचे दी गई वैल्यू देखें।
`process.result`	enum	सत्यापन का परिणाम। केवल तब मौजूद होता है जब `state = PROCESS_STATE_FINISHED` हो।
`process.createdAt`	string (datetime)	प्रोसेस बनने का ISO 8601 टाइमस्टैंप।
`process.finishedAt`	string (datetime)	प्रोसेस पूरा होने का ISO 8601 टाइमस्टैंप। केवल तब मौजूद होता है जब `state = PROCESS_STATE_FINISHED` हो।
`process.expiresAt`	string (datetime)	प्रोसेस के एक्सपायर होने का ISO 8601 टाइमस्टैंप।
`process.purpose`	string	flow में कॉन्फ़िगर किया गया प्रोसेस का उद्देश्य।
`process.clientReference`	string	पोर्टल में इंडेक्सिंग के लिए वैकल्पिक क्लाइंट-साइड रेफ़रेंस।
`process.useCase`	string	flow से जुड़ा सिनैरियो आइडेंटिफ़ायर।
`process.capacities`	array of strings	इस प्रोसेस में सक्रिय की गई क्षमताओं की सूची।
`process.token`	string	SDK इंटीग्रेशन के लिए साइन किया गया JWT।
`process.person`	object	बनाते समय दी गई पहचान जानकारी।
`process.person.notifications`	array	जर्नी के लिए कॉन्फ़िगर किए गए नोटिफ़िकेशन चैनल (उदाहरण: `email`)।
`process.authenticationInfo`	object	Per-capability रिज़ल्ट। नीचे देखें।
`process.companyData`	object	Company और branch का संदर्भ।
`process.companyData.branchId`	string	Branch आइडेंटिफ़ायर।
`process.companyData.countryCode`	string	ISO 3166-1 alpha-2 country code।
`process.bioTokenData`	object	रेफ़रेंस प्रोसेस की जानकारी — केवल 1:1 सत्यापन और स्मार्ट पुनर्सत्यापन फ़्लो में मौजूद होती है।
`process.services`	array	Signed envelope, कैप्चर किए गए दस्तावेज़, और अन्य सर्विस आउटपुट। नीचे देखें।

process.state values

Value	Meaning
`PROCESS_STATE_CREATED`	प्रोसेस बन गई है; यूज़र ने अभी जर्नी पूरी नहीं की है।
`AWAITING_FOR_DOCUMENT`	प्रोसेस बिना पहचान दस्तावेज़ के बनी है। यह केवल तब मौजूद होता है जब Custom Flow वैकल्पिक दस्तावेज़ की अनुमति देता है। प्रोसेस दस्तावेज़ सेट करें के ज़रिए दस्तावेज़ भेजें।
`PROCESS_STATE_FINISHED`	जर्नी पूरी हो गई। `result` और `authenticationInfo` जाँचें।
`PROCESS_STATE_FAILED`	प्रोसेसिंग एरर।

स्थिति के नामकरण में असंगति

AWAITING_FOR_DOCUMENT अन्य स्थितियों में इस्तेमाल होने वाले PROCESS_STATE_* प्रीफ़िक्स कन्वेंशन का पालन नहीं करता। यह मौजूदा API में एक ज्ञात नामकरण असंगति है।

process.result values

Value	Meaning
`PROCESS_RESULT_OK`	सभी क्षमताओं ने पॉज़िटिव रिज़ल्ट लौटाया।
`PROCESS_RESULT_INVALID_IDENTITY`	कम से कम एक क्षमता ने निर्णायक नेगेटिव रिज़ल्ट लौटाया (उदाहरण: liveness फ़ेल, पहचान मैच नहीं हुई)।
`PROCESS_RESULT_ERROR`	रिज़ल्ट प्रोसेसिंग के दौरान एरर।
`PROCESS_RESULT_EXPIRED`	जर्नी पूरी होने से पहले प्रोसेस एक्सपायर हो गई।
`PROCESS_RESULT_UNSPECIFIED`	प्रोसेस अभी पूरी नहीं हुई है।

Capability results in authenticationInfo

flow के बावजूद सभी field हमेशा लौटाए जाते हैं। flow में उपयोग न की गई क्षमताओं के field *_UNSPECIFIED लौटाते हैं।

संक्षिप्त enum वैल्यू

संक्षिप्त वैल्यू (उदाहरण: livenessResult = LIVE, authenticationResult = INCONCLUSIVE) यहाँ डॉक्यूमेंटेड पूरी enum वैल्यू (LIVENESS_RESULT_LIVE, AUTHENTICATION_RESULT_INCONCLUSIVE, आदि) से सीधे मैप होती हैं — संक्षिप्तता के लिए प्रीफ़िक्स छोड़ दिया जाता है।

Field	Capability	Possible values
`authenticationId`	—	इस ऑथेंटिकेशन प्रयास के लिए यूनीक आइडेंटिफ़ायर।
`livenessResult`	Liveness	`LIVENESS_RESULT_LIVE`, `LIVENESS_RESULT_NOT_LIVE`, `LIVENESS_RESULT_UNSPECIFIED`
`authenticationResult`	Identity Verification	`AUTHENTICATION_RESULT_POSITIVE`, `AUTHENTICATION_RESULT_NEGATIVE`, `AUTHENTICATION_RESULT_INCONCLUSIVE`, `AUTHENTICATION_RESULT_UNSPECIFIED`
`identityFraudstersResult`	Fraud Risk Classification	`TRUST_RESULT_YES`, `TRUST_RESULT_INCONCLUSIVE`, `TRUST_RESULT_UNSPECIFIED`
`bioTokenEngineResult`	1:1 Validation	`BIO_TOKEN_ENGINE_RESULT_POSITIVE`, `BIO_TOKEN_ENGINE_RESULT_NEGATIVE`, `BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED`
`smartRevalidationResult`	Smart Revalidation	`SMART_REVALIDATION_RESULT_POSITIVE`, `SMART_REVALIDATION_RESULT_NEGATIVE`, `SMART_REVALIDATION_RESULT_UNSPECIFIED`
`idAgeResult`	Age Verification	`ID_AGE_RESULT_POSITIVE`, `ID_AGE_RESULT_NEGATIVE`, `ID_AGE_RESULT_INCONCLUSIVE`, `ID_AGE_RESULT_UNSPECIFIED`
`scoreEngineResult.scoreEnabled`	Risk Score	`SCORE_ENABLED_TRUE`, `SCORE_ENABLED_FALSE`, `SCORE_ENABLED_UNSPECIFIED`
`scoreEngineResult.score`	Risk Score	-100 से +100 तक की संख्या। यह तब मौजूद होता है जब `authenticationResult = AUTHENTICATION_RESULT_INCONCLUSIVE` हो और Risk Score सक्षम हो।
`serproResult.score`	Serpro Similarity	`0`–`100` (समानता); `-1` (इस CPF के लिए कोई फ़ेस फ़ाइल में नहीं); `-2` (इंटीग्रेशन एरर)।

process.services fields

services में मिश्रित नामकरण कन्वेंशन

services array envelope-level field (envelopeId, documentIds) के लिए camelCase और document-level field (doc_id, consent_granted, face_match, आदि) के लिए snake_case का उपयोग करता है। यह असली API रिस्पॉन्स को दर्शाता है — दोनों कन्वेंशन जानबूझकर हैं, यह कोई डॉक्यूमेंटेशन एरर नहीं है।

Field	Type	Description
`envelopeId`	string (UUID)	Signed envelope आइडेंटिफ़ायर।
`documentIds`	array of strings	इस सेवा में कैप्चर किए गए दस्तावेज़ों के ID।
`consent_granted`	boolean	यह बताता है कि यूज़र ने डेटा शेयरिंग सहमति दी या नहीं।
`documents`	array	OCR डेटा और वैलिडेशन रिज़ल्ट के साथ कैप्चर किए गए दस्तावेज़।
`documents[].doc_id`	string	दस्तावेज़ आइडेंटिफ़ायर।
`documents[].typified`	boolean	यह बताता है कि दस्तावेज़ प्रकार की सफलतापूर्वक पहचान हुई या नहीं।
`documents[].cpf_match`	boolean	यह बताता है कि दस्तावेज़ पर मौजूद CPF दिए गए CPF से मैच करता है या नहीं (केवल ब्राज़ील)।
`documents[].face_match`	boolean	यह बताता है कि सेल्फी दस्तावेज़ पर मौजूद फ़ोटो से मैच करती है या नहीं।
`documents[].validate_doc`	boolean	यह बताता है कि दस्तावेज़ ने प्रामाणिकता वैलिडेशन पास किया या नहीं।
`documents[].reused_doc`	boolean	यह बताता है कि यह दस्तावेज़ किसी पहले की प्रोसेस से रीयूज़ किया गया था या नहीं।
`documents[].signed_url`	string	दस्तावेज़ PDF डाउनलोड करने के लिए pre-signed URL (5 मिनट तक वैध — रीन्यू करने के लिए फिर से फ़ेच करें)।
`documents[].doc.version`	integer	OCR स्कीमा वर्शन।
`documents[].doc.code`	string	संक्षिप्त दस्तावेज़ प्रकार कोड (उदाहरण: `CNH`)। हर वैल्यू और कोड कैसे प्राप्त होता है, इसके लिए Document types and OCR fields देखें।
`documents[].doc.data`	object	एक्सट्रैक्ट किए गए OCR field। सामग्री दस्तावेज़ प्रकार के अनुसार अलग-अलग होती है — पूरे कैटलॉग के लिए full field reference देखें। `doc.data` के भीतर field के नाम (उदाहरण: `nomeCivil`, `dataNascimento`) पुर्तगाली में लौटाए जाते हैं — यह OCR इंजन द्वारा उत्पन्न असली वैल्यू हैं।

Error Codes

400 Bad Request
401 Unauthorized
404 Not Found
429 Too Many Requests
500 Internal Server Error

Code	Message	Description
`3`	process id is invalid	जब प्रोसेस ID अमान्य हो।

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

Code	Message	Description
`5`	error getting process: rpc error: code = NotFound desc = process not found	जब प्रोसेस ID नहीं मिला हो।

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

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

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

चेतावनी

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

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

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

Polling vs webhook

प्रगति की जाँच करने के लिए आप इस एंडपॉइंट को पोल कर सकते हैं, लेकिन सुझाया गया पैटर्न है एक webhook को सब्सक्राइब करना और इस एंडपॉइंट को केवल फ़ॉलबैक के रूप में कॉल करना। देखें Webhooks and Events।

What's next

कैप्चर की गई सेल्फी के लिए, देखें Get Selfie।
एविडेंस ऑडिट बंडल के लिए, देखें Get Evidence Set।

Endpoint​

Request​

Example​

Responses​

Error Codes​

Polling vs webhook​

What's next​