Інформації про перевірку документу що засвідчує персону

Повертає інформацію про перевірку документу на відсутність записів про його недійсність в базах даних. перевіряється по номеру та переліку типів. Id для ідентифікації типів можна отримати з функції /ind_doc/types
якщо all_valid=true - перевірка по жодному з типів не виявила записів про недійсність.
Передані номери будуть приведені до верхнього регістру та, за необхідністю приведені до кирилиці або латиниці - у залежності від типу документа.
В полі skipped_types_count - повертає кількість типів по котрим перевірка не проходила тому що переданий номер не відповідає формі номера для цього типу. Для того щоб переконатись чи передано коректний номер - перевіряйте це поле.
Для цієї функції заборонено передавати ensure_valid_on_date більш стару ніж today.

Request

Authorization

Add parameter in query

key

Example:

key: ********************

Query Params

number

string

required

номер документу

types[]

array[string]

optional

id типів, котрі необхідно перевірити

ensure_valid_on_date

string

optional

чи ставити дані на оновлення (за вмовчанням - today)

only_check_updated

boolean

optional

тільки перевірити стан оновлення даних (за вмовчанням - false)

wait_data_timeout

integer

optional

час в секундах очікуванн

language

string

optional

3 літ. ISO 639-1

key

string

optional

ключ доступу

Responses

🟢200Success

application/json

Body

answer

object

required

all_valid

boolean

optional

усі пройшли перевірку

items

array [object {5}]

optional

skipped_types_count

integer

optional

кількість невідповідних типів

is_updating

boolean

required

чи зараз в процесі оновлення

updated_datetime

string <date-time>

required

час останнього оновлення

data_checkvalue

string

required

якщо значення змінюється - дані були змінені

status

enum<string>

required

Allowed values:

SuccessWarningError

statusCode

integer

required

message

string

optional

Example

{
    "status": "Warning",
    "statusCode": 204,
    "message": "Дані не актуальні.",
    "answer": {
        "all_valid": true,
        "items": [
            {
                "type_id": "1",
                "type_name": "Паспорт громадянина України",
                "updated_datetime": "2023-12-31 18:40:32.203",
                "is_valid": true,
                "message": ""
            },
            {
                "type_id": "3",
                "type_name": "Паспорт громадянина України для виїзду за кордон",
                "updated_datetime": "2023-12-31 18:40:32.203",
                "is_valid": true,
                "message": ""
            },
            {
                "type_id": "4",
                "type_name": "Тимчасове посвідчення громадянина України",
                "updated_datetime": "2023-12-31 18:40:32.203",
                "is_valid": true,
                "message": ""
            },
            {
                "type_id": "5",
                "type_name": "Посвідчення особи без громадянства для виїзду за кордон",
                "updated_datetime": "2023-12-31 18:40:32.203",
                "is_valid": true,
                "message": ""
            },
            {
                "type_id": "6",
                "type_name": "Посвідка на постійне проживання",
                "updated_datetime": "2023-12-31 18:40:32.203",
                "is_valid": true,
                "message": ""
            },
            {
                "type_id": "8",
                "type_name": "Посвідка на тимчасове проживання",
                "updated_datetime": "2023-12-31 18:40:32.203",
                "is_valid": true,
                "message": ""
            },
            {
                "type_id": "10",
                "type_name": "Посвідчення біженця",
                "updated_datetime": "2023-12-31 18:40:32.203",
                "is_valid": true,
                "message": ""
            },
            {
                "type_id": "11",
                "type_name": "Проїзний документ біженця",
                "updated_datetime": "2023-12-31 18:40:32.203",
                "is_valid": true,
                "message": ""
            },
            {
                "type_id": "12",
                "type_name": "Посвідчення особи, яка потребує додаткового захисту",
                "updated_datetime": "2023-12-31 18:40:32.203",
                "is_valid": true,
                "message": ""
            },
            {
                "type_id": "13",
                "type_name": "Проїзний документ особи, якій надано додатковий захист",
                "updated_datetime": "2023-12-31 18:40:32.203",
                "is_valid": true,
                "message": ""
            },
            {
                "type_id": "14",
                "type_name": "Проїзний документ дитини",
                "updated_datetime": "2023-12-31 18:40:32.203",
                "is_valid": true,
                "message": ""
            }
        ],
        "skipped_types_count": 3,
        "is_updating": false,
        "updated_datetime": "2023-12-31 18:40:32.203",
        "data_checkvalue": "9DA17B3156F2513D51855E2C4AC3ACD5"
    }
}