प्रक्रिया प्राप्त करें

चेतावनी

प्रक्रिया प्राप्त करने से पहले, हमारी webhook कॉन्फ़िगरेशन और fallback रणनीतियों की समीक्षा करें — यहाँ क्लिक करें.

एंडपॉइंट

वातावरण	URL
Production	`GET https://api.idcloud.unico.app/client/v1/process/{processId}`
Sandbox	`GET https://api.idcloud.uat.unico.app/client/v1/process/{processId}`

अनुरोध

Headers

Header	मान
`Authorization`	`Bearer <access_token>`

Path parameters

पैरामीटर	प्रकार	आवश्यक	विवरण
`processId`	string (UUID)	हाँ	प्रक्रिया बनाएं द्वारा लौटाया गया प्रक्रिया पहचानकर्ता।

उदाहरण

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();

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

200 OK

{
  "process": {
    "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
    "flow": "idunicosign",
    "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": "smart_revalidation",
    "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_INCONCLUSIVE",
      "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
      "smartRevalidationResult": "SMART_REVALIDATION_RESULT_UNSPECIFIED",
      "idAgeResult": "ID_AGE_RESULT_UNSPECIFIED",
      "scoreEngineResult": {
        "scoreEnabled": "SCORE_ENABLED_TRUE",
        "score": 85.5
      },
      "serproResult": {
        "score": 92
      }
    },
    "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"
              }
            }
          }
        ]
      }
    ]
  }
}

शीर्ष-स्तरीय फ़ील्ड

फ़ील्ड	प्रकार	विवरण
`process.id`	string (UUID)	प्रक्रिया पहचानकर्ता।
`process.flow`	string	निर्माण के समय भेजा गया फ्लो पहचानकर्ता।
`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	फ्लो में कॉन्फ़िगर किया गया प्रक्रिया का उद्देश्य।
`process.clientReference`	string	पोर्टल में अनुक्रमण के लिए वैकल्पिक क्लाइंट-साइड संदर्भ।
`process.useCase`	string	फ्लो से जुड़ा उपयोग-केस पहचानकर्ता।
`process.capacities`	array of strings	इस प्रक्रिया में सक्रिय क्षमताओं की सूची।
`process.token`	string	SDK इंटीग्रेशन के लिए हस्ताक्षरित JWT।
`process.person`	object	निर्माण के समय प्रदान की गई पहचान।
`process.person.notifications`	array	यात्रा के लिए कॉन्फ़िगर किए गए अधिसूचना चैनल (जैसे `email`)।
`process.authenticationInfo`	object	प्रति-क्षमता परिणाम। नीचे देखें।
`process.companyData`	object	कंपनी और शाखा संदर्भ।
`process.companyData.branchId`	string	शाखा पहचानकर्ता।
`process.companyData.countryCode`	string	ISO 3166-1 alpha-2 देश कोड।
`process.bioTokenData`	object	संदर्भ प्रक्रिया जानकारी — केवल 1:1 सत्यापन और स्मार्ट पुनर्सत्यापन flows में उपस्थित।
`process.services`	array	हस्ताक्षरित लिफाफे, कैप्चर किए गए दस्तावेज़, और अन्य सेवा आउटपुट। नीचे देखें।

process.state के मान

मान	अर्थ
`PROCESS_STATE_CREATED`	प्रक्रिया बनाई गई; उपयोगकर्ता ने अभी तक यात्रा पूरी नहीं की।
`AWAITING_FOR_DOCUMENT`	प्रक्रिया बिना पहचान दस्तावेज़ के बनाई गई; Set Process Document के माध्यम से इसे सेट करने की प्रतीक्षा है। केवल तब उपस्थित जब Custom Flow वैकल्पिक दस्तावेज़ की अनुमति देता है।
`PROCESS_STATE_FINISHED`	यात्रा पूरी हुई। `result` और `authenticationInfo` जाँचें।
`PROCESS_STATE_FAILED`	प्रसंस्करण त्रुटि।

State नामकरण असंगतता

AWAITING_FOR_DOCUMENT अन्य states द्वारा उपयोग किए जाने वाले PROCESS_STATE_* उपसर्ग सम्मेलन का पालन नहीं करता। यह वर्तमान API में एक ज्ञात नामकरण असंगतता है।

process.result के मान

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

authenticationInfo में क्षमता परिणाम

फ्लो की परवाह किए बिना सभी फ़ील्ड हमेशा लौटाए जाते हैं। फ्लो में उपयोग न की गई क्षमताओं के फ़ील्ड *_UNSPECIFIED लौटाते हैं।

संक्षिप्त enum मान

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

फ़ील्ड	क्षमता	संभावित मान
`authenticationId`	—	इस प्रमाणीकरण प्रयास का अद्वितीय पहचानकर्ता।
`livenessResult`	लाइवनेस	`LIVENESS_RESULT_LIVE`, `LIVENESS_RESULT_NOT_LIVE`, `LIVENESS_RESULT_UNSPECIFIED`
`authenticationResult`	पहचान सत्यापन	`AUTHENTICATION_RESULT_POSITIVE`, `AUTHENTICATION_RESULT_NEGATIVE`, `AUTHENTICATION_RESULT_INCONCLUSIVE`, `AUTHENTICATION_RESULT_UNSPECIFIED`
`identityFraudstersResult`	धोखाधड़ी जोखिम वर्गीकरण	`TRUST_RESULT_YES`, `TRUST_RESULT_INCONCLUSIVE`, `TRUST_RESULT_UNSPECIFIED`
`bioTokenEngineResult`	1:1 सत्यापन	`BIO_TOKEN_ENGINE_RESULT_POSITIVE`, `BIO_TOKEN_ENGINE_RESULT_NEGATIVE`, `BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED`
`smartRevalidationResult`	स्मार्ट पुनर्सत्यापन	`SMART_REVALIDATION_RESULT_POSITIVE`, `SMART_REVALIDATION_RESULT_NEGATIVE`, `SMART_REVALIDATION_RESULT_UNSPECIFIED`
`idAgeResult`	आयु सत्यापन	`ID_AGE_RESULT_POSITIVE`, `ID_AGE_RESULT_NEGATIVE`, `ID_AGE_RESULT_INCONCLUSIVE`, `ID_AGE_RESULT_UNSPECIFIED`
`scoreEngineResult.scoreEnabled`	जोखिम स्कोर	`SCORE_ENABLED_TRUE`, `SCORE_ENABLED_FALSE`, `SCORE_ENABLED_UNSPECIFIED`
`scoreEngineResult.score`	जोखिम स्कोर	-100 से +100 तक की संख्या। उपस्थित जब `authenticationResult = AUTHENTICATION_RESULT_INCONCLUSIVE` और धोखाधड़ी जोखिम वर्गीकरण सक्षम हो।
`serproResult.score`	सेर्प्रो समानता रिटर्न	`0`–`100` (समानता); `-1` (इस CPF के लिए फ़ाइल में कोई चेहरा नहीं); `-2` (एकीकरण त्रुटि)।

process.services फ़ील्ड

फ़ील्ड	प्रकार	विवरण
`envelopeId`	string (UUID)	हस्ताक्षरित लिफाफा पहचानकर्ता।
`documentIds`	array of strings	इस सेवा में कैप्चर किए गए दस्तावेज़ों की IDs।
`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 डाउनलोड करने के लिए पूर्व-हस्ताक्षरित URL (5 मिनट के लिए वैध — नवीनीकरण के लिए पुनः प्राप्त करें)।
`documents[].doc.version`	integer	OCR स्कीमा संस्करण।
`documents[].doc.code`	string	दस्तावेज़ प्रकार कोड (जैसे `CNH`, `RG`)।
`documents[].doc.data`	object	निकाले गए OCR फ़ील्ड। सामग्री दस्तावेज़ प्रकार और उपलब्ध डेटा के अनुसार भिन्न होती है।

400 Bad Request

processId path पैरामीटर अनुपस्थित या गलत रूप में है।

401 Unauthorized

Bearer टोकन अनुपस्थित, समाप्त, या अमान्य।

404 Not Found

processId मौजूद नहीं है या प्रमाणित टेनेंट से संबंधित नहीं है।

429 Too Many Requests

दर सीमा पहुँच गई।

त्रुटि कोड

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

कोड	संदेश	विवरण
`3`	process id is invalid	जब प्रक्रिया ID अमान्य हो।

संदेश	विवरण
Jwt header is an invalid JSON	जब उपयोग किए गए एक्सेस टोकन में गलत वर्ण हों।
Jwt is expired	जब उपयोग किया गया एक्सेस टोकन समाप्त हो गया हो।

कोड	संदेश	विवरण
`5`	error getting process: rpc error: code = NotFound desc = process not found	जब प्रक्रिया ID नहीं मिली।

कोड	संदेश	विवरण
`99999`	Internal failure! Try again later	जब कोई आंतरिक त्रुटि हो।

पोलिंग बनाम वेबहुक

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

आगे क्या है

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

एंडपॉइंट​

अनुरोध​

उदाहरण​

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

त्रुटि कोड​

पोलिंग बनाम वेबहुक​

आगे क्या है​