واجهة الشركاء

    ابنِ مع
    واجهة سهل للشركاء

    اقرأ مستندات العملاء، وتحقق من ملف، وقيّم المخاطر، وأجرِ فحوص الهوية الإلكترونية (eID) عبر واجهة REST واحدة. جرّب في بيئة sandbox بمفتاحك، ثم غيّر حقل environment إلى production.

    بداية سريعة

    الإطلاق في 4 خطوات

    من طلب الوصول إلى أول استدعاء. تُفعَّل واجهة الشركاء لكل مساحة عمل.

    1

    اطلب الوصول

    اطلب وصولاً إلى sandbox. نفعّل واجهة الشركاء على مساحة عملك.

    2

    أنشئ مفتاح API

    في وحدة التحكم، أنشئ مفتاحاً بالصلاحيات التي تحتاجها: kyc:extract وkyc:verify وkyc:eid.

    3

    جرّب في sandbox

    أرسل environment=sandbox مع بيانات اختبار. لا يوجد مضيف sandbox منفصل.

    4

    انتقل إلى الإنتاج

    أرسل environment=production بنفس نوع الطلب عندما تصبح مساحة عملك جاهزة.

    العنوان الأساسي

    مضيف واحد لكل الاستدعاءات. يحدد حقل environment في كل طلب بيانات الاختبار أو البيانات الفعلية: sandbox افتراضياً وproduction للإطلاق.

    https://app.sahlfinancial.com/api
    التغطية

    ما تغطيه الواجهة اليوم

    أربع إمكانات متاحة لمفاتيح واجهة الشركاء. بقية المنصة داخل وحدة التحكم.

    الإمكانيةوظيفتهانقاط النهايةالصلاحية
    قراءة المستنداتتقرأ من 1 إلى 5 ملفات في كل استدعاء (JPEG أو PNG أو WebP أو TIFF أو PDF، حتى 30 ميغابايت لكل ملف) إلى حقول منظّمة.POST /v1/kyc/extractkyc:extract
    التحققتفحص ملف العميل ومستنداته وتعيد حكماً مع الفحوص التي بُني عليها.POST /v1/kyc/verifykyc:verify
    تقييم المخاطرنفس محتوى طلب التحقق، مع تقييم للمخاطر مبني على الحكم.POST /v1/kyc/assesskyc:verify
    الهوية الإلكترونية (eID)تبدأ فحص eID، وتعرض حالته، وتنزّل التقرير.POST /v1/kyc/eid, GET /v1/kyc/eid/{key}, GET /v1/kyc/eid/{key}/reportkyc:eid
    في وحدة التحكمالربط البنكي، والملفات، وسياسات التقييم. غير متاحة عبر مفاتيح واجهة الشركاء.وحدة التحكم فقط
    أمثلة برمجية

    اقرأ مستنداً ثم تحقق منه

    استدعاءان حقيقيان. عيّن SAHL_API_KEY بمفتاح sandbox ووجّه الملف إلى مستند اختبار.

    # 1. Read a document (multipart). environment defaults to sandbox.
    curl -X POST https://app.sahlfinancial.com/api/v1/kyc/extract \
      -H "Authorization: Bearer $SAHL_API_KEY" \
      -F "files=@passport-test.jpg" \
      -F "doc_type=passport" \
      -F "reference=client-0001" \
      -F "environment=sandbox"
    
    # 2. Verify the profile (send back the documents the first call returned).
    curl -X POST https://app.sahlfinancial.com/api/v1/kyc/verify \
      -H "Authorization: Bearer $SAHL_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{"reference":"client-0001","environment":"sandbox","subject":"Test Client","kind":"individual","values":{"first_name":"Test","last_name":"Client"},"documents":[]}'
    مرجع API

    نقاط النهاية

    ست نقاط نهاية على مضيف واحد. المخططات الكاملة للطلبات والاستجابات في ملف OpenAPI والوثائق.

    المصادقة

    أرسل مفتاح API كرمز Bearer. تُنشأ المفاتيح في وحدة التحكم بالصلاحيات kyc:extract وkyc:verify وkyc:eid. المفتاح الذي يفتقر إلى صلاحية استدعاء ما يتلقى الرمز 403. احتفظ بالمفاتيح على خادمك، ولا تضعها أبداً في متصفح أو تطبيق جوال.

    Authorization: Bearer <API key>
    الطريقةالمساروظيفتهاالصلاحية
    POST/v1/kyc/extractقراءة المستندات (multipart: files وdoc_type وreference وenvironment)kyc:extract
    POST/v1/kyc/verifyالتحقق من ملفkyc:verify
    POST/v1/kyc/assessالتحقق وتقييم المخاطرkyc:verify
    POST/v1/kyc/eidبدء فحص eIDkyc:eid
    GET/v1/kyc/eid/{key}عرض فحص eIDkyc:eid
    GET/v1/kyc/eid/{key}/reportتنزيل تقرير eIDkyc:eid
    جدير بالمعرفة

    مفاتيح بصلاحيات

    يحمل كل مفتاح الصلاحيات التي تمنحها له فقط: قراءة المستندات والتحقق وeID.

    مضيف واحد وبيئتان

    يشترك sandbox وproduction في المضيف نفسه ويختلفان بحقل environment.

    يُحفظ لك

    أرسل reference فيُحفظ الملف ومستنداته والحكم في مساحة عملك، حيث يراها فريقك.

    ابدأ البناء اليوم

    اطلب وصولاً إلى sandbox وأجرِ أول استدعاء.

    نحن نحترم خصوصيتك

    نستخدم ملفات تعريف الارتباط لتحسين تجربة التصفح وتحليل حركة المرور وتخصيص المحتوى. بالنقر على 'قبول الكل'، فإنك توافق على استخدامنا لملفات تعريف الارتباط. معرفة المزيد