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

GET/v3/documents

Получение списка регистрационных профилей

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

На этой странице
  1. Поиск существующих регистрационных профилей
  2. Запрос списка
  3. Список в ответе
  4. Возвращаемые поля профиля
  5. Дальнейшие действия

Поиск существующих регистрационных профилей

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

Запрос списка

Пройдите аутентификацию с помощью активированной учётной записи MultiTEL API с разрешённого для неё IP-адреса. В примерах используются учётные данные HTTP Basic, хранящиеся в переменных окружения. Проверяйте как HTTP-ответ, так и поле JSON status.code; сам по себе HTTP-ответ 200 не подтверждает успешное выполнение. Все значения в примерах вымышлены.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  https://api.multitel.net/v3/documents

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

Список в ответе

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": [
    {
      "id": "11111111111111111111111111111111",
      "first_name": "Example",
      "last_name": "Person",
      "phone_number": "12025550123",
      "id_number": "",
      "birth_date": null,
      "company_name": "",
      "company_reg_number": "",
      "vat_id": "",
      "personal_tax_id": "",
      "description": "Example profile",
      "identity_type": "Personal",
      "postal_code": "00000",
      "city": "Example City",
      "address": "1 Example Street",
      "signature": "BASE64_PNG_SIGNATURE_DATA",
      "date_created": "2026-10-23 16:00:00"
    }
  ]
}

Если подходящих активных профилей нет, обработчик возвращает код API 200 и пустой список в ответе. response[].id — это UUID локального профиля, возвращаемый в поле uuid при создании; это не идентификатор удостоверения личности и не идентификатор адреса.

Возвращаемые поля профиля

В набор возвращаемых полей входят id, first_name, last_name, phone_number, id_number, birth_date, company_name, company_reg_number, vat_id, personal_tax_id, description, identity_type, postal_code, city, address, signature и date_created.

Необязательные значения могут быть пустыми или иметь значение null в зависимости от сохранённых данных. Этот набор полей прежнего формата не включает email, поля выбора страны, identity_id, address_id, ссылки на загруженные файлы, списки подтверждающих документов и статус проверки. Этот эндпоинт не предназначен для получения статуса подтверждающих документов или одобрения регистрации. Обращайтесь с возвращаемыми идентификационными и контактными данными, а также данными подписи как с конфиденциальной информацией.

Дальнейшие действия

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