مستندات سرویس API استعلام عدم سوء پیشینه
Criminal Record API Documents
نسخه 1.1.0 - 08/20/2023
فهرست مطالب
۱. مقدمه
در سرویس استعلام عدم سوء پیشینه یوآیدی ، با ارسال اطلاعات میتوانید وضعیت کیفری شخص را در callback دریافت نمایید.
۲. فراخوانی سرویس Criminal Record
برای استفاده از سرویس API یوآیدی می‌بایست سرویس زیر با پارامترهای درخواستی فراخوانی نمائید. این سرویس با دریافت کد ملی ، تاریخ تولد ، شماره همراه و کد پستی و با اختصاص کد رهگیری پس از 3 روز کاری نتیجه استعلام را به callback برمیگرداند.
۱.۲. نمونه درخواست
نمونه‌ی درخواست به شرح زیر است:
POST - https://json-api.uid.ir/api/inquiry/criminal-record
Content-Type: application/json;charset=UTF-8
{
"requestContext": {
"apiInfo": {
"businessId": "<UID_BUSINESS_ID>",
"businessToken": "<UID_BUSINESS_TOKEN>"
}
},
"nationalId" : "0123456789",
"birthdate" : "1366/10/10",
"mobileNumber" : "09123456789",
"postalCode" : "1234567890",
"callbackUri" : "<CALL_BACK_URL>"
}
۲.۲. توضیح پارامترهای درخواست
| Field | Type | Kind | Description |
| businessId | string | Required | شناسه کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
| businessToken | string | Required | توکن کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
| nationalId | string | Required | کد ملی کاربر |
| birthdate | string | Required | تاریخ تولد کاربر |
| mobileNumber | string | Required | تلفن همراه کاربر به صورت 09xxxxxxxxx |
| postalCode | string | Required | کد پستی محل سکونت کاربر |
| callbackUri | string | Required | آدرس کال بک به سمت بیزینس |
۳.۲. نمونه پاسخ
{
"responseContext": {
"status": {
"code": 0,
"message": "SUCCESS.",
"details": []
},
"requestId": "",
"correlationId": "",
"navigationURI": "",
"nextStepToken": "",
"userSessionId": "",
"custom": {}
},
"trackingId": "<TRACKING_ID>"
}
۴.۲. توضیح پارامترهای پاسخ
| Field | Type | Description |
| trackingId | string | شناسه رهگیری ایجاد شده برای کاربر در UID* |
* توجه : trackingId یک مقدار یکتا بوده که یوآیدی به هر کاربر اختصاص می دهد. *
۳. فراخوانی کال بک پذیرنده توسط UID
پس از ارسال موفق درخواست استعلام عدم سوء پیشینه و دریافت نتیحه ، UID کال بک اعلامی پذیرنده را با پارامتر های مربوطه فراخوانی کرده و نتیجه استعلام را پس از سه روز کاری به اطلاع پذیرنده می رساند.
(فرایند استعلام 2 تا 3 روز کاری زمانبر است)
۱.۳.نمونه فراخوانی کال بک
کال بک پذیرنده با آبجکت زیر و متد POST فراخوانی می شود :
POST – BUSINESS_CALLBACK_URL eg:
Content-Type: application/json;charset=UTF-8
CallbackResponse {
"hasCriminalRecord" : <TRUE_OR_FALSE>, // boolean
"nationalId" : "<NATIONAL_ID>",
"trackingId" : "<TRACKING_ID>"
}
۲.۳.توضیح پارامترهای پاسخ
| Field | Type | Description |
| hasCriminalRecord | boolean | نتیجه استعلام بصورت TRUE یا FALSE |
| nationalId | string | کد ملی کاربر |
| trackingId | string | شناسه رهگیری ایجاد شده برای کاربر در UID* |
