مستندات سرویس API اسعتلام اطلاعات هویتی
Personal Info Inquiry API Documents
نسخه ۱.۱.۰ - ۰۸/۲۰/۲۰۲۳
فهرست مطالب
۱. مقدمه
در سرویس استعلام اطلاعات هویتی یوآیدی، با ارسال کد ملی و تاریخ تولد کاربر، می‌توانید استعلام اطلاعات هویتی را دریافت نمائید.
۲. فراخوانی سرویس inquiry/person
برای استفاده از سرویس API استعلام اطلاعات هویتی یوآیدی می‌بایست سرویس زیر با پارامترهای درخواستی فراخوانی نمائید. این سرویس با دریافت کد ملی و تاریخ تولد کاربر، اطلاعات هویتی کاربر را در پاسخ بر می‌گرداند.
۱.۲. نمونه درخواست
نمونه‌ی درخواست به شرح زیر است:
POST - https://json-api.uid.ir/api/inquiry/person
Content-Type: application/json;charset=UTF-8
{
"requestContext" : {
"apiInfo" : {
"businessId" : <UID_BUSINESS_ID>,
"businessToken" : <UID_BUSINESS_TOKEN>
}
},
"nationalId" : "0123456789",
"birthDate" : "1372/11/02"
}
۲.۲. توضیح پارامترهای درخواست
| Field | Type | Kind | Description |
| businessId | string | Required | شناسه کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
| businessToken | string | Required | توکن کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
| nationalId | string | Required | کد ملی کاربر |
birthDate | string | Required | تاریخ تولد کاربر با فرمت: YYYY/MM/DD |
۳.۲. نمونه پاسخ
{
"basicInformation": {
"firstName": <FIRST_NAME>,
"lastName": <LAST_NAME>,
"fatherName": <FATHER_NAME>,
"gender": "GENDER_MAlE" | "GENDER_FEMALE"
},
"identificationInformation": {
"nationalId": <NATIONAL_CODE>, // Note: 8-10 DIGITS!!!
"birthDate": <BIRTH_DATE>, // Format: yyyy/mm/dd
"shenasnameSeri": <SHENASNAME_SERI>, // Note: 3 Characters
"shenasnameSerial": <SHENASNAME_SERIAL>, // Example: "543422"
"shenasnamehNumber": <SHENASNAME_NUMBER> // 0 If NationalID = SHENASNAME_NUMBER
},
"registrationStatus": {
"deathStatus": <DEATH_STATUS>
},
// More Response Details:
"responseContext": {
"status": {
"code": 0,
"message": "SUCCESS.",
"details": []
},
"requestId": "",
"correlationId": "",
"navigationURI": "",
"nextStepToken": "",
"userSessionId": "",
"custom": {}
}
}
۴.۲. توضیح پارامترهای پاسخ
| Field | Type | Description |
| firstName | string | نام |
| lastName | string | نام خانوادگی |
| fatherName | string | نام پدر |
| gender | string | ENUM | مرد: GENDER_MAlE زن: GENDER_FEMALE توجه: در حالت جنسیت مذکر، حرف L در Enum با حرف کوچک است. |
nationalId | string | کد ملی کاربر توجه: این مقدار می‌تواند بین ۸ تا ۱۰ کاراکتر باشد. در صورتی که ابتدای کد ملی کاربر صفر وجود داشته باشد، در اینجا بدون صفرهای ابتدائی برگردانده خواهد شد. مثال: کد ملی کاربر: ۰۰۱۲۳۴۵۶۷۸ -> مقدار nationalId: 12345678 |
birthDate | string | تاریخ تولد کاربر با فرمت YYYY/MM/DD |
shenasnameSeri | string | سری شناسنامه کاربر – این مقدار عموما دارای ۳ کاراکتر است. مثال: سری شناسنامه = الف | ۳۲ -> مقدار shenasnameSeri = ا۳۲ (کاراکتر اول الف است) |
shenasnameSerial | string | سریال شناسنامه کاربر |
shenasnamehNumber | string | شماره شناسنامه کاربر توجه: در صورتی که شماره ملی و شماره شناسنامه کاربر یکسان باشد، این مقدار ۰ برگردانده می‌شود. |
deathStatus | string | ENUM | وضعیت حیات کاربر در قید حیات: DEATH_STATUS_ALIVE فوت شده: DEATH_STATUS_DEATH |
