> For the complete documentation index, see [llms.txt](https://docs.go-data.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.go-data.app/models.md). # Models ## The BatchCheckRequest object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"BatchCheckRequest":{"properties":{"numbers":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":1000},{"type":"null"}],"title":"Numbers","description":"Список номеров для проверки (до 1000)"}},"type":"object","title":"BatchCheckRequest","description":"Схема запроса для создания массовой проверки."}}}} ``` ## The BatchCheckResponse object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"BatchCheckResponse":{"properties":{"task_id":{"type":"string","format":"uuid","title":"Task Id","description":"ID созданной задачи"},"task_type":{"type":"string","title":"Task Type","description":"Тип задачи (batch)"},"total_numbers":{"type":"integer","title":"Total Numbers","description":"Общее количество номеров для проверки"},"status":{"type":"string","title":"Status","description":"Статус задачи (pending)"}},"type":"object","required":["task_id","task_type","total_numbers","status"],"title":"BatchCheckResponse","description":"Ответ на создание массовой проверки."}}}} ``` ## The BatchEnrichmentRequest object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"BatchEnrichmentRequest":{"properties":{"queries":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":10000},{"type":"null"}],"title":"Queries","description":"List of queries for enrichment (up to 10000 items). Format depends on `from_type`. Empty strings and duplicates are ignored."},"from_type":{"type":"string","enum":["phone","fio_birth","inn","snils","passport"],"title":"From Type","description":"Source data type. Allowed values:\n- `phone` - phone number (e.g. `+79991234567`)\n- `fio_birth` - full name + date of birth (e.g. `Ivanov Ivan 01.01.1990`)\n- `inn` - tax ID: 12 digits (individual) or 10 digits (legal entity)\n- `snils` - pension insurance number (11 digits)\n- `passport` - RF passport series and number"},"to_type":{"type":"string","enum":["phone","fio_birth","address"],"title":"To Type","description":"Target data type to retrieve. Allowed values:\n- `phone` - phone numbers\n- `fio_birth` - full name and date of birth\n- `address` - residential or registration address"},"limit":{"type":"integer","maximum":500,"minimum":1,"title":"Limit","description":"Maximum number of records per query result (1-500)","default":500}},"type":"object","required":["from_type","to_type"],"title":"BatchEnrichmentRequest","description":"Batch data enrichment task request.\n\nEnrichment retrieves additional information about a person based on a\nknown identifier. For example, find full name by phone number, or address\nby full name + date of birth.\n\nBalance is charged upfront for all queries. Results are available after\ncompletion via `GET /enrichment/task/{task_id}/result`."}}}} ``` ## The BatchEnrichmentResponse object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"BatchEnrichmentResponse":{"properties":{"task_id":{"type":"string","format":"uuid","title":"Task Id","description":"UUID of the created task - used in subsequent status and result requests"},"task_type":{"type":"string","title":"Task Type","description":"Task type - always `batch`"},"total_queries":{"type":"integer","title":"Total Queries","description":"Number of accepted queries in the task"},"status":{"type":"string","title":"Status","description":"Initial task status - always `pending`"},"from_type":{"type":"string","enum":["phone","fio_birth","inn","snils","passport"],"title":"From Type","description":"Source data type (as passed in request)"},"to_type":{"type":"string","enum":["phone","fio_birth","address"],"title":"To Type","description":"Target data type (as passed in request)"}},"type":"object","required":["task_id","task_type","total_queries","status","from_type","to_type"],"title":"BatchEnrichmentResponse","description":"Response to a batch enrichment task creation.\n\nThe task is queued (`status: pending`) and processed asynchronously.\nTrack progress via `GET /enrichment/task/{task_id}/status`."}}}} ``` ## The BatchSearchRequest object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"BatchSearchRequest":{"properties":{"queries":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":1000},{"type":"null"}],"title":"Queries","description":"Список поисковых запросов (до 1000)"},"limit":{"type":"integer","maximum":500,"minimum":1,"title":"Limit","description":"Максимальное количество результатов на запрос","default":500}},"type":"object","title":"BatchSearchRequest","description":"Схема запроса для создания массового поиска."}}}} ``` ## The BatchSearchResponse object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"BatchSearchResponse":{"properties":{"task_id":{"type":"string","format":"uuid","title":"Task Id","description":"ID созданной задачи"},"task_type":{"type":"string","title":"Task Type","description":"Тип задачи (batch)"},"total_queries":{"type":"integer","title":"Total Queries","description":"Общее количество поисковых запросов"},"status":{"type":"string","title":"Status","description":"Статус задачи (pending)"}},"type":"object","required":["task_id","task_type","total_queries","status"],"title":"BatchSearchResponse","description":"Ответ на создание массового поиска."}}}} ``` ## The BorderCrossing object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"BorderCrossing":{"properties":{"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date","description":"Дата пересечения"},"from_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From Country","description":"Страна выезда"},"from_city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From City","description":"Город выезда"},"to_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Country","description":"Страна въезда"},"to_checkpoint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Checkpoint","description":"Пункт пропуска"},"vehicle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vehicle","description":"Транспортное средство / рейс"},"transport_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transport Type","description":"Тип транспорта"}},"type":"object","title":"BorderCrossing","description":"Одно пересечение границы."}}}} ``` ## The CarInfo object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"CarInfo":{"properties":{"plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plate","description":"Гос. номер"},"make":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Make","description":"Марка (Toyota, BMW…)"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Модель (Camry, X5…)"},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year","description":"Год выпуска"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color","description":"Цвет"},"vin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin","description":"VIN"},"body_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Type","description":"Тип кузова"},"engine":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Engine","description":"Объём двигателя, напр. «2.5»"},"power_hp":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Power Hp","description":"Мощность, л.с."},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region","description":"Регион регистрации"},"sts":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sts","description":"Свидетельство о регистрации (СТС)"},"pts":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pts","description":"Паспорт ТС (ПТС)"},"engine_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Engine Number","description":"Номер двигателя"},"price_min":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Price Min","description":"Оценочная стоимость — от (руб.)"},"price_max":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Price Max","description":"Оценочная стоимость — до (руб.)"}},"type":"object","title":"CarInfo","description":"Данные об автомобиле, собранные из записей."}}}} ``` ## The ClassifiedRecordItem object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"ClassifiedRecordItem":{"properties":{"database_id":{"type":"string","title":"Database Id","description":"ID базы данных"},"data":{"additionalProperties":true,"type":"object","title":"Data","description":"Данные записи"},"classified_data":{"additionalProperties":true,"type":"object","title":"Classified Data","description":"Классифицированные поля (phones, emails, passports, passport_details, etc.)"}},"type":"object","required":["database_id","data","classified_data"],"title":"ClassifiedRecordItem","description":"Запись с классифицированными полями."}}}} ``` ## The CurrencyInfo object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"CurrencyInfo":{"properties":{"name":{"type":"string","title":"Name","description":"Полное название валюты на русском"},"rate":{"type":"number","title":"Rate","description":"Курс: сколько единиц этой валюты равно 1 USD"},"base":{"type":"string","title":"Base","description":"Базовая валюта (всегда USD)","default":"USD"}},"type":"object","required":["name","rate"],"title":"CurrencyInfo","description":"Информация об одной валюте."}}}} ``` ## The CurrencyRatesResponse object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"CurrencyRatesResponse":{"properties":{"base_currency":{"type":"string","title":"Base Currency","description":"Базовая валюта для всех курсов","default":"USD"},"rates":{"additionalProperties":{"$ref":"#/components/schemas/CurrencyInfo"},"type":"object","title":"Rates","description":"Курсы поддерживаемых валют. Ключи: RUB, UAH, KZT, BYN"},"updated_at":{"type":"string","title":"Updated At","description":"Время последнего обновления курсов в ISO 8601"}},"type":"object","required":["rates","updated_at"],"title":"CurrencyRatesResponse","description":"Актуальные курсы валют относительно USD. Обновляются каждые 15 минут."},"CurrencyInfo":{"properties":{"name":{"type":"string","title":"Name","description":"Полное название валюты на русском"},"rate":{"type":"number","title":"Rate","description":"Курс: сколько единиц этой валюты равно 1 USD"},"base":{"type":"string","title":"Base","description":"Базовая валюта (всегда USD)","default":"USD"}},"type":"object","required":["name","rate"],"title":"CurrencyInfo","description":"Информация об одной валюте."}}}} ``` ## The DailyStatItem object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"DailyStatItem":{"properties":{"date":{"type":"string","title":"Date","description":"Дата в формате YYYY-MM-DD"},"requests_count":{"type":"integer","title":"Requests Count","description":"Количество запросов за этот день"}},"type":"object","required":["date","requests_count"],"title":"DailyStatItem","description":"Статистика запросов за один день."}}}} ``` ## The DatabaseLeakInfo object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"DatabaseLeakInfo":{"properties":{"database_id":{"type":"string","title":"Database Id","description":"ID базы данных"},"database_name":{"type":"string","title":"Database Name","description":"Название базы данных"},"records_count":{"type":"integer","title":"Records Count","description":"Количество найденных записей"}},"type":"object","required":["database_id","database_name","records_count"],"title":"DatabaseLeakInfo","description":"Информация о найденных утечках в одной базе данных."}}}} ``` ## The EnrichmentTaskResultResponse object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"EnrichmentTaskResultResponse":{"properties":{"task_id":{"type":"string","format":"uuid","title":"Task Id","description":"Task UUID"},"limit":{"type":"integer","title":"Limit","description":"Applied page size (max 5000)"},"offset":{"type":"integer","title":"Offset","description":"Applied row offset"},"count":{"type":"integer","title":"Count","description":"Number of rows returned in this page"},"results":{"items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array","title":"Results","description":"List of enriched rows; each object maps semantic field names to values"}},"type":"object","required":["task_id","limit","offset","count","results"],"title":"EnrichmentTaskResultResponse","description":"Enrichment task result as a JSON list.\n\nEach item in `results` is one row of the enriched dataset, with semantic\nkeys instead of raw column headers. The exact set of keys depends on the\ntask's `from_type`/`to_type`:\n\n- `phone` - phone number in international format without `+` (e.g. `79991234567`)\n- `full_name` - full name in \"Lastname Firstname Patronymic\" title case\n- `birth_date` - date of birth in `DD.MM.YYYY`\n- `inn` / `snils` / `passport` - digits only\n- `address` - address string\n\nThe source field that enrichment was performed *from* is returned verbatim\n(exactly as received in the input), without any normalization. For example,\nfor `from_type=phone` the `phone` field keeps its original formatting.\n\nUse `limit` (max 5000) and `offset` for pagination over large results."}}}} ``` ## The EnrichmentTaskStatusResponse object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"EnrichmentTaskStatusResponse":{"properties":{"task_id":{"type":"string","format":"uuid","title":"Task Id","description":"Task UUID"},"status":{"type":"string","title":"Status","description":"Status: pending | processing | completed | failed"},"task_type":{"type":"string","title":"Task Type","description":"Task type - always `batch`"},"from_type":{"type":"string","enum":["phone","fio_birth","inn","snils","passport"],"title":"From Type","description":"Source data type"},"to_type":{"type":"string","enum":["phone","fio_birth","address"],"title":"To Type","description":"Target data type"},"total_queries":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Queries","description":"Total number of queries in the task"},"processed_queries":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Processed Queries","description":"Number of queries already processed"},"found_queries":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Found Queries","description":"Number of queries with results found"},"spent_requests":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Spent Requests","description":"Requests actually deducted from balance"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message","description":"Error message (only when status=failed)"},"created_at":{"type":"string","title":"Created At","description":"Task creation time in ISO 8601"},"started_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Started At","description":"Processing start time in ISO 8601 (None if not yet started)"},"completed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completed At","description":"Completion time in ISO 8601 (None if not yet completed)"}},"type":"object","required":["task_id","status","task_type","from_type","to_type","created_at"],"title":"EnrichmentTaskStatusResponse","description":"Current status of an enrichment task.\n\nPossible `status` values:\n- `pending` - waiting to be processed\n- `processing` - currently being processed\n- `completed` - finished, result is available\n- `failed` - finished with error (see `error_message`)"}}}} ``` ## The ErrorResponse object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"ErrorResponse":{"properties":{"detail":{"type":"string","title":"Detail","description":"Человекочитаемое сообщение об ошибке"}},"type":"object","required":["detail"],"title":"ErrorResponse","description":"Стандартный ответ с ошибкой."}}}} ``` ## The HTTPValidationError object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## The InvitedCount object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"InvitedCount":{"properties":{"by_ref_link":{"type":"integer","title":"By Ref Link","description":"Приглашено по реферальной ссылке"},"by_bot":{"type":"integer","title":"By Bot","description":"Приглашено через партнёрский канал"},"total":{"type":"integer","title":"Total","description":"Итого уникальных приглашённых пользователей"}},"type":"object","required":["by_ref_link","by_bot","total"],"title":"InvitedCount","description":"Разбивка приглашённых пользователей по каналу привлечения."}}}} ``` ## The NormalSearchRequest object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"NormalSearchRequest":{"properties":{"query":{"type":"string","maxLength":500,"minLength":1,"title":"Query","description":"Поисковый запрос"},"search_type":{"$ref":"#/components/schemas/SearchType","description":"Технический код типа данных для поиска"},"limit":{"type":"integer","maximum":500,"minimum":1,"title":"Limit","description":"Максимальное количество результатов","default":500},"additional_sources":{"anyOf":[{"additionalProperties":{"type":"boolean"},"type":"object"},{"type":"null"}],"title":"Additional Sources","description":"Дополнительные источники обогащения, строго opt-in. Словарь {ключ_источника: bool}. Поддерживается ключ \"operator\" — оператор, регион и часовой пояс номера (доступен только при поиске по телефону). Неизвестные ключи игнорируются."}},"type":"object","required":["query","search_type"],"title":"NormalSearchRequest","description":"Схема запроса для normal-поиска с указанием типа данных."},"SearchType":{"type":"string","enum":["phone","email","nickname","full_name","full_name_birthdate","first_last_name","first_middle_name","first_last_name_birthdate","first_middle_name_birthdate","last_name_birthdate","first_name_birthdate","url_telegram","url_instagram","url_vk","url_facebook","url_twitter","domain","url","vk_id","tg_id","ipv4","ipv6","mac_address","btc_address","eth_address","passport_ru","passport_eu","inn_individual","inn_legal","snils","ogrn","ogrnip","kpp","car_plate","vin","credit_card","iban","bic_swift","coordinates","date","address","unknown"],"title":"SearchType","description":"Перечисление типов поисковых запросов.\n\nЗначения — короткие технические коды в snake_case. Человекочитаемые\nподписи (локализация) формируются на стороне клиента.\n\nСуффиксы стран/категорий (``_ru``/``_eu``, ``_individual``/``_legal``)\nиспользуются только там, где они несут смысловую дизамбигуацию\n(паспорт РФ vs ЕС, ИНН физлица vs юрлица). Для остальных РФ-специфичных\nидентификаторов канон — короткий код без суффикса.\n\nСовместимость со старыми кодами (``snils_ru``, ``passport``, ``inn`` и т.п.)\nобеспечивается картой алиасов ``_SEARCH_TYPE_ALIASES`` ниже."}}}} ``` ## The PersonContactData object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"PersonContactData":{"properties":{"phone_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Phone Numbers","description":"Номера телефонов"},"emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Emails","description":"Email адреса"},"cars":{"anyOf":[{"items":{"$ref":"#/components/schemas/CarInfo"},"type":"array"},{"type":"null"}],"title":"Cars","description":"Автомобили"},"passport":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Passport","description":"Паспортные данные"},"inn":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Inn","description":"ИНН"},"snils":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Snils","description":"СНИЛС"},"addresses":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Addresses","description":"Адреса"}},"type":"object","title":"PersonContactData","description":"Контактные данные личности."},"CarInfo":{"properties":{"plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plate","description":"Гос. номер"},"make":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Make","description":"Марка (Toyota, BMW…)"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Модель (Camry, X5…)"},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year","description":"Год выпуска"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color","description":"Цвет"},"vin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin","description":"VIN"},"body_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Type","description":"Тип кузова"},"engine":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Engine","description":"Объём двигателя, напр. «2.5»"},"power_hp":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Power Hp","description":"Мощность, л.с."},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region","description":"Регион регистрации"},"sts":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sts","description":"Свидетельство о регистрации (СТС)"},"pts":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pts","description":"Паспорт ТС (ПТС)"},"engine_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Engine Number","description":"Номер двигателя"},"price_min":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Price Min","description":"Оценочная стоимость — от (руб.)"},"price_max":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Price Max","description":"Оценочная стоимость — до (руб.)"}},"type":"object","title":"CarInfo","description":"Данные об автомобиле, собранные из записей."}}}} ``` ## The PersonInfo object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"PersonInfo":{"properties":{"full_name":{"type":"string","title":"Full Name","description":"Полное ФИО"},"birth_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Birth Date","description":"Дата рождения в формате DD.MM.YYYY"},"contact_data":{"$ref":"#/components/schemas/PersonContactData","description":"Контактные данные"},"border_crossings":{"anyOf":[{"items":{"$ref":"#/components/schemas/BorderCrossing"},"type":"array"},{"type":"null"}],"title":"Border Crossings","description":"Пересечения границы"}},"type":"object","required":["full_name","contact_data"],"title":"PersonInfo","description":"Информация о личности."},"PersonContactData":{"properties":{"phone_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Phone Numbers","description":"Номера телефонов"},"emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Emails","description":"Email адреса"},"cars":{"anyOf":[{"items":{"$ref":"#/components/schemas/CarInfo"},"type":"array"},{"type":"null"}],"title":"Cars","description":"Автомобили"},"passport":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Passport","description":"Паспортные данные"},"inn":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Inn","description":"ИНН"},"snils":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Snils","description":"СНИЛС"},"addresses":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Addresses","description":"Адреса"}},"type":"object","title":"PersonContactData","description":"Контактные данные личности."},"CarInfo":{"properties":{"plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plate","description":"Гос. номер"},"make":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Make","description":"Марка (Toyota, BMW…)"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Модель (Camry, X5…)"},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year","description":"Год выпуска"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color","description":"Цвет"},"vin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin","description":"VIN"},"body_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Type","description":"Тип кузова"},"engine":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Engine","description":"Объём двигателя, напр. «2.5»"},"power_hp":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Power Hp","description":"Мощность, л.с."},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region","description":"Регион регистрации"},"sts":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sts","description":"Свидетельство о регистрации (СТС)"},"pts":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pts","description":"Паспорт ТС (ПТС)"},"engine_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Engine Number","description":"Номер двигателя"},"price_min":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Price Min","description":"Оценочная стоимость — от (руб.)"},"price_max":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Price Max","description":"Оценочная стоимость — до (руб.)"}},"type":"object","title":"CarInfo","description":"Данные об автомобиле, собранные из записей."},"BorderCrossing":{"properties":{"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date","description":"Дата пересечения"},"from_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From Country","description":"Страна выезда"},"from_city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From City","description":"Город выезда"},"to_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Country","description":"Страна въезда"},"to_checkpoint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Checkpoint","description":"Пункт пропуска"},"vehicle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vehicle","description":"Транспортное средство / рейс"},"transport_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transport Type","description":"Тип транспорта"}},"type":"object","title":"BorderCrossing","description":"Одно пересечение границы."}}}} ``` ## The ProfileMeResponse object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"ProfileMeResponse":{"properties":{"user_id":{"type":"integer","title":"User Id","description":"Числовой идентификатор аккаунта"},"uuid":{"type":"string","title":"Uuid","description":"UUID аккаунта"},"username":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Username","description":"Имя пользователя (username, без @)"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"Имя пользователя"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"Фамилия пользователя"},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Avatar","description":"URL аватара пользователя"},"balance":{"type":"number","title":"Balance","description":"Денежный баланс аккаунта (USD)"},"partner_balance":{"type":"number","title":"Partner Balance","description":"Партнёрский баланс (USD)"},"requests_balance":{"type":"integer","title":"Requests Balance","description":"Количество поисковых запросов на балансе"},"tariff":{"type":"string","title":"Tariff","description":"Текущий тариф пользователя"},"status":{"type":"string","title":"Status","description":"Статус аккаунта: active, banned, trial"},"subscription":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subscription","description":"Дата окончания подписки в ISO 8601 (None — нет активной подписки)"},"registration":{"type":"string","title":"Registration","description":"Дата регистрации в ISO 8601"},"currency":{"type":"string","title":"Currency","description":"Предпочитаемая валюта: USD, RUB, UAH, KZT, BYN","default":"USD"},"is_lifetime":{"type":"boolean","title":"Is Lifetime","description":"Бессрочная (lifetime) подписка","default":false},"api_access":{"type":"boolean","title":"Api Access","description":"Доступ к программному API (тариф BUSINESS)","default":false},"price_per_request":{"type":"number","title":"Price Per Request","description":"Цена за 1 запрос сверх недельного лимита (USD, по тарифу)","default":0},"weekly_limit":{"type":"integer","title":"Weekly Limit","description":"Бесплатных запросов в неделю (по тарифу)","default":0},"weekly_used":{"type":"integer","title":"Weekly Used","description":"Использовано запросов недельного лимита на этой неделе","default":0},"weekly_remaining":{"type":"integer","title":"Weekly Remaining","description":"Остаток недельного бесплатного лимита","default":0},"week_resets_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Week Resets At","description":"Когда сбросится недельный лимит (ISO 8601, ближайший понедельник 00:00 МСК)"}},"type":"object","required":["user_id","uuid","balance","partner_balance","requests_balance","tariff","status","registration"],"title":"ProfileMeResponse","description":"Полная информация о профиле текущего пользователя."}}}} ``` ## The PurchaseRequestsRequest object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"PurchaseRequestsRequest":{"properties":{"quantity":{"type":"integer","minimum":1,"title":"Quantity","description":"Количество запросов для покупки"}},"type":"object","required":["quantity"],"title":"PurchaseRequestsRequest","description":"Запрос на покупку запросов за денежный баланс."}}}} ``` ## The PurchaseRequestsResponse object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"PurchaseRequestsResponse":{"properties":{"success":{"type":"boolean","title":"Success","description":"Признак успешной покупки"},"quantity":{"type":"integer","title":"Quantity","description":"Сколько запросов куплено"},"price_per_request":{"type":"number","title":"Price Per Request","description":"Применённый прайс за 1 запрос (USD)"},"total":{"type":"number","title":"Total","description":"Списано с баланса (USD)"},"balance":{"type":"number","title":"Balance","description":"Новый денежный баланс (USD)"},"requests_balance":{"type":"integer","title":"Requests Balance","description":"Новый остаток запросов"}},"type":"object","required":["success","quantity","price_per_request","total","balance","requests_balance"],"title":"PurchaseRequestsResponse","description":"Результат покупки запросов."}}}} ``` ## The PurchaseSubscriptionRequest object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"PurchaseSubscriptionRequest":{"properties":{"tariff":{"type":"string","title":"Tariff","description":"Код тарифа: hobby или business"},"period":{"type":"string","title":"Period","description":"Период: 1m, 3m, 6m, 12m, lifetime"}},"type":"object","required":["tariff","period"],"title":"PurchaseSubscriptionRequest","description":"Запрос на покупку подписки за денежный баланс."}}}} ``` ## The PurchaseSubscriptionResponse object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"PurchaseSubscriptionResponse":{"properties":{"success":{"type":"boolean","title":"Success","description":"Признак успеха"},"tariff":{"type":"string","title":"Tariff","description":"Установленный тариф"},"period":{"type":"string","title":"Period","description":"Купленный период"},"price":{"type":"number","title":"Price","description":"Списано с баланса (USD)"},"balance":{"type":"number","title":"Balance","description":"Новый денежный баланс (USD)"},"subscription":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subscription","description":"Дата окончания подписки (ISO 8601), null для lifetime"},"is_lifetime":{"type":"boolean","title":"Is Lifetime","description":"Бессрочная подписка"}},"type":"object","required":["success","tariff","period","price","balance","is_lifetime"],"title":"PurchaseSubscriptionResponse","description":"Результат покупки подписки."}}}} ``` ## The ReferralStatsResponse object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"ReferralStatsResponse":{"properties":{"invited_count":{"$ref":"#/components/schemas/InvitedCount","description":"Количество приглашённых пользователей с разбивкой по каналу"},"earnings":{"type":"number","title":"Earnings","description":"Сумма реферальных отчислений (USD) по оплаченным депозитам приглашённых"}},"type":"object","required":["invited_count","earnings"],"title":"ReferralStatsResponse","description":"Статистика реферальной программы текущего пользователя."},"InvitedCount":{"properties":{"by_ref_link":{"type":"integer","title":"By Ref Link","description":"Приглашено по реферальной ссылке"},"by_bot":{"type":"integer","title":"By Bot","description":"Приглашено через партнёрский канал"},"total":{"type":"integer","title":"Total","description":"Итого уникальных приглашённых пользователей"}},"type":"object","required":["by_ref_link","by_bot","total"],"title":"InvitedCount","description":"Разбивка приглашённых пользователей по каналу привлечения."}}}} ``` ## The RegionAnalysis object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"RegionAnalysis":{"properties":{"primary":{"type":"string","title":"Primary","description":"Наиболее вероятный регион"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"Наиболее вероятный населённый пункт (если определён)"},"confidence":{"type":"integer","title":"Confidence","description":"Уверенность (доля топ-региона), %"},"level":{"type":"string","title":"Level","description":"Качественный уровень: высокая/средняя/низкая"},"candidates":{"items":{"$ref":"#/components/schemas/RegionCandidate"},"type":"array","title":"Candidates","description":"Кандидаты-регионы (топ-5)"},"evidence":{"items":{"$ref":"#/components/schemas/RegionEvidence"},"type":"array","title":"Evidence","description":"Сигналы-обоснования"},"signals_count":{"type":"integer","title":"Signals Count","description":"Всего учтённых сигналов"}},"type":"object","required":["primary","confidence","level","signals_count"],"title":"RegionAnalysis","description":"Вероятностная оценка региона личности по совокупности факторов.\n\nЗаполняется только для запросов поиска одной личности (ФИО+ДР, ИНН,\nСНИЛС, паспорт). Не является официальными данными."},"RegionCandidate":{"properties":{"region":{"type":"string","title":"Region","description":"Название региона"},"percent":{"type":"integer","title":"Percent","description":"Доля сигналов за этот регион, %"},"sources":{"items":{"type":"string"},"type":"array","title":"Sources","description":"Источники сигналов (Адрес ×3, ИНН, …)"}},"type":"object","required":["region","percent"],"title":"RegionCandidate","description":"Кандидат-регион в оценке региона личности."},"RegionEvidence":{"properties":{"source":{"type":"string","title":"Source","description":"Тип источника (Адрес, ИНН, Госномер, …)"},"detail":{"type":"string","title":"Detail","description":"Исходное значение сигнала"},"region":{"type":"string","title":"Region","description":"Регион, на который указывает сигнал"}},"type":"object","required":["source","detail","region"],"title":"RegionEvidence","description":"Один сигнал-обоснование оценки региона."}}}} ``` ## The RegionCandidate object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"RegionCandidate":{"properties":{"region":{"type":"string","title":"Region","description":"Название региона"},"percent":{"type":"integer","title":"Percent","description":"Доля сигналов за этот регион, %"},"sources":{"items":{"type":"string"},"type":"array","title":"Sources","description":"Источники сигналов (Адрес ×3, ИНН, …)"}},"type":"object","required":["region","percent"],"title":"RegionCandidate","description":"Кандидат-регион в оценке региона личности."}}}} ``` ## The RegionEvidence object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"RegionEvidence":{"properties":{"source":{"type":"string","title":"Source","description":"Тип источника (Адрес, ИНН, Госномер, …)"},"detail":{"type":"string","title":"Detail","description":"Исходное значение сигнала"},"region":{"type":"string","title":"Region","description":"Регион, на который указывает сигнал"}},"type":"object","required":["source","detail","region"],"title":"RegionEvidence","description":"Один сигнал-обоснование оценки региона."}}}} ``` ## The RequestsPricingResponse object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"RequestsPricingResponse":{"properties":{"tariff":{"type":"string","title":"Tariff","description":"Текущий тариф пользователя"},"price_per_request":{"type":"number","title":"Price Per Request","description":"Цена за 1 запрос сверх недельного лимита (USD, по тарифу)"},"weekly_limit":{"type":"integer","title":"Weekly Limit","description":"Бесплатных запросов в неделю (по тарифу)"},"weekly_used":{"type":"integer","title":"Weekly Used","description":"Использовано запросов недельного лимита на этой неделе"},"weekly_remaining":{"type":"integer","title":"Weekly Remaining","description":"Остаток недельного бесплатного лимита"},"week_resets_at":{"type":"string","title":"Week Resets At","description":"Когда сбросится недельный лимит (ISO 8601)"},"requests_balance":{"type":"integer","title":"Requests Balance","description":"Остаток предоплаченных запросов (пакеты)"},"min_quantity":{"type":"integer","title":"Min Quantity","description":"Минимальное количество запросов для покупки пакета"},"max_quantity":{"type":"integer","title":"Max Quantity","description":"Максимальное количество запросов для покупки пакета"}},"type":"object","required":["tariff","price_per_request","weekly_limit","weekly_used","weekly_remaining","week_resets_at","requests_balance","min_quantity","max_quantity"],"title":"RequestsPricingResponse","description":"Прайс на запросы по тарифу + прогресс недельного бесплатного лимита."}}}} ``` ## The SearchInfoResponse object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"SearchInfoResponse":{"properties":{"request_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Request Id","description":"Идентификатор запроса. Передайте его в GET /search/info/{request_id}, чтобы повторно получить эти результаты."},"query":{"type":"string","title":"Query","description":"Исходный поисковый запрос"},"query_type":{"type":"string","title":"Query Type","description":"Тип запроса, которым были получены данные (например, normal)"},"databases":{"additionalProperties":{"additionalProperties":true,"type":"object"},"type":"object","title":"Databases","description":"Словарь баз данных с результатами (ключ - database_id)"},"records":{"items":{"$ref":"#/components/schemas/ClassifiedRecordItem"},"type":"array","title":"Records","description":"Список найденных записей с классифицированными полями"},"persons":{"items":{"$ref":"#/components/schemas/PersonInfo"},"type":"array","title":"Persons","description":"Список уникальных личностей с контактными данными"},"statistics":{"$ref":"#/components/schemas/SearchInfoStatistics","description":"Расширенная статистика поиска"},"information":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Information","description":"Дополнительная информация (оператор, СБП)"},"region_analysis":{"anyOf":[{"$ref":"#/components/schemas/RegionAnalysis"},{"type":"null"}],"description":"Вероятностная оценка региона личности по совокупности данных. Заполняется только для запросов поиска одной личности (ФИО+ДР, ИНН, СНИЛС, паспорт)."}},"type":"object","required":["query","query_type","databases","records","persons","statistics"],"title":"SearchInfoResponse","description":"Единый формат результата поиска.\n\nВозвращается синхронным POST /search/normal и GET /search/info/{request_id}."},"ClassifiedRecordItem":{"properties":{"database_id":{"type":"string","title":"Database Id","description":"ID базы данных"},"data":{"additionalProperties":true,"type":"object","title":"Data","description":"Данные записи"},"classified_data":{"additionalProperties":true,"type":"object","title":"Classified Data","description":"Классифицированные поля (phones, emails, passports, passport_details, etc.)"}},"type":"object","required":["database_id","data","classified_data"],"title":"ClassifiedRecordItem","description":"Запись с классифицированными полями."},"PersonInfo":{"properties":{"full_name":{"type":"string","title":"Full Name","description":"Полное ФИО"},"birth_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Birth Date","description":"Дата рождения в формате DD.MM.YYYY"},"contact_data":{"$ref":"#/components/schemas/PersonContactData","description":"Контактные данные"},"border_crossings":{"anyOf":[{"items":{"$ref":"#/components/schemas/BorderCrossing"},"type":"array"},{"type":"null"}],"title":"Border Crossings","description":"Пересечения границы"}},"type":"object","required":["full_name","contact_data"],"title":"PersonInfo","description":"Информация о личности."},"PersonContactData":{"properties":{"phone_numbers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Phone Numbers","description":"Номера телефонов"},"emails":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Emails","description":"Email адреса"},"cars":{"anyOf":[{"items":{"$ref":"#/components/schemas/CarInfo"},"type":"array"},{"type":"null"}],"title":"Cars","description":"Автомобили"},"passport":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Passport","description":"Паспортные данные"},"inn":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Inn","description":"ИНН"},"snils":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Snils","description":"СНИЛС"},"addresses":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Addresses","description":"Адреса"}},"type":"object","title":"PersonContactData","description":"Контактные данные личности."},"CarInfo":{"properties":{"plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plate","description":"Гос. номер"},"make":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Make","description":"Марка (Toyota, BMW…)"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Модель (Camry, X5…)"},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year","description":"Год выпуска"},"color":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Color","description":"Цвет"},"vin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin","description":"VIN"},"body_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Type","description":"Тип кузова"},"engine":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Engine","description":"Объём двигателя, напр. «2.5»"},"power_hp":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Power Hp","description":"Мощность, л.с."},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region","description":"Регион регистрации"},"sts":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sts","description":"Свидетельство о регистрации (СТС)"},"pts":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pts","description":"Паспорт ТС (ПТС)"},"engine_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Engine Number","description":"Номер двигателя"},"price_min":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Price Min","description":"Оценочная стоимость — от (руб.)"},"price_max":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Price Max","description":"Оценочная стоимость — до (руб.)"}},"type":"object","title":"CarInfo","description":"Данные об автомобиле, собранные из записей."},"BorderCrossing":{"properties":{"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date","description":"Дата пересечения"},"from_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From Country","description":"Страна выезда"},"from_city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From City","description":"Город выезда"},"to_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Country","description":"Страна въезда"},"to_checkpoint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Checkpoint","description":"Пункт пропуска"},"vehicle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vehicle","description":"Транспортное средство / рейс"},"transport_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transport Type","description":"Тип транспорта"}},"type":"object","title":"BorderCrossing","description":"Одно пересечение границы."},"SearchInfoStatistics":{"properties":{"total_records":{"type":"integer","title":"Total Records","description":"Общее количество найденных записей"},"total_databases":{"type":"integer","title":"Total Databases","description":"Общее количество баз данных с результатами"},"total_persons":{"type":"integer","title":"Total Persons","description":"Количество уникальных личностей"},"search_time_ms":{"type":"integer","title":"Search Time Ms","description":"Время выполнения поиска в миллисекундах"}},"type":"object","required":["total_records","total_databases","total_persons","search_time_ms"],"title":"SearchInfoStatistics","description":"Расширенная статистика поиска."},"RegionAnalysis":{"properties":{"primary":{"type":"string","title":"Primary","description":"Наиболее вероятный регион"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"Наиболее вероятный населённый пункт (если определён)"},"confidence":{"type":"integer","title":"Confidence","description":"Уверенность (доля топ-региона), %"},"level":{"type":"string","title":"Level","description":"Качественный уровень: высокая/средняя/низкая"},"candidates":{"items":{"$ref":"#/components/schemas/RegionCandidate"},"type":"array","title":"Candidates","description":"Кандидаты-регионы (топ-5)"},"evidence":{"items":{"$ref":"#/components/schemas/RegionEvidence"},"type":"array","title":"Evidence","description":"Сигналы-обоснования"},"signals_count":{"type":"integer","title":"Signals Count","description":"Всего учтённых сигналов"}},"type":"object","required":["primary","confidence","level","signals_count"],"title":"RegionAnalysis","description":"Вероятностная оценка региона личности по совокупности факторов.\n\nЗаполняется только для запросов поиска одной личности (ФИО+ДР, ИНН,\nСНИЛС, паспорт). Не является официальными данными."},"RegionCandidate":{"properties":{"region":{"type":"string","title":"Region","description":"Название региона"},"percent":{"type":"integer","title":"Percent","description":"Доля сигналов за этот регион, %"},"sources":{"items":{"type":"string"},"type":"array","title":"Sources","description":"Источники сигналов (Адрес ×3, ИНН, …)"}},"type":"object","required":["region","percent"],"title":"RegionCandidate","description":"Кандидат-регион в оценке региона личности."},"RegionEvidence":{"properties":{"source":{"type":"string","title":"Source","description":"Тип источника (Адрес, ИНН, Госномер, …)"},"detail":{"type":"string","title":"Detail","description":"Исходное значение сигнала"},"region":{"type":"string","title":"Region","description":"Регион, на который указывает сигнал"}},"type":"object","required":["source","detail","region"],"title":"RegionEvidence","description":"Один сигнал-обоснование оценки региона."}}}} ``` ## The SearchInfoStatistics object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"SearchInfoStatistics":{"properties":{"total_records":{"type":"integer","title":"Total Records","description":"Общее количество найденных записей"},"total_databases":{"type":"integer","title":"Total Databases","description":"Общее количество баз данных с результатами"},"total_persons":{"type":"integer","title":"Total Persons","description":"Количество уникальных личностей"},"search_time_ms":{"type":"integer","title":"Search Time Ms","description":"Время выполнения поиска в миллисекундах"}},"type":"object","required":["total_records","total_databases","total_persons","search_time_ms"],"title":"SearchInfoStatistics","description":"Расширенная статистика поиска."}}}} ``` ## The SearchTaskStatusResponse object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"SearchTaskStatusResponse":{"properties":{"task_id":{"type":"string","format":"uuid","title":"Task Id","description":"ID задачи"},"status":{"type":"string","title":"Status","description":"Статус: pending, processing, completed, failed"},"task_type":{"type":"string","title":"Task Type","description":"Тип задачи: batch"},"total_queries":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Queries","description":"Общее количество запросов в задаче"},"processed_queries":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Processed Queries","description":"Обработано запросов"},"found_queries":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Found Queries","description":"Найдено запросов с результатами"},"spent_requests":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Spent Requests","description":"Потрачено запросов из баланса"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message","description":"Сообщение об ошибке (если есть)"},"created_at":{"type":"string","title":"Created At","description":"Дата создания"},"started_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Started At","description":"Дата начала обработки"},"completed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completed At","description":"Дата завершения обработки"}},"type":"object","required":["task_id","status","task_type","created_at"],"title":"SearchTaskStatusResponse","description":"Ответ на запрос статуса задачи поиска."}}}} ``` ## The SearchType object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"SearchType":{"type":"string","enum":["phone","email","nickname","full_name","full_name_birthdate","first_last_name","first_middle_name","first_last_name_birthdate","first_middle_name_birthdate","last_name_birthdate","first_name_birthdate","url_telegram","url_instagram","url_vk","url_facebook","url_twitter","domain","url","vk_id","tg_id","ipv4","ipv6","mac_address","btc_address","eth_address","passport_ru","passport_eu","inn_individual","inn_legal","snils","ogrn","ogrnip","kpp","car_plate","vin","credit_card","iban","bic_swift","coordinates","date","address","unknown"],"title":"SearchType","description":"Перечисление типов поисковых запросов.\n\nЗначения — короткие технические коды в snake_case. Человекочитаемые\nподписи (локализация) формируются на стороне клиента.\n\nСуффиксы стран/категорий (``_ru``/``_eu``, ``_individual``/``_legal``)\nиспользуются только там, где они несут смысловую дизамбигуацию\n(паспорт РФ vs ЕС, ИНН физлица vs юрлица). Для остальных РФ-специфичных\nидентификаторов канон — короткий код без суффикса.\n\nСовместимость со старыми кодами (``snils_ru``, ``passport``, ``inn`` и т.п.)\nобеспечивается картой алиасов ``_SEARCH_TYPE_ALIASES`` ниже."}}}} ``` ## The SingleCheckRequest object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"SingleCheckRequest":{"properties":{"query":{"type":"string","maxLength":500,"minLength":1,"title":"Query","description":"Номер телефона или другой запрос для проверки"}},"type":"object","required":["query"],"title":"SingleCheckRequest","description":"Схема запроса для единичной проверки на утечки."}}}} ``` ## The SingleCheckResponse object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"SingleCheckResponse":{"properties":{"query":{"type":"string","title":"Query","description":"Проверенный запрос"},"found":{"type":"boolean","title":"Found","description":"Найдено ли в базах данных"},"databases":{"items":{"$ref":"#/components/schemas/DatabaseLeakInfo"},"type":"array","title":"Databases","description":"Список баз с найденными записями"},"total_databases":{"type":"integer","title":"Total Databases","description":"Общее количество баз с найденными записями"},"total_records":{"type":"integer","title":"Total Records","description":"Общее количество найденных записей"}},"type":"object","required":["query","found","total_databases","total_records"],"title":"SingleCheckResponse","description":"Ответ на единичную проверку."},"DatabaseLeakInfo":{"properties":{"database_id":{"type":"string","title":"Database Id","description":"ID базы данных"},"database_name":{"type":"string","title":"Database Name","description":"Название базы данных"},"records_count":{"type":"integer","title":"Records Count","description":"Количество найденных записей"}},"type":"object","required":["database_id","database_name","records_count"],"title":"DatabaseLeakInfo","description":"Информация о найденных утечках в одной базе данных."}}}} ``` ## The StatsDetailResponse object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"StatsDetailResponse":{"properties":{"period":{"$ref":"#/components/schemas/StatsPeriod","description":"Запрошенный период"},"daily_stats":{"items":{"$ref":"#/components/schemas/DailyStatItem"},"type":"array","title":"Daily Stats","description":"Разбивка по дням (включает дни без запросов с requests_count=0)"},"total_requests":{"type":"integer","title":"Total Requests","description":"Суммарное количество запросов за весь период"}},"type":"object","required":["period","daily_stats","total_requests"],"title":"StatsDetailResponse","description":"Статистика поисковых запросов пользователя за период."},"StatsPeriod":{"properties":{"start":{"type":"string","title":"Start","description":"Начало периода в формате YYYY-MM-DD"},"end":{"type":"string","title":"End","description":"Конец периода в формате YYYY-MM-DD"}},"type":"object","required":["start","end"],"title":"StatsPeriod","description":"Период запрошенной статистики."},"DailyStatItem":{"properties":{"date":{"type":"string","title":"Date","description":"Дата в формате YYYY-MM-DD"},"requests_count":{"type":"integer","title":"Requests Count","description":"Количество запросов за этот день"}},"type":"object","required":["date","requests_count"],"title":"DailyStatItem","description":"Статистика запросов за один день."}}}} ``` ## The StatsPeriod object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"StatsPeriod":{"properties":{"start":{"type":"string","title":"Start","description":"Начало периода в формате YYYY-MM-DD"},"end":{"type":"string","title":"End","description":"Конец периода в формате YYYY-MM-DD"}},"type":"object","required":["start","end"],"title":"StatsPeriod","description":"Период запрошенной статистики."}}}} ``` ## The SubscriptionOptionsResponse object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"SubscriptionOptionsResponse":{"properties":{"current_tariff":{"type":"string","title":"Current Tariff","description":"Текущий тариф пользователя"},"subscription":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subscription","description":"Дата окончания подписки (ISO 8601) или null"},"is_lifetime":{"type":"boolean","title":"Is Lifetime","description":"Бессрочная подписка","default":false},"balance":{"type":"number","title":"Balance","description":"Денежный баланс пользователя (USD)"},"tariffs":{"items":{"$ref":"#/components/schemas/SubscriptionTariffOption"},"type":"array","title":"Tariffs","description":"Тарифы, доступные к покупке"}},"type":"object","required":["current_tariff","balance","tariffs"],"title":"SubscriptionOptionsResponse","description":"Опции покупки подписки + текущее состояние пользователя."},"SubscriptionTariffOption":{"properties":{"tariff":{"type":"string","title":"Tariff","description":"Код тарифа: hobby, business"},"title":{"type":"string","title":"Title","description":"Название тарифа"},"emoji":{"type":"string","title":"Emoji","description":"Эмодзи тарифа"},"weekly_free":{"type":"integer","title":"Weekly Free","description":"Бесплатных запросов в неделю"},"price_per_request":{"type":"number","title":"Price Per Request","description":"Цена за запрос сверх лимита (USD)"},"monthly_price":{"type":"number","title":"Monthly Price","description":"Базовая цена за месяц (USD)"},"api_access":{"type":"boolean","title":"Api Access","description":"Доступ к программному API"},"periods":{"items":{"$ref":"#/components/schemas/SubscriptionPeriodOption"},"type":"array","title":"Periods","description":"Доступные периоды и цены"}},"type":"object","required":["tariff","title","emoji","weekly_free","price_per_request","monthly_price","api_access","periods"],"title":"SubscriptionTariffOption","description":"Тариф и его опции подписки."},"SubscriptionPeriodOption":{"properties":{"period":{"type":"string","title":"Period","description":"Ключ периода: 1m, 3m, 6m, 12m, lifetime"},"name":{"type":"string","title":"Name","description":"Название периода (человекочитаемое)"},"months":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Months","description":"Длительность в месяцах (null для lifetime)"},"price":{"type":"number","title":"Price","description":"Цена за период (USD)"}},"type":"object","required":["period","name","price"],"title":"SubscriptionPeriodOption","description":"Вариант периода подписки для тарифа."}}}} ``` ## The SubscriptionPeriodOption object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"SubscriptionPeriodOption":{"properties":{"period":{"type":"string","title":"Period","description":"Ключ периода: 1m, 3m, 6m, 12m, lifetime"},"name":{"type":"string","title":"Name","description":"Название периода (человекочитаемое)"},"months":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Months","description":"Длительность в месяцах (null для lifetime)"},"price":{"type":"number","title":"Price","description":"Цена за период (USD)"}},"type":"object","required":["period","name","price"],"title":"SubscriptionPeriodOption","description":"Вариант периода подписки для тарифа."}}}} ``` ## The SubscriptionTariffOption object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"SubscriptionTariffOption":{"properties":{"tariff":{"type":"string","title":"Tariff","description":"Код тарифа: hobby, business"},"title":{"type":"string","title":"Title","description":"Название тарифа"},"emoji":{"type":"string","title":"Emoji","description":"Эмодзи тарифа"},"weekly_free":{"type":"integer","title":"Weekly Free","description":"Бесплатных запросов в неделю"},"price_per_request":{"type":"number","title":"Price Per Request","description":"Цена за запрос сверх лимита (USD)"},"monthly_price":{"type":"number","title":"Monthly Price","description":"Базовая цена за месяц (USD)"},"api_access":{"type":"boolean","title":"Api Access","description":"Доступ к программному API"},"periods":{"items":{"$ref":"#/components/schemas/SubscriptionPeriodOption"},"type":"array","title":"Periods","description":"Доступные периоды и цены"}},"type":"object","required":["tariff","title","emoji","weekly_free","price_per_request","monthly_price","api_access","periods"],"title":"SubscriptionTariffOption","description":"Тариф и его опции подписки."},"SubscriptionPeriodOption":{"properties":{"period":{"type":"string","title":"Period","description":"Ключ периода: 1m, 3m, 6m, 12m, lifetime"},"name":{"type":"string","title":"Name","description":"Название периода (человекочитаемое)"},"months":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Months","description":"Длительность в месяцах (null для lifetime)"},"price":{"type":"number","title":"Price","description":"Цена за период (USD)"}},"type":"object","required":["period","name","price"],"title":"SubscriptionPeriodOption","description":"Вариант периода подписки для тарифа."}}}} ``` ## The TaskStatusResponse object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"TaskStatusResponse":{"properties":{"task_id":{"type":"string","format":"uuid","title":"Task Id","description":"ID задачи"},"status":{"type":"string","title":"Status","description":"Статус: pending, processing, completed, failed"},"task_type":{"type":"string","title":"Task Type","description":"Тип задачи: single или batch"},"total_numbers":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Numbers","description":"Общее количество номеров в задаче"},"processed_numbers":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Processed Numbers","description":"Обработано номеров"},"found_numbers":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Found Numbers","description":"Найдено номеров с утечками"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message","description":"Сообщение об ошибке (если есть)"},"created_at":{"type":"string","title":"Created At","description":"Дата создания задачи"},"started_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Started At","description":"Дата начала обработки"},"completed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Completed At","description":"Дата завершения обработки"}},"type":"object","required":["task_id","status","task_type","created_at"],"title":"TaskStatusResponse","description":"Ответ на запрос статуса задачи."}}}} ``` ## The UpdateProfileSettingsRequest object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"UpdateProfileSettingsRequest":{"properties":{"currency":{"anyOf":[{"type":"string","maxLength":3,"pattern":"^(USD|RUB|UAH|KZT|BYN)$"},{"type":"null"}],"title":"Currency","description":"Предпочитаемая валюта. Допустимые значения: USD, RUB, UAH, KZT, BYN"}},"type":"object","title":"UpdateProfileSettingsRequest","description":"Запрос на обновление настроек профиля. Передайте только нужные поля."}}}} ``` ## The UpdateProfileSettingsResponse object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"UpdateProfileSettingsResponse":{"properties":{"success":{"type":"boolean","title":"Success","description":"Признак успешности операции"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency","description":"Установленная валюта (если передавалась в запросе)"}},"type":"object","required":["success"],"title":"UpdateProfileSettingsResponse","description":"Ответ на успешное обновление настроек профиля."}}}} ``` ## The ValidationError object ```json {"openapi":"3.1.0","info":{"title":"GoData API","version":"1.0.0"},"components":{"schemas":{"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.go-data.app/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.