Pakeiskite redaguojamus profilio duomenis
Atnaujinkite esamą paskyrai priklausantį registracijos profilį naudodami jo vietinį UUID, gautą iš create_document arba documents. Ši operacija pakeičia paskyros ir išorinio ryšio operatoriaus duomenis. Ji nekeičia išsaugoto tapatybės tipo Personal/Business ir nėra dalinis laukų atnaujinimas naudojant PATCH.
Atnaujinimo užklausa
Autentifikuokitės naudodami aktyvią MultiTEL API paskyrą iš leidžiamo IP adreso. Pavyzdžiuose naudojami aplinkos kintamuosiuose saugomi prisijungimo duomenys ir išgalvoti duomenys. Skaitykite JSON laukus status.code ir status.msg, taip pat HTTP atsakymą.
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": ""
}Pavyzdyje pateiktas Personal tipo profilis; pakeiskite jo duomenis visais numatytais galutinio naudotojo duomenimis ir teisėtai suteiktu parašu. Nesiųskite pavyzdinių parašų ar tuščių reikšmių siekdami išsaugoti esamus duomenis. Palaikomi JSON ir formos koduote pateikti įvesties duomenys.
| Laukai | Veikimas |
|---|---|
| first_name, last_name, city, postal_code, address | Privalomi; kiekviename gali būti ne daugiau kaip 64 simboliai. |
| phone_number | Privaloma skaitinė reikšmė, kurią sudaro bent aštuoni simboliai; naudokite tarptautinio formato skaitmenis, įskaitant šalies kodą. |
| signature | Privalomas. Portalas pateikia Base64 koduotės PNG baitus be duomenų URL priešdėlio. |
| country | Pateikite adreso šalies ISO kodą iš registracijos katalogo. Apdorojimo programa pagal jį nustato šalį, nors peržiūrėtas adreso atnaujinimas nekeičia sąsajos su šalimi. |
| nationality | Esamam Personal tipo profiliui privalomas šalies ISO kodas. |
| company_name, incorporation_country | Privalomi esamam Business tipo profiliui; įmonės pavadinimą gali sudaryti ne daugiau kaip 64 simboliai, o įsteigimo šalis turi būti nurodyta ISO kodu. |
| Neprivalomas galiojantis el. pašto adresas, kurį sudaro ne daugiau kaip 254 simboliai. Praleiskite šį lauką, kad išsaugotumėte įrašytą kontaktinį el. pašto adresą; siųskite tuščią reikšmę, kad jį pašalintumėte vietinėje sistemoje. | |
| id_number, personal_tax_id, birth_date, description, company_reg_number, vat_id | Siųskite numatytas dabartines reikšmes. Praleistoms reikšmėms pagal numatytąją nuostatą priskiriamos tuščios reikšmės, kurios gali perrašyti esamas išsaugotas reikšmes. |
Konkrečios šalies registracijos taisyklėse gali būti reikalaujama papildomos informacijos ar tam tikrų formatų. Nerengkite viso atnaujinimo remdamiesi get_document vien atsakymu: jo ribotame atsakyme nėra šalies parinkčių, email ir subjektų identifikatorių. Išsaugokite pirminius duomenis, kuriuos turite teisę naudoti, arba naudokitės portalo dokumentų rengykle.
Išplėstinės parinktys: pridėkite iš anksto įkeltus patvirtinamuosius dokumentus
Neprivalomuose masyvuose identity_encryptfiles ir address_encryptfiles priimamos aktyvios, paskyrai priklausančios nuorodos iš create_encrypt_files. Pasirinkite įkelto failo subjekto kategoriją atitinkančią kategoriją ir pateikite, kol nuorodos galiojimas nepasibaigė. Kiekvienas failas pridedamas atskira patvirtinamojo dokumento užklausa, net jei keli failai yra to paties patvirtinamojo dokumento tipo. Jei tapatybės patvirtinamąjį dokumentą sudaro keli failai, vėliau naudokite patvirtinamųjų dokumentų pridėjimo procesą su vienu masyvu.
Jei vėlesnis naujai sukurto adreso įrodymas atmetamas, nekeiskite jo profilio UUID ir nekurkite tapatybės pakartotinai. Sustokite ir patikrinkite profilį portale arba su palaikymo tarnyba. Adreso įrodymų nuskaitymo / paieškos kelias tebėra peržiūros apribojimas.
Senojo formato sėkmės ir nesėkmės atsakymai
{
"status": {
"code": "success",
"msg": "Successfully Saved."
},
"response": ""
}Įprastas šio galinio taško sėkmės kodas yra eilutė success, o ne skaičius 200. Įprastos išorinės ar vietinės sistemos nesėkmės atveju gali būti naudojama eilutė error. Skaitinis kodas 400 reiškia netinkamus laukus arba patvirtinamųjų dokumentų klaidas, 404 – nerastą profilį arba netinkamą nuorodą į įkeltą failą, o 500 – tuščią užklausos turinį arba nenustatytą šalį. Perskaitykite pranešimą ir visus tikrinimo įrašus; vien HTTP 200 nelaikykite sėkme.
Dabartiniai atnaujinimo apribojimai ir atkūrimas
Pranešimas apie sėkmę negarantuoja, kad pasikeitė visi išorinės sistemos laukai. Peržiūrėtas kodas gali išsaugoti vietinį profilį po to, kai nepavyksta atnaujinti adreso išorinėje sistemoje. Atnaujinant tapatybę išorinėje sistemoje, email neįtraukiamas. Šis vykdymo kelias nepatvirtina adreso šalies pakeitimų ir adreso aprašymo sinchronizavimo. Jei jums reikia šių pakeitimų, patikrinkite rezultatą portale ir kreipkitės į pagalbos tarnybą, užuot manę, kad registracija išorinėje sistemoje buvo atnaujinta.
Atnaujinimas nėra viena atominė operacija: tapatybės pakeitimai ir patvirtinamųjų dokumentų pridėjimas gali įvykti prieš vėlesnę nesėkmę. Idempotentiškumo raktas nepateikiamas. Gavę neaiškų atsakymą, prieš bandydami dar kartą patikrinkite profilį ir priedus; pakartotinai pateikus patvirtinamuosius dokumentus gali atsirasti dublikatų. Profilio atnaujinimas nereiškia, kad patvirtinamieji dokumentai patvirtinti, ir neaktyvina numerio.