foreign_vng — Вид на жительство (ВНЖ)¶

POST https://api.newdb.net/v2

Метод выполняет проверку вида на жительство иностранного гражданина по данным документа и ФИО.

Раздел: Иностранные граждане

Связанные страницы¶

Когда использовать¶

Используйте метод, когда нужно проверить статус документа или разрешительного основания иностранного гражданина.

Типовые кейсы¶

Проверка ВНЖ, патента, РВП или разрешения на работу перед оформлением
Контроль миграционных документов в HR или compliance-процессе
Подтверждение статуса документа по данным анкеты и реквизитам

Заголовки¶

Content-Type: application/json
X-API-KEY: <your_token>

Входная схема (request)¶

{
  "params": {
    "method": "foreign_vng",
    "doctype": "vng",
    "firstname": "string",
    "lastname": "string",
    "doc_seria": "string",
    "doc_number": "string",
    "dob": "YYYY-MM-DD",
    "country": "ru"
  },
  "requestId": "optional-string"
}

Обязательные поля¶

Поле	Формат и назначение
`method`	Строго `foreign_vng`.
`doctype`	Строго `vng`.
`firstname`	Имя иностранного гражданина на русском языке.
`lastname`	Фамилия иностранного гражданина на русском языке.
`dob`	Дата рождения в формате `YYYY-MM-DD`.
`doc_seria`	Серия ВНЖ строкой. Допустимые серии: `80`, `81`, `82`, `83`, `90`, `91`.
`doc_number`	Номер ВНЖ строкой. Ведущие нули необходимо сохранять.
`country`	Код страны запроса — `ru`.

Внешнее поле requestId необязательно. Если идентификатор используется в вашей интеграции, передавайте уникальную строку или UUID.

Для книжечного ВНЖ, на котором указано 83 № 0000000, передавайте:

"doc_seria": "XX",
"doc_number": "0000000"

Поля blank_seria и blank_number в методе foreign_vng не используются: отдельной второй пары реквизитов у книжечного ВНЖ нет, поэтому дублировать в них серию и номер ВНЖ не нужно. Поля id_doc_seria и id_doc_number также не являются обязательными для этого метода.

Пример запроса¶

POST /v2 HTTP/1.1
Host: api.newdb.net
Content-Type: application/json
X-API-KEY: YOUR_TOKEN

{
  "params": {
    "method": "foreign_vng",
    "doctype": "vng",
    "firstname": "Имя",
    "lastname": "Фамилия",
    "doc_seria": "XX",
    "doc_number": "0000000",
    "dob": "1990-01-01",
    "country": "ru"
  },
  "requestId": "b4c63a7b-45cc-031e-bbeb-a6518014bca4"
}

Пример ответа¶

{
  "params": {
    "method": "foreign_vng",
    "doctype": "vng",
    "firstname": "Имя",
    "lastname": "Фамилия",
    "doc_seria": "XX",
    "doc_number": "0000000",
    "dob": "1990-01-01",
    "country": "ru",
    "newdb_qid": "EJQYIJ7pnYm9MygA"
  },
  "requestId": "b4c63a7b-45cc-031e-bbeb-a6518014bca4",
  "datecreated": "2026-01-18 15:49:41",
  "state": "complete",
  "balance": 9875,
  "tasks": 1,
  "is_repeat": false,
  "results": {
    "foreign_vng": {
      "taskId": "c0fb4556-152b-4590-99d8-8779cb887a74",
      "dateupdated": "2026-01-18 15:50:13",
      "result": {
        "status": 200,
        "data": [
          {
            "doc_status": "Данные не найдены"
          }
        ]
      }
    }
  }
}

AI Summary¶

Компактные метаданные для AI и агентных систем

{
  "method": "foreign_vng",
  "intent": "Проверка вида на жительство иностранного гражданина",
  "endpoint": "POST https://api.newdb.net/v2",
  "required_headers": ["X-API-KEY"],
  "required_fields": ["method", "doctype", "firstname", "lastname", "doc_seria", "doc_number", "dob", "country"],
  "returns": ["state", "results.foreign_vng.result.status", "results.foreign_vng.result.data"]
}