Clean Combined

POST

/clean

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

Стандартизует запись, которая состоит из нескольких полей. Например:

• ФИО + адрес + телефон + второй телефон
• Дата рождения + паспорт
• Адрес + email

В одном запросе можно передавать только одну составную запись.
Максимальное количество полей в одной записи:

• 3 адреса
• 3 телефона
• 3 email
• 1 ФИО
• 1 дата рождения
• 1 паспорт
• 1 автомобиль

Official documentation:

https://dadata.ru/api/clean/record/

Authorizations

ApiKey

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

Type

API Key (header: Authorization)

+

SecretKey

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

Type

API Key (header: X-Secret)

Request Body

application/json

object

Формат запроса для стандартизации составной записи с контактными данными, например:

• ФИО + адрес + телефон + телефон
• Дата рождения + паспорт
• Адрес + email

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

{
  structure: [ "NAME", "ADDRESS", "PHONE" ],
  data: [
    [
        "Федотов Алексей",
        "Москва, Сухонская улица, 11 кв 89",
        "8 916 823 3454"
    ]
  ]
}

Из чего состоит запрос в примере:

• structure — структура записи, содержит четыре поля:
  • AS_IS — оставить как есть (не стандартизировать),
  • NAME — разобрать как ФИО,
  • ADDRESS — разобрать как адрес,
  • PHONE — разобрать как телефон.
• data — составная запись из 4 полей (№, ФИО, адрес, телефон).

Типы полей:

• ADDRESS - Почтовый адрес
• PHONE - Телефон
• PASSPORT - Номер и серия паспорта
• NAME - ФИО
• EMAIL - Адрес электронной почты
• VEHICLE - Марка и модель автомобиля
• AS_IS - Скопировать поле в ответ «как есть»

Количество полей в data не должно быть больше указанного в structure.

Ограничения:

• В запросе разрешено передавать только одну запись.
• Максимальное количество полей в одной записи:
  • 1 ФИО,
  • 3 адреса,
  • 3 телефона,
  • 3 email,
  • 1 дата рождения,
  • 1 паспорт,
  • 1 автомобиль

See https://dadata.ru/api/clean/record/

string[]

Required

Поле structure определяет тип данных в поле data.

Например, если нужно стандартизировать одновременно имя, адрес и телефон,
то поле structure должно иметь вид [ "NAME", "ADDRESS", "PHONE" ],
а в массиве в поле data - исходные имя, адрес и телефон в том же порядке

Valid values"AS_IS""ADDRESS""PHONE""PASSPORT""NAME""EMAIL""VEHICLE"

Массив из одного элемента, тоже массива, элементы которого (строки) - это составные
части записи, требующие стандартизации.

Например, если нужно стандартизировать одновременно имя, адрес и телефон,
то в поле structure следует указать [ "NAME", "ADDRESS", "PHONE" ],
а поле data будет иметь вид:

[
  [
    "Федотов Алексей",
    "Москва, Сухонская улица, 11 кв 89",
    "8 916 823 3454"
  ]
]

Min Items1

Max Items1