आयु सत्यापन
पूर्ण एकीकरण प्रवाह के लिए, API अवलोकन देखें।
एंडपॉइंट
| वातावरण | 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> (प्रमाणीकरण देखें) |
APIKEY | प्रावधानित API कुंजी — इसमें आयु सत्यापन क्षमताएं सक्षम होनी चाहिए। |
Content-Type | application/json |
Body parameters
| फ़ील्ड | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
subject | object | हाँ | उपयोगकर्ता जानकारी कंटेनर। |
subject.code | string | सशर्त | CPF (BR) या CURP (MX), बिना फ़ॉर्मेटिंग के। जब प्रवाह में लाइवनेस या पहचान सत्यापन शामिल हो तो आवश्यक है (आयु सत्यापन क्षमता देखें); केवल आयु सत्यापन प्रवाह के लिए आवश्यक नहीं। |
subject.name | string | नहीं | उपयोगकर्ता का पूरा नाम। |
subject.gender | string | नहीं | पुरुष के लिए M या महिला के लिए F। |
subject.birthDate | string (ISO 8601) | नहीं | जन्म तिथि (YYYY-MM-DD)। |
subject.email | string | नहीं | उपयोगकर्ता का ईमेल पता। |
subject.phone | string | नहीं | फ़ोन नंबर: देश कोड + क्षेत्र कोड + नंबर, बिना विभाजक (जैसे 5519725570707)। |
useCase | string | नहीं | ऑपरेशन का परिस्थिति पहचानकर्ता। |
subsidiaryId | string | नहीं | शाखा ID — केवल तभी आवश्यक है जब एकाधिक शाखाएं मौजूद हों। |
imageBase64 | string | हाँ | एन्क्रिप्टेड SDK आउटपुट या base64 इमेज (PNG, JPEG, WebP)। |
इमेज आवश्यकताएं
- न्यूनतम रिज़ॉल्यूशन: 640 × 480 (HD मानक)
- अधिकतम फ़ाइल आकार: 800 KB (JPEG92 संपीड़न अनुशंसित)
- SDK के JWT टोकन 10 मिनट के बाद समाप्त हो जाते हैं और केवल एक बार उपयोग किए जा सकते हैं
उदाहरण
- cURL
- Node.js
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": {
"code": "12345678909",
"name": "Luke Skywalker",
"birthDate": "2000-05-20",
"email": "[email protected]",
"phone": "5519725570707"
},
"useCase": "AgeVerification",
"imageBase64": "/9j/4AAQSkZJR..."
}'
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: {
code: '12345678909',
name: 'Luke Skywalker',
birthDate: '2000-05-20',
phone: '5519725570707'
},
useCase: 'AgeVerification',
imageBase64: capturedImage
})
});
const result = await res.json();
प्रतिक्रियाएं
200 OK
लौटाए गए प्रतिक्रिया फ़ील्ड इस बात पर निर्भर करते हैं कि आपके APIKEY के लिए कौन सी क्षमताएं सक्षम हैं।
केवल आयु सत्यापन (कोई लाइवनेस नहीं, कोई पहचान सत्यापन नहीं):
{
"id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
"status": 3,
"idAge": { "result": "yes" }
}
आयु सत्यापन + लाइवनेस + पहचान सत्यापन:
{
"id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
"status": 3,
"unicoId": { "result": "yes" },
"idAge": { "result": "yes" },
"liveness": 1
}
| फ़ील्ड | प्रकार | विवरण |
|---|---|---|
id | string (UUID) | प्रक्रिया पहचानकर्ता। पुनः-क्वेरी के लिए Get Process के साथ उपयोग करें। |
status | integer | 3 (सफलता के साथ समाप्त), 5 (त्रुटि)। व्यावसायिक निर्णयों के लिए केवल status = 3 का उपयोग करें। सभी संभावित मानों के लिए, Get Process देखें। |
idAge.result | string | yes, no, inconclusive — आयु सत्यापन परिणाम। सभी प्रतिक्रियाओं में मौजूद। |
unicoId.result | string | yes, no, inconclusive — केवल तभी मौजूद जब पहचान सत्यापन सक्षम हो। |
liveness | integer | 1 (पास), 2 (विफल) — केवल तभी मौजूद जब लाइवनेस सक्षम हो। |
त्रुटि कोड
- 400 Bad Request
- 403 Forbidden
- 409 Conflict
- 429 Too Many Requests
- 500 Internal Server Error
| कोड | संदेश | विवरण |
|---|---|---|
20900 | O base64 informado não é válido. | अमान्य base64 पैरामीटर; संभावित इमेज या इंजेक्शन समस्या। |
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 उपसर्ग। |
20062 | The useCase field is invalid. | useCase फ़ील्ड में अज्ञात मान। |
20021 | The subject.phone field is invalid. | subject.phone फ़ॉर्मेट अमान्य है (IDD + क्षेत्र कोड + नंबर, 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 या विकृत पेलोड। |
20002 | O parâmetro APIKey não foi informado. | APIKEY हेडर अनुपस्थित। |
20001 | O parâmetro authtoken não foi informado. | प्रमाणीकरण टोकन हेडर अनुपस्थित। |
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 नहीं है। |
Bearer टोकन या APIKEY अनुपस्थित, समाप्त, या अमान्य है। प्रमाणीकरण देखें।
| कोड | संदेश | विवरण |
|---|---|---|
30017 | User does not have permission to perform this action. | विकृत JWT या इस ऑपरेशन को करने की अनुमति के बिना उपयोगकर्ता। |
30017 | Jwt header is an invalid JSON. | access-token में अमान्य वर्ण हैं। |
10502 | O token informado está expirado. | समाप्त access-token। |
10501 | O token informado é inválido. | अमान्य प्रमाणीकरण टोकन। |
10201 | O AppKey informado é inválido. | APIKEY अनुपस्थित या अनुपस्थित। |
| कोड | संदेश | विवरण |
|---|---|---|
20073 | The processID already exists. | प्रदान किया गया processId इस टेनेंट के लिए पहले से मौजूद है। |
दर सीमा पहुँच गई। Retry-After प्रतिक्रिया हेडर में दर्शाए गए अंतराल के बाद पुनः प्रयास करें। दर सीमाएं देखें।
| कोड | संदेश | विवरण |
|---|---|---|
99999 | Internal failure! Try again later. | सर्वर-साइड प्रोसेसिंग त्रुटि। |
आगे क्या है
- किसी मौजूदा प्रक्रिया की क्वेरी के लिए, Get Process देखें।