مستندات سرویس API اطلاعات ثبتی شرکت

Check company inquiry API Documents

نسخه 1.1.1 - 05/01/2024

فهرست مطالب

بخش اول: فراخوانی company inquiry

این بخش مربوط به سرویس استعلام عضویت هیئت مدیره می‌باشد.

۱. مقدمه

در سرویس استعلام عضویت هیئت مدیره یوآیدی، با ارسال شناسه ملی شرکت، اطلاعات ثبتی شرکت را دریافت کنید.

۲. استعلام اطلاعات ثبتی شرکت یوآیدی

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

۱.۲. نمونه درخواست استعلام اطلاعات ثبتی شرکت

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

				
					https://json-api.uid.ir/api/inquiry/company

Content-Type: application/json;charset=UTF-8
{
    "requestContext" : {
            "apiInfo" : {
                "businessId" : <UID_BUSINESS_ID>,
                "businessToken" : <UID_BUSINESS_TOKEN>
            }
    },
    "legalId" : "14005556644"
}
				
			

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

FieldTypeKindDescription
businessIdstringRequired

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

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

businessTokenstringRequired

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

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

legalId
string Required

شناسه ملی شرکت

۳. نمونه پاسخ

 

				
					{
    "activityEndDate": <ACTIVITY_END_DATE>,
    "addressDesc": <ADDRESS_DESC>,
    "emailAddress": <EMAIL_ADDRESS>,
    "faxNumber": <FAX_NUMBER>,
    "fixPhoneNumber": <FIX_PHONE_NUMBER>,
    "issuanceDate": <ISSUANCE_DATE>,
    "name": <NAME>,
    "nationalCode": <NATIONAL_CODE>,
    "postCode": <POST_CODE>,
    "registerDate": <REGISTER_DATE>,
    "registerNumber": <REGISTER_NUMBER>,
    "smsNumber": <SMS_NUMBER>,
    "theCiCompanyType": {
        "code": <CODE>,
        "state": 1,
        "title": <TITLE>
    },
    "theNajaUnit": {
        "code": <CODE>,
        "state": 1,
        "unitName": <UNIT_NAME>
    },
    "theGeoLocation": {
        "locationCode": <LOCATION_CODE>,
        "locationName": <LOCATION_NAME>,
        "locationType": 3,
        "state": 1
    },
    "theObjectState": {
        "code": <CODE>,
        "stateType": 1,
        "title": <TITLE>
    },
    "theUnit": {
        "code": <CODE>,
        "state": 1,
        "unitName": <UNIT_NAME>
    },
    "webAddress": ""
}