Document Process बनाएं

यह endpoint दो document flows को संभालता है जो एक ही path साझा करते हैं लेकिन body पैरामीटर में भिन्न हैं:

• नया कैप्चर — प्रसंस्करण के लिए base64 में दस्तावेज़ छवि(यां) सबमिट करता है (document.files आवश्यक)।
• पुन:उपयोग — पहले कैप्चर किए गए दस्तावेज़ को संदर्भित करके कैप्चर छोड़ता है (document.documentId आवश्यक)।

सक्रिय flow इस बात से निर्धारित होता है कि request body में document.documentId प्रदान किया गया है या नहीं।

document process बनाने से पहले, यह जांचने के लिए पुन:उपयोगी दस्तावेज़ प्राप्त करें का उपयोग करें कि उपयोगकर्ता के पास पहले से पुन:उपयोग के लिए कोई दस्तावेज़ उपलब्ध है या नहीं।

पूर्ण एकीकरण प्रवाह के लिए, देखें API Overview।

Endpoint

वातावरण	URL
Production	POST https://api.id.unico.app/processes/v1
Sandbox	POST https://api.id.uat.unico.app/processes/v1

अनुरोध

Headers

Header	मान
Authorization	Bearer <access_token> (देखें Authentication)
APIKEY	Document Capture और Reuse सक्षम प्रावधानित API key।
Content-Type	application/json

Body parameters

नया कैप्चर

फ़ील्ड	प्रकार	आवश्यक	विवरण
subject.duiType	string	हाँ	पहचानकर्ता प्रकार। संभावित मान: DUI_TYPE_BR_CPF, DUI_TYPE_MX_CURP, DUI_TYPE_US_SSN, DUI_TYPE_NG_NIN, DUI_TYPE_AR_DNI, DUI_TYPE_ID_NIK।
subject.code	string	हाँ	subject.duiType द्वारा परिभाषित उपयोगकर्ता पहचानकर्ता मान। बिना डॉट या डैश के।
subject.name	string	नहीं	पूरा नाम।
subject.gender	string	नहीं	M या F।
subject.birthDate	string (ISO 8601)	नहीं	जन्म तिथि (YYYY-MM-DD)।
subject.email	string	नहीं	ईमेल पता।
subject.phone	string	नहीं	E.164 फ़ोन नंबर।
document.purpose	string	हाँ	व्यावसायिक उद्देश्य। मान: creditprocess, carpurchase, paybypaycheck, onboarding, fgts।
document.authProcessId	string	हाँ	इस document कैप्चर से जुड़ी biometric process का ID।
document.files	array	हाँ	base64 में दस्तावेज़ छवियां (आगे और/या पीछे)।
document.files[].data	string	हाँ	base64 में दस्तावेज़ छवि (PNG, JPEG या WebP, अधिकतम 800 KB)।
subsidiaryId	string	नहीं	शाखा ID — केवल तब आवश्यक जब एकाधिक शाखाएं हों।

पुन:उपयोग

फ़ील्ड	प्रकार	आवश्यक	विवरण
subject.duiType	string	हाँ	पहचानकर्ता प्रकार। संभावित मान: DUI_TYPE_BR_CPF, DUI_TYPE_MX_CURP, DUI_TYPE_US_SSN, DUI_TYPE_NG_NIN, DUI_TYPE_AR_DNI, DUI_TYPE_ID_NIK।
subject.code	string	हाँ	subject.duiType द्वारा परिभाषित उपयोगकर्ता पहचानकर्ता मान। बिना डॉट या डैश के।
subject.name	string	नहीं	पूरा नाम।
subject.gender	string	नहीं	M या F।
subject.birthDate	string (ISO 8601)	नहीं	जन्म तिथि (YYYY-MM-DD)।
subject.email	string	नहीं	ईमेल पता।
subject.phone	string	नहीं	E.164 फ़ोन नंबर।
document.purpose	string	हाँ	व्यावसायिक उद्देश्य। मान: creditprocess, carpurchase, paybypaycheck, onboarding, fgts।
document.authProcessId	string	हाँ	इस दस्तावेज़ से जुड़ी biometric process का ID।
document.documentId	string	हाँ	पहले कैप्चर किए गए दस्तावेज़ का ID (पुन:उपयोगी दस्तावेज़ प्राप्त करें से प्राप्त)। जब यह प्रदान किया जाता है, तो document.files छोड़ा जा सकता है।
subsidiaryId	string	नहीं	शाखा ID — केवल तब आवश्यक जब एकाधिक शाखाएं हों।

उदाहरण

नया कैप्चर — cURL

curl -X POST https://api.id.unico.app/processes/v1 \
  -H "Authorization: Bearer $TOKEN" \
  -H "APIKEY: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": {
      "duiType": "DUI_TYPE_BR_CPF",
      "code": "12345678909",
      "name": "Luke Skywalker"
    },
    "document": {
      "purpose": "onboarding",
      "authProcessId": "80371b2a-3ac7-432e-866d-57fe37896ac6",
      "files": [
        { "data": "/9j/4AAQSkZJR..." }
      ]
    }
  }'

नया कैप्चर — Node.js

import fetch from 'node-fetch';

const res = await fetch('https://api.id.unico.app/processes/v1', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.UNICO_ACCESS_TOKEN}`,
    'APIKEY': process.env.UNICO_API_KEY,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    subject: {
      duiType: 'DUI_TYPE_BR_CPF',
      code: '12345678909',
      name: 'Luke Skywalker'
    },
    document: {
      purpose: 'onboarding',
      authProcessId: '80371b2a-3ac7-432e-866d-57fe37896ac6',
      files: [{ data: documentImageBase64 }]
    }
  })
});

const result = await res.json();

पुन:उपयोग — cURL

curl -X POST https://api.id.unico.app/processes/v1 \
  -H "Authorization: Bearer $TOKEN" \
  -H "APIKEY: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": {
      "duiType": "DUI_TYPE_BR_CPF",
      "code": "12345678909"
    },
    "document": {
      "purpose": "onboarding",
      "authProcessId": "80371b2a-3ac7-432e-866d-57fe37896ac6",
      "documentId": "doc-abc-123"
    }
  }'

पुन:उपयोग — Node.js

import fetch from 'node-fetch';

const res = await fetch('https://api.id.unico.app/processes/v1', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.UNICO_ACCESS_TOKEN}`,
    'APIKEY': process.env.UNICO_API_KEY,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    subject: {
      duiType: 'DUI_TYPE_BR_CPF',
      code: '12345678909'
    },
    document: {
      purpose: 'onboarding',
      authProcessId: '80371b2a-3ac7-432e-866d-57fe37896ac6',
      documentId: 'doc-abc-123'
    }
  })
});

const result = await res.json();

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

200 OK

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "document": {
    "id": "doc-abc-123",
    "type": "unico.moja.dictionary.br.cnh.v2.Cnh",
    "cpfMatch": true,
    "faceMatch": true,
    "content": {
      "numero": "12345678",
      "nomeCivil": "Luke Skywalker",
      "dataNascimento": "2000-05-20T00:00:00Z",
      "categoria": "B",
      "dataExpiracao": "2030-05-20T00:00:00Z"
    },
    "fileUrls": [
      "https://storage.unico.app/documents/doc-abc-123/front.jpg"
    ]
  }
}

फ़ील्ड	प्रकार	विवरण
id	string (UUID)	प्रक्रिया पहचानकर्ता।
status	integer	3 (सफलतापूर्वक समाप्त), 5 (विफलता के साथ समाप्त)।
document.id	string	कैप्चर किया गया दस्तावेज़ पहचानकर्ता। पुन:उपयोग के लिए भविष्य के document.documentId अनुरोधों में इस मान का उपयोग करें।
document.type	string	पहचाना गया दस्तावेज़ प्रकार। संभावित मान: unico.moja.dictionary.br.rg.v2.Rg, unico.moja.dictionary.br.cnh.v2.Cnh, unico.moja.dictionary.br.cin.v1.Cin, unico.moja.dictionary.br.passaporte.v1.Passaporte।
document.cpfMatch	boolean	true यदि दस्तावेज़ से निकाला गया पहचानकर्ता subject.code से मेल खाता है।
document.faceMatch	boolean	true यदि दस्तावेज़ का चेहरा document.authProcessId से biometric selfie से मेल खाता है।
document.content	object	OCR के माध्यम से निकाले गए फ़ील्ड। संरचना दस्तावेज़ प्रकार के अनुसार भिन्न होती है — नीचे देखें।
document.fileUrls	array	दस्तावेज़ छवियां डाउनलोड करने के लिए अस्थायी URL (10 मिनट की वैधता)।

400 Bad Request

payload अविधिमान्य है, छवि अमान्य है, या आवश्यक फ़ील्ड अनुपस्थित हैं। नीचे त्रुटि कोड देखें।

403 Forbidden

Bearer token या APIKEY अनुपस्थित, समाप्त या अमान्य। देखें Authentication।

409 Conflict

प्रदान किया गया processId इस tenant के लिए पहले से मौजूद है। नीचे त्रुटि कोड देखें।

त्रुटि कोड

400 Bad Request

कोड	संदेश	विवरण
99989	The document is invalid.	document object की संरचना अमान्य है।
99988	The document is empty.	document object request body से अनुपस्थित है।
20900	O base64 informado não é válido.	base64 पैरामीटर अमान्य है। संभावित कारण: यह छवि नहीं है या injection का प्रयास है।
20807	A imagem precisa estar no padrão HD ou possuir uma resolução superior a 640 x 480.	अपलोड की गई छवि का रिज़ॉल्यूशन बहुत कम है।
20509	The subject.name field is invalid.	subject.name में अमान्य वर्ण हैं।
20508	The subject.gender field is invalid.	subject.gender का मान M या F होना चाहिए।
20507	O parâmetro subject.code é inválido.	गैर-मानक या अस्तित्वहीन पहचानकर्ता मान।
20506	O base64 informado é muito grande. O tamanho máximo suportado é até 800kb.	छवि आकार 800 KB से अधिक है; JPEG92 में संपीड़ित करें।
20505	O base64 informado não é suportado. Os formatos aceitos são png, jpeg e webp.	base64 प्रारूप अमान्य या असमर्थित है।
20068	The document.documentId or document.files parameter must be present.	न document.documentId और न document.files प्रदान किए गए।
20067	The document.purpose parameter is invalid.	document.purpose में अपरिचित मान।
20066	The document.authProcessId parameter is invalid.	document.authProcessId में अमान्य मान।
20062	The useCase field is invalid.	useCase फ़ील्ड में अपरिचित मान।
20021	The subject.phone field is invalid.	subject.phone प्रारूप अमान्य (IDD + area code + number, 13 वर्ण)।
20019	The subject.birthDate field is invalid.	subject.birthDate ISO 8601 प्रारूप (YYYY-MM-DD) से बाहर है।
20009	O parâmetro imagebase64 não foi informado.	दस्तावेज़ छवि पैरामीटर अनुपस्थित।
20008	The subject.email field is invalid.	subject.email में अमान्य ईमेल प्रारूप।
20005	O parâmetro subject.code não foi informado.	subject.code पैरामीटर अनुपस्थित।
20004	O parâmetro subject não foi informado.	subject पैरामीटर अनुपस्थित।
20003	The request body is missing or invalid.	Null या अमान्य payload।
20002	O parâmetro APIKey não foi informado.	APIKEY पैरामीटर अनुरोध header से अनुपस्थित।
20001	O parâmetro authtoken não foi informado.	integration token पैरामीटर अनुरोध header से अनुपस्थित।
10508	The JWT with the captured face has already been used.	JWT केवल एक बार उपयोग किया जा सकता है।
10507	The JWT with the captured face is expired.	JWT समाप्त हो गया; 10 मिनट के भीतर भेजना होगा।
10506	The imageBase64 field is not a valid JWT from SDK.	imageBase64 SDK द्वारा उत्पन्न वैध JWT नहीं है।

403 Forbidden

कोड	संदेश	विवरण
30017	User does not have permission to perform this action.	अविधिमान्य JWT या उपयोगकर्ता के पास यह ऑपरेशन करने की अनुमति नहीं।
10502	O token informado está expirado.	access-token समाप्त हो गया।
10501	O token informado é inválido.	authentication token अमान्य है।
10201	O AppKey informado é inválido.	APIKEY अमान्य है या मौजूद नहीं है।

409 Conflict

कोड	संदेश	विवरण
20073	The processID already exists.	प्रदान किया गया processId इस tenant के लिए पहले से मौजूद है।

500 Internal Server Error

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

आगे क्या करें

• इस कॉल से पहले कोई दस्तावेज़ पहले से उपलब्ध है या नहीं यह जांचने के लिए देखें पुन:उपयोगी दस्तावेज़ प्राप्त करें।
• biometric process निर्माण (document.authProcessId के लिए आवश्यक) के लिए देखें प्रक्रिया बनाएं।