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

ڈیولپرز

شناخت کی تصدیق کی API دستاویزات، جو واقعی استعمال کے لیے بنائی گئی ہیں۔

ایک REST API، ان حصوں کے لیے ایک hosted صفحہ جو آپ خود نہیں بنانا چاہتے، اور دستخط شدہ webhooks تاکہ نتیجہ آتے ہی آپ کو پتا چل جائے۔ Sandbox کلیدوں کا بل کبھی نہیں بنتا، اس لیے ShieldID کو سمجھنے کا تیز ترین طریقہ اسے کال کرنا ہے۔

sandbox میں مفت شروع کریںکوئیک اسٹارٹ پڑھیں

پانچ منٹ کا خلاصہ

چار کالز۔ ایک ذہنی خاکہ۔

ان دستاویزات میں باقی سب کچھ اسی چکر کی مزید تفصیل ہے۔

  1. سیشن بنائیں

    return URL اور webhook URL کے ساتھ POST /v1/sessions کریں۔ آپ کو واپس ایک session_id اور ایک verification_url ملے گا۔

  2. اسے درخواست دہندہ تک پہنچائیں

    verification_url کو لنک کے طور پر بھیجیں، یا انہیں وہ QR کوڈ اسکین کرنے دیں جو hosted صفحہ ڈیسک ٹاپ پر دکھاتا ہے۔ وہ اپنے فون پر مکمل کرتے ہیں۔

  3. دستخط شدہ webhook وصول کریں

    جب سیشن VERIFIED یا FAILED تک پہنچتا ہے تو ShieldID نتیجہ آپ کے webhook URL پر POST کرتا ہے، دستخط کے ساتھ تاکہ آپ بھروسا کر سکیں کہ یہ ہماری طرف سے آیا ہے۔

  4. نتیجہ پڑھیں

    webhook پر بھروسا کریں، یا خود GET /v1/sessions/{id}/result کال کریں۔ دونوں صورتوں میں آپ کو ہر جانچ کا الگ فیصلہ ملتا ہے، کوئی ایک مبہم اسکور نہیں۔

آزما کر دیکھیں

اپنا پہلا سیشن بنائیں۔

ایک ہی درخواست تین زبانوں میں۔ یہ وہی کال ہے جس کا ذہنی ماڈل کا پہلا مرحلہ ذکر کرتا ہے۔

bash
# Create a verification session (sandbox keys are never billed)
curl -X POST https://api.shieldid.ca/v1/sessions \
  -H "X-Api-Key: vk_sand_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "return_url": "https://yourapp.example/verified",
    "webhook_url": "https://yourapp.example/hooks/shieldid"
  }'

# → { "session_id": "…", "verification_url": "https://…/v/…", "environment": "sandbox" }

Sandbox کلیدیں (vk_sand_…) یہی فلو مفت چلاتی ہیں۔ vk_live_ کلید لگا دیں اور انوائس کے سوا کچھ نہیں بدلتا۔

اپنا راستہ تلاش کریں

باقی ڈیولپر دستاویزات۔

چھ صفحات۔ وہی پڑھیں جو آپ کو درکار ہوں۔

API حوالہ

ہر endpoint، ہر فیلڈ، اور ہر وہ غلطی جس کے لیے آپ پہلے سے منصوبہ بنا سکتے ہیں۔
کھولیں API حوالہ

SDKs

ویب ویجٹ، hosted فلو، اور جو آنے والا ہے۔
کھولیں SDKs

Sandbox

ٹیسٹ موڈ کیسے کام کرتا ہے، اور کلید کیسے حاصل کی جائے۔
کھولیں Sandbox

Sandbox

کسی بھی چیز پر دستخط کرنے سے پہلے پورے فلو کو آزما کر دیکھیں۔

sandbox کلید (جس کا سابقہ vk_sand_ ہے) پروڈکشن جیسا ہی API، ہوسٹڈ پیج اور ویب ہک فلو چلاتی ہے۔ سیشنز جہاں بھی دکھائی دیں ان پر environment: "sandbox" کی مہر لگی ہوتی ہے، اور sandbox سیشنز کا بل کسی بھی پلان پر کبھی نہیں بنتا۔

sandbox گائیڈ پڑھیں
  • حقیقی سیشنز بنائیں، اپنے ہی فون پر کوئی اصل دستاویز تصدیق کریں، اور واپس ایک حقیقی دستخط شدہ ویب ہک حاصل کریں
  • sandbox میں آپ جو کچھ بھی کریں، اس کا کسی انوائس پر کوئی اثر نہیں پڑتا
  • کلید کا سابقہ بدل کر پروڈکشن پر چلے جائیں؛ درخواست کی ساخت وہی رہتی ہے

کھلے عام تعمیر کیا گیا

کیا مکمل ہو چکا ہے، اور کیا ابھی نہیں۔

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

ویب ویجیٹ کے تکمیلی کال بیکس

جلد آ رہا ہے

onComplete، onCancel اور onStep آج ویجیٹ کے انٹرفیس میں موجود ہیں، لیکن ابھی کوئی چیز انہیں فعال نہیں کرتی۔ ریٹرن URL اور ویب ہک استعمال کریں — دونوں اب کام کر رہے ہیں۔

نافذ شدہ ریٹ کی حدیں

جلد آ رہا ہے

ہر API کی کے لیے آپ کے پلان کے مطابق ایک ریٹ کی حد درج ہے، لیکن درخواستوں پر ابھی اس کا نفاذ نہیں ہوتا — اسی کے مطابق منصوبہ بندی کریں، ShieldID پر انحصار نہ کریں کہ وہ آپ کی رفتار کو محدود کرے گا۔

خود سے sandbox سائن اپ

جلد آ رہا ہے

جب تک خود سائن اپ کی سہولت تیار کی جا رہی ہے، sandbox کیز درخواست پر جاری کی جاتی ہیں۔ بس کہہ دیں، ہم جلد از جلد ایک فراہم کر دیں گے۔

سوالات

ڈویلپرز کے لیے سیدھے جوابات۔

شروع کریں

ایک دوپہر میں لائیو ہو جائیں۔

sandbox کلید سے آغاز کریں، اپنے ہی فون پر ایک تصدیق چلائیں، اور وہ webhook پڑھیں جو آپ کو بھیجا جاتا ہے۔ سیلز کال کی ضرورت نہیں۔

sandbox میں مفت شروع کریںکوئیک اسٹارٹ پڑھیں

سینڈ باکس سیشنز کا بل کبھی نہیں بنتا۔