Izstrādātājiem

POST/v3/update_document/{uuid}

Reģistrācijas profila atjaunināšana

Iesniedziet visus rediģējamos profila datus un apstrādājiet mantoto veiksmīga rezultāta formātu.

Šajā lapā
  1. Aizstājiet profila rediģējamos datus
  2. Atjaunināšanas pieprasījums
  3. Papildu iespējas: pievienojiet iepriekš augšupielādētus apliecinājuma dokumentus
  4. Mantotās atbildes par veiksmīgu izpildi un kļūmēm
  5. Pašreizējie atjaunināšanas ierobežojumi un atkopšana

Aizstājiet profila rediģējamos datus

Atjauniniet esošu, kontam piederošu reģistrācijas profilu, izmantojot tā lokālo UUID, kas iegūts no create_document vai documents. Šī darbība maina konta datus un datus operatora sistēmā. Tā nemaina saglabāto identitātes tipu Personal/Business un nav atsevišķu lauku daļējs PATCH atjauninājums.

Atjaunināšanas pieprasījums

Autentificējieties ar savu iespējoto MultiTEL API kontu no atļautas IP adreses. Piemēros izmantoti vides mainīgajos glabāti piekļuves dati un izdomāti dati. Papildus HTTP atbildei pārbaudiet arī JSON laukus status.code un 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": ""
}

Piemērā parādīts Personal profils; aizstājiet tā datus ar visiem paredzētajiem galalietotāja datiem un pienācīgi pilnvarotu parakstu. Neiesniedziet parakstu aizstājējus vai tukšas vērtības, lai saglabātu datus. Tiek atbalstīta ievade JSON un formas kodējuma formātā.

Prasības atjaunināšanas laukiem
LaukiDarbība
first_name, last_name, city, postal_code, addressObligāti; katrā ne vairāk kā 64 rakstzīmes.
phone_numberObligāta skaitliska vērtība ar vismaz astoņām rakstzīmēm; norādiet ciparus starptautiskajā formātā, iekļaujot valsts kodu.
signatureObligāts. Portāls nodrošina Base64 kodētus PNG baitus bez datu URL prefiksa.
countryNorādiet adreses valsts ISO kodu no reģistrācijas kataloga. Apstrādātājs pēc tā nosaka valsti, lai gan pārskatītā adreses atjaunināšana nemaina saistību ar valsti.
nationalityEsošam Personal profilam obligāti jānorāda valsts ISO kods.
company_name, incorporation_countryObligāti esošam Business profilam; uzņēmuma nosaukums nedrīkst pārsniegt 64 rakstzīmes, un dibināšanas valsts jānorāda kā ISO kods.
emailNeobligāta derīga e-pasta adrese ar ne vairāk kā 254 rakstzīmēm. Izlaidiet šo lauku, lai saglabātu glabāto saziņas e-pasta adresi; nosūtiet tukšu vērtību, lai to lokāli notīrītu.
id_number, personal_tax_id, birth_date, description, company_reg_number, vat_idNosūtiet paredzētās pašreizējās vērtības. Izlaistās vērtības pēc noklusējuma ir tukšas un var pārrakstīt jau saglabātās vērtības.

Konkrētās valsts reģistrācijas noteikumi var prasīt papildu informāciju vai noteiktus formātus. Neveidojiet pilnīgu atjauninājumu, pamatojoties tikai uz get_document atbildi: tās ierobežotajā saturā nav valstu atlases lauku, email un entītiju ID. Saglabājiet sākotnējos datus, kurus esat tiesīgs izmantot, vai izmantojiet portāla dokumentu redaktoru.

Papildu iespējas: pievienojiet iepriekš augšupielādētus apliecinājuma dokumentus

Neobligātie masīvi identity_encryptfiles un address_encryptfiles pieņem aktīvas, kontam piederošas atsauces, kas iegūtas no create_encrypt_files. Nodrošiniet atbilstību augšupielādes entītijas kategorijai un iesniedziet pirms atsauces derīguma termiņa beigām. Katrs fails tiek pievienots atsevišķā apliecinājuma pieprasījumā, pat ja vairākiem failiem ir viens apliecinājuma tips. Ja identitātes apliecinājums sastāv no vairākiem failiem, vēlāk izmantojiet apliecinājuma pievienošanas darbplūsmu ar vienu masīvu.

Ja vēlāks adreses pierādījums jaunizveidotai adresei tiek noraidīts, neaizstājiet to ar profila UUID un atkārtoti neveidojiet identitāti. Apstājieties un pārbaudiet profilu portālā vai ar atbalsta dienestu. Adreses pierādījuma nolasīšanas/meklēšanas ceļš joprojām ir pārskatīšanas ierobežojums.

Mantotās atbildes par veiksmīgu izpildi un kļūmēm

{
  "status": {
    "code": "success",
    "msg": "Successfully Saved."
  },
  "response": ""
}

Šī galapunkta parastais veiksmīgas izpildes kods ir virkne success, nevis skaitliskais kods 200. Parastai kļūmei operatora sistēmā vai lokālajā sistēmā var tikt izmantota virkne error. Skaitliskais kods 400 apzīmē nederīgus laukus vai apliecinājumu kļūmes, 404 — neesošu profilu vai nederīgu atsauci uz augšupielādētu failu, bet 500 — tukšu pieprasījuma pamatdaļu vai nenoteiktu valsti. Izlasiet ziņojumu un visus validācijas ierakstus; neuzskatiet tikai HTTP 200 par veiksmīgas izpildes apliecinājumu.

Pašreizējie atjaunināšanas ierobežojumi un atkopšana

Paziņojums par veiksmīgu izpildi negarantē, ka operatora sistēmā ir mainīti visi lauki. Pārskatītais kods var saglabāt lokālo profilu pēc tam, kad adreses atjaunināšana operatora sistēmā ir neizdevusies. Identitātes atjauninājumā operatora sistēmā nav iekļauts email. Šim izpildes ceļam nav apstiprināta adreses valsts maiņa un adreses apraksta sinhronizācija. Ja jums nepieciešamas šīs izmaiņas, pārbaudiet rezultātu portālā un sazinieties ar atbalsta dienestu, nevis pieņemiet, ka reģistrācija operatora sistēmā ir atjaunināta.

Atjaunināšana nav viena atomāra transakcija: identitātes izmaiņas un apliecinājumu pievienošana var notikt pirms vēlākas kļūmes. Idempotences atslēga nav pieejama. Pēc neskaidras atbildes pirms atkārtota mēģinājuma pārbaudiet profilu un pielikumus; atkārtota apliecinājumu iesniegšana var radīt dublikātus. Profila atjaunināšana nenozīmē apliecinājumu apstiprināšanu un neaktivizē numuru.