API Reference अवलोकन

शून्य से अपने पहले humanToken तक पहुँचने के लिए आपको जो कुछ भी चाहिए।

Markdown

Human Token में तीन endpoints हैं। यह पेज दिखाता है कि वे एक साथ कैसे काम करते हैं ताकि आप तुरंत एकीकरण शुरू कर सकें।

बेस URL

वातावरण	बेस URL
प्रोडक्शन	https://humantoken.unico.app

सभी अनुरोधों के लिए x-unico-accesskey हेडर आवश्यक है। अपनी कुंजी जनरेट करने के लिए प्रमाणीकरण देखें।

---

त्वरित-प्रारंभ प्रवाह

---

चरण 1 — प्रमाणीकरण

Human Dashboard में या Authentication API के माध्यम से अपना x-unico-accesskey जनरेट करें। नीचे प्रत्येक अनुरोध इस कुंजी का उपयोग करता है।

x-unico-accesskey: uip_ak.prod.a1b2c3d4.e5f6g7h8.i9j0k1l2

---

चरण 2 — एक प्रक्रिया बनाएँ

सत्यापन शुरू करने के लिए Create Process को कॉल करें। दो में से एक मॉडल चुनें:

मॉडल	Flows	यह कैसे काम करता है
API Only	api+humantoken, api+liveness+humantoken, api+liveness+humantoken+revalidation	आपका बैकएंड सेल्फी को imageBase64 के रूप में भेजता है। humanToken उसी प्रतिक्रिया में वापस आता है।
Human Token Journey	humantoken, humantoken+revalidation	उपयोगकर्ता Unico प्लेटफ़ॉर्म पर कैप्चर पूरा करता है। आपको journey प्रस्तुत करने के लिए token और link मिलता है, फिर Get Process से परिणाम प्राप्त करें।

API Only उदाहरण:

curl -X POST https://humantoken.unico.app/client/v1/process \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "flow": "api+humantoken",
    "imageBase64": "<base64-encoded-selfie>",
    "companyBranchId": "<your-branch-id>"
  }'

Human Token Journey उदाहरण:

curl -X POST https://humantoken.unico.app/client/v1/process \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "flow": "humantoken",
    "callbackUri": "https://yourapp.com/callback",
    "companyBranchId": "<your-branch-id>"
  }'

सभी flows, पैरामीटर और प्रतिक्रिया विवरण के लिए Create Process देखें।

---

चरण 3 — उपयोगकर्ता को journey प्रस्तुत करें (केवल Journey flows)

humantoken और humantoken+revalidation flows के लिए, Create Process की प्रतिक्रिया में शामिल हैं:

• token — Web SDK या नेटिव एकीकरण को इनिशियलाइज़ करता है
• link — उपयोगकर्ता को रीडायरेक्ट करने के लिए URL

अपने प्लेटफ़ॉर्म के अनुकूल एकीकरण चुनें:

प्लेटफ़ॉर्म	दृष्टिकोण
Web — SDK	idpay-b2b-sdk के साथ journey को इनलाइन एम्बेड करें → Web Integration
Web — Redirect	उपयोगकर्ता को link पर रीडायरेक्ट करें → Web Integration
Android	Custom Tabs → Android
iOS	ASWebAuthenticationSession → iOS
Ionic	Capacitor plugin → Ionic
React Native	Native module → React Native
Flutter	Platform Channels → Flutter

जब journey समाप्त होती है, उपयोगकर्ता आपके callbackUri पर लौटता है। चरण 4 पर आगे बढ़ें।

API Only flows

इस चरण को छोड़ दें — परिणाम पहले से ही Create Process की प्रतिक्रिया में है।

---

चरण 4 — परिणाम प्राप्त करें (केवल Journey flows)

परिणाम प्राप्त करने के लिए प्रक्रिया id के साथ Get Process को कॉल करें:

curl https://humantoken.unico.app/client/v1/process/$PROCESS_ID \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY"

प्रतिक्रिया में data.humanToken.value (मानक flows) या data.humanTokenMatch (पुनर्सत्यापन flows) शामिल है। पूर्ण प्रतिक्रिया स्कीमा और स्थिति मानों के लिए Get Process देखें।

---

चरण 5 — humanToken का उपयोग करें

humanToken एक स्थिर, अपारदर्शी पहचानकर्ता है (100 वर्णों तक)। वही व्यक्ति हमेशा उसी मान में हल होता है।

const { humanToken } = process.data;

if (!humanToken?.value) {
  // Inconclusive — retry or reject per your business rules
  return;
}

const existing = await db.persons.findByHumanToken(humanToken.value);

if (existing) {
  // Same person seen before — returning user or duplicate
} else {
  // First time — create a new record
  await db.persons.create({ humanToken: humanToken.value });
}

चेतावनी

स्टोर या मैच करने से पहले हमेशा जाँचें कि data.humanToken.value खाली नहीं है।

---

चरण 6 — सेल्फी प्राप्त करें (वैकल्पिक)

कैप्चर की गई छवि डाउनलोड करने के लिए Get Selfie को कॉल करें। प्रक्रिया समाप्त होने के बाद सेल्फी 24 घंटे तक उपलब्ध रहती है — उसके बाद इसे स्थायी रूप से हटा दिया जाता है।

curl https://humantoken.unico.app/client/v1/process/$PROCESS_ID/selfie \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY"

प्रतिक्रिया विवरण और त्रुटि कोड के लिए Get Selfie देखें।

---

एक नज़र में Endpoints

विधि	Endpoint	विवरण
POST	/client/v1/process	Create Process — सत्यापन शुरू करें
GET	/client/v1/process/{processId}	Get Process — परिणाम प्राप्त करें
GET	/client/v1/process/{processId}/selfie	Get Selfie — सेल्फी डाउनलोड करें (24 घंटे)

आगे क्या

• Create Process — सभी पाँच flows के लिए पूर्ण पैरामीटर संदर्भ
• Authentication — अपनी एक्सेस कुंजियाँ जनरेट और प्रबंधित करें
• Build With LLM — पूर्ण एकीकरण जनरेट करने के लिए अपने AI सहायक में एक प्रॉम्प्ट पेस्ट करें