اقرأ مستندات العملاء، وتحقق من ملف، وقيّم المخاطر، وأجرِ فحوص الهوية الإلكترونية (eID) عبر واجهة REST واحدة. جرّب في بيئة sandbox بمفتاحك، ثم غيّر حقل environment إلى production.
الإطلاق في 4 خطوات
من طلب الوصول إلى أول استدعاء. تُفعَّل واجهة الشركاء لكل مساحة عمل.
اطلب الوصول
اطلب وصولاً إلى sandbox. نفعّل واجهة الشركاء على مساحة عملك.
أنشئ مفتاح API
في وحدة التحكم، أنشئ مفتاحاً بالصلاحيات التي تحتاجها: kyc:extract وkyc:verify وkyc:eid.
جرّب في sandbox
أرسل environment=sandbox مع بيانات اختبار. لا يوجد مضيف sandbox منفصل.
انتقل إلى الإنتاج
أرسل environment=production بنفس نوع الطلب عندما تصبح مساحة عملك جاهزة.
العنوان الأساسي
مضيف واحد لكل الاستدعاءات. يحدد حقل environment في كل طلب بيانات الاختبار أو البيانات الفعلية: sandbox افتراضياً وproduction للإطلاق.
https://app.sahlfinancial.com/apiما تغطيه الواجهة اليوم
أربع إمكانات متاحة لمفاتيح واجهة الشركاء. بقية المنصة داخل وحدة التحكم.
| الإمكانية | وظيفتها | نقاط النهاية | الصلاحية |
|---|---|---|---|
| قراءة المستندات | تقرأ من 1 إلى 5 ملفات في كل استدعاء (JPEG أو PNG أو WebP أو TIFF أو PDF، حتى 30 ميغابايت لكل ملف) إلى حقول منظّمة. | POST /v1/kyc/extract | kyc:extract |
| التحقق | تفحص ملف العميل ومستنداته وتعيد حكماً مع الفحوص التي بُني عليها. | POST /v1/kyc/verify | kyc:verify |
| تقييم المخاطر | نفس محتوى طلب التحقق، مع تقييم للمخاطر مبني على الحكم. | POST /v1/kyc/assess | kyc:verify |
| الهوية الإلكترونية (eID) | تبدأ فحص eID، وتعرض حالته، وتنزّل التقرير. | POST /v1/kyc/eid, GET /v1/kyc/eid/{key}, GET /v1/kyc/eid/{key}/report | kyc: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":[]}'نقاط النهاية
ست نقاط نهاية على مضيف واحد. المخططات الكاملة للطلبات والاستجابات في ملف 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 | بدء فحص eID | kyc:eid |
| GET | /v1/kyc/eid/{key} | عرض فحص eID | kyc:eid |
| GET | /v1/kyc/eid/{key}/report | تنزيل تقرير eID | kyc:eid |
مفاتيح بصلاحيات
يحمل كل مفتاح الصلاحيات التي تمنحها له فقط: قراءة المستندات والتحقق وeID.
مضيف واحد وبيئتان
يشترك sandbox وproduction في المضيف نفسه ويختلفان بحقل environment.
يُحفظ لك
أرسل reference فيُحفظ الملف ومستنداته والحكم في مساحة عملك، حيث يراها فريقك.