Прикачете придружаващ документ

Прикачете придружаващ документ, базиран на шаблон

Използвайте шаблон от 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 не е достатъчно.

Качете и прикачете файловете в рамките на срока на валидност на върнатата препратка към файл. След нееднозначен отговор проверете придружаващите документи на самоличността в портала, преди да опитате отново. Тази обработваща функция не предоставя ключ за идемпотентност.