Kehittäjät

POST/v3/update_document/{uuid}

Päivitä rekisteröintiprofiili

Lähetä muokattavat profiilitiedot kokonaisuudessaan ja käsittele vanhanmuotoinen onnistumisvastaus.

Tällä sivulla
  1. Korvaa profiilin muokattavat tiedot
  2. Päivityspyyntö
  3. Lisäasetukset: lisää aiemmin ladattuja todistusasiakirjoja
  4. Vanhanmuotoiset onnistumis- ja virhevastaukset
  5. Päivityksen nykyiset rajoitukset ja virheistä palautuminen

Korvaa profiilin muokattavat tiedot

Päivitä olemassa oleva tilille kuuluva rekisteröintiprofiili käyttämällä sen paikallista UUID-tunnusta, jonka saat rajapintatoiminnosta create_document tai documents. Tämä toiminto muuttaa tilin ja operaattorin taustajärjestelmän tietoja. Se ei muuta tallennettua identiteettityyppiä Personal/Business, eikä se ole yksittäisten kenttien PATCH-päivitys.

Päivityspyyntö

Tunnistaudu käytössä olevalla MultiTEL API -tililläsi sallitusta IP-osoitteesta. Esimerkeissä käytetään ympäristömuuttujiin tallennettuja tunnuksia ja kuvitteellisia tietoja. Lue HTTP-vastauksen lisäksi JSON-kentät 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": ""
}

Esimerkissä on Personal-tyyppinen profiili; korvaa sen tiedot loppukäyttäjän kaikilla tarkoitetuilla tiedoilla ja valtuutetulla allekirjoituksella. Älä lähetä paikkamerkkiallekirjoituksia tai tyhjiä arvoja tietojen säilyttämiseksi. Syötteenä tuetaan JSON-muotoa ja lomakekoodattua muotoa.

Päivityskenttien vaatimukset
KentätToiminta
first_name, last_name, city, postal_code, addressPakollisia; kukin enintään 64 merkkiä.
phone_numberPakollinen vähintään kahdeksan merkin numeerinen arvo; käytä kansainvälisen numeron numeroita maatunnus mukaan lukien.
signaturePakollinen. Portaali toimittaa PNG-tavut Base64-koodattuina ilman data-URL-etuliitettä.
countryAnna osoitteen maan ISO-koodi rekisteröintiluettelosta. Käsittelijä selvittää koodia vastaavan maan, vaikka katselmoitu osoitepäivitys ei muuta maakytkentää.
nationalityPakollinen maan ISO-koodi olemassa olevalle Personal-tyyppiselle profiilille.
company_name, incorporation_countryPakollisia olemassa olevalle Business-tyyppiselle profiilille; yrityksen nimi saa olla enintään 64 merkkiä ja perustamismaa on annettava ISO-koodina.
emailValinnainen kelvollinen sähköpostiosoite, enintään 254 merkkiä. Jätä kenttä pois säilyttääksesi tallennetun yhteyssähköpostiosoitteen; lähetä tyhjä arvo poistaaksesi sen paikallisesti.
id_number, personal_tax_id, birth_date, description, company_reg_number, vat_idLähetä tarkoitetut nykyiset arvot. Pois jätetyt arvot ovat oletusarvoisesti tyhjiä ja voivat korvata aiemmin tallennetut arvot.

Maakohtaiset rekisteröintisäännöt voivat edellyttää lisätietoja tai tiettyjä muotoja. Älä kokoa täydellistä päivitystä pelkän seuraavan toiminnon vastauksen perusteella: get_document. Sen rajallisesta vastauksesta puuttuvat maavalinnat, email ja entiteettitunnukset. Säilytä lähdetiedot, joiden käyttöön sinulla on valtuutus, tai käytä portaalin asiakirjaeditoria.

Lisäasetukset: lisää aiemmin ladattuja todistusasiakirjoja

Valinnaiset taulukot identity_encryptfiles ja address_encryptfiles hyväksyvät aktiivisia, tilille kuuluvia viitteitä, jotka saadaan toiminnosta create_encrypt_files. Käytä samaa entiteettiluokkaa kuin ladatussa tiedostossa ja lähetä pyyntö ennen viitteen vanhenemista. Kukin tiedosto liitetään erillisellä todistuspyynnöllä, vaikka useilla tiedostoilla olisi sama todistustyyppi. Jos henkilöllisyystodistus koostuu useasta tiedostosta, käytä myöhempää työnkulkua todistusasiakirjojen liittäminen ja yhtä taulukkoa.

Jos myöhempi osoitetodiste hylätään vasta luodulle osoitteelle, älä korvaa sitä profiilin UUID-tunnuksella äläkä luo henkilöllisyyttä toistuvasti uudelleen. Pysähdy ja tarkista profiili portaalissa tai tuen kanssa. Osoitetodisteiden luku-/hakupolku on edelleen katselmoinnin rajoitus.

Vanhanmuotoiset onnistumis- ja virhevastaukset

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

Tämän päätepisteen tavallinen onnistumiskoodi on merkkijono success, ei numeerinen 200. Tavallinen taustajärjestelmän tai paikallisen käsittelyn virhe voi käyttää merkkijonoa error. Numeerinen 400 tarkoittaa virheellisiä kenttiä tai todistusasiakirjoihin liittyviä virheitä, 404 puuttuvaa profiilia tai virheellistä ladatun tiedoston viitettä ja 500 tyhjää viestirunkoa tai maata, jota ei voitu selvittää. Lue viesti ja mahdolliset validointimerkinnät; älä tulkitse pelkkää HTTP 200 -vastausta onnistumiseksi.

Päivityksen nykyiset rajoitukset ja virheistä palautuminen

Ilmoitettu onnistuminen ei takaa, että kaikki taustajärjestelmän kentät muuttuivat. Katselmoitu koodi voi tallentaa paikallisen profiilin sen jälkeen, kun taustajärjestelmän osoitepäivitys on epäonnistunut. Taustajärjestelmän identiteettipäivitys ei sisällä kenttää email. Tämän koodipolun ei ole osoitettu muuttavan osoitteen maata tai synkronoivan osoitteen kuvausta. Jos tarvitset nämä muutokset, tarkista tulos portaalissa ja ota yhteyttä tukeen sen sijaan, että olettaisit taustajärjestelmän rekisteröinnin päivittyneen.

Päivitys ei ole yksi atominen transaktio: identiteettimuutokset ja todistusasiakirjojen liittäminen voivat tapahtua ennen myöhempää virhettä. Idempotenssiavainta ei ole tarjolla. Tarkista profiili ja liitteet epäselvän vastauksen jälkeen ennen uutta yritystä; todistusasiakirjojen toistuva lähettäminen voi luoda kaksoiskappaleita. Profiilin päivittäminen ei merkitse todistusasiakirjojen hyväksyntää eikä aktivoi numeroa.