ФИО и почта

Подсказки дополняют то, что человек набирает прямо сейчас. Разобрать уже собранные данные — ФИО, телефон, почту, дату рождения — можно в разделе «Стандартизация».

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

POST/v1/suggest/fioсовместимо с DaData: /suggestions/api/4_1/rs/suggest/fio

Дополняет ФИО по началу ввода, раскладывает на фамилию/имя/отчество и определяет пол. Два режима: целая строка ("query": "иванова мари") или дополнение одной части через parts. С флагом declensions к каждой подсказке добавляются склонения по шести падежам. Доступен по публичному ключу (pk_…) — подходит для браузерных форм.

Параметры запроса

ПолеТипОписание
queryrequiredstringНачало ФИО или отдельной части.
countintegerСколько подсказок вернуть (1–20, по умолчанию 10).
genderstringФильтр пола: MALE или FEMALE.
partsarrayДополнять только указанную часть: SURNAME, NAME, PATRONYMIC.
declensionsbooleantrue — добавить к каждой подсказке склонения по 6 падежам.
POST /v1/suggest/fio                          // к нам
POST /suggestions/api/4_1/rs/suggest/fio      // совместимо с DaData
// фильтр по полу + склонения по 6 падежам:
{ "query": "иванова мария сергеевна", "gender": "FEMALE", "declensions": true }

// по мере ввода, без фильтров:
{ "query": "иванова мари", "count": 5 }

// дополнение одной части (фамилия / имя / отчество):
{ "query": "ал", "parts": ["NAME"], "gender": "MALE" }

Поля ответа

ПолеТипОписание
suggestions[].valuestringПолное ФИО в правильном регистре.
suggestions[].surnamestringФамилия.
suggestions[].namestringИмя.
suggestions[].patronymicstringОтчество.
suggestions[].genderstringПол: male, female или unknown.
suggestions[].declensionsobjectСклонения по 6 падежам (nominative…prepositional), каждый — { surname, name, patronymic }. Только при declensions: true.

Подсказки email

POST/v1/suggest/emailсовместимо с DaData: /suggestions/api/4_1/rs/suggest/email

Достраивает адрес по началу ввода: к локальной части подставляет распространённые почтовые домены (gmail.com, yandex.ru, mail.ru и др.). Доступен по публичному ключу (pk_…).

Параметры запроса

ПолеТипОписание
queryrequiredstringНачало адреса, например ivan или ivan@gma.
countintegerСколько подсказок вернуть (1–20, по умолчанию 10).
POST /v1/suggest/email                        // к нам
POST /suggestions/api/4_1/rs/suggest/email    // совместимо с DaData
{ "query": "ivan@gma", "count": 3 }

Поля ответа

ПолеТипОписание
suggestions[].valuestringДостроенный адрес целиком.
suggestions[].localstringЛокальная часть (до @).
suggestions[].domainstringПочтовый домен (после @).