> For the complete documentation index, see [llms.txt](https://docs.femida-search.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.femida-search.tech/raspoznavanie-dokumentov/raspoznavanie-pasporta-s-proverkami.md).

# Распознавание паспорта с проверками

<table><thead><tr><th width="213"></th><th></th></tr></thead><tbody><tr><td>url</td><td><a href="https://femida-search.online/apis/document/api/v1/rest/recognize">https://femida-search.online/apis/document/api/v1/rest/recognize</a></td></tr><tr><td>метод</td><td>POST</td></tr><tr><td>формат ответа</td><td>JSON</td></tr></tbody></table>

Параметры запроса (Query Params):

<table><thead><tr><th width="269.3333333333333">Параметр</th><th>Описание</th></tr></thead><tbody><tr><td>requiredDocument</td><td>тип проверяемого документа (для проверки паспорта необходимо передавать «RUSSIAN_PASSPORT»)</td></tr></tbody></table>

Тело запроса (Body):

<table><thead><tr><th width="269.3333333333333">Параметр</th><th>Описание</th></tr></thead><tbody><tr><td>image</td><td>изображение.jpg (формат JPEG/JPG, PDF, PNG, TIFF, BMP, GIF, HEIC, HEIF, DJVU)</td></tr></tbody></table>

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

`{`\
&#x20;  `«isSuccess»: true,`\
&#x20;  `«documentType»: «RUSSIAN_PASPORT»,`\
&#x20;  `«isExpectedDocumentType»: true,`\
&#x20;  `«recognizedDocumentType»: «RUSSIAN_PASPORT»,`\
&#x20;  `«isFake»: false,`\
&#x20;  `«isFraud»: false,`\
&#x20;  `«isExpired»: true,`\
&#x20;  `«unrecognizedFieldNames»: ["surname", "sex"],` \
&#x20;  `«document»: {`\
&#x20;     `"issuingAuthority":"ГУ МВД РОССИИ ПО Г. МОСКВЕ",`\
&#x20;     `"placeOfBirth":"Г. МОСКВА",`\
&#x20;     `"seriesAndNumber":"4111111111",`\
&#x20;     `"lastName":"ИВАНОВ",`\
&#x20;     `"firstName":"ИВАН",`\
&#x20;     `"otherNames":"ИВАНОВИЧ",`\
&#x20;     `"sex":"MALE",`\
&#x20;     `"dateOfBirth":"1990-01- 01",`\
&#x20;     `"subdivisionCode":"770-001"`\
&#x20;  `}`\
`}`

Значения вернувшихся в ответе полей:

<table><thead><tr><th width="210"></th><th width="182"></th><th></th></tr></thead><tbody><tr><td>isSuccess</td><td>Boolean</td><td>Флаг успешной проверки (true или false)</td></tr><tr><td>documentType</td><td>String</td><td>Ожидаемые тип распознанного DRIVER_LICENCE, UNKNOWN)</td></tr><tr><td>isExpectedDocumentType</td><td>Boolean</td><td>Флаг совпадения ожидаемого и полученного (фактического) документа (true или false)</td></tr><tr><td>recognizedDocumentType</td><td>String</td><td>Фактический тип распознанного документа (RUSSIAN_PASSPORT, DRIVER_LICENCE, UNKNOWN)</td></tr><tr><td>isFake</td><td>Boolean</td><td>Флаг проверки на фальшивость (фотошоп/переклей и тд) полученного изображения документа (true или false)</td></tr><tr><td>isFraud</td><td>Boolean</td><td>Флаг проверки связки ФИО и номера паспорта - совпадает ли ФИО и номер паспорта на изображении с данными из закрытых источников (true или false)</td></tr><tr><td>isExpired</td><td>Boolean</td><td>Флаг недействительности паспорта (true или false)</td></tr><tr><td>unrecognizedFieldNames</td><td>List&#x3C;String></td><td>Нераспознанные поля документа (["surname", "other_names", "date_of_issue","sex","issuing_authority", "place_of_birth"])</td></tr><tr><td>document</td><td>Map&#x3C;String,String></td><td>Распознанные поля документа и их значения ({"issuing_authority", "place_of_birth", "seriesAndNumber", "lastName", "firstName", "otherNames", "sex", "dateOfBirth", "subdivisionCode"})</td></tr></tbody></table>