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

Check Business License API Documents

نسخه 1.1.1 - 03/11/2025

فهرست مطالب

۱. مقدمه

در سرویس استعلام جواز کسب یوآیدی ، با ارسال اطلاعات جواز میتوانید استعلام جواز کسب و کار را مشاهده نمایید.

۲. استعلام اعتبار معاملاتی یوآیدی Business License

برای استفاده از سرویس API استعلام جواز کسب یوآیدی می بایست سرویس زیر با پارامتر های درخواستی  فراخوانی نمایید . این سرویس امکان استعلام جواز اشخاص حقیقی و حقوقی را دارا بوده و برای هر یک پارامتر ورودی مشخصی دریافت می کند :

  • حقیقی
    1. کد ملی
    2. شناسه صنفی
    3. کد پستی (درج شده در جواز)
  • حقوقی
    1. کد ملی مدیر عامل(شخص نامبرده درجواز)
    2. شناسه ملی شرکت
    3. شناسه صنفی
    4. کد پستی (درج شده در جواز)

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

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

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

				
					POST - https://json-api.uid.ir/api/business/license

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

				
			

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

FieldTypeKindDescription
businessIdstringRequired

شناسه کسب‌و‌کار یا BusinessID

(توسط یوآیدی در اختیار شما قرار می‌گیرد)

businessTokenstringRequired

توکن کسب‌و‌کار یا BusinessToken

(توسط یوآیدی در اختیار شما قرار می‌گیرد)

nationalIdstringRequiredکد ملی کاربر
senfCode string Required

شناسه صنفی

companyNationalIdstringOptional

شناسه ملی شرکت (برای اشخاص حقوقی)

postalCodestringRequired

کد پستی محل کسب

۳. نمونه پاسخ

 

				
					{
    "responseContext": {
        "status": {
            "code": 0,
            "message": "SUCCESS.",
            "details": []
        },
        "requestId": "",
        "correlationId": "",
        "navigationURI": "",
        "nextStepToken": "",
        "userSessionId": "",
        "custom": {}
    },
    "dataList": [
        {
            "avatarUrl": "<LICENSE_OWNER>",
            "company": "<COMPANY_NAME>",
            "duration": "<DURATION_TIME>",
            "durationInt": 0,
            "expiredAt": "<EXPIRE_DATE>",
            "expiredNotifiedAt": "",
            "hasTobaccoLicense": <true_or_false>,
            "id": 0,
            "issuedAt": "",
            "licenseType": "",
            "licenseTypeInt": 0,
            "organ": {
                "city": {
                    "id": <CITY_ID>,
                    "nationalId": "<CITY_NATIONAL_ID>",
                    "title": "<CITY_NAME>"
                },
                "id": 3002,
                "nationalCode": "<ORGAN_NATIONAL_CODE>",
                "state": {
                    "id": <STATE_ID>,
                    "nationalId": "<STATE_NATIONAL_ID>",
                    "title": "<STATE_NAME>"
                },
                "title": "<SENF_TYPE_NAME>",
                "type": 1
            },
            "pendingPayments": [],
            "personType": "",
            "personTypeInt": 0,
            "raste": {
                "isic": "<ISIC_NUMBER>",
                "isicName": "<ISIC_NAME>",
                "isicTitle": "<ISIC_TITLE>",
                "jobType": "prd",
                "jobTypeInt": 2,
                "type": 1
            },
            "requestType": 0,
            "senf": {
                "address": "<ADDRESS>",
                "bluePlaque": "",
                "chassisNumber": "",
                "city": {
                    "id": <CITY_ID>,
                    "nationalId": "<NATIONAL_ID>",
                    "title": "<CITY_NAME>"
                },
                "deviceType": "",
                "email": "<BUSINESS_EMAIL>",
                "fax": "<BUSINESS_FAX_NUMBER>",
                "fuelType": "1_2_3_10",
                "fuelTypes": [
                    1,
                    2,
                    3,
                    10
                ],
                "motorNumber": "",
                "phone": "<BUSINESS_PHONE_NUMBER>",
                "plaque": "",
                "plaqueNumber": "",
                "plaqueType": "",
                "postalCode": "<POSTAL_CODE>",
                "productionYear": "",
                "senfCode": "<SENF_CODE>",
                "state": {
                    "id": <STATE_ID>,
                    "nationalId": "<NATIONAL_ID>",
                    "title": "<STATE_NAME>"
                },
                "title": "<BUSINESS_NAME>",
                "vin": "",
                "website": "<BUSINESS_WEBSITE>"
            },
            "status": 0,
            "statusDisplay": "",
            "title": "",
            "type": 0,
            "user": {
                "birthDate": "<BIRTH_DATE>",
                "eduDegree": 3,
                "fatherName": "<FATHER_NAME>",
                "firstName": "<FIRST_NAME>",
                "gender": "<m_or_f>",
                "id": 13099901,
                "identityNumber": "<IDENTITY_NUMBER>",
                "isForeigner": false,
                "isHousehold": true,
                "isMarried": true,
                "lastName": "<LAST_NAME>",
                "militaryStatus": "med",
                "militaryStatusInt": 2,
                "mobile": "<BUSINESS_MOBILE_NUMBER>",
                "nationalId": "<BUSINESS_NATIONAL_ID>",
                "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 آدرس ثبت شده
email 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