مرکزی مواد پر جائیں
ShieldID

ویب ہکس اور انضمام

شناخت کی تصدیق کے ویب ہکس، ایک ہوسٹڈ صفحہ اور ایک ویجیٹ۔

درخواست گزار کو ہوسٹڈ تصدیقی صفحے پر بھیجیں یا ویجیٹ کو اپنے فلو میں شامل کریں، نتیجہ آتے ہی دستخط شدہ ویب ہک حاصل کریں، اور لنک رکھنے والے ہر شخص کو عوامی اسناد کی جانچ کے صفحے پر اس کی تصدیق کرنے دیں۔ ایک KYC API انضمام جو ایک سہ پہر میں لائیو ہونے کے لیے بنایا گیا ہے۔

sandbox میں مفت شروع کریںدستخط کا نمونہ دیکھیں
  • HMAC-SHA256 سے دستخط شدہ کال بیکس
  • ڈیسک ٹاپ سے فون پر QR کے ذریعے منتقلی
  • sandbox سیشنز کا کبھی بل نہیں بنتا

Hosted ویریفیکیشن صفحہ

ایک لنک پورا فلو چلاتا ہے۔

API کے ذریعے سیشن بنائیں اور آپ کو تصدیقی URL مل جاتا ہے۔ اسے ای میل، ٹیکسٹ یا اپنی ایپ میں بھیجیں — باقی سب صفحہ سنبھال لیتا ہے۔

ڈیسک ٹاپ

درخواست گزار اپنی میز پر لنک کھولتا ہے۔

QR ہینڈ آف

صفحہ ایک QR کوڈ اور مختصر ہدایتی کارڈ دکھاتا ہے۔

فون سے کیپچر

اسے اسکین کرنے سے وہی سیشن دستاویز اور سیلفی کیپچر پر منتقل ہو جاتا ہے۔

تصدیق شدہ

سیشن VERIFIED تک پہنچتا ہے، اب بھی فون پر۔

آپ کی طرف واپسی

آپ کے ریٹرن URL پر ری ڈائریکٹ، اور ساتھ ہی دستخط شدہ ویب ہک، دونوں صورتوں میں۔

پیمنٹ ری ڈائریکٹ کی طرح کام کرتا ہے

درخواست گزار آپ کے سیشن کے اپنے URL پر موجود صفحے پر پہنچتا ہے۔ نہ اکاؤنٹ، نہ انسٹال کرنے کے لیے ایپ۔

QR کے ذریعے منتقلی، ڈیسک ٹاپ سے فون پر

ڈیسک ٹاپ پر کھولنے پر صفحہ کیمرا تک رسائی مانگنے کے بجائے QR کوڈ اور مختصر ہدایتی کارڈ دکھاتا ہے۔ اسے اسکین کرنے سے وہی لنک فون پر کھلتا ہے، جو سیدھا دستاویز اور سیلفی کیپچر پر چلا جاتا ہے۔

جواب کے ساتھ آپ کی طرف واپسی

سیشن کے VERIFIED ہوتے ہی صفحہ آپ کے ریٹرن URL پر ری ڈائریکٹ کرتا ہے جس کے ساتھ سیشن ID اور اسٹیٹس جڑے ہوتے ہیں، تاکہ آپ کی ایپ کو کسی اور چیز کا انتظار کیے بغیر پتا چل جائے کہ کیا ہوا۔

برانڈڈ، اہل پلانز پر

آپ کی کمپنی کا نام، لوگو، نمایاں رنگ اور شرائط و پرائیویسی کے لنکس، جو ہوسٹڈ صفحے اور کریڈینشل چیک صفحے پر لاگو ہوتے ہیں۔

ویب ہکس

نتیجہ آتے ہی ایک دستخط شدہ کال بیک۔

سیشن بناتے وقت ہمیں webhook URL دیں اور سیشن ختم ہوتے ہی ہم نتیجہ اس پر پوسٹ کر دیتے ہیں، پولنگ کی ضرورت نہیں۔

صرف بھیجا نہیں، دستخط شدہ

ہر ڈیلیوری کے ساتھ X-Bio-Signature ہیڈر ہوتا ہے: ریکویسٹ باڈی کا HMAC-SHA256، تاکہ بھروسہ کرنے سے پہلے آپ ثابت کر سکیں کہ یہ ہماری طرف سے آیا ہے۔

