Розробникам

POST/v3/create_proof

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

Пов’яжіть завантажені файли підтвердних документів із відповідною особою або адресою.

На цій сторінці
  1. Додайте документ для підтвердження особи або адреси
  2. Створіть зв’язок із підтвердним документом
  3. Збережіть ідентифікатор підтвердного документа
  4. Помилки та завантажені файли зі спливлим строком дії

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

Виконуйте цей крок після створення запису особи або адреси та завантаження необхідних для нього файлів через create_encrypt_files із вибраним типом підтвердного документа. Використовуйте актуальний ідентифікатор із get_proof_types, що відповідає вимозі та категорії об’єкта.

Збережіть identity_id і address_id, отримані від create_document; UUID профілю — це інший ідентифікатор. Можливість подальшого додавання документа для підтвердження адреси до новостворених профілів усе ще перевіряється. Якщо адресу відхилено, перш ніж повторювати спробу, перевірте інформацію на порталі або зверніться до служби підтримки.

Створіть зв’язок із підтвердним документом

Використовуйте активований обліковий запис 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 @proof-request.json \
  https://api.multitel.net/v3/create_proof
{
  "entity_type": "identities",
  "entity_id": "33333333333333333333333333333333",
  "proof_type_id": "11111111111111111111111111111111",
  "encrypted_file_ids": [
    "22222222222222222222222222222222"
  ]
}
Поля запиту
ПолеЗначення
entity_typeВикористовуйте identities або addresses. Виберіть категорію, що відповідає як об’єкту, до якого додається документ, так і завантаженим файлам.
entity_idІдентифікатор запису особи або адреси, що належить вашому обліковому запису. Використовуйте ідентифікатор, повернутий у процесі роботи з документами; не замінюйте його номером телефону чи ідентифікатором стороннього документа.
proof_type_idІдентифікатор вибраного типу підтвердного документа. Він має відповідати типу, вибраному під час завантаження, та вимозі.
encrypted_file_idsНепорожній масив JSON з ідентифікаторами файлів, повернутими create_encrypt_files. Файли мають належати тому самому обліковому запису, їхній строк дії не повинен сплинути, і вони мають відповідати категорії об’єкта. Це не список шляхів до локальних файлів.

Також приймаються дані форми з повторюваними полями encrypted_file_ids[]. Надавайте перевагу справжньому масиву JSON або масиву форми; не надсилайте масив, закодований у форматі JSON, як звичайне скалярне значення форми.

Збережіть ідентифікатор підтвердного документа

{
  "status": {
    "code": 200,
    "msg": "Proof created successfully."
  },
  "response": {
    "id": "44444444444444444444444444444444",
    "entity_type": "identities",
    "entity_id": "33333333333333333333333333333333",
    "proof_type_id": "11111111111111111111111111111111",
    "proof_type_name": "Example identity proof"
  }
}

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

Помилки та завантажені файли зі спливлим строком дії

Код API 500 використовується за відсутності обов’язкових вхідних даних, у разі збоїв оператора зв’язку та некоректної відповіді оператора. Код 404 використовується, коли об’єкт не пов’язаний із поточним обліковим записом, тип підтвердного документа некоректний, завантажений файл неможливо знайти для цього облікового запису чи категорії або строк його дії сплив, чи не залишилося придатних ідентифікаторів файлів. Читайте status.msg разом із кодом.

Перш ніж додавати обов’язковий файл зі спливлим строком дії, завантажте його повторно, вибравши правильну категорію підтвердного документа. Якщо будь-який із наданих файлів непридатний, цей обробник зупиняється до надсилання запиту на створення зв’язку з підтвердним документом. Ключ ідемпотентності не надається: після вичерпання часу очікування перевірте наявний документ на порталі, перш ніж повторювати додавання.