مستندات سرویس API استعلام اعتبار معاملاتی

Check Justice API Documents

نسخه 1.1.1 - 05/01/2024

بخش اول: فراخوانی Justice

این بخش مربوط به هدایت کاربر به سرویس استعلام اعتبار معاملاتی یوآیدی می‌باشد.

۱. مقدمه

در سرویس استعلام اعتبار معاملاتی یوآیدی، با ارسال کد ملی و شماره تلفن، پس از دریافت کد تایید از سوی کاربر می‌توانید استعلام اعتبار معاملاتی را دریافت نمائید.

۲. استعلام اعتبار معاملاتی یوآیدیrequest-permission

برای استفاده از سرویس API استعلام اعتبار معاملاتی یوآیدی می‌بایست سرویس زیر با پارامتر‌های درخواستی فراخوانی نمائید. این سرویس با دریافت کد ملی و شماره موبایل کاربر، trackingId اختصاصی کاربر را در پاسخ بر می‌گرداند.

۱.۲. نمونه درخواست permission

نمونه‌ی درخواست به شرح زیر است:

				
					POST - https://json-api.uid.ir/api/check-justice-profile/request-permission-from-user

Content-Type: application/json;charset=UTF-8
{
    "requestContext" : {
            "apiInfo" : {
                "businessId" : <UID_BUSINESS_ID>,
                "businessToken" : <UID_BUSINESS_TOKEN>
            }
    },
    "nationalId" : "0123456789",
    "mobileNumber" : "09000000000"
}

۲.۲. پارامترها

Field	Type	Kind	Description
businessId	string	Required	شناسه کسب‌و‌کار یا BusinessID (توسط یوآیدی در اختیار شما قرار می‌گیرد)
businessToken	string	Required	توکن کسب‌و‌کار یا BusinessToken (توسط یوآیدی در اختیار شما قرار می‌گیرد)
nationalId	string	Required	کد ملی کاربر
mobileNumber	string	Required	تلفن همراه کاربر به صورت 09xxxxxxxxx به نام کاربر

۳. نمونه پاسخ

				
					{
    "responseContext": {
        "status": {
            "code": 0,
            "message": "SUCCESS.",
            "details": []
        },
        "requestId": "",
        "correlationId": "",
        "navigationURI": "",
        "nextStepToken": "",
        "userSessionId": "",
        "custom": {}
    },
    "trackingId": <TRACKING_ID>
}

۲.۳. توضیح پارامترهای پاسخ

Field	Type	Description
massage	string	پیام دریافتی از سمت یوآیدی
trackingId	string	شناسه‌ای که توسط یوآیدی به کاربر پذیرنده اختصاص داده می‌شود.

همزمان با دریافت پیام موفق از سمت بیزینس ، پیامک کد اعتبار سنجی برای کاربر ارسال میشود که در مرحله بعد مورد نیاز است.

۴.نمونه درخواست Verify permission

نمونه‌ی درخواست به شرح زیر است:

				
					POST - https://json-api.uid.ir/api/check-justice-profile/verify-user-permission


Content-Type: application/json;charset=UTF-8
{
    "requestContext": {
        "apiInfo": {
            "businessId": <UID_BUSINESS_ID>,
            "businessToken":<UID_BUSINESS_TOKEN>
        }
    },
    "personType" : "0",
    "nationalId" : "0123456789",
    "otp" : "12345",
    "trackingId" : <TRACKING_ID>
}

۱.۴. توضیح پارامترهای پاسخ

Field	Type	Description
businessId	string	شناسه کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد)
businessToken	string	توکن کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد)
personTyp	string	نوع شخص (0 به منزله فرد حقیقی)
nationalId	string	کد ملی کاربر
otp	string	کد ارسال شده به شماره موبایل کاربر
trackingId	string	شناسه‌ای که توسط یوآیدی به کاربر پذیرنده اختصاص داده شده. (در مرحله قبل)

۲.۴. نمونه پاسخ

				
					{
    "responseContext": {
        "status": {
            "code": 3,
            "message": "خطا سرویس دهنده",
            "details": []
        },
        "requestId": "",
        "correlationId": "",
        "navigationURI": "",
        "nextStepToken": "",
        "userSessionId": "",
        "custom": {}
    }
}

۳.۴. توضیح پارامترهای درخواستی

Field	Type	Kind	Description
code	string	Required	کد خطا (مقدار 0 در صورت موفق بودن)
message	string	Required	پیام خطا

توجه: در صورت دریافت پیام “خطا سرویس دهنده” مجدد استعلام شود.

توجه: در صورت دریافت پیام “امکان تلاش بیش از 3 بار وجود ندارد” با دریافت trackingId جدید ، مجددا استعلام شود.

۵.فراخوانی کال‌بک پذیرنده توسط UID

پس از خاتمه فرآیند ، UID کال‌بک اعلامی پذیرنده را با پارامتر‌های مربوطه فراخوانی کرده و نتیجه اعتبار معاملاتی را به اطلاع پذیرنده می‌رساند.

۱.۵. نمونه فراخوانی کال‌بک

کال‌بک پذیرنده با آبجکت زیر و متد POST فراخوانی می‌شود:

				
					POST - BUSINESS_CALLBACK_URL eg: <https://uid-business.com/uid-callback>
  {
  "result" : {
    "data" : "کد ملی 0123456789 در قوه قضائیه احراز شده است \nدر مورد این شخص،سابقه منفی یافت نشد",
    "status" : {
      "statusCode" : "200",
      "message" : null
    }
  },
  "status" : {
    "statusCode" : "200",
    "message" : "OK"
  }
}

۲.۵. توضیح پارامترهای ارسالی

Field	Type	Description
data	string	توضیحات وضعیت (مطابق جدول زیر)

۳.۵. جداول توضیحات وضعیت (reason)

Value	Result	Description
کد ملی 0123456789 ممنوع المعامله است	REJECTED	ممنوع المعامله بودن
کد ملی 0123456789 ممنوع المعامله است	REJECTED	محجور المعامله بودن
کد ملی 0123456789 ممنوع المعامله است	REJECTED	غایب مفقود الاثر شخص
کد ملی 0123456789 ممنوع المعامله است	REJECTED	متوفی فرضی شخص
کد ملی 0123456789 ممنوع المعامله است	REJECTED	متوقف شخص
کد ملی 0123456789 ممنوع المعامله است	REJECTED	ورشکسته
کد ملی 0123456789 باید به مراجع قضایی مراجعه کند	REJECTED	متهم/محکوم متواری
کد ملی 0123456789 دارای سابقه اعسار است	REJECTED	معصر
کد ملی 0123456789 دارای محکومیت مالی اجرا شده/اجرا نشده است	REJECTED	محکومیت مالی محاکم
کد ملی 0123456789 دارای محکومیت مالی اجرا شده/اجرا نشده است	REJECTED	محکومیت مالی اجرائیات ثبت
کد ملی 0123456789 در قوه قضاییه احراز نشده است.لطفا جهت ثبت نام از آدرس زیر اقدام نمایید sana.adliran.ir	UNDEFINED	دارا نبودن سامانه ثنا
کد ملی 0123456789 در مورد این شخص سابقه منفی یافت نشد	ACCEPTED	بدون مشکل