مستندات سرویس API استعلام جواز کسب
Check Business License API Documents
نسخه 1.1.1 - 03/11/2025
فهرست مطالب
۱. مقدمه
در سرویس استعلام جواز کسب یوآیدی ، با ارسال اطلاعات جواز میتوانید استعلام جواز کسب و کار را مشاهده نمایید.
۲. استعلام اعتبار معاملاتی یوآیدی Business License
برای استفاده از سرویس API استعلام جواز کسب یوآیدی می بایست سرویس زیر با پارامتر های درخواستی فراخوانی نمایید . این سرویس امکان استعلام جواز اشخاص حقیقی و حقوقی را دارا بوده و برای هر یک پارامتر ورودی مشخصی دریافت می کند :
- حقیقی
- کد ملی
- شناسه صنفی
- کد پستی (درج شده در جواز)
- حقوقی
- کد ملی مدیر عامل(شخص نامبرده درجواز)
- شناسه ملی شرکت
- شناسه صنفی
- کد پستی (درج شده در جواز)
برای استفاده از سرویس API استعلام اعتبار معاملاتی یوآیدی میبایست سرویس زیر با پارامترهای درخواستی فراخوانی نمائید. این سرویس با دریافت کد ملی و شماره موبایل کاربر، trackingId اختصاصی کاربر را در پاسخ بر میگرداند.
۱.۲. نمونه درخواست
نمونهی درخواست به شرح زیر است:
POST - https://json-api.uid.ir/api/business/license
Content-Type: application/json;charset=UTF-8
{
"requestContext": {
"apiInfo": {
"businessId": "",
"businessToken": ""
}
},
"nationalId" : "0123456789",
"senfCode" : "1234567890",
"companyNationalId" : "1234567890",
"postalCode" : "1234567890"
}
۲.۲. پارامترها
Field | Type | Kind | Description |
businessId | string | Required | شناسه کسبوکار یا BusinessID (توسط یوآیدی در اختیار شما قرار میگیرد) |
businessToken | string | Required | توکن کسبوکار یا BusinessToken (توسط یوآیدی در اختیار شما قرار میگیرد) |
nationalId | string | Required | کد ملی کاربر |
senfCode | string | Required | شناسه صنفی |
companyNationalId | string | Optional | شناسه ملی شرکت (برای اشخاص حقوقی) |
postalCode | string | Required | کد پستی محل کسب |
۳. نمونه پاسخ
{
"responseContext": {
"status": {
"code": 0,
"message": "SUCCESS.",
"details": []
},
"requestId": "",
"correlationId": "",
"navigationURI": "",
"nextStepToken": "",
"userSessionId": "",
"custom": {}
},
"dataList": [
{
"avatarUrl": "",
"company": "",
"duration": "",
"durationInt": 0,
"expiredAt": "",
"expiredNotifiedAt": "",
"hasTobaccoLicense": ,
"id": 0,
"issuedAt": "",
"licenseType": "",
"licenseTypeInt": 0,
"organ": {
"city": {
"id": ,
"nationalId": "",
"title": ""
},
"id": 3002,
"nationalCode": "",
"state": {
"id": ,
"nationalId": "",
"title": ""
},
"title": "",
"type": 1
},
"pendingPayments": [],
"personType": "",
"personTypeInt": 0,
"raste": {
"isic": "",
"isicName": "",
"isicTitle": "",
"jobType": "prd",
"jobTypeInt": 2,
"type": 1
},
"requestType": 0,
"senf": {
"address": "",
"bluePlaque": "",
"chassisNumber": "",
"city": {
"id": ,
"nationalId": "",
"title": ""
},
"deviceType": "",
"email": "",
"fax": "",
"fuelType": "1_2_3_10",
"fuelTypes": [
1,
2,
3,
10
],
"motorNumber": "",
"phone": "",
"plaque": "",
"plaqueNumber": "",
"plaqueType": "",
"postalCode": "",
"productionYear": "",
"senfCode": "",
"state": {
"id": ,
"nationalId": "",
"title": ""
},
"title": "",
"vin": "",
"website": ""
},
"status": 0,
"statusDisplay": "",
"title": "",
"type": 0,
"user": {
"birthDate": "",
"eduDegree": 3,
"fatherName": "",
"firstName": "",
"gender": "",
"id": 13099901,
"identityNumber": "",
"isForeigner": false,
"isHousehold": true,
"isMarried": true,
"lastName": "",
"militaryStatus": "med",
"militaryStatusInt": 2,
"mobile": "",
"nationalId": "",
"personTypeInt": 0,
"religion": 9
}
}
]
}
۲.۳. توضیح پارامترهای پاسخ
Field | Type | Description |
avatarUrl | string |
آدرس تصویر صاحب جواز |
Company | String | نام شرکت (در صورت وجود) |
duration | String | مدت اعتبار جواز کسب |
avatarUrl | string | تصویر صاحب جواز |
company | String | نام شرکت (جواز های حقوقی) |
expiredAt | String | تاریخ انقضاء |
hasTobaccoLicense | bool | آیا مجاز به فروش دخانیات میباشد؟ (true/false) |
organ | اطلاعات اتحادیه | |
nationalCode | string | شناسه ملی اتحادیه (صنف کشوری) |
id | int | شناسه یکتا (شهر ، استان ، اتحادیه) |
nationalId | string | شناسه ملی اتحادیه (صنف مختص شهر) |
title | string | نام اتحادیه (مثال : خواربار فروشان) |
isic | string | شناسه آیسیک |
isicName | string | نام آیسیک |
isicTitle | string | نام آیسیک |
senf | اطلاعات صنفی | |
address | string | آدرس ثبت شده |
string | آدرس ایمیل (فروشگاه های اینترنتی و حقوقی) | |
fax | string | شماره فکس |
phone | string | شماره ثابت |
postalCode | string | کد پستی |
senfCode | string | کد صنفی کسب وکار |
title | string | نام برند کسب و کار |
website | string | 0 |
user | ||
birthdate | string | |
firstName | string | |
lastName | string | |
fatherName | string | |
gender | String | ENUM | |
mobile | string | |
nationalId | string |