Замініть редаговані дані профілю
Оновіть наявний реєстраційний профіль, що належить обліковому запису, за його локальним UUID із create_document або documents. Ця операція змінює дані облікового запису та зовнішнього оператора зв’язку. Вона не змінює збережений тип суб’єкта Personal/Business і не є частковим оновленням полів через PATCH.
Запит на оновлення
Пройдіть автентифікацію за допомогою активованого облікового запису MultiTEL API з дозволеної IP-адреси. У прикладах використано облікові дані зі змінних середовища та вигадані дані. Читайте поля JSON status.code і status.msg, а також відповідь HTTP.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--header 'Content-Type: application/json' \
--data @registration-profile-update.json \
"https://api.multitel.net/v3/update_document/$DOCUMENT_UUID"{
"first_name": "Example",
"last_name": "Person",
"phone_number": "12025550123",
"email": "end-user@example.com",
"city": "Example City",
"postal_code": "00000",
"address": "1 Example Street",
"country": "US",
"nationality": "US",
"signature": "BASE64_PNG_OF_THE_AUTHORIZED_END_USER_SIGNATURE",
"id_number": "",
"personal_tax_id": "",
"birth_date": "",
"description": "Example profile",
"company_name": "",
"company_reg_number": "",
"incorporation_country": "",
"vat_id": "",
"address_description": ""
}У прикладі наведено профіль типу Personal; замініть його дані повними запланованими даними кінцевого користувача та підписом, на використання якого надано дозвіл. Не надсилайте підписи-заповнювачі або порожні значення, щоб зберегти наявні дані. Підтримуються вхідні дані у форматі JSON і в кодуванні форми.
| Поля | Поведінка |
|---|---|
| first_name, last_name, city, postal_code, address | Обов’язкові; кожне містить щонайбільше 64 символи. |
| phone_number | Обов’язкове числове значення завдовжки щонайменше вісім символів; використовуйте цифри в міжнародному форматі, включно з кодом країни. |
| signature | Обов’язковий. Портал надає байти PNG у кодуванні Base64 без префікса URL даних. |
| country | Надайте ISO-код країни адреси з реєстраційного каталогу. Обробник визначає країну за цим кодом, хоча переглянуте оновлення адреси не змінює зв’язок із країною. |
| nationality | Обов’язковий ISO-код країни для наявного профілю типу Personal. |
| company_name, incorporation_country | Обов’язкові для наявного профілю типу Business; назва компанії має містити щонайбільше 64 символи, а країну реєстрації слід указати ISO-кодом. |
| Необов’язкова коректна адреса електронної пошти завдовжки до 254 символів. Не передавайте це поле, щоб зберегти записану контактну адресу електронної пошти; надішліть порожнє значення, щоб очистити її локально. | |
| id_number, personal_tax_id, birth_date, description, company_reg_number, vat_id | Надсилайте заплановані поточні значення. Пропущені значення за замовчуванням стають порожніми й можуть перезаписати наявні збережені значення. |
Правила реєстрації для конкретної країни можуть вимагати додаткових відомостей або певних форматів. Не відтворюйте повне оновлення на основі get_document як єдиного джерела: його обмежена відповідь не містить полів вибору країни, email та ідентифікаторів суб’єктів. Зберігайте вихідні дані, які ви маєте право використовувати, або користуйтеся редактором документів на порталі.
Розширені можливості: додавання попередньо завантажених підтвердних документів
Необов’язкові масиви identity_encryptfiles і address_encryptfiles приймають активні посилання, що належать обліковому запису, з create_encrypt_files. Забезпечте відповідність категорії суб’єкта завантаженого файлу та надішліть дані до завершення строку дії посилання. Кожен файл долучається окремим запитом на підтвердний документ, навіть якщо кілька файлів мають однаковий тип підтвердження. Для підтвердження особи кількома файлами згодом використовуйте процес долучення підтвердних документів з одним масивом.
Якщо пізніше підтвердження адреси для новоствореної адреси відхилено, не підставляйте UUID профілю і не створюйте ідентичність повторно. Зупиніться і перевірте профіль у порталі або зі службою підтримки. Шлях зчитування та пошуку підтверджень адреси залишається обмеженням перегляду.
Застарілі відповіді про успіх і помилку
{
"status": {
"code": "success",
"msg": "Successfully Saved."
},
"response": ""
}Звичайний код успіху цієї кінцевої точки — рядок success, а не число 200. Для звичайної помилки зовнішньої або локальної системи може використовуватися рядок error. Числовий код 400 означає некоректні поля або помилки підтвердних документів, 404 — відсутній профіль або некоректне посилання на завантажений файл, а 500 — порожнє тіло запиту або невизначену країну. Читайте повідомлення та всі записи перевірки; не вважайте сам лише HTTP 200 ознакою успіху.
Поточні обмеження оновлення та відновлення
Повідомлення про успіх не гарантує, що всі поля в зовнішній системі змінилися. Переглянутий код може зберегти локальний профіль після невдалого оновлення адреси в зовнішній системі. Оновлення даних суб’єкта в зовнішній системі не включає email. Цей шлях виконання не підтверджує зміни країни адреси та синхронізацію опису адреси. Якщо вам потрібні ці зміни, перевірте результат на порталі й зверніться до служби підтримки, замість того щоб вважати реєстрацію в зовнішній системі оновленою.
Оновлення не є однією атомарною транзакцією: зміни даних суб’єкта та долучення підтвердних документів можуть відбутися до подальшої помилки. Ключ ідемпотентності не надається. Після неоднозначної відповіді перевірте профіль і вкладення перед повторною спробою; повторне надсилання підтвердних документів може створити дублікати. Оновлення профілю не означає схвалення підтвердних документів і не активує номер.