↑ Все API

API стандартизации паспортов

✔️ Проверяет формат серии и номера.

✔️ Проверяет паспорт по справочнику недействительных паспортов МВД.

Как вызвать

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

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

[ "4509 235857" ]
curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Token ${API_KEY}" \
-H "X-Secret: ${SECRET_KEY}" \
-d '[ "4509 235857" ]' \
https://cleaner.dadata.ru/api/v1/clean/passport
// https://github.com/hflabs/dadata-csharp

var token = "${API_KEY}";
var secret = "${SECRET_KEY}";
var api = new CleanClientAsync(token, secret);
var result = await api.Clean<Passport>("4509 235857");
// https://github.com/ekomobile/dadata
// Использует API-ключ из переменной окружения DADATA_API_KEY,
// а секретный ключ из переменной окружения DADATA_SECRET_KEY

import (
    "context"
    dadata "github.com/ekomobile/dadata/v2"
)

func main() {
    api := dadata.NewCleanApi()
    query := "4509 235857"
    result, err := api.Passport(context.Background(), query)
}
var url = "https://cleaner.dadata.ru/api/v1/clean/passport";
var token = "${API_KEY}";
var secret = "${SECRET_KEY}";
var query = "4509 235857";

var options = {
    method: "POST",
    mode: "cors",
    headers: {
        "Content-Type": "application/json",
        "Authorization": "Token " + token,
        "X-Secret": secret
    },
    body: JSON.stringify([query])
}

fetch(url, options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log("error", error));
// https://github.com/hflabs/dadata-php

$token = "${API_KEY}";
$secret = "${SECRET_KEY}";
$dadata = new \Dadata\DadataClient($token, $secret);
$result = $dadata->clean("passport", "4509 235857");
# https://github.com/hflabs/dadata-py

from dadata import Dadata
token = "${API_KEY}"
secret = "${SECRET_KEY}"
dadata = Dadata(token, secret)
result = dadata.clean("passport", "4509 235857")

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

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

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

Что в ответе

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

[
{
    "source": "4509 235857",
    "series": "45 09",
    "number": "235857",
    "qc": 0
}
]
НазваниеДлинаОписание
source 100 Исходная серия и номер одной строкой
series 20 Серия
number 20 Номер
qc 5 Код проверки

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

Действует паспорт или нет, по данным Федеральной миграционной службы:

Код qc Описание Нужно проверить вручную?
0 Действующий паспорт нет
2 Исходное значение пустое нет
1 Неправильный формат серии или номера да
10 Недействительный паспорт да

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

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

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

Ограничения

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

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

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

Стоимость

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

ajax-spinner

Ошибка

Укажите свой адрес электронной почты, и мы отправим на него инструкции по восстановлению пароля.