## Документация API api-assist.com Реестр уведомлений о залоге движимого имущества

### Основные запросы

Основные запросы к сервису позволяют выполнять поиск по различным типам данных в Реестре уведомлений о залоге движимого имущества. Все запросы требуют указания ключа доступа (`key`).

#### 1. Поиск по VIN

```
https://service.api-assist.com/parser/reestr_api/search_by_vin?key=ВАШ_КЛЮЧ_ДОСТУПА&vin=SALLMAMH4CA388911
```

**Параметры:**
- **vin** - идентификационный номер транспортного средства (VIN) (обязательный)

**Результат:**

```json
{
  "success": 1, // 1 - успешный ответ, 0 - ошибка
  "records": [
    {
      "register_date": "2015-02-07", // дата регистрации
      "number": "2015-000-426318-974", // номер уведомления о возникновении залога
      "pledgor_hidden": 0, // флаг 0/1, указывающий на наличие скрытых из выдачи залогодателей
      "pledgee_hidden": 1, // флаг 0/1, указывающий на наличие скрытых из выдачи залогодержателей
      "objects": [ // имущество
        "VIN TMBLB25L9C6086447",
        "VIN SALLMAMH4CA388911"
      ],
      "pledgors": [ // залогодатели
        {
          "type": "org", // тип: "org" (организация) или "person" (физическое лицо)
          "name": "ООО \"КМЗ\"" // наименование
        }
      ],
      "pledgees": [ // залогодержатели
        {
          "type": "org", // тип: "org" (организация) или "person" (физическое лицо)
          "name": "Открытое акционерное общество «Сбербанк России»" // наименование
        }
      ],
      "history": [ // история изменений
        {
          "date": "01.06.2018 16:47", // дата
          "type": "Возникновение", // тип: Возникновение, Изменение, Исключение, Исключение по решению суда
          "number": "2018-002-340302-436" // номер записи
        },
        {
          "date": "02.07.2018 20:45",
          "type": "Изменение",
          "number": "2018-002-340302-436/1"
        }
      ]
    }
  ]
}
```

#### 2. Поиск по номеру кузова

```
https://service.api-assist.com/parser/reestr_api/search_by_body?key=ВАШ_КЛЮЧ_ДОСТУПА&bodyNumber=RF11473076
```

**Параметры:**
- **bodyNumber** - номер кузова транспортного средства (обязательный)

**Результат:** Аналогичен результату поиска по VIN

#### 3. Поиск по номеру шасси

```
https://service.api-assist.com/parser/reestr_api/search_by_chassis?key=ВАШ_КЛЮЧ_ДОСТУПА&chassis=FRR12LA3603981
```

**Параметры:**
- **chassis** - номер шасси транспортного средства (обязательный)

**Результат:** Аналогичен результату поиска по VIN

#### 4. Поиск по PIN

```
https://service.api-assist.com/parser/reestr_api/search_by_pin?key=ВАШ_КЛЮЧ_ДОСТУПА&pin=5TDDKRFH30S123456
```

**Параметры:**
- **pin** - идентификационный номер транспортного средства (PIN) (обязательный)

**Результат:** Аналогичен результату поиска по VIN


#### 5. Поиск по ФИО физического лица (залогодателя)

```
https://service.api-assist.com/parser/reestr_api/search_by_fiz_name?key=ВАШ_КЛЮЧ_ДОСТУПА&lastName=Иванов&firstName=Иван&patronymic=Иванович&dob=21.08.1989
```

**Параметры:**
- **lastName** - фамилия (обязательный)
- **firstName** - имя (обязательный)
- **patronymic** - отчество (необязательный)
- **dob** - дата рождения в формате DD.MM.YYYY (необязательный)

**Результат:**

