Прикрепление дополнительного документа

Прикрепление дополнительного документа на основе шаблона

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

Создание дополнительного документа

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

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @supporting-request.json \
  https://api.multitel.net/v3/create_supporting_document

{
  "identity_id": "33333333333333333333333333333333",
  "template_id": "55555555555555555555555555555555",
  "encrypted_file_ids": [
    "66666666666666666666666666666666"
  ]
}

Поля запроса
Поле	Описание
`identity_id`	Обязательный идентификатор записи идентификационных данных, связанной с вашей учётной записью. Этот запрос прикрепляет документ к записи идентификационных данных, а не непосредственно к адресу или телефонному номеру.
`template_id`	Обязательный идентификатор шаблона дополнительного документа; используйте тот же выбранный шаблон, что и при загрузке дополнительных файлов. Поле для прикрепления — template_id, а поле для загрузки — supporting_template_id.
`encrypted_file_ids`	Обязательный непустой массив JSON с идентификаторами, возвращёнными при загрузке файлов. Каждый идентификатор должен принадлежать текущей учётной записи, иметь неистёкший срок действия и относиться к категории supporting_documents.

Также принимаются данные формы с повторяющимися полями encrypted_file_ids[]. Не отправляйте байты файлов на эту конечную точку прикрепления.

Созданный дополнительный документ

{
  "status": {
    "code": 200,
    "msg": "Supporting document created successfully."
  },
  "response": {
    "id": "77777777777777777777777777777777",
    "template_id": "55555555555555555555555555555555",
    "identity_id": "33333333333333333333333333333333",
    "template_name": "Example supporting template"
  }
}

Это подтверждает создание дополнительного документа, а не одобрение регулирующим органом или активацию номера. Термин «постоянный» в ресурсе вышестоящей системы не является гарантией для клиента относительно срока хранения или правил удаления.

Ошибки и повторные попытки

Код API 500 означает отсутствие входных данных, ошибки оператора связи или некорректный ответ оператора связи. Код 404 означает, что запись идентификационных данных не связана с учётной записью, шаблон недействителен, загруженные файлы отсутствуют, имеют истёкший срок действия или неверную категорию либо набор пригодных для использования файлов пуст. Проверяйте status.msg; одного кода HTTP 200 недостаточно.

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