Nahrazení upravitelných údajů profilu
Aktualizujte existující registrační profil patřící účtu pomocí jeho místního UUID získaného z create_document nebo documents. Tato operace mění údaje účtu i údaje u nadřazeného operátora. Nemění uložený typ identity Personal/Business a nejde o PATCH aktualizující pouze některá pole.
Požadavek na aktualizaci
Ověřte se pomocí svého aktivovaného účtu MultiTEL API z povolené IP adresy. Příklady používají přihlašovací údaje v proměnných prostředí a smyšlená data. Kromě odpovědi HTTP čtěte také hodnoty status.code a status.msg v JSON.
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": ""
}Příklad znázorňuje profil typu Personal; nahraďte údaje úplnými zamýšlenými údaji koncového uživatele a jeho autorizovaným podpisem. Neodesílejte zástupné podpisy ani prázdné hodnoty ve snaze zachovat data. Podporován je vstup ve formátu JSON i ve formulářovém kódování.
| Pole | Chování |
|---|---|
| first_name, last_name, city, postal_code, address | Povinná; každé nejvýše 64 znaků. |
| phone_number | Povinná číselná hodnota o nejméně osmi znacích; použijte číslice v mezinárodním formátu včetně předvolby země. |
| signature | Povinné. Portál poskytuje bajty obrázku PNG zakódované v Base64 bez předpony datového URL. |
| country | Zadejte ISO kód země adresy z registračního katalogu. Obslužný kód podle něj vyhledá zemi, přestože přezkoumaná aktualizace adresy vazbu na zemi nemění. |
| nationality | Povinný ISO kód země pro existující profil typu Personal. |
| company_name, incorporation_country | Povinné pro existující profil typu Business; název společnosti smí mít nejvýše 64 znaků a země založení společnosti musí být uvedena jako ISO kód. |
| Nepovinná platná e-mailová adresa o nejvýše 254 znacích. Vynecháním zachováte uloženou kontaktní e-mailovou adresu; odesláním prázdné hodnoty ji místně vymažete. | |
| id_number, personal_tax_id, birth_date, description, company_reg_number, vat_id | Odešlete požadované aktuální hodnoty. Vynechané hodnoty se standardně nastaví na prázdné a mohou přepsat již uložené hodnoty. |
Registrační pravidla pro jednotlivé země mohou vyžadovat další údaje nebo formáty. Nesestavujte úplnou aktualizaci pouze na základě get_document: jeho omezená odpověď neobsahuje volby zemí, email ani identifikátory entit. Uchovávejte si zdrojová data, k jejichž použití máte oprávnění, nebo použijte editor dokumentů v portálu.
Pokročilé: přidání předem nahraných dokladů
Nepovinná pole identity_encryptfiles a address_encryptfiles přijímají aktivní odkazy patřící účtu získané z create_encrypt_files. Dodržte kategorii entity nahraného souboru a požadavek odešlete před vypršením platnosti odkazu. Každý soubor se připojuje v samostatném požadavku na doklad, i když má několik souborů stejný typ dokladu. Pro doklad totožnosti tvořený více soubory použijte následný postup připojení dokladu s jedním polem.
Pokud je pozdější doklad adresy pro nově vytvořenou adresu zamítnut, nenahrazujte jej UUID profilu ani opakovaně nevytvářejte identitu znovu. Zastavte se a zkontrolujte profil na portálu nebo s podporou. Cesta zpětného čtení/vyhledání dokladu adresy zůstává omezením revize.
Původní odpovědi při úspěchu a selhání
{
"status": {
"code": "success",
"msg": "Successfully Saved."
},
"response": ""
}Běžným kódem úspěchu tohoto koncového bodu je řetězec success, nikoli číselná hodnota 200. Běžné selhání u nadřazeného operátora nebo místní selhání může používat řetězec error. Číselný kód 400 označuje neplatná pole nebo selhání související s doklady, 404 chybějící profil nebo neplatný odkaz na nahraný soubor a 500 prázdné tělo požadavku nebo zemi, kterou se nepodařilo vyhledat. Čtěte zprávu i případné položky ověření platnosti; samotný stav HTTP 200 nepovažujte za úspěch.
Současná omezení aktualizace a náprava po selhání
Ohlášený úspěch nezaručuje, že se změnila všechna pole u nadřazeného operátora. Přezkoumaný kód může uložit místní profil i po selhání aktualizace adresy u nadřazeného operátora. Aktualizace identity u nadřazeného operátora nezahrnuje email. U tohoto postupu není doloženo provádění změn země adresy ani synchronizace popisu adresy. Pokud tyto změny potřebujete, zkontrolujte výsledek v portálu a obraťte se na podporu; nepředpokládejte, že registrace u nadřazeného operátora byla aktualizována.
Aktualizace není jedinou atomickou transakcí: změny identity a připojení dokladů mohou proběhnout před pozdějším selháním. Klíč idempotence není k dispozici. Po nejednoznačné odpovědi zkontrolujte profil a přílohy, než požadavek zopakujete; opakované odeslání dokladů může vytvořit duplicity. Aktualizace profilu neznamená schválení dokladů ani neaktivuje číslo.