Skip to content

If you're interested in the English version of this spec, let us know on the GitHub.

fio


Подсказки по ФИО

POST
/suggest/fio
  • Подсказывает ФИО одной строкой или отдельно фамилию, имя, отчество.
  • Исправляет клавиатурную раскладку («fynjy» → «Антон»).
  • Определяет пол.

Authorizations

ApiKey

API-ключ. Полный вид заголовка: Authorization: Token <YOUR_KEY>. Получить ключ

Type
API Key (header: Authorization)

Request Body

application/json
object

Текст запроса.
@maxLength 300

Max Length300

Максимальное количество результатов.
@minimum 1
@maximum 20
@default 10

Minimum1
Maximum20
Default10

Пол (UNKNOWN / MALE / FEMALE)

Valid values"MALE""FEMALE""UNKNOWN"
string[]

Подсказки по части ФИО:

  • Только имена: ["NAME"]
  • Имена и отчества: ["NAME", "PATRONYMIC"]
  • Имена и фамилии: ["NAME", "SURNAME"]
Valid values"NAME""SURNAME""PATRONYMIC"

Responses

Запрос успешно обработан

application/json
object

Объект с массивом подсказок

object[]
Required

Массив подсказок или пустой массив

ФИО одной строкой

= value (ФИО одной строкой)

object
Required

Подробности о ФИО

Playground

Server
Authorization
Body

Samples


Стандартизация ФИО

POST
/clean/name
  • Исправляет опечатки и транслитерирует.
  • Проставляет пол.
  • Склоняет по падежам (кого? кому? кем?).

Authorizations

ApiKey

API-ключ. Полный вид заголовка: Authorization: Token <YOUR_KEY>. Получить ключ

Type
API Key (header: Authorization)
+
SecretKey

Секретный ключ

Type
API Key (header: X-Secret)

Request Body

application/json

Формат запроса ко всем эндпоинтам API стандартизации (clean) «Дадаты»,
кроме стандартизации составной записи https://dadata.ru/api/clean/record/

Все эндпоинты поддерживают стандартизацию только одной записи в одном запросе, например:
@example [ "мск сухонска 11/-89" ] // Адрес - https://dadata.ru/api/clean/address/
@example [ "Срегей владимерович иванов" ] // ФИО - https://dadata.ru/api/clean/name/
@example [ "serega@yandex/ru" ] // Email - https://dadata.ru/api/clean/email/
@example [ "раб 846)231.60.14 *139" ] // Телефон - https://dadata.ru/api/clean/phone/
@example [ "4509 235857" ] // Проверка паспорта - https://dadata.ru/api/clean/passport/
@example [ "24/3/12" ] // Дата - https://dadata.ru/api/clean/birthdate/
@example [ "форд фокус" ] // Марка и модель автомобиля - https://dadata.ru/api/clean/vehicle/

Min Items1
Max Items1

Responses

Запрос успешно обработан

application/json
object

Исходное ФИО одной строкой

Стандартизованное ФИО одной строкой

в родительном падеже

ФИО в дательном падеже

ФИО в творительном падеже

Фамилия

Имя

Отчество

Пол (Значение - Кириллицей):

  • М - мужской
  • Ж - женский
  • НД - не удалось однозначно определить
Valid values"М""Ж""НД"

Код проверки https://dadata.ru/api/clean/name/#qc

Требуется ли вручную проверить распознанное значение:

Код Проверить? Описание
0 Нет Исходное значение распознано уверенно
1 Да Исходное значение распознано с допущениями или не распознано
2 Нет Исходное значение пустое или заведомо «мусорное»
Valid values01

Playground

Server
Authorization
Body

Samples


Powered by VitePress OpenAPI