Fejlesztők

POST/v3/update_document/{uuid}

Regisztrációs profil frissítése

Küldje el a profil összes szerkeszthető adatát, és kezelje a sikeres válasz régi formátumát.

Ezen az oldalon
  1. A profil szerkeszthető adatainak cseréje
  2. Frissítési kérés
  3. Haladó: korábban feltöltött igazolások hozzáadása
  4. Sikeres és sikertelen válaszok régi formátumban
  5. A frissítés jelenlegi korlátai és helyreállítás

A profil szerkeszthető adatainak cseréje

Frissítse a fiókhoz tartozó meglévő regisztrációs profilt a helyi UUID-ja alapján, amelyet a következőből szerezhet be: create_document vagy documents. Ez a művelet a fiók és a háttérben működő szolgáltató adatait is módosítja. Nem változtatja meg a tárolt Personal/Business személyazonossági típust, és nem csupán egyes mezőket módosító PATCH művelet.

Frissítési kérés

Hitelesítse magát engedélyezett IP-címről az aktív MultiTEL API-fiókjával. A példák környezeti változókban tárolt hitelesítő adatokat és fiktív adatokat használnak. A HTTP-válasz mellett olvassa el a JSON status.code és status.msg mezőit is.

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": ""
}

A példa egy Personal típusú profilt mutat be; cserélje le a végfelhasználó összes megadni kívánt adatára és az engedélyével használt aláírására. Ne küldjön helykitöltő aláírásokat vagy üres értékeket az adatok megőrzésének szándékával. A JSON és az űrlapkódolású bemenet is támogatott.

A frissítési mezőkre vonatkozó követelmények
MezőkMűködés
first_name, last_name, city, postal_code, addressKötelező mezők; egyenként legfeljebb 64 karaktert tartalmazhatnak.
phone_numberKötelező, legalább nyolc karakterből álló számérték; a számot nemzetközi formátumban, az országhívó kódot is beleértve adja meg.
signatureKötelező. A portál Base64-kódolású PNG-bájtokat ad meg, az adat-URL előtagja nélkül.
countryAdja meg a cím országának ISO-kódját a regisztrációs katalógusból. A kéréskezelő ez alapján azonosítja az országot, bár a felülvizsgált címfrissítés nem módosítja az országhoz való hozzárendelést.
nationalityMeglévő Personal típusú profil esetén kötelező ISO-országkód.
company_name, incorporation_countryMeglévő Business típusú profil esetén kötelező; a cégnév legfeljebb 64 karakter lehet, a bejegyzés országát pedig ISO-kóddal kell megadni.
emailNem kötelező, érvényes e-mail-cím, legfeljebb 254 karakterrel. A tárolt kapcsolattartási e-mail-cím megőrzéséhez hagyja ki a mezőt; a helyi törléséhez küldjön üres értéket.
id_number, personal_tax_id, birth_date, description, company_reg_number, vat_idKüldje el a kívánt aktuális értékeket. A kihagyott értékek alapértelmezés szerint üresek, és felülírhatják a már tárolt értékeket.

Az országspecifikus regisztrációs szabályok további adatokat vagy formátumokat írhatnak elő. Ne állítson össze teljes frissítést kizárólag a következő válaszából: get_document; a korlátozott válasz ugyanis nem tartalmazza az országválasztó mezőket, az email mezőt és az entitásazonosítókat. Őrizze meg az engedéllyel használt forrásadatait, vagy használja a portál dokumentumszerkesztőjét.

Haladó: korábban feltöltött igazolások hozzáadása

A nem kötelező identity_encryptfiles és address_encryptfiles tömbök a fiókhoz tartozó, aktív hivatkozásokat fogadnak el a következőből: create_encrypt_files. Az entitáskategória egyezzen meg a feltöltésével, és a hivatkozás lejárta előtt küldje el a kérést. Minden fájl külön igazolási kérésben kerül csatolásra, még akkor is, ha több fájl azonos igazolástípushoz tartozik. Több fájlból álló személyazonossági igazoláshoz használja a későbbi igazoláscsatolási munkafolyamatot egyetlen tömbbel.

Ha egy későbbi címigazolást elutasítanak egy újonnan létrehozott címnél, ne helyettesítse a profil UUID-jével, és ne hozza létre ismételten a személyazonosságot. Álljon meg, és ellenőrizze a profilt a portálon vagy az ügyfélszolgálattal. A címigazolás visszaolvasási/keresési útvonala továbbra is felülvizsgálati korlátozás.

Sikeres és sikertelen válaszok régi formátumban

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

Ennek a végpontnak a szokásos sikerkódja a következő karakterlánc: success; nem a numerikus 200. Egy szokásos szolgáltatói vagy helyi hiba a következő karakterláncot használhatja: error. A numerikus 400 érvénytelen mezőket vagy igazolási hibákat, a 404 hiányzó profilt vagy érvénytelen feltöltöttfájl-hivatkozást, az 500 pedig üres kéréstörzset vagy nem azonosítható országot jelez. Olvassa el az üzenetet és az esetleges érvényesítési bejegyzéseket; a HTTP 200 önmagában nem jelent sikert.

A frissítés jelenlegi korlátai és helyreállítás

A jelzett siker nem garantálja, hogy a szolgáltatónál minden mező megváltozott. A felülvizsgált kód akkor is mentheti a helyi profilt, ha a szolgáltatói címfrissítés meghiúsul. A szolgáltatói személyazonosság-frissítés nem tartalmazza az email mezőt. Ez az eljárás nem biztosítja a cím országának módosítását és a címleírás szinkronizálását. Ha ezekre a módosításokra van szüksége, ellenőrizze az eredményt a portálon, és forduljon az ügyfélszolgálathoz, ahelyett hogy feltételezné a szolgáltatói regisztráció frissítését.

A frissítés nem egyetlen atomi tranzakció: a személyazonossági adatok módosítása és az igazolások csatolása egy későbbi hiba előtt már megtörténhet. Idempotenciakulcs nem áll rendelkezésre. Bizonytalan válasz után az újrapróbálkozás előtt ellenőrizze a profilt és a mellékleteket; az igazolások ismételt beküldése másolatokat hozhat létre. A profil frissítése nem jelenti az igazolások jóváhagyását, és nem aktivál telefonszámot.