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

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

Markdown
चेतावनी

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

Endpoint​

EnvironmentURL
ProductionGET https://api.idcloud.unico.app/client/v1/process/{processId}
SandboxGET https://api.idcloud.uat.unico.app/client/v1/process/{processId}

Request​

Headers
HeaderValue
AuthorizationBearer <access_token>
Path parameters
ParameterTypeRequiredDescription
processIdstring (UUID)yesप्रोसेस बनाएं द्वारा लौटाया गया प्रोसेस आइडेंटिफ़ायर।

Example​

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

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
FieldMeaning
idप्रोसेस UUID; फ़्लो को क्वेरी और ट्रैक करने के लिए इस्तेमाल की जाने वाली key।
flowचलाई गई जर्नी का प्रकार (उदाहरण: id_r2, idlivetrust_r2, idtrust_r2, ...)।
callbackUriवह कॉलबैक URI जिस पर फ़्लो के अंत में क्लाइंट ऐप को रीडायरेक्ट किया जाता है।
userRedirectUrlCbU पेज का पूरा URL जिसे यूज़र जर्नी चलाने के लिए खोलता है (इसमें id और behavior flags शामिल होते हैं)।
stateप्रोसेस की लाइफ़साइकिल स्थिति (उदाहरण: PROCESS_STATE_CREATED, PROCESS_STATE_FAILED, PROCESS_STATE_FINISHED, PROCESS_STATE_AWAITING_FOR_DOCUMENT, PROCESS_STATE_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।
simulatedBoolean; यह बताता है कि यह एक सिमुलेशन/sandbox प्रोसेस है (true) या असली (false)।
Person fields
FieldMeaning
duiTypeयूनीक आइडेंटिफ़िकेशन दस्तावेज़ का प्रकार। DUI_TYPE_* वैल्यू (उदाहरण: BR_CPF)।
duiValueदस्तावेज़ की वैल्यू (उदाहरण: CPF नंबर)।
friendlyNameव्यक्ति के लिए फ़्रेंडली नाम/निकनेम (फ़्री टेक्स्ट, वैलिडेट नहीं किया जाता)।
emailव्यक्ति का ईमेल; खाली हो सकता है।
phoneE.164 फ़ॉर्मेट में फ़ोन नंबर (country code + area code + number)।
notificationsनोटिफ़िकेशन चैनलों की सूची। हर आइटम में NOTIFICATION_CHANNEL_* वैल्यू (उदाहरण: WHATSAPP, SMS, EMAIL) के साथ notificationChannel होता है।
phoneCountryCodeAlpha3फ़ोन नंबर का ISO alpha-3 country code (उदाहरण: BRA); खाली हो सकता है।
Company data fields
FieldMeaning
branchIdtenant की branch का आइडेंटिफ़ायर; branch के आधार पर सेगमेंट न होने पर खाली।
countryCodeISO alpha-3 में company का देश (उदाहरण: BRA)।
Document types and OCR fields

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

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

Specific schemas

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

Countrydoc.codeDictionary typeDocument
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 खाली है

ब्राज़ील और मैक्सिको के दस्तावेज़ केवल ऊपर दिए गए विशिष्ट स्कीमा का उपयोग करते हैं। किसी अन्य प्रकार का ब्राज़ीलियाई या मैक्सिकन दस्तावेज़ — उदाहरण के लिए, मैक्सिकन रेज़िडेंट कार्ड — UNKNOWN के रूप में रिपोर्ट किया जाता है, यूनिफ़ाइड स्कीमा के साथ नहीं।

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

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

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

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

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

ब्राज़ील में इंटीग्रेशन को नीचे दिया गया पूरा प्रोसेस ऑब्जेक्ट मिल सकता है, जिसमें 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": "BRA"
},
"bioTokenData": {
"referenceProcessId": "ref-proc-123",
"authenticationId": "auth-ref-123"
},
"services": [
{
"consent_granted": true,
"documents": [
{
"doc_id": "doc-abc-123",
"share_id": "share-abc-123",
"typified": true,
"cpf_match": true,
"validate_doc": true,
"face_match": true,
"verified": true,
"reused_doc": false,
"signed_url": "https://example.com/doc?token=xyz",
"doc": {
"version": 2,
"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
FieldTypeDescription
process.idstring (UUID)प्रोसेस आइडेंटिफ़ायर।
process.flowstringबनते समय भेजा गया flow आइडेंटिफ़ायर।
process.callbackUristringप्रोसेस इवेंट के लिए कॉन्फ़िगर किया गया कॉलबैक 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 में कॉन्फ़िगर किया गया प्रोसेस का उद्देश्य।
process.​clientReferencestringपोर्टल में इंडेक्सिंग के लिए वैकल्पिक क्लाइंट-साइड रेफ़रेंस।
process.useCasestringflow से जुड़ा सिनैरियो आइडेंटिफ़ायर।
process.capacitiesarray of stringsइस प्रोसेस में सक्रिय की गई क्षमताओं की सूची।
process.tokenstringSDK इंटीग्रेशन के लिए साइन किया गया JWT।
process.personobjectबनाते समय दी गई पहचान जानकारी।
process.​person.​notificationsarrayजर्नी के लिए कॉन्फ़िगर किए गए नोटिफ़िकेशन चैनल (उदाहरण: email)।
process.​authenticationInfoobjectPer-capability रिज़ल्ट। नीचे देखें।
process.companyDataobjectCompany और branch का संदर्भ।
process.​companyData.​branchIdstringBranch आइडेंटिफ़ायर।
process.​companyData.​countryCodestringISO 3166-1 alpha-3 country code (उदाहरण: BRA)।
process.​bioTokenDataobjectरेफ़रेंस प्रोसेस की जानकारी — केवल 1:1 सत्यापन और स्मार्ट पुनर्सत्यापन फ़्लो में मौजूद होती है।
process.servicesarraySigned envelope, कैप्चर किए गए दस्तावेज़, और अन्य सर्विस आउटपुट। नीचे देखें।
process.state values
ValueMeaning
PROCESS_STATE_CREATEDप्रोसेस बन गई है; यूज़र ने अभी जर्नी पूरी नहीं की है।
PROCESS_STATE_AWAITING_FOR_DOCUMENTप्रोसेस बिना पहचान दस्तावेज़ के बनी है। यह केवल तब मौजूद होता है जब Custom Flow वैकल्पिक दस्तावेज़ की अनुमति देता है। प्रोसेस दस्तावेज़ सेट करें के ज़रिए दस्तावेज़ भेजें।
PROCESS_STATE_FINISHEDजर्नी पूरी हो गई। result और authenticationInfo जाँचें।
PROCESS_STATE_FAILEDप्रोसेसिंग एरर।
process.result values
ValueMeaning
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, आदि) से सीधे मैप होती हैं — संक्षिप्तता के लिए प्रीफ़िक्स छोड़ दिया जाता है।

FieldCapabilityPossible values
authenticationId—इस ऑथेंटिकेशन प्रयास के लिए यूनीक आइडेंटिफ़ायर।
livenessResultLivenessLIVENESS_RESULT_LIVE, LIVENESS_RESULT_NOT_LIVE, LIVENESS_RESULT_UNSPECIFIED
authenticationResultIdentity VerificationAUTHENTICATION_RESULT_POSITIVE, AUTHENTICATION_RESULT_NEGATIVE, AUTHENTICATION_RESULT_INCONCLUSIVE, AUTHENTICATION_RESULT_UNSPECIFIED
identityFraudstersResultFraud Risk ClassificationTRUST_RESULT_YES, TRUST_RESULT_INCONCLUSIVE, TRUST_RESULT_UNSPECIFIED
bioTokenEngineResult1:1 ValidationBIO_TOKEN_ENGINE_RESULT_POSITIVE, BIO_TOKEN_ENGINE_RESULT_NEGATIVE, BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED
smartRevalidationResultSmart RevalidationSMART_REVALIDATION_RESULT_POSITIVE, SMART_REVALIDATION_RESULT_NEGATIVE, SMART_REVALIDATION_RESULT_UNSPECIFIED
idAgeResultAge VerificationID_AGE_RESULT_POSITIVE, ID_AGE_RESULT_NEGATIVE, ID_AGE_RESULT_INCONCLUSIVE, ID_AGE_RESULT_UNSPECIFIED
scoreEngineResult.​scoreEnabledRisk ScoreSCORE_ENABLED_TRUE, SCORE_ENABLED_FALSE, SCORE_ENABLED_UNSPECIFIED
scoreEngineResult.​scoreRisk Score-100 से +100 तक की संख्या। यह तब मौजूद होता है जब authenticationResult = AUTHENTICATION_RESULT_INCONCLUSIVE हो और Risk Score सक्षम हो।
serproResult.scoreSerpro Similarity0–100 (समानता); -1 (इस CPF के लिए कोई फ़ेस फ़ाइल में नहीं); -2 (इंटीग्रेशन एरर)।
deviceMetadataडिवाइस मेटाडेटाstatus (found, not_found, unavailable) और डिवाइस डेटा वाला ऑब्जेक्ट। जब क्षमता flow में सक्षम न हो तब अनुपस्थित।
process.services fields
प्रति मॉड्यूल एक आइटम

services में प्रोसेस में पूरे हुए हर मॉड्यूल के लिए एक आइटम होता है: हर मॉड्यूल का सबसे हाल का पूरा हुआ रन, और सिर्फ़ तब तक जब तक प्रोसेस PROCESS_STATE_FINISHED या PROCESS_STATE_AWAITING_FOR_DOCUMENT में हो। केवल API से बनाई गई प्रोसेस अपना दस्तावेज़ आइटम किसी भी स्थिति में रखती हैं। दस्तावेज़ कैप्चर आइटम में documents और consent_granted होते हैं। इलेक्ट्रॉनिक सिग्नेचर आइटम में envelope_id और document_ids होते हैं। आइटम में कोई type field नहीं होता और उनका क्रम स्थिर नहीं है: हर आइटम को उसकी keys से पहचानें, उसकी स्थिति से नहीं, और जिन आइटम को आप नहीं पहचानते उन्हें अनदेखा करें। keys snake_case में हैं, सिवाय doc.data के अंदर की keys के, जो दस्तावेज़ के स्कीमा का पालन करती हैं (उदाहरण: nomeCivil)।

FieldTypeDescription
consent_grantedbooleanदस्तावेज़ कैप्चर आइटम। यह बताता है कि यूज़र ने आपकी कंपनी के साथ दस्तावेज़ शेयर करने की सहमति दी या नहीं।
documentsarrayदस्तावेज़ कैप्चर आइटम। OCR डेटा और वैलिडेशन रिज़ल्ट के साथ कैप्चर किए गए दस्तावेज़।
documents[].doc_idstringदस्तावेज़ आइडेंटिफ़ायर।
documents[].​share_idstringउस share का आइडेंटिफ़ायर जो यूज़र ने इस प्रोसेस के लिए आपकी कंपनी को दिया।
documents[].​typifiedbooleanयह बताता है कि दस्तावेज़ प्रकार की पहचान हुई या नहीं।
documents[].​cpf_matchbooleanकेवल ब्राज़ील। यह बताता है कि दस्तावेज़ पर मौजूद CPF, प्रोसेस बनाते समय भेजे गए CPF से मैच करता है या नहीं। जिन कंपनियों का देश ब्राज़ील सेट है, उनके लिए हमेशा मौजूद रहता है; अन्य देशों के लिए और जिन कंपनियों का देश सेट नहीं है, उनके लिए नहीं भेजा जाता।
documents[].​validate_docbooleanकेवल ब्राज़ील। यह बताता है कि दस्तावेज़ Unico के दस्तावेज़ वैलिडेशन में पास हुआ या नहीं। जिन कंपनियों का देश ब्राज़ील सेट है, उनके लिए हमेशा मौजूद रहता है (वैलिडेशन न चलने पर false); अन्य देशों के लिए और जिन कंपनियों का देश सेट नहीं है, उनके लिए नहीं भेजा जाता।
documents[].​face_matchboolean or nullयह बताता है कि सेल्फी दस्तावेज़ पर मौजूद फ़ोटो से मैच करती है या नहीं। null का अर्थ है कि जाँच नहीं चली — यह नेगेटिव रिज़ल्ट नहीं है।
documents[].​verifiedboolean or nulltrue केवल तब, जब दस्तावेज़ प्रकार ज्ञात हो, दस्तावेज़ डिलीट न किया गया हो, face_match true हो और दस्तावेज़ quality checks में पास हुआ हो। अन्यथा false, जिसमें वह स्थिति भी शामिल है जब face_match नहीं चला। null तब, जब प्रोसेस document module से नहीं गुज़री।
documents[].​reused_docbooleanयह बताता है कि यह दस्तावेज़ किसी पहले की प्रोसेस से रीयूज़ किया गया था या नहीं।
documents[].​signed_urlstringदस्तावेज़ की इमेज डाउनलोड करने के लिए अल्पकालिक signed URL। इसकी समय-सीमा समाप्त हो जाती है: इसे स्टोर न करें और न ही किसी निश्चित अवधि पर निर्भर रहें; नया URL पाने के लिए इस एंडपॉइंट को फिर से कॉल करें।
documents[].​doc.​versionintegerदस्तावेज़ प्रकार की dictionary का वर्शन (उदाहरण: unico.moja.dictionary.br.cnh.v2.Cnh के लिए 2)।
documents[].​doc.​codestringदस्तावेज़ प्रकार, छोटे कोड (उदाहरण: CNH) या पूरे dictionary प्रकार (उदाहरण: unico.moja.dictionary.br.cnh.v2.Cnh) के रूप में। document module द्वारा प्रोसेस किए गए दस्तावेज़ छोटा कोड रखते हैं। दोनों को हैंडल करें। हर वैल्यू और कोड कैसे प्राप्त होता है, इसके लिए Document types and OCR fields देखें।
documents[].​doc.​dataobjectएक्सट्रैक्ट किए गए OCR field। सामग्री दस्तावेज़ प्रकार के अनुसार अलग-अलग होती है — पूरे कैटलॉग के लिए full field reference देखें। field के नाम दस्तावेज़ के स्कीमा का पालन करते हैं: ब्राज़ीलियाई दस्तावेज़ों के लिए पुर्तगाली (उदाहरण: nomeCivil, dataNascimento), मैक्सिकन दस्तावेज़ों के लिए स्पेनिश और यूनिफ़ाइड स्कीमा के लिए अंग्रेज़ी।
envelope_idstring (UUID)इलेक्ट्रॉनिक सिग्नेचर आइटम। Signed envelope आइडेंटिफ़ायर।
document_idsarray of stringsइलेक्ट्रॉनिक सिग्नेचर आइटम। envelope में मौजूद दस्तावेज़ों के ID।
केवल API से बनाई गई प्रोसेस

केवल API से बनाई गई प्रोसेस में, दस्तावेज़ आइटम API कॉल से आता है, Unico के document module से नहीं, और कुछ वैल्यू ऊपर दी गई तालिका से अलग होती हैं:

  • consent_granted हमेशा false होता है: सहमति आपकी कंपनी लेती है, और Unico उसे ट्रैक नहीं करता।
  • share_id और signed_url खाली होते हैं।
  • face_match हमेशा true या false होता है, कभी null नहीं।
  • verified हमेशा null होता है।
  • doc.version 0 होता है।
  • doc.code आमतौर पर पूरा dictionary प्रकार (उदाहरण: unico.moja.dictionary.br.cnh.v2.Cnh) रखता है, लेकिन छोटा कोड भी रख सकता है।
  • OCR डेटा पढ़ा न जा सकने पर doc.data null होता है।

Error Codes​

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

Polling vs webhook​

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

What's next​

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