مستندات API – سرویس تطابقی اطلاعات مالی (شبا و کدملی)
مستندات سرویس API تطابقی اطلاعات مالی (شماره شبا یا IBAN با اطلاعات هویتی)
IBAN (Sheba) Validate API Documents
نسخه 1.1.0 - 11/28/2023
فهرست مطالب
۱. مقدمه
در سرویس تطابقی اطلاعات مالی (شماره شبا یا IBAN و اطلاعات هویتی) یوآیدی، با ارسال شماره شبای کاربر، می‌توانید تطابق اطلاعات مالی مربوط به صاحب حساب را با اطلاعات هویتی صحت سنجی کنید.
۲. فراخوانی سرویس validate/iban/ownership
برای استفاده از سرویس API تطابقی اطلاعات مالی (شماره شبا یا IBAN با اطلاعات هویتی) یوآیدی می‌بایست سرویس زیر با پارامترهای درخواستی فراخوانی نمائید. این سرویس با دریافت شماره شبای کاربر، کدملی و تاریخ تولد صحت اطلاعات کاربر (true یا false) را در پاسخ بر می‌گرداند.
۱.۲. نمونه درخواست
نمونه‌ی درخواست به شرح زیر است:
https://json-api.uid.ir/api/validate/iban/ownership
Content-Type: application/json;charset=UTF-8
{
"requestContext" : {
"apiInfo": {
"businessId": <UID_BUSINESS_ID>,
"businessToken": <UID_BUSINESS_TOKEN>
}
},
"iban" : "IR123456789012345678901234",// String - 26 Digits with IR
"nationalId" : "0123456789",
"birthDate" : "1370/05/17"
},
۲.۲. توضیح پارامترهای درخواست
| Field | Type | Kind | Description |
| businessId | string | Required | شناسه کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
| businessToken | string | Required | توکن کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
| iban | string | Required | شماره شبای کاربر |
nationalId | string | Required | کد ملی کاربر |
birthDate | string | Required | تاریخ تولد کاربر |
۳.۲. نمونه پاسخ
{
"responseContext": {
"status": {
"code": 0,
"message": "SUCCESS.",
"details": []
},
"requestId": "",
"correlationId": "",
"navigationURI": "",
"nextStepToken": "",
"userSessionId": "",
"custom": {}
},
"isMatched": true
}
۴.۲. توضیح پارامترهای پاسخ
| Field | Type | Description |
| code | int | کد خطا |
| message | string | توضیحات خطا |
| isMatched | bool | تطابق مالکیت: true عدم تطابق مالکیت: false |