Додати супровідний документ

Додати супровідний документ на основі шаблону

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

Створити супровідний документ

Використовуйте активний обліковий запис MultiTEL API і дозволену для нього 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 недостатньо.

Завантажте та додайте файли протягом строку дії повернених посилань на файли. Якщо відповідь неоднозначна, перед повторною спробою перевірте супровідні документи запису особи на порталі. Цей обробник не надає ключа ідемпотентності.