سرویس استعلام

این سرویس به شما اجازه میده تا مشخصات هویتی کاربران تون رو اعتبارسنجی کنید. با این سرویس میتونید از صحت مالکیت شماره موبایل اعلام شده و کدپستی محل سکونت و اطلاعات هویتی کاربران تون اطمینان حاصل کنید.

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

مرحله اول: دریافت توکن

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

هنگام ارسال درخواست، توکن دریافتی را در Header و فیلد Authorization و بعد از Bearer ارسال کنید.

Authorization: Bearer {token}

استعلام اطلاعات هویتی

با متد زیر میتونید با ارسال کدملی و تاریخ تولد، اطلاعات هویتی کاربر رو به همراه وضعیت حیات (زنده بودن) بررسی کنید

Method: POST
URL:    https://pay.ir/api/v2/inquiry/person
Header: Authorization: Bearer {token}

پارامتر

فیلد	نوع	توضیحات
nationalCode	String	کد ملی
birthDate	String	تاریخ تولد (فرمت: yyyy-mm-dd)

HTTP/1.1 200 OK

{
  "success": true,
  "data": {
    "inquiry": {
      "firstName": "",
      "lastName": "",
      "fatherName": "",
      "gender": "",
      "nationalCode": "",
      "birthDate": "",
      "birthCertificateNumber": "",
      "birthCertificateSeries": "",
      "birthCertificateSerial": "",
      "isAlive": ""
    }
  },
  "errors": [],
  "message": ""
}

HTTP/1.1 422 Error

{
  "success": false,
  "data": null,
  "errors": [
    {
      "field": [
        "error message"
      ]
    }
  ],
  "message": "error message"
}

استعلام مالکیت موبایل

با این متد میتونید مالکیت شماره موبایل کاربر رو با استفاده از کد ملیش بررسی کنید :

Method: POST
Url:    https://pay.ir/api/v2/inquiry/mobile-ownership
Header: Authorization: Bearer {token}

پارامتر

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

HTTP/1.1 201 Created

{
  "success": true,
  "data": {
    "inquiry": {
      "isMobileOwnership": true
    }
  },
  "errors": [],
  "message": ""
}

HTTP/1.1 422 Error

{
  "success": false,
  "data": null,
  "errors": [
    {
      "field": [
        "error message"
      ]
    }
  ],
  "message": "error message"
}

استعلام کد پستی

کدپستی اعلام شده کاربر رو میتونید با این سرویس بررسی کنید :

Method: POST
Url:    https://pay.ir/api/v2/inquiry/postal-code
Header: Authorization: Bearer {token}

پارامترهای مجاز

فیلد	نوع	توضیحات
postalCode	String	کد پستی

HTTP/1.1 200 OK

{
  "success": true,
  "data": {
    "inquiry": {
      "address": "",
      "detail": {
        "state": "",
        "townShip": "",
        "village": "",
        "parish": "",
        "preAvenue": "",
        "avenue": "",
        "houseNumber": "",
        "floorNumber": "",
        "sideFloor": "",
        "buildingName": "",
        "postalCode": ""
      }
    }
  },
  "errors": [],
  "message": ""
}

HTTP/1.1 422 Error

{
  "success": false,
  "data": null,
  "errors": [
    {
      "field": [
        "error message"
      ]
    }
  ],
  "message": "error message"
}