Разработчикам

GET/v3/get_proof_types

Список категорий подтверждающих документов

Найдите идентификаторы категорий подтверждающих документов и типы субъектов перед подготовкой документов для подтверждения личности или адреса.

На этой странице
  1. Выберите категорию подтверждающих документов
  2. Учитывайте применимые требования
  3. Запрос
  4. Ответ
  5. Ошибки
  6. Доступность и побочные эффекты

Выберите категорию подтверждающих документов

Используйте полученные категорию и тип субъекта при подготовке подтверждающих документов, необходимых для идентификационной записи. Этот список описывает категории, а не загруженные вами файлы, и не означает одобрения каких-либо подтверждающих документов.

Учитывайте применимые требования

Наличие категории в списке не означает, что она соответствует требованиям для любой страны, любого типа номера или любой идентификационной записи клиента. Прочитайте применимые требования перед загрузкой подтверждающих документов и рассматривайте полученные идентификаторы как непрозрачные значения.

Запрос

Используйте учётные данные своей активированной учётной записи API при подключении по HTTPS. Поддерживаются базовая аутентификация и разрешённые для учётной записи API токены предъявителя; действуют ограничения учётной записи.

GET с любым документированным параметром в пути URL.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_proof_types"

Ответ

Проверяйте status.code в теле JSON, а также статус HTTP. response — массив объектов с полями id, name и entity_type. Эти значения взяты из текущего каталога подтверждающих документов. Идентификаторы непрозрачны; копируйте их, а не создавайте самостоятельно и не вычисляйте хеш для получения идентификатора. Пустой каталог также может быть возвращён в успешном ответе. Не задавайте в коде полный перечень типов субъектов на основе этого примера.

Пример структуры ответа; это не актуальные данные учётной записи и не действующее ценовое предложение.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "PROOF_TYPE_ID_FROM_RESPONSE",
      "name": "Example proof category",
      "entity_type": "ENTITY_TYPE_FROM_RESPONSE"
    }
  ]
}

Ошибки

  • Проверяйте status.code и status.msg на наличие ошибок аутентификации или сервиса. Успешный ответ с пустым каталогом не означает одобрения документа или освобождения от регистрации.

Доступность и побочные эффекты

  • Этот запрос каталога или требований не создаёт идентификационную запись, не загружает подтверждающий документ, не регистрирует номер и не размещает заказ.
  • Успешный ответ с каталогом не означает одобрения ваших документов и не подтверждает возможность активации выбранного номера.