Ontwikkelaars

POST/v3/update_document/{uuid}

Werk 'n registrasieprofiel by

Dien volledige wysigbare profielbesonderhede in en hanteer die ou suksesformaat.

Op hierdie bladsy
  1. Vervang 'n profiel se wysigbare besonderhede
  2. Bywerkingsversoek
  3. Gevorderd: voeg vooraf opgelaaide bewysstukke by
  4. Sukses- en mislukkingsantwoorde in die ou formaat
  5. Huidige bywerkingsbeperkings en herstel

Vervang 'n profiel se wysigbare besonderhede

Werk 'n bestaande registrasieprofiel wat aan die rekening behoort by met sy plaaslike UUID uit create_document of documents. Hierdie bewerking verander rekeningdata en data by die stroomop-netwerkoperateur. Dit verander nie die gestoorde identiteitstipe Personal/Business nie en is nie 'n PATCH vir gedeeltelike veldwysigings nie.

Bywerkingsversoek

Staaf jou identiteit vanaf 'n toegelate IP-adres met jou geaktiveerde MultiTEL API-rekening. Die voorbeelde gebruik aanmeldbesonderhede in omgewingsveranderlikes en fiktiewe data. Lees die JSON-velde status.code en status.msg sowel as die HTTP-antwoord.

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

Die voorbeeld toon 'n Personal-profiel; vervang dit met die eindgebruiker se volledige beoogde besonderhede en gemagtigde handtekening. Moenie plekhouerhandtekeninge of leë waardes indien om data te probeer behou nie. JSON en vormgekodeerde invoer word ondersteun.

Veldvereistes vir bywerking
VeldeWerking
first_name, last_name, city, postal_code, addressVerpligtend; elk hoogstens 64 karakters.
phone_number'n Numeriese waarde van minstens agt karakters is verpligtend; gebruik syfers in internasionale formaat, insluitend die landkode.
signatureVerpligtend. Die portaal verskaf Base64-gekodeerde PNG-grepe sonder die data-URL-voorvoegsel.
countryVerskaf 'n ISO-kode vir die adres se land uit die registrasiekatalogus. Die versoekhanteerder bepaal die land op grond daarvan, hoewel die nagegane adresbywerking nie die verwantskap met die land verander nie.
nationality'n ISO-landkode is verpligtend vir 'n bestaande Personal-profiel.
company_name, incorporation_countryVerpligtend vir 'n bestaande Business-profiel; die maatskappynaam mag hoogstens 64 karakters bevat en die land van inlywing moet 'n ISO-kode wees.
email'n Opsionele geldige e-posadres van hoogstens 254 karakters. Laat dit weg om die gestoorde kontak-e-posadres te behou; stuur 'n leë waarde om dit plaaslik uit te vee.
id_number, personal_tax_id, birth_date, description, company_reg_number, vat_idStuur die beoogde huidige waardes. Weggelate waardes is by verstek leeg en kan bestaande gestoorde waardes oorskryf.

Die landspesifieke registrasiereëls kan bykomende inligting of formate vereis. Moenie 'n volledige bywerking rekonstrueer op grond van get_document alleen nie: die beperkte antwoord laat landkeusevelde, email en entiteit-ID's weg. Bewaar die brondata wat jy gemagtig is om te gebruik, of gebruik die portaal se dokumentredigeerder.

Gevorderd: voeg vooraf opgelaaide bewysstukke by

Die opsionele skikkings identity_encryptfiles en address_encryptfiles aanvaar aktiewe verwysings wat aan die rekening behoort uit create_encrypt_files. Maak seker dat die entiteitskategorie met dié van die opgelaaide lêer ooreenstem en dien dit in voordat die verwysing verval. Elke lêer word in 'n afsonderlike bewysversoek aangeheg, selfs wanneer verskeie dieselfde bewystipe het. Vir 'n identiteitsbewys wat uit verskeie lêers bestaan, gebruik die latere werkvloei om bewysstukke aan te heg met een skikking.

As 'n latere adresbewys vir 'n nuut geskepte adres verwerp word, moenie die profiel-UUID in die plek daarvan gebruik of die identiteit herhaaldelik herskep nie. Stop en kontroleer die profiel in die portaal of by ondersteuning. Die teruglees-/opsoekpad vir adresbewyse bly 'n hersieningsbeperking.

Sukses- en mislukkingsantwoorde in die ou formaat

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

Hierdie eindpunt se gewone sukseskode is die string success, eerder as die numeriese kode 200. 'n Gewone stroomop- of plaaslike mislukking kan die string error gebruik. Die numeriese kode 400 dek ongeldige velde of mislukkings met bewysstukke, 404 'n ontbrekende profiel of ongeldige verwysing na 'n opgelaaide lêer, en 500 'n leë liggaam of 'n land wat nie bepaal kon word nie. Lees die boodskap en enige valideringsinskrywings; moenie HTTP 200 alleen as sukses beskou nie.

Huidige bywerkingsbeperkings en herstel

'n Aangeduide sukses waarborg nie dat elke stroomopveld verander het nie. Die nagegane kode kan die plaaslike profiel stoor nadat 'n stroomop-adresbywerking misluk het. Die stroomop-identiteitsbywerking sluit nie email in nie. Dit is nie vasgestel dat hierdie roete veranderinge aan die adres se land of sinchronisasie van die adresbeskrywing bewerkstellig nie. As jy daardie veranderinge nodig het, gaan die resultaat in die portaal na en kontak ondersteuning eerder as om aan te neem dat die stroomopregistrasie bygewerk is.

Die bywerking is nie een atomiese transaksie nie: identiteitsveranderinge en die aanheg van bewysstukke kan voor 'n latere mislukking plaasvind. Geen idempotensiesleutel word beskikbaar gestel nie. Gaan ná 'n onsekere antwoord die profiel en aanhegsels na voordat jy weer probeer; herhaalde indiening van bewysstukke kan duplikate skep. Die bywerking van 'n profiel bevestig nie dat bewysstukke goedgekeur is nie en aktiveer nie 'n nommer nie.