```json
{
  "success": 1, // 1 - успешный ответ, 0 - ошибка
  "records": [
    {
      "register_date": "2015-02-07", // дата регистрации
      "number": "2015-000-426318-974", // номер уведомления о возникновении залога
      "pledgor_hidden": 0, // флаг 0/1, указывающий на наличие скрытых из выдачи залогодателей
      "pledgee_hidden": 0, // флаг 0/1, указывающий на наличие скрытых из выдачи залогодержателей
      "objects": [ // имущество
        "VIN TMBLB25L9C6086447"
      ],
      "pledgors": [ // залогодатели
        {
          "type": "person", // тип: "org" (организация) или "person" (физическое лицо)
          "name": "Иванов Иван Иванович", // ФИО
          "birth": "21.08.1989" // дата рождения (если доступна)
        }
      ],
      "pledgees": [ // залогодержатели
        {
          "type": "org", // тип
          "name": "ПАО \"Сбербанк\"" // наименование
        }
      ],
      "history": [ // история изменений
        {
          "date": "01.06.2018 16:47", // дата
          "type": "Возникновение", // тип
          "number": "2018-002-340302-436" // номер записи
        }
      ]
    }
  ]
}
```

#### 6. Поиск по наименованию организации (залогодателя)

```
https://service.api-assist.com/parser/reestr_api/search_by_org_name?key=ВАШ_КЛЮЧ_ДОСТУПА&orgName=Сбербанк
```

**Параметры:**
- **orgName** - наименование организации (обязательный)

**Результат:** Аналогичен результату поиска по физическому лицу

#### 7. Поиск по ИНН организации (залогодателя)

```
https://service.api-assist.com/parser/reestr_api/search_by_org_inn?key=ВАШ_КЛЮЧ_ДОСТУПА&orgInn=7707083893
```

**Параметры:**
- **orgInn** - ИНН организации (обязательный)

**Результат:** Аналогичен результату поиска по физическому лицу

#### 8. Поиск по ОГРН организации (залогодателя)

```
https://service.api-assist.com/parser/reestr_api/search_by_org_ogrn?key=ВАШ_КЛЮЧ_ДОСТУПА&orgOgrn=1027700132195
```

**Параметры:**
- **orgOgrn** - ОГРН организации (обязательный)

**Результат:** Аналогичен результату поиска по физическому лицу

---

### Интерпретация ответа и обработка ошибок

**Общие рекомендации:**
- Если поле `success` заполнено и `success = 1` — перед вами успешный ответ, с которым можно работать. Только такие запросы учитываются в статистике и расходуют оплаченный лимит.
- Иначе, если поле `error` заполнено — запрос требует вашего внимания. Текст ошибки рекомендуется сохранить или отправить для дальнейшего анализа.
- Иначе, если поле `error` не заполнено — это ошибка, связанная со стабильностью источника. В таком случае мы рекомендуем игнорировать ответ и повторить запрос.

В данном разделе описаны возможные коды ответов сервиса и их значения. Каждый код ответа сопровождается пояснением и примером JSON-ответа.

#### 1. Код ответа - 200

- Поле `success = 1` - удалось получить информацию от источника. Такие и только такие запросы можно запускать в дальнейшую обработку. Пример ответа см. в разделе **Результат основного запроса**.
- Поле `success = 0` - не удалось получить информацию от источника. Запрос не будет учтен в статистике. Необходимо повторить запрос.

#### 2. Код ответа - 403

Выдается сервисом в случае невозможности обработки запроса из-за ограничения доступа: закончилась подписка, превышен лимит и так далее. Причины ошибок отражены в поле `error` ответа. Ниже приведен список возможных ошибок с их описанием и кодами:

- **Invalid access key**
  `error_code = 40301`
  Указанный ключ доступа недействителен или отсутствует.

- **The subscription period has expired**
  `error_code = 40302`
  Доступ к сервису истек, требуется продление.

- **Invalid IP**
  `error_code = 40303`
  Запрос выполнен с IP-адреса, который не разрешён для доступа.

- **Day limit of requests exceeded**
  `error_code = 40304`
  Достигнут оплаченный лимит запросов на день.

- **Month limit of requests exceeded**
  `error_code = 40305`
  Достигнут оплаченный лимит запросов на месяц.

**Пример ответа:**
```json
{
  "error": "Invalid access key",
  "error_code": 40301
}
```

#### 3. Код ответа - 400

Выдается сервисом в случае невозможности обработки запроса из-за ошибки валидации запроса, неверного или отсутствующего значения какого-либо поля. Поле `error_code` всегда равно `40001`, подробности доступны в поле `error`.

**Пример ответа:**
```json
{
  "error": "Empty id",
  "error_code": 40001
}
```