Разработчици

POST/v3/update_document/{uuid}

Актуализиране на регистрационен профил

Изпратете всички редактируеми данни на профила и обработете стария формат за успешен отговор.

На тази страница
  1. Заменете редактируемите данни на профил
  2. Заявка за актуализиране
  3. Разширени настройки: добавяне на предварително качени доказателства
  4. Стар формат на отговорите за успех и неуспех
  5. Текущи ограничения на актуализирането и възстановяване

Заменете редактируемите данни на профил

Актуализирайте съществуващ регистрационен профил, принадлежащ на акаунта, чрез неговия локален UUID от create_document или documents. Тази операция променя данните в акаунта и при оператора доставчик. Тя не променя съхранения тип идентичност Personal/Business и не представлява PATCH за промяна само на отделни полета.

Заявка за актуализиране

Удостоверете се с активирания си акаунт за MultiTEL API от разрешен IP адрес. Примерите използват идентификационни данни в променливи на средата и измислени данни. Прочетете status.code и status.msg в JSON, както и 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 код.
emailНезадължителен валиден имейл адрес с до 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. При този начин на обработка не са потвърдени промените на държавата на адреса и синхронизирането на описанието на адреса. Ако са ви необходими тези промени, проверете резултата в портала и се свържете с поддръжката, вместо да приемате, че регистрацията при оператора доставчик е актуализирана.

Актуализирането не е една атомарна транзакция: промените на идентичността и прикачването на доказателства може да бъдат извършени преди последващ неуспех. Не е предоставен ключ за идемпотентност. След отговор с неясен резултат проверете профила и прикачените файлове, преди да опитате отново; повторното изпращане на доказателства може да създаде дубликати. Актуализирането на профил не означава одобрение на доказателствата и не активира номер.