دوبارہ آزمائی جاتی ہے، بھیج کر بھول نہیں جاتے

ناکام ڈیلیوری تین بار دوبارہ آزمائی جاتی ہے، اور ہر کوشش سے پہلے انتظار کا وقت بڑھتا جاتا ہے۔

ہر کوشش ریکارڈ ہوتی ہے

کامیابی ہو یا ناکامی، ہم اپنی طرف کوشش کا ریکارڈ رکھتے ہیں۔

جلد آ رہا ہے پورٹل کے اندر ڈیلیوری لاگ، تاکہ آپ ہر کوشش خود دیکھ سکیں، جلد آ رہا ہے۔

تازہ ترین VERIFIED کو سچ مانیں

دوبارہ کوششوں کا مطلب ہے کہ نادر صورتوں میں ڈیلیوری ترتیب سے ہٹ کر پہنچ سکتی ہے۔ اپنی لاجک کو webhook ملنے پر منحصر نہ رکھیں — اسے سیشن ID پر رکھیں، اور بعد کے VERIFIED کو پہلے والے کی جگہ لینے دیں۔ اگر آپ اپنی اسٹیٹ رکھتے ہیں تو webhook کی وصولی کے بجائے سیشن ID کی بنیاد پر ڈپلیکیٹ ختم کریں۔

دستخط کی تصدیق کریں

کارروائی سے پہلے پے لوڈ پر اعتماد کریں۔

کچھ بھی پارس کرنے سے پہلے خام ریکویسٹ باڈی پر HMAC-SHA256 دوبارہ نکالیں اور اس کا X-Bio-Signature سے موازنہ کریں۔

javascript
const crypto = require("crypto");

function verifySignature(rawBody, signatureHeader, secret) {
  const expected = crypto.createHmac("sha256", secret).update(rawBody).digest("hex");
  const a = Buffer.from(expected, "hex");
  const b = Buffer.from(signatureHeader || "", "hex");
  return a.length === b.length && crypto.timingSafeEqual(a, b);
}

// Read the raw body — don't let a JSON body-parser touch it first.
app.post("/hooks/shieldid", express.raw({ type: "application/json" }), (req, res) => {
  const signature = req.header("X-Bio-Signature") || "";
  if (!verifySignature(req.body, signature, process.env.SHIELDID_WEBHOOK_SECRET)) {
    return res.status(401).send("invalid signature");
  }
  const event = JSON.parse(req.body);
  // Treat the latest VERIFIED status as authoritative; de-duplicate by session_id.
  res.status(200).send("ok");
});

JS ویجیٹ

ہوسٹڈ فلو، آپ کے اپنے صفحے میں شامل۔

ویجیٹ سیشن بناتا ہے اور وہی ہوسٹڈ فلو iframe میں ان لائن دکھاتا ہے، تاکہ درخواست گزار کبھی آپ کی سائٹ نہ چھوڑیں۔

  • کیمرا اور مائیکروفون کی رسائی کے ساتھ iframe میں دکھایا جاتا ہے، اور اپنے کنٹینر کے مطابق سائز ہوتا ہے۔
  • سیشن کی حیثیت اسی طرح پڑھتا ہے جیسے ہوسٹڈ صفحہ پڑھتا ہے: سیشن مکمل ہونے پر آپ کے واپسی URL اور آپ کے ویب ہک کے ذریعے۔

جلد آ رہا ہے صفحے کے اندر تکمیل کے کال بیکس (onComplete، onCancel، onStep، خودکار ری سائز) جلد آ رہے ہیں۔ تب تک سیشن مکمل ہونے کا پتہ لگانے کے لیے return_url اور ویب ہکس استعمال کریں — یہ آج کام کرتے ہیں۔

اسے پروڈکشن میں بھیجنے سے پہلے

ویجیٹ فی الحال براؤزر میں براہِ راست API کلید قبول کرتا ہے۔ اسے sandbox کی سہولت سمجھیں، پروڈکشن کا طریقہ نہیں: سیشن اپنے بیک اینڈ سے بنائیں اور اپنی کلید سرور کی طرف ہی رکھیں، اور ویجیٹ کو صرف نتیجے میں بننے والا سیشن دیں، کبھی ایسی لائیو کلید نہیں جسے وزیٹر کا براؤزر پڑھ سکے۔

html
<script src="https://cdn.shieldid.ca/sdk/v1/widget.js"></script>
<div id="shieldid-verify"></div>
<script>
  TLVerify.init({
    apiKey: "vk_sand_your_key", // sandbox only — see the note above for production
    containerId: "shieldid-verify",
    returnUrl: "https://yourapp.example/verified",
    webhookUrl: "https://yourapp.example/hooks/shieldid",
    locale: "en",
  });
</script>

اسناد کی جانچ کا صفحہ

تصدیق شدہ سیشن کے لیے ایک عوامی صفحہ۔

جب کوئی سیشن VERIFIED تک پہنچ جاتا ہے تو اس کا اپنا اسناد کی جانچ کا لنک سادہ زبان میں تصدیق دکھاتا ہے: درخواست گزار کا نام، دستاویز کی قسم اور حیثیت۔ لنک رکھنے والا کوئی بھی — شریک دستخط کنندہ، فرنٹ ڈیسک کلرک، فریقِ مخالف — آپ کے ڈیش بورڈ میں سائن اِن کیے بغیر نتیجے کی تصدیق کر سکتا ہے۔

Jordan Reyes

نمونہ ڈیٹا

کیلیفورنیا ڈرائیونگ لائسنس

تصدیق شدہ

  • اسے دیکھنے کے لیے سائن اِن ضروری نہیں۔
  • اس پر کبھی شناختی دستاویز کی اصل تصویر یا اعتماد کا اسکور ظاہر نہیں ہوتا — صرف حیثیت اور شناخت، اس سے زیادہ کچھ نہیں۔
  • ہوسٹڈ صفحے کی طرح برانڈڈ، اہل پلانز پر۔

انضمام کے نمونے

چھ قسم کے کاروبار اسے کیسے جوڑتے ہیں۔

بنیادی اجزا ہر جگہ ایک جیسے ہیں: ایک سیشن، ایک لنک یا ویجیٹ، ایک ویب ہک۔ کون سا نمونہ موزوں ہے، یہ اس پر منحصر ہے کہ آپ کو جواب کیسے اور کب چاہیے۔

کرایہ داری اور پراپرٹی مینجمنٹ

ہوسٹڈ لنک کرائے کی درخواست والی ای میل ہی میں بھیجیں۔ آپ کے فائل کا جائزہ لینے سے پہلے ویب ہک آپ کے سسٹم میں درخواست گزار کو تصدیق شدہ کر دیتا ہے۔

قانونی شعبہ اور لا فرمز

کلائنٹ کے اندراج کے دوران لنک بھیجیں اور ویب ہک کی رسید فائل کے ساتھ محفوظ کریں، تاکہ ریٹینر شروع ہونے سے پہلے کلائنٹ کی شناخت ریکارڈ پر ہو۔

کونڈو اور HOA ایسوسی ایشنز

مالک یا کرایہ دار کے اندراج کے اس فارم سے لنک کریں جو بورڈ پہلے ہی استعمال کرتا ہے؛ یونٹ کے رجسٹر میں شامل ہونے سے پہلے نتیجہ پہنچ جاتا ہے۔

فن ٹیک اور قرضے

ویب ہک آپ کے اپنے انڈر رائٹنگ مرحلے کو خودکار طور پر چلا دیتا ہے، اس لیے درخواست گزار کو کبھی اس انتظار میں نہیں رہنا پڑتا کہ کوئی شخص نتیجہ آنے کو نوٹس کرے۔

مارکیٹ پلیسز اور گگ پلیٹ فارمز

سیلر یا ڈرائیور آن بورڈنگ میں ویجیٹ ایمبیڈ کریں تاکہ فلو آپ کی ایپ سے باہر نہ جائے؛ سیشن اپنے بیک اینڈ سے بنائیں، جیسا کہ اوپر سفارش کی گئی ہے۔

E-signature

دستخط کی تقریب شروع ہونے سے پہلے ہوسٹڈ فلو چلائیں، اور دستاویزات کی ریلیز کو درخواست گزار کے اپنے دعوے پر نہیں بلکہ webhook پر منحصر رکھیں۔

سوالات

انضمام کے بارے میں سیدھے جوابات۔

شروع کریں

webhook جوڑیں۔ اسے چلتے دیکھیں۔

webhook URL کے ساتھ sandbox سیشن بنائیں، اپنے فون پر تصدیق چلائیں، اور بھیجا گیا دستخط شدہ کال بیک پڑھیں۔

sandbox میں مفت شروع کریںAPI حوالہ