Замена редактируемых данных профиля
Обновите существующий регистрационный профиль, принадлежащий вашей учётной записи, используя его локальный UUID из create_document или documents. Эта операция изменяет данные учётной записи и данные у вышестоящего оператора связи. Она не меняет сохранённый тип субъекта Personal/Business и не является запросом PATCH для частичного обновления полей.
Запрос на обновление
Пройдите аутентификацию с разрешённого IP-адреса, используя свою активированную учётную запись MultiTEL API. В примерах используются учётные данные из переменных окружения и вымышленные данные. Помимо ответа HTTP проверяйте поля JSON status.code и status.msg.
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. Для этого способа обновления не подтверждены изменение страны адреса и синхронизация описания адреса. Если вам нужны эти изменения, проверьте результат на портале и обратитесь в службу поддержки, не полагаясь на то, что регистрационные данные у оператора обновлены.
Обновление не является единой атомарной транзакцией: данные субъекта могут измениться, а подтверждающие документы — прикрепиться до возникновения последующей ошибки. Ключ идемпотентности не предоставляется. Если ответ не позволяет однозначно определить результат, проверьте профиль и вложения перед повторной попыткой; повторная отправка подтверждающих документов может создать дубликаты. Обновление профиля не означает одобрения подтверждающих документов и не активирует номер.