Asendage profiili muudetavad andmed
Uuendage olemasolevat kontole kuuluvat registreerimisprofiili, kasutades selle kohalikku UUID-d, mille saate päringust create_document või documents. See toiming muudab konto andmeid ja operaatori süsteemi andmeid. See ei muuda salvestatud identiteeditüüpi Personal/Business ega ole üksikute väljade osaline PATCH-uuendus.
Uuendamispäring
Autentige oma aktiveeritud MultiTEL API kontoga lubatud IP-aadressilt. Näidetes kasutatakse keskkonnamuutujates olevaid autentimisandmeid ja väljamõeldud andmeid. Lisaks HTTP-vastusele lugege ka JSON-välju status.code ja 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": ""
}Näites on Personal-profiil; asendage selle andmed lõppkasutaja kõigi soovitud andmete ja nõuetekohaselt volitatud allkirjaga. Ärge esitage andmete säilitamiseks allkirja kohatäitjaid ega tühje väärtusi. Toetatud on JSON-vormingus ja vormikodeeringus sisend.
| Väljad | Käitumine |
|---|---|
| first_name, last_name, city, postal_code, address | Kohustuslikud; igaüks kuni 64 märki. |
| phone_number | Kohustuslik vähemalt kaheksa märgi pikkune arvväärtus; kasutage rahvusvahelises vormingus numbreid koos riigikoodiga. |
| signature | Kohustuslik. Portaal annab Base64-kodeeritud PNG-baidid ilma andme-URL-i eesliiteta. |
| country | Esitage registreerimiskataloogist aadressi riigi ISO-kood. Töötleja määrab selle põhjal riigi, kuigi ülevaadatud aadressiuuendus ei muuda seost riigiga. |
| nationality | Olemasoleva Personal-profiili puhul kohustuslik riigi ISO-kood. |
| company_name, incorporation_country | Olemasoleva Business-profiili puhul kohustuslikud; ettevõtte nimi võib olla kuni 64 märki pikk ja asutamisriik tuleb esitada ISO-koodina. |
| Valikuline kehtiv e-posti aadress pikkusega kuni 254 märki. Salvestatud kontaktmeili säilitamiseks jätke väli välja; selle kohalikuks tühjendamiseks saatke tühi väärtus. | |
| id_number, personal_tax_id, birth_date, description, company_reg_number, vat_id | Saatke soovitud praegused väärtused. Väljajäetud väärtused on vaikimisi tühjad ja võivad olemasolevad salvestatud väärtused üle kirjutada. |
Riigipõhised registreerimisreeglid võivad nõuda lisateavet või kindlaid vorminguid. Ärge koostage täielikku uuendust üksnes päringu get_document põhjal: selle piiratud vastus ei sisalda riigi valikuvälju, välja email ega olemite ID-sid. Säilitage lähteandmed, mille kasutamiseks teil on õigus, või kasutage portaali dokumendiredaktorit.
Täpsemad võimalused: lisage varem üles laaditud tõendusdokumendid
Valikulised massiivid identity_encryptfiles ja address_encryptfiles võtavad vastu aktiivseid kontole kuuluvaid viiteid, mille saate päringust create_encrypt_files. Tagage vastavus üleslaadimise olemi kategooriale ja esitage andmed enne viite aegumist. Iga fail lisatakse eraldi tõenduspäringuga, isegi kui mitmel failil on sama tõendi tüüp. Mitmest failist koosneva isikutõendi korral kasutage hilisemat tõendi lisamise töövoogu ühe massiiviga.
Kui hilisem aadressitõend lükatakse äsja loodud aadressi puhul tagasi, ärge asendage seda profiili UUID-ga ega looge identiteeti korduvalt uuesti. Peatuge ja kontrollige profiili portaalis või koos toega. Aadressitõendi tagasilugemise/otsingu tee jääb ülevaatuse piiranguks.
Pärandvormingus õnnestumis- ja tõrkevastused
{
"status": {
"code": "success",
"msg": "Successfully Saved."
},
"response": ""
}Selle lõpp-punkti tavapärane õnnestumiskood on string success, mitte arvuline kood 200. Tavapärase operaatori süsteemi või kohaliku tõrke korral võidakse kasutada stringi error. Arvuline kood 400 tähistab vigaseid välju või tõenditega seotud tõrkeid, 404 puuduvat profiili või kehtetut viidet üleslaaditud failile ning 500 tühja päringukeha või tuvastamata riiki. Lugege sõnumit ja kõiki valideerimiskirjeid; ärge pidage üksnes HTTP 200 vastust õnnestumiseks.
Praegused uuendamispiirangud ja taastamine
Teatatud õnnestumine ei taga, et operaatori süsteemis muutusid kõik väljad. Ülevaadatud kood võib salvestada kohaliku profiili pärast seda, kui aadressi uuendamine operaatori süsteemis ebaõnnestub. Operaatori süsteemi identiteediuuendus ei sisalda välja email. Selle töötlustee puhul ei ole aadressi riigi muutmine ega aadressi kirjelduse sünkroonimine kinnitatud. Kui vajate neid muudatusi, kontrollige tulemust portaalis ja võtke ühendust kasutajatoega, selle asemel et eeldada registreeringu uuendamist operaatori süsteemis.
Uuendamine ei ole üks atomaarne tehing: identiteedi muutmine ja tõendite lisamine võivad toimuda enne hilisemat tõrget. Idempotentsusvõtit ei ole saadaval. Pärast ebaselget vastust kontrollige enne uuesti proovimist profiili ja manuseid; tõendite korduv esitamine võib tekitada duplikaate. Profiili uuendamine ei tähenda tõendite heakskiitmist ega aktiveeri numbrit.