SPL National Address Services
SPL National Address Services enable the retrieval of registered National Address information for individuals using a National ID or Iqama number, and for businesses using a Commercial Registration number. The services also support retrieving National Address details through mobile number verification using a One-Time Password (OTP).
Description
SPL National Address Services enable the retrieval of registered National Address information for individuals using a National ID or Iqama number, and for businesses using a Commercial Registration number. The services also support retrieving National Address details through mobile number verification using a One-Time Password (OTP).
Documentation
توفر خدمات العنوان الوطني المقدمة من البريد السعودي (سبل) واجهات برمجية تتيح للأنظمة والمنصات الرقمية الاستعلام عن بيانات العنوان الوطني المسجلة للأفراد والمنشآت داخل المملكة العربية السعودية.
تشمل الخدمات المتاحة:
1. الاستعلام عن العنوان الوطني للأفراد: استرجاع تفاصيل العنوان الوطني باستخدام رقم الهوية الوطنية أو الإقامة.
2. الاستعلام عن العنوان الوطني للمنشآت: استرجاع بيانات العنوان الوطني المرتبط بالمنشأة باستخدام رقم السجل التجاري.
3. إرسال رمز التحقق: إرسال رمز تحقق (OTP) إلى رقم الجوال المسجل في العنوان الوطني.
4. استرجاع العنوان الوطني باستخدام رمز التحقق: الحصول على تفاصيل العنوان الوطني المرتبط برقم الجوال بعد التحقق من الرمز المرسل.
تشمل البيانات المسترجعة رقم المبنى واسم الشارع والحي والمدينة والرمز البريدي والرقم الإضافي والعنوان المختصر والإحداثيات الجغرافية، بحسب الخدمة المستخدمة.
تساهم هذه الخدمات في تسهيل التكامل بين الأنظمة، والتحقق من بيانات العناوين الوطنية، ورفع جودة ودقة البيانات المستخدمة في العمليات والخدمات الرقمية.
Endpoints
Endpoints are grouped as the provider publishes them, and are tied to a version and an environment. Changing either returns a different list.
National Address Services
4تتيح الخدمة الاستعلام عن تفاصيل العنوان الوطني المسجل لدى سبل باستخدام رقم الهوية الوطنية أو الإقامة.
| Field | Location | Default Value | Description |
|---|---|---|---|
IqamaRequired | query | — | National ID or Iqama number used to retrieve the National Address. |
encode | query | — | Response character encoding. |
language | query | — | Response language. A = Arabic, E = English. |
format | query | — | Response format: json or xml. |
| Field | Type | Example | Description |
|---|---|---|---|
totalSearchResults | string | "1" | إجمالي عدد العناوين الوطنية المطابقة لعملية البحث. |
Addresses | array | […] | قائمة العناوين الوطنية المسجلة للفرد. |
Addresses[].BuildingNumber | string | "3846" | رقم المبنى المسجل في العنوان الوطني. |
Addresses[].Street | string | "Maymonah Bint Al Harith" | اسم الشارع باللغة الإنجليزية. |
Addresses[].DistrictID | string | null | null | المعرف الخاص بالحي في نظام العنوان الوطني. |
Addresses[].District | string | "Al Darb" | اسم الحي باللغة الإنجليزية. |
Addresses[].City | string | "KHAMIS MUSHAYT" | اسم المدينة باللغة الإنجليزية. |
Addresses[].PostCode | string | "62461" | الرمز البريدي الخاص بالعنوان الوطني. |
Addresses[].AdditionalNumber | string | "8647" | الرقم الإضافي المرتبط بموقع المبنى. |
Addresses[].City_L2 | string | "خميس مشيط" | اسم المدينة باللغة العربية. |
Addresses[].Street_L2 | string | "ميمونة بنت الحارث" | اسم الشارع باللغة العربية. |
Addresses[].District_L2 | string | "الدرب" | اسم الحي باللغة العربية. |
Addresses[].ObjLatLng | string | "42.7287613806559 18.305964353939…" | الإحداثيات الجغرافية لموقع العنوان الوطني، وتشمل خط الطول وخط العرض. |
Addresses[].ShortAddress | string | "AKPG3846" | العنوان الوطني المختصر المكون من أربعة أحرف وأربعة أرقام. |
Addresses[].IsPrimaryAddress | string | "true" | مؤشر يوضح ما إذا كان العنوان هو العنوان الوطني الرئيسي للفرد. |
Addresses[].PKAddressID | string | "6246138468647" | المعرف الفريد لسجل العنوان الوطني. |
Addresses[].CityID | string | "62" | المعرف الخاص بالمدينة في نظام العنوان الوطني. |
Addresses[].RegionID | string | "6" | المعرف الخاص بالمنطقة الإدارية. |
Addresses[].Address1 | string | "3846 Maymonah Bint Al Harith - A…" | السطر الأول من العنوان الوطني، ويشمل رقم المبنى واسم الشارع والحي. |
Addresses[].Address2 | string | "KHAMIS MUSHAYT 62461 - 8647" | السطر الثاني من العنوان الوطني، ويشمل المدينة والرمز البريدي والرقم الإضافي. |
Addresses[].RegionName | string | "Assir" | اسم المنطقة الإدارية باللغة الإنجليزية. |
Addresses[].RegionName_L2 | string | "عسير" | اسم المنطقة الإدارية باللغة العربية. |
Addresses[].Latitude | string | "18.3059643539398" | خط العرض الجغرافي لموقع العنوان الوطني. |
Addresses[].Longitude | string | "42.7287613806559" | خط الطول الجغرافي لموقع العنوان الوطني. |
PostCode | null | null | حقل الرمز البريدي على مستوى الاستجابة العامة، وتكون قيمته فارغة في المثال الحالي. |
success | boolean | true | مؤشر نجاح أو فشل تنفيذ طلب الاستعلام. |
result | null | null | حقل مخصص لنتيجة إضافية، وتكون قيمته فارغة في المثال الحالي. |
statusdescription | string | "SUCCESS" | وصف حالة معالجة الطلب، مثل SUCCESS عند نجاح الاستعلام. |
fullexception | null | null | تفاصيل الاستثناء أو الخطأ التقني، وتكون قيمته فارغة في المثال الحالي. |
تتيح هذه الخدمة الاستعلام عن بيانات العنوان الوطني المسجل للمنشآت باستخدام رقم السجل التجاري، واسترجاع تفاصيل العنوان المرتبطة به، بما في ذلك رقم المبنى واسم الشارع والحي والمدينة والرمز البريدي والرقم الإضافي.
| Field | Location | Default Value | Description |
|---|---|---|---|
language | query | — | Response language. A = Arabic, E = English. |
crnumberRequired | query | — | Commercial Registration number used to retrieve the business National Address. |
format | query | — | Response format: json or xml. |
encode | query | — | Response character encoding. |
| Field | Type | Example | Description |
|---|---|---|---|
totalSearchResults | string | "1" | إجمالي عدد نتائج البحث عن العناوين الوطنية المرتبطة بالسجل التجاري. |
KSABusinesses | array | […] | قائمة العناوين الوطنية المسجلة للمنشأة المرتبطة برقم السجل التجاري. |
KSABusinesses[].Title | string | "مؤسسة نوره محمد المطيري" | اسم أو عنوان المنشأة المرتبط بالعنوان الوطني. |
KSABusinesses[].Address1 | string | "4283 Al Harith Ibn Al Abbas Ibn …" | السطر الأول من العنوان الوطني، ويتضمن رقم المبنى واسم الشارع والحي. |
KSABusinesses[].Address2 | string | "UNAYZAH 56432 - 6933" | السطر الثاني من العنوان الوطني، ويتضمن المدينة والرمز البريدي والرقم الإضافي. |
KSABusinesses[].ObjLatLng | string | "44.0234698533012 26.123773339701…" | بيانات الإحداثيات الجغرافية للعنوان الوطني التي يمكن استخدامها لتحديد موقعه على الخريطة. |
KSABusinesses[].BuildingNumber | string | "4283" | رقم المبنى المسجل ضمن العنوان الوطني. |
KSABusinesses[].Street | string | "Al Harith Ibn Al Abbas Ibn Abdul…" | اسم الشارع الذي يقع فيه المبنى. |
KSABusinesses[].District | string | "Al Muruj Dist." | اسم الحي الذي يقع فيه العنوان الوطني. |
KSABusinesses[].City | string | "UNAYZAH" | اسم المدينة التي يقع فيها العنوان الوطني. |
KSABusinesses[].PostCode | string | "56432" | الرمز البريدي الخاص بالعنوان الوطني. |
KSABusinesses[].AdditionalNumber | string | "6933" | الرقم الإضافي المستخدم لتحديد موقع المبنى ضمن العنوان الوطني. |
KSABusinesses[].RegionName | string | "Al Qassim" | اسم المنطقة الإدارية التي يتبع لها العنوان الوطني. |
KSABusinesses[].PolygonString | null | null | بيانات الحدود الجغرافية المرتبطة بالعنوان، وتكون القيمة فارغة في نموذج الاستجابة الحالي. |
KSABusinesses[].IsPrimaryAddress | string | "true" | مؤشر يوضح ما إذا كان العنوان هو العنوان الوطني الرئيسي للمنشأة. |
KSABusinesses[].UnitNumber | string | "3" | رقم الوحدة داخل المبنى، مثل رقم المكتب أو المحل. |
KSABusinesses[].Latitude | string | "26.1237733397015" | خط العرض الجغرافي لموقع العنوان الوطني. |
KSABusinesses[].Longitude | string | "44.0234698533012" | خط الطول الجغرافي لموقع العنوان الوطني. |
KSABusinesses[].CityId | string | "80" | المعرف الخاص بالمدينة في نظام العنوان الوطني. |
KSABusinesses[].RegionId | string | "4" | المعرف الخاص بالمنطقة الإدارية في نظام العنوان الوطني. |
KSABusinesses[].Restriction | string | "" | بيانات القيود أو المحددات المرتبطة بالعنوان الوطني، إن وجدت. |
KSABusinesses[].PKAddressID | string | "5643242836933" | المعرف الفريد لسجل العنوان الوطني في النظام. |
KSABusinesses[].DistrictID | string | "" | المعرف الخاص بالحي في نظام العنوان الوطني. |
KSABusinesses[].Title_L2 | null | null | اسم أو عنوان المنشأة باللغة الثانية، وتكون القيمة فارغة في نموذج الاستجابة الحالي. |
KSABusinesses[].RegionName_L2 | string | "القصيم" | اسم المنطقة الإدارية باللغة الثانية. |
KSABusinesses[].City_L2 | string | "عنيزة" | اسم المدينة باللغة الثانية. |
KSABusinesses[].Street_L2 | string | "الحارث بن العباس بن عبدالمطلب" | اسم الشارع باللغة الثانية. |
KSABusinesses[].District_L2 | string | "حي المروج" | اسم الحي باللغة الثانية. |
KSABusinesses[].CompanyName_L2 | null | null | اسم الشركة أو المنشأة باللغة الثانية، وتكون القيمة فارغة في نموذج الاستجابة الحالي. |
KSABusinesses[].GovernorateID | string | "" | المعرف الخاص بالمحافظة التي يتبع لها العنوان الوطني. |
KSABusinesses[].Governorate | string | "" | اسم المحافظة التي يقع ضمن نطاقها العنوان الوطني. |
KSABusinesses[].Governorate_L2 | string | "" | اسم المحافظة باللغة الثانية. |
success | boolean | true | مؤشر يوضح ما إذا تم تنفيذ طلب الاستعلام بنجاح. |
result | null | null | حقل مخصص لبيانات النتيجة الإضافية، وتكون قيمته فارغة في نموذج الاستجابة الحالي. |
statusdescription | string | "SUCCESS" | وصف حالة تنفيذ الطلب، ويوضح نتيجة عملية الاستعلام. |
fullexception | null | null | حقل مخصص لتفاصيل الاستثناء أو الخطأ، وتكون قيمته فارغة في نموذج الاستجابة الحالي. |
تتيح الخدمة إرسال رمز تحقق (OTP) إلى رقم الجوال المسجل في العنوان الوطني لدى سبل، لاستخدامه في التحقق واسترجاع بيانات العنوان الوطني.
| Field | Location | Default Value | Description |
|---|---|---|---|
MobileNoRequired | query | — | Mobile number registered with the National Address. |
| Field | Type | Example | Description |
|---|---|---|---|
Status | string | "true" | مؤشر يوضح حالة تنفيذ طلب إرسال رمز التحقق، حيث تشير القيمة true إلى نجاح العملية. |
ErrorCode | string | "001" | رمز حالة تنفيذ الطلب أو رمز الخطأ، حيث تشير القيمة 001 إلى نجاح إرسال رمز التحقق وفق الاستجابة المعروضة. |
ErrorFriendlyMessage | string | "Sent Successfully" | رسالة توضح نتيجة عملية إرسال رمز التحقق بصيغة مفهومة للمستخدم. |
SystemErrorMessage | string | "" | رسالة تقنية توضح تفاصيل الخطأ عند فشل تنفيذ الطلب، وقد تكون فارغة عند نجاح العملية. |
PinCode | string | "****" | رمز التحقق (OTP) المرسل إلى رقم الجوال المسجل في العنوان الوطني. |
SMSBody | string | "**** عزيزنا العميل يمكنك مشاركة …" | محتوى الرسالة النصية المرسلة إلى المستفيد، والتي تتضمن رمز التحقق المستخدم لاسترجاع العنوان الوطني. |
تتيح الخدمة استرجاع تفاصيل العنوان الوطني المسجل لدى سبل باستخدام رقم الجوال ورمز التحقق (OTP).
| Field | Location | Default Value | Description |
|---|---|---|---|
MobileNoRequired | query | — | Mobile number used in the OTP request. |
PinCodeRequired | query | — | OTP / PIN code received in the previous step. |
| Field | Type | Example | Description |
|---|---|---|---|
waselAddressDetails | array | […] | قائمة تفاصيل العناوين الوطنية المسجلة برقم الجوال بعد التحقق من رمز OTP. |
waselAddressDetails[].City | string | "1" | المعرف الخاص بالمدينة التي يقع فيها العنوان الوطني. |
waselAddressDetails[].CityName | string | "الرياض" | اسم المدينة باللغة العربية. |
waselAddressDetails[].CityNameEn | string | "" | اسم المدينة باللغة الإنجليزية. |
waselAddressDetails[].District | string | "" | المعرف الخاص بالحي الذي يقع فيه العنوان الوطني. |
waselAddressDetails[].DistrictArea | string | "" | بيانات منطقة الحي المرتبطة بالعنوان الوطني. |
waselAddressDetails[].DistrictName | string | "حي الضباط" | اسم الحي باللغة العربية. |
waselAddressDetails[].DistrictNameEN | string | "" | اسم الحي باللغة الإنجليزية. |
waselAddressDetails[].LocationX | string | "8546" | رقم المبنى المكون من أربعة أرقام، ويستخدم لتمييز المبنى ضمن العنوان الوطني. |
waselAddressDetails[].LocationY | string | "4080" | الرقم الإضافي المكون من أربعة أرقام ضمن بيانات العنوان الوطني. |
waselAddressDetails[].LocationZ | string | "12623" | الرمز البريدي المكون من خمسة أرقام والمرتبط بالعنوان الوطني. |
waselAddressDetails[].IsPrimaryAddress | boolean | true | مؤشر يحدد ما إذا كان العنوان هو العنوان الرئيسي للفرد. تكون القيمة true للعنوان الرئيسي وfalse إذا كان الفرد تابعًا في هذا العنوان. |
waselAddressDetails[].MobileNo | string | "966593969083" | رقم الجوال المرتبط بالعنوان الوطني. |
waselAddressDetails[].Street | string | "" | المعرف الخاص بالشارع الذي يقع فيه المبنى. |
waselAddressDetails[].StreetNameEn | string | "" | اسم الشارع باللغة الإنجليزية. |
waselAddressDetails[].StreetName | string | "جابر بن سفيان" | اسم الشارع باللغة العربية. |
waselAddressDetails[].UnitNo | string | "10" | رقم الوحدة داخل المبنى، مثل رقم الشقة أو المكتب. |
waselAddressDetails[].Latitude | string | "24.68753767" | خط العرض الجغرافي لموقع العنوان الوطني، معبرًا عنه بالدرجات. |
waselAddressDetails[].Longitude | string | "46.72034532" | خط الطول الجغرافي لموقع العنوان الوطني، معبرًا عنه بالدرجات. |
waselAddressDetails[].UnitTypeID | string | "" | المعرف الخاص بنوع الوحدة داخل المبنى. |
waselAddressDetails[].ShortAddress | string | "RCTA8546" | العنوان الوطني المختصر، ويتكون من أربعة أحرف وأربعة أرقام، مثل RCTA8546. |
GenericResult | null | null | حقل مخصص لنتيجة معالجة الطلب أو تفاصيل الأخطاء، وتكون قيمته null عند نجاح الاستعلام. |
There is no plan currently.
Subscription Prerequisites
Prerequisite Documents
No prerequisite documents required
Select from Profile
No attachments found in your profile
Notice
Your request is under review. We'll let you know once the vendor responds.
KYC/KYB Required
You need to complete your KYC/KYB info first to subscribe
Review & Confirm
Check the package and its price. Nothing is created until you confirm.
- Package
- Package
- Number of requests
- —
VAT (15%) is added on the payment page, which shows the full total before you pay.
Provide Your Credentials
This API requires credentials provided by you. Enter the requested information below to continue your subscription.
Upgrade Required to Continue
This API supports Bring Your Own Key (BYOK), but your current subscription plan does not include BYOK access. Upgrade your plan to continue.
No Active Subscription Found
You do not have an active subscription plan. Please subscribe to a plan to continue.
Endpoints & Pricing
- 1View Pricing Details
- 2Configure & Subscribe
- 3Review & Confirm
Select the endpoints you need and enter the number of requests. Pricing is per request — volume discounts apply automatically.
| Endpoint | Method | Version | Base Price | Volume Tiers | Failed Call Price |
|---|
- Volume tiers: price per request drops as quantity increases. Tier applied automatically at checkout.
- Failed Call Price: deducted when the endpoint returns 4xx or 5xx. It is one fixed price per request and does not change with the volume tiers.
Select the endpoints you need and enter the number of requests. Pricing is per request — volume discounts apply automatically.
✦ Volume tiers: price per request drops as quantity increases. Tier applied automatically at checkout.
| Select Endpoints | Endpoint | Method | Version | Quantity (Requests) | Tier Applied | Price Per Request (success) | Subtotal | Failed Call Price |
|---|
✦ Failed Call Price: deducted when the endpoint returns 4xx or 5xx. It is one fixed price per request and does not change with the volume tiers.
Please select at least one endpoint and enter a quantity.
Notice
Your request is under review. We'll let you know once the vendor responds.
Consumer Warning Message
Important: The endpoints you are adding will be attached to your existing subscription and will follow the same expiry date and renewal cycle. The subscription period will not be extended for the newly added endpoints.
Endpoints Quota Detail
no data is available
Notice
Your request is under review. We'll let you know once the vendor responds.
Try the call
Copy the snippet in your preferred language, or open the console to run it in the browser.
تتيح الخدمة الاستعلام عن تفاصيل العنوان الوطني المسجل لدى سبل باستخدام رقم الهوية الوطنية أو الإقامة.
تتيح هذه الخدمة الاستعلام عن بيانات العنوان الوطني المسجل للمنشآت باستخدام رقم السجل التجاري، واسترجاع تفاصيل العنوان المرتبطة به، بما في ذلك رقم المبنى واسم الشارع والحي والمدينة والرمز البريدي والرقم الإضافي.
تتيح الخدمة إرسال رمز تحقق (OTP) إلى رقم الجوال المسجل في العنوان الوطني لدى سبل، لاستخدامه في التحقق واسترجاع بيانات العنوان الوطني.
تتيح الخدمة استرجاع تفاصيل العنوان الوطني المسجل لدى سبل باستخدام رقم الجوال ورمز التحقق (OTP).