↑ Все API

API: стандартизация ФИО

✔️ Исправляет опечатки и транслитерирует.

✔️ Проставляет пол.

✔️ Склоняет по падежам (кого? кому? кем?).

Как вызвать

Чтобы вызвать метод, и подтвердите почту.

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

            
                POST https://cleaner.dadata.ru/api/v1/clean/name
            
            
[ "Срегей владимерович иванов" ]

Укажите при вызове:

  • Content-Type: application/json.
  • Accept: application/json.
  • ${API_KEY} — API-ключ.
  • ${SECRET_KEY} — секретный ключ.

Тело запроса передавайте в кодировке UTF-8.

Что в ответе

Стандартизованный объект:

[
{
    "source": "Срегей владимерович иванов",
    "result": "Иванов Сергей Владимирович",
    "result_genitive": "Иванова Сергея Владимировича",
    "result_dative": "Иванову Сергею Владимировичу",
    "result_ablative": "Ивановым Сергеем Владимировичем",
    "surname": "Иванов",
    "name": "Сергей",
    "patronymic": "Владимирович",
    "gender": "М",
    "qc": 1
}
]
НазваниеТипОписание
sourcestring(100)Исходное ФИО одной строкой
resultstring(150)Стандартизованное ФИО одной строкой
result_genitivestring(150)ФИО в родительном падеже (кого?)
result_dativestring(150)ФИО в дательном падеже (кому?)
result_ablativestring(150)ФИО в творительном падеже (кем?)
surnamestring(50)Фамилия
namestring(50)Имя
patronymicstring(50)Отчество
genderstring(10)Пол
  М — мужской
  Ж — женский
  НД — не удалось однозначно определить
qcnumberКод проверки

Код проверки qc

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

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

Коды ответа на запрос

HTTP-код ответаОписание
200Запрос успешно обработан
400 Некорректный запрос
401 В запросе отсутствует API-ключ или секретный ключ
Или в запросе указан несуществующий ключ
403 Не подтверждена почта
Или недостаточно средств для обработки запроса, пополните баланс
405Запрос сделан с методом, отличным от POST
429Слишком много запросов в секунду или новых соединений в минуту
5xxПроизошла внутренняя ошибка сервиса

Примеры и интеграции

Ограничения

В запросе разрешено передавать только одно ФИО.

Максимальная частота запросов — 20 в секунду с одного IP-адреса.

Максимальная частота создания новых соединений — 60 в минуту с одного IP-адреса.

Дадата не поддерживает вызов этого метода из браузерного JavaScript. Иначе злоумышленник мог бы похитить секретный ключ и использовать API за ваш счет.

Стоимость

20 копеек за запись