مرجع api / commercial/persons/resolve/
یافتن شخص
یافتن شخص با شناسه ملی کامل یا ماسک‌شده + نام.
GET
commercial/persons/resolve/یافتن شخص بر اساس شناسه ملی کامل (۱۰ رقم) یا شناسه ماسک‌شده + نام کامل. هویت، شناسه ملی ماسک‌شده، تاریخ تولد و نام پدر را برمی‌گرداند. اشخاص دارای حریم‌خصوصی فعال یا opt-out در دسترس نخواهند بود.
نیازمند اعتبار20 درخواست در دقیقه
هدرها
X-API-KEYstringبلهکلید api شما.
پارامترهای کوئری
idempotency_keystringبلهUUID یکتا.
national_idstringشناسه ملی کامل (۱۰ رقم). یکی از این یا masked_national_id الزامی است.
masked_national_idstringشناسه ماسک‌شده (مثل 123****890). در این حالت full_name هم باید ارسال شود.
full_namestringنام و نام خانوادگی کامل. هنگام استفاده از masked_national_id الزامی است.
نمونه درخواست
curl -X GET 'https://www.saravar.com/api/commercial/persons/resolve/?national_id=1234567890&idempotency_key=550e8400-e29b-41d4-a716-446655440000' \-H 'X-API-KEY: <YOUR_API_KEY>'
پاسخ
debit_transaction_idinteger | nullبلهشناسه تراکنش.
total_chargedintegerبلهمبلغ کسر شده بر حسب IRR.
data.id_codestringبلهشناسه داخلی شخص.
data.full_namestringبلهنام کامل.
data.national_idstringبلهشناسه ملی کامل.
data.masked_national_idstringبلهشناسه ملی ماسک‌شده.
data.date_of_birthstring | nullبلهتاریخ تولد (در صورت موجود بودن و عدم محدودیت حریم‌خصوصی).
data.father_namestring | nullبلهنام پدر (در صورت موجود بودن و عدم محدودیت حریم‌خصوصی).
نکات قیمت‌گذاری و رفتار
- یک واحد به ازای هر فراخوانی موفق محاسبه می‌شود.
- فیلدهای محدود توسط حریم‌خصوصی از پاسخ حذف می‌شوند و در محاسبه هزینه لحاظ نخواهند شد.
- حداقل کارمزد به ازای هر فراخوانی موفق اعمال می‌شود.
خطاها
400کد وضعیتعلتidempotency_key مفقود، هیچ پارامتر جستجویی ارسال نشده، یا insufficient_credits.
اقدام پیشنهادییکی از national_id یا (masked_national_id + full_name) را ارسال کنید و کلید معتبر بفرستید.
401کد وضعیتعلتکلید api نامعتبر است.
اقدام پیشنهادیکلید فعال بسازید.
403کد وضعیتعلتاحراز هویت ملی تکمیل نشده.
اقدام پیشنهادیاحراز هویت را تکمیل کنید.
404کد وضعیتعلتشخص یافت نشد یا دارای حریم‌خصوصی فعال است.
اقدام پیشنهادیصحت شناسه ملی را بررسی کنید.
429کد وضعیتعلتاز سقف نرخ عبور کرده‌اید.
اقدام پیشنهادیbackoff اعمال کنید.