مستندات سرویس API استعلام اطلاعات هویتی اتباع خارجی (فیدا)
Personal Info Inquiry Fida API Documents
نسخه 1.1.0 - 08/20/2023
فهرست مطالب
۱. مقدمه
در سرویس استعلام اطلاعات هویتی اتباع یوآیدی، با ارسال کد اتباع کاربر، می‌توانید استعلام اطلاعات هویتی را دریافت نمائید.
۲. فراخوانی سرویس inquiry/foreign/residency
برای استفاده از سرویس API استعلام اطلاعات هویتی یوآیدی می‌بایست سرویس زیر با پارامترهای درخواستی فراخوانی نمائید. این سرویس با دریافت کد اتباع کاربر، اطلاعات هویتی کاربر را در پاسخ بر می‌گرداند.
۱.۲. نمونه درخواست
نمونه‌ی درخواست به شرح زیر است:
POST - https://json-api.uid.ir/api/inquiry/foreign/residency
Content-Type: application/json;charset=UTF-8
{
"requestContext": {
"apiInfo": {
"businessId": <UID_BUSINESS_ID>,
"businessToken": <UID_BUSINESS_TOKEN>
}
},
"foreignerType": 1,
"identificationId" : "101111111111"
}
۲.۲. توضیح پارامترهای درخواست
| Field | Type | Kind | Description |
| businessId | string | Required | شناسه کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
| businessToken | string | Required | توکن کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
foreignerType | string | Required | مقدار “1” برای افراد حقیقی |
identificationId | string | Required | کد اتباع |
۳.۲. نمونه پاسخ
"realForeigner": {
"nationality": "",
"identificationCode": "101111111111",
"ancestorName": <ANCESTOR_NAME>,
"birthDate": <BIRTH_DATE>,
"birthPlaceCountry": <BIRTH_PLACE_COUNTRY>
"cityOfBirth": <CITY_OF_BIRTH>
"documentDescription": <DOCUMENT_DESCRIPTION>,
"documentExpirationDate": <DOCUMENT_EXPIRATION_DATE>,
"documentIssueDate": <DOCUMENT_ISSUE_DATE>,
"documentNumber": <DOCUMENT_NUMBER>,
"documentType": <DOCUMENT_TYPE>,
"fatherName": <FATHER_NAME>,
"gender": <GENDER>,
"lastName": <LAST_NAME>,
"latinFatherName": <LATIN_FATHER_NAME>,
"latinFirstName": <LATIN_FIRST_NAME>,
"latinLastName": <LATIN_LAST_NAME>
}
۴.۲. توضیح پارامترهای پاسخ
| Field | Type | Description |
identificationCode | string | کد اتباع |
ancestorName | string | نیاکان |
birthDate | string | تاریخ تولد |
birthPlaceCountry | string | کشور محل تولد |
cityOfBirth | string | شهر محل تولد |
documentDescription | string | توضیحات مدرک |
documentExpirationDate | string | تاریخ انقضای سند |
documentIssueDate | string | تاریخ صدور سند |
documentNumber | string | شماره‌ی سند |
documentType | string | نوع سند |
fatherName | string | نام پدر |
gender | string | ENUM | مرد: GENDER_MAlE زن: GENDER_FEMALE توجه: در حالت جنسیت مذکر، حرف L در Enum با حرف کوچک است. |
lastName | string | نام خانوادگی |
latinFatherName | string | نام پدر (انگلیسی) |
latinFirstName | string | نام کوچک (انگلیسی) |
latinLastName | string | نام خانوادگی (انگلیسی) |
