पुन:उपयोगी दस्तावेज़ प्राप्त करें

नया Document कैप्चर फ़्लो शुरू करने से पहले यह जांचने के लिए इस endpoint का उपयोग करें कि उपयोगकर्ता के पास पुन:उपयोग के लिए कोई दस्तावेज़ उपलब्ध है या नहीं। यदि कोई दस्तावेज़ मिलता है, तो कैप्चर चरण को छोड़ने के लिए उसका documentId सीधे POST /processes/v1 (Document प्रकार) में पास किया जा सकता है।

Endpoint

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

अनुरोध (Request)

Headers

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

Query parameters

पैरामीटर	प्रकार	आवश्यक	विवरण
code	string	हाँ	उपयोगकर्ता पहचानकर्ता (CPF या CURP, बिना फ़ॉर्मेटिंग के)।
type	string	हाँ	क्वेरी करने के लिए दस्तावेज़ प्रकार। स्वीकृत मान: BR_RG, BR_CNH, BR_CIN, BR_PASSPORT।

नोट

ऊपर दिए type मान केवल इस endpoint के लिए विशिष्ट हैं। इन्हें निम्न से भ्रमित न करें:

• POST अनुरोधों में subject.duiType — DUI_TYPE_* उपसर्ग का उपयोग करता है और दस्तावेज़ प्रकार नहीं बल्कि व्यक्ति की पहचान करता है (जैसे, DUI_TYPE_BR_CPF)।
• प्रतिक्रिया में documentType — पूर्ण रजिस्ट्री पथ का उपयोग करता है (जैसे, unico.moja.dictionary.br.cnh.v2.Cnh)।

उदाहरण (Example)

cURL

curl -X GET "https://api.id.unico.app/documents/v1?code=12345678909&type=BR_CNH" \
  -H "Authorization: Bearer $TOKEN" \
  -H "APIKEY: $API_KEY"

Node.js

import fetch from 'node-fetch';

const params = new URLSearchParams({ code: '12345678909', type: 'BR_CNH' });
const res = await fetch(
  `https://api.id.unico.app/documents/v1?${params}`,
  {
    headers: {
      Authorization: `Bearer ${accessToken}`,
      APIKEY: apiKey
    }
  }
);
const data = await res.json();
// data.items[0].documentId → pass to POST /processes/v1 for reuse

प्रतिक्रियाएं (Responses)

200 OK

{
  "items": [
    {
      "documentType": "unico.moja.dictionary.br.cnh.v2.Cnh",
      "documentId": "doc-abc-123"
    }
  ]
}

फ़ील्ड	प्रकार	विवरण
items	array	उपयोगकर्ता के लिए मिले पुन:उपयोगी दस्तावेज़ों की सूची। यदि दिए गए code और type के लिए कोई पुन:उपयोगी दस्तावेज़ नहीं मिला तो खाली array।
items[].documentType	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।
items[].documentId	string	दस्तावेज़ पहचानकर्ता। दस्तावेज़ पुन:उपयोग करने के लिए इस मान को POST /processes/v1 पर document.documentId में पास करें।

403 Forbidden

Bearer token या APIKEY अनुपस्थित, समाप्त, या अमान्य।

429 Too Many Requests

दर सीमा पहुँच गई। Retry-After प्रतिक्रिया हेडर में दर्शाए गए अंतराल के बाद पुनः प्रयास करें। दर सीमाएँ देखें।

पुन:उपयोग के लिए documentId का उपयोग

एक बार documentId मिलने के बाद, कैप्चर छोड़ने के लिए इसे Document process अनुरोध में पास करें:

{
  "subject": {
    "code": "12345678909",
    "name": "Luke Skywalker"
  },
  "document": {
    "purpose": "onboarding",
    "authProcessId": "<biometric-process-id>",
    "documentId": "doc-abc-123"
  }
}

फ़ील्ड	विवरण
document.purpose	इस document process के लिए व्यावसायिक उद्देश्य। स्वीकृत मान: creditprocess, carpurchase, paybypaycheck, onboarding, fgts। ये मान Document API के लिए विशिष्ट हैं और biometric SDK के purpose enum से भिन्न हैं।
document.authProcessId	इस उपयोगकर्ता के लिए पहले बनाई गई biometric process का ID (POST /processes/v1 से)।
document.documentId	इस endpoint की प्रतिक्रिया से प्राप्त Document ID। जब यह प्रदान किया जाता है, तो document.files को छोड़ा जा सकता है — platform पहले कैप्चर किए गए दस्तावेज़ को स्वचालित रूप से प्राप्त करती है।

पूर्ण Document process अनुरोध schema के लिए देखें Document Process बनाएं।

त्रुटि कोड (Error Codes)

400 Bad Request

कोड	संदेश	विवरण
20507	O parâmetro subject.code é inválido.	अविधिमान्य या अस्तित्वहीन पहचानकर्ता मान (CPF या CURP)।
20002	O parâmetro APIKey não foi informado.	APIKEY header अनुपस्थित।
20001	O parâmetro authtoken não foi informado.	authentication token header अनुपस्थित।

403 Forbidden

कोड	संदेश	विवरण
30017	Jwt header is an invalid JSON.	एक्सेस-टोकन में अमान्य वर्ण हैं।
10502	O token informado está expirado.	समाप्त हो चुका access-token।
10501	O token informado é inválido.	अमान्य प्रमाणीकरण token।
10201	O AppKey informado é inválido.	APIKEY अनुपस्थित या अस्तित्वहीन।

404 Not Found

कोड	संदेश	विवरण
99987	Attachment not found.	दस्तावेज़ से जुड़ा attachment नहीं मिला।
50001	The process is not found.	दिए गए पैरामीटर के लिए कोई दस्तावेज़ नहीं मिला।

500 Internal Server Error

कोड	संदेश	विवरण
99999	Internal failure! Try again later.	सर्वर-साइड प्रसंस्करण त्रुटि।