# استعلام فهرست سیاه بانک مرکزی

این سرویس برای استعلام فهرست سیاه بانک مرکزی استفاده می‌شود. درخواست را با توکن معتبر ارسال کنید و نتیجه را در فیلد data پاسخ بخوانید.

:::

# ارسال اطلاعات

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

نام نوع الزامی توضیحات
nationalCode رشته بله کد ملی
نکته

تمامی داده‌های برگشتی از API به صورت JSON هستند.

# آدرس سرویس

https://zarin-hub.com/api/v5/KYC/CentralBankBlackListInquiry

نمونه درخواست:

  • PHP
  • Python
  • Java
  • Node.js
  • Go
  • cURL
  • C#
<?php
$curl = curl_init('https://zarin-hub.com/api/v5/KYC/CentralBankBlackListInquiry');

curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer {ACCESS_TOKEN}',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => '{"nationalCode":"0013546299"}',
]);

$response = curl_exec($curl);
curl_close($curl);

# پاسخ سرویس

پارامترهای پاسخ این سرویس:

نام نوع الزامی توضیحات
پارامتری ندارد

نمونه پاسخ موفق:

{
  "meta": {
    "trackId": "9b126e9a-184c-4cb0-a47e-62b9a3b7176f",
    "status": "success",
    "isSuccess": true,
    "code": 0,
    "message": "عملیات با موفقیت انجام شد",
    "errorMessage": null,
    "errors": [],
    "errorType": null
  },
  "data": {}
}

نمونه پاسخ ناموفق:

{
  "data": {},
  "meta": {
    "trackId": null,
    "status": "error",
    "isSuccess": false,
    "code": -1,
    "message": "درخواست ناموفق بود",
    "errorMessage": "پارامترهای درخواست نامعتبر هستند",
    "errorType": "validation_error",
    "errors": []
  }
}