मुख्य सामग्री पर जाएं
प्रक्रिया प्राप्त करेंGET

अपने पहचानकर्ता द्वारा किसी मौजूदा प्रक्रिया को पुनः प्राप्त करें। API contract के अनुसार, परिणाम प्रक्रिया के निर्माण पर ही समकालिक रूप से लौटा दिया जाता है — पुनः-क्वेरी, ऑडिटिंग और सहायता के लिए इस endpoint का उपयोग करें।

चेतावनी

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

Endpoint​

वातावरणURL
ProductionGET https://api.idcloud.unico.app/client/v1/process/{processId}
SandboxGET https://api.idcloud.uat.unico.app/client/v1/process/{processId}

अनुरोध​

Headers
Headerमान
AuthorizationBearer <access_token>
Path parameters
पैरामीटरप्रकारआवश्यकविवरण
processIdstring (UUID)हाँप्रक्रिया बनाएं द्वारा लौटाया गया प्रक्रिया पहचानकर्ता।

उदाहरण​

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

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

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
  }
}
प्रक्रिया फ़ील्ड
फ़ील्डअर्थ
idप्रक्रिया का UUID; flow को क्वेरी करने और ट्रैक करने के लिए उपयोग की जाने वाली key।
flowनिष्पादित की गई यात्रा का प्रकार (जैसे id_r2, idlivetrust_r2, idtrust_r2, ...)।
callbackUriकॉलबैक URI जिस पर flow के अंत में क्लाइंट ऐप को रीडायरेक्ट किया जाता है।
userRedirectUrlCbU पेज का पूरा URL जिसे उपयोगकर्ता यात्रा चलाने के लिए खोलता है (इसमें id और behavior flags शामिल होते हैं)।
stateप्रक्रिया के lifecycle की स्थिति। 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, व्यक्ति registration)।
servicesप्रक्रिया से जुड़ी अतिरिक्त services की सूची; न होने पर खाली।
authenticationInfo.authenticationIdflow द्वारा उत्पन्न identity authentication event की ID।
capacitiesउपयोग की गई Capabilities/products। PROCESS_CAPACITY_* मान (जैसे IDCLOUDONE)।
expiresAtप्रक्रिया/लिंक की समय-सीमा समाप्त होने का टाइमस्टैंप (UTC)।
tokenप्रक्रिया से जुड़ा session/access token (खाली हो सकता है)।
companyDataप्रक्रिया के मालिक company/tenant के डेटा वाला sub-object।
simulatedBoolean; क्या यह एक simulation/sandbox प्रक्रिया है (true) या असली (false)।
व्यक्ति फ़ील्ड
फ़ील्डअर्थ
duiTypeअद्वितीय पहचान दस्तावेज़ का प्रकार। DUI_TYPE_* मान (जैसे BR_CPF)।
duiValueदस्तावेज़ मान (जैसे CPF नंबर)।
friendlyNameव्यक्ति के लिए friendly name/nickname (free text, validated नहीं होता)।
emailव्यक्ति का email; खाली हो सकता है।
phoneE.164 फ़ॉर्मेट में फ़ोन नंबर (country code + area code + number)।
notificationsअधिसूचना चैनलों की सूची। प्रत्येक item में notificationChannel होता है जिसके मान NOTIFICATION_CHANNEL_* होते हैं (जैसे WHATSAPP, SMS, EMAIL)।
phoneCountryCodeAlpha3फ़ोन नंबर का ISO alpha-3 देश कोड (जैसे BRA); खाली हो सकता है।
कंपनी डेटा फ़ील्ड
फ़ील्डअर्थ
branchIdtenant की शाखा का पहचानकर्ता; शाखा के अनुसार विभाजित न होने पर खाली।
countryCodeISO alpha-3 में कंपनी का देश (जैसे BRA)।
दस्तावेज़ प्रकार और OCR फ़ील्ड

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

एकीकृत स्कीमा का उपयोग करने वाले दस्तावेज़ प्रकार — फ़ील्ड संदर्भ में 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 के रूप में रिपोर्ट किए जाते हैं।

विशिष्ट स्कीमा

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

देशdoc.codeDictionary प्रकारदस्तावेज़
BRRGunico.moja.dictionary.br.rg.v2.RgRG
BRCNHunico.moja.dictionary.br.cnh.v2.CnhCNH (ड्राइविंग लाइसेंस)
BRCINunico.moja.dictionary.br.cin.v1.CinCIN
BRPASSAPORTEunico.moja.dictionary.br.passaporte.v1.Passaporteपासपोर्ट
MXINEunico.moja.dictionary.mx.ine.v1.IneINE मतदाता क्रेडेंशियल
MXLPCunico.moja.dictionary.mx.lpc.v1.LpcLicencia para conducir (ड्राइविंग लाइसेंस)
MXPASAPORTEunico.moja.dictionary.mx.pasaporte.v1.Pasaporteपासपोर्ट
—UNKNOWNunico.moja.dictionary.other.unknown.v1.Unknownप्रकार की पहचान नहीं हो सकी — doc.data खाली है
PASSAPORTE और PASAPORTE अलग-अलग दस्तावेज़ हैं

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

जब doc.code UNKNOWN होता है, तो कोई OCR निष्कर्षण नहीं किया जाता और doc.data में कोई फ़ील्ड रिपोर्ट नहीं किया जाता।

Brazilब्राज़ील में क्लाइंट पूर्ण प्रक्रिया payload प्राप्त कर सकते हैं

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

ब्राज़ील में integrations नीचे दिया गया पूर्ण process object प्राप्त कर सकती हैं, जिसमें authenticationInfo में प्रति-capability परिणाम होते हैं।

{
  "process": {
    "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
    "flow": "idchecktrust",
    "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
      }
    },
    "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.idstring (UUID)प्रक्रिया पहचानकर्ता।
process.flowstringनिर्माण के समय भेजा गया flow पहचानकर्ता।
process.callbackUristringप्रक्रिया इवेंट के लिए configured कॉलबैक URL।
process.userRedirectUrlstringयात्रा पूरी होने के बाद उपयोगकर्ता को रीडायरेक्ट करने का URL।
process.stateenumप्रक्रिया की वर्तमान स्थिति। नीचे दिए गए मान देखें।
process.resultenumसत्यापन परिणाम। केवल तब उपस्थित जब state = PROCESS_STATE_FINISHED।
process.createdAtstring (datetime)प्रक्रिया बनाए जाने का ISO 8601 टाइमस्टैंप।
process.finishedAtstring (datetime)प्रक्रिया समाप्त होने का ISO 8601 टाइमस्टैंप। केवल तब उपस्थित जब state = PROCESS_STATE_FINISHED।
process.expiresAtstring (datetime)प्रक्रिया की समय-सीमा समाप्त होने का ISO 8601 टाइमस्टैंप।
process.purposestringflow में configured प्रक्रिया का उद्देश्य।
process.clientReferencestringपोर्टल में अनुक्रमण के लिए वैकल्पिक क्लाइंट-साइड संदर्भ।
process.useCasestringflow से जुड़ा परिस्थिति पहचानकर्ता।
process.capacitiesarray of stringsइस प्रक्रिया में सक्रिय capabilities की सूची।
process.tokenstringSDK इंटीग्रेशन के लिए हस्ताक्षरित JWT।
process.personobjectनिर्माण के समय प्रदान की गई पहचान।
process.person.notificationsarrayयात्रा के लिए configured अधिसूचना चैनल (जैसे email)।
process.authenticationInfoobjectप्रति-capability परिणाम। नीचे देखें।
process.companyDataobjectकंपनी और शाखा संदर्भ।
process.companyData.branchIdstringशाखा पहचानकर्ता।
process.companyData.countryCodestringISO 3166-1 alpha-2 देश कोड।
process.bioTokenDataobjectसंदर्भ प्रक्रिया जानकारी — केवल 1:1 सत्यापन और स्मार्ट पुनर्सत्यापन flows में उपस्थित।
process.servicesarrayहस्ताक्षरित लिफाफे, कैप्चर किए गए दस्तावेज़, और अन्य सेवा आउटपुट। नीचे देखें।
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सभी capabilities ने सकारात्मक परिणाम लौटाए।
PROCESS_RESULT_INVALID_IDENTITYकम से कम एक capability ने निश्चित नकारात्मक परिणाम लौटाया (जैसे liveness विफल, पहचान मेल नहीं खाई)।
PROCESS_RESULT_ERRORपरिणाम प्रसंस्करण के दौरान त्रुटि।
PROCESS_RESULT_EXPIREDयात्रा पूरी होने से पहले प्रक्रिया की समय-सीमा समाप्त हो गई।
PROCESS_RESULT_UNSPECIFIEDप्रक्रिया अभी पूरी नहीं हुई।
authenticationInfo में capability परिणाम

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

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

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

फ़ील्डCapabilityसंभावित मान
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
bioTokenEngineResult1: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 फ़ील्ड
services में मिश्रित naming conventions

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

फ़ील्डप्रकारविवरण
envelopeIdstring (UUID)हस्ताक्षरित लिफाफा पहचानकर्ता।
documentIdsarray of stringsइस सेवा में कैप्चर किए गए दस्तावेज़ों की IDs।
consent_grantedbooleanक्या उपयोगकर्ता ने डेटा शेयरिंग की सहमति दी।
documentsarrayOCR डेटा और सत्यापन परिणामों के साथ कैप्चर किए गए दस्तावेज़।
documents[].doc_idstringदस्तावेज़ पहचानकर्ता।
documents[].typifiedbooleanक्या दस्तावेज़ प्रकार सफलतापूर्वक पहचाना गया।
documents[].cpf_matchbooleanक्या दस्तावेज़ पर CPF प्रदान किए गए CPF से मेल खाता है (केवल ब्राज़ील)।
documents[].face_matchbooleanक्या सेल्फी दस्तावेज़ पर फोटो से मेल खाती है।
documents[].validate_docbooleanक्या दस्तावेज़ प्रामाणिकता सत्यापन पास हुआ।
documents[].reused_docbooleanक्या यह दस्तावेज़ पिछली प्रक्रिया से पुनः उपयोग किया गया।
documents[].signed_urlstringदस्तावेज़ PDF डाउनलोड करने के लिए पूर्व-हस्ताक्षरित URL (5 मिनट के लिए वैध — नवीनीकरण के लिए पुनः प्राप्त करें)।
documents[].doc.versionintegerOCR स्कीमा संस्करण।
documents[].doc.codestringसंक्षिप्त दस्तावेज़ प्रकार कोड (जैसे CNH)। सभी मानों और कोड कैसे प्राप्त होता है, इसके लिए दस्तावेज़ प्रकार और OCR फ़ील्ड देखें।
documents[].doc.dataobjectनिकाले गए OCR फ़ील्ड। सामग्री दस्तावेज़ प्रकार के अनुसार भिन्न होती है — पूरे कैटलॉग के लिए पूर्ण फ़ील्ड संदर्भ देखें। doc.data के अंदर field names (जैसे nomeCivil, dataNascimento) Portuguese में लौटाए जाते हैं — ये OCR engine द्वारा उत्पादित वास्तविक मान हैं।

त्रुटि कोड​

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

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

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

आगे क्या है​

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