Перейти к содержанию

Вид на жительство

Примеры изображений документов

Получение результатов

Пример ответа по обработанному документу:

{
  "document_id": "s-39182",
  "documents": [
    {
      "key": "VNG",
      "type": "VNG",
      "data": {
        "Series": "",
        "Number": "",
        "IssueId": "",
        "Gender": "",
        "LastName": "",
        "FirstName": "",
        "MiddleName": "",
        "BirthDate": "",
        "BirthPlace": "",
        "Citizenship": "",
        "SolutionDate": "",
        "SolutionNumber": "",
        "IssuedBy": "",
        "IssueDate": "",
        "ExpiryDate": null,
        "Address": "",
        "RegIssueDate": null,
        "RegExpiryDate": null
      },
      "metadata": {
        "confidences": null,
        "verifications": {},
        "metadata_check": {}
      },
      "broken": null,
      "broken_reasons": [],
      "broken_reasons_ru": []
    }
  ]
}

Описание ключей

Ключ Тип Описание
document_id string номер документа в формате s-<номер документа>
documents list список данных по каждому документу
documents[].key string ключ заданный при отправке документа для отслеживания
documents[].type string тип документа
documents[].data dictionary обработанные данные по каждому полю,
содержит ключи полей и их определенные значения
Series string Серия документа
Number string Номер документа
IssueId string Идентификатор выдачи
Gender string Пол
LastName string Фамилия
FirstName string Имя
MiddleName string Отчество
BirthDate string Дата рождения
BirthPlace string Место рождения
Citizenship string Гражданство
SolutionDate string Дата решения
SolutionNumber string Номер решения
IssuedBy string Выдано кем
IssueDate string Дата выдачи документа
ExpiryDate string null
Address string Адрес проживания
RegIssueDate string null
RegExpiryDate string null
metadata dictionary содержит ключи метаданных
confidences dictionary
{key: float}
метаданные с точностью обработки по каждому полю -
содержит ключи полей и значения уровня уверенности.
Значения от 0.0000 до 0.9999, где чем значение больше,
тем уверенность в результате выше.
Максимальная уверенность - 0.9999.