Utvecklare

POST/v3/update_document/{uuid}

Uppdatera en registreringsprofil

Skicka in fullständiga redigerbara profiluppgifter och hantera det äldre formatet för lyckade svar.

På denna sida
  1. Ersätt en profils redigerbara uppgifter
  2. Uppdateringsbegäran
  3. Avancerat: lägg till tidigare uppladdade styrkande handlingar
  4. Äldre svarsformat vid lyckade och misslyckade anrop
  5. Nuvarande begränsningar för uppdateringar och återställning

Ersätt en profils redigerbara uppgifter

Uppdatera en befintlig registreringsprofil som tillhör kontot med dess lokala UUID från create_document eller documents. Åtgärden ändrar uppgifter på kontot och i operatörens bakomliggande system. Den ändrar inte den lagrade identitetstypen Personal/Business och är inte en PATCH för enskilda fält.

Uppdateringsbegäran

Autentisera dig med ditt aktiverade MultiTEL API-konto från en tillåten IP-adress. Exemplen använder autentiseringsuppgifter i miljövariabler och fiktiva data. Läs JSON-fälten status.code och status.msg samt HTTP-svaret.

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

Exemplet visar en profil av typen Personal; ersätt uppgifterna med slutanvändarens fullständiga avsedda uppgifter och godkända underskrift. Skicka inte platshållare för underskrifter eller tomma värden i syfte att bevara data. Indata i JSON-format och formulärkodat format stöds.

Krav på fält vid uppdatering
FältFunktion
first_name, last_name, city, postal_code, addressObligatoriska; högst 64 tecken vardera.
phone_numberObligatoriskt numeriskt värde med minst åtta tecken; ange numret i internationellt format med landskod.
signatureObligatoriskt. Portalen tillhandahåller Base64-kodade PNG-byte utan prefixet för data-URL.
countryAnge en ISO-kod för adresslandet från registreringskatalogen. Hanteraren slår upp koden, även om den granskade adressuppdateringen inte ändrar kopplingen till landet.
nationalityObligatorisk ISO-landskod för en befintlig profil av typen Personal.
company_name, incorporation_countryObligatoriska för en befintlig profil av typen Business; företagsnamnet får innehålla högst 64 tecken och registreringslandet ska anges som en ISO-kod.
emailValfri giltig e-postadress med högst 254 tecken. Utelämna fältet för att behålla den lagrade kontaktadressen; skicka ett tomt värde för att radera den lokalt.
id_number, personal_tax_id, birth_date, description, company_reg_number, vat_idSkicka de avsedda aktuella värdena. Utelämnade värden blir som standard tomma och kan skriva över befintliga lagrade värden.

De landsspecifika registreringsreglerna kan kräva ytterligare uppgifter eller format. Återskapa inte en fullständig uppdatering enbart utifrån get_document: det begränsade svaret saknar landsval, email och entitets-ID:n. Behåll dina källdata som du har behörighet att använda eller använd portalens dokumentredigerare.

Avancerat: lägg till tidigare uppladdade styrkande handlingar

De valfria arrayerna identity_encryptfiles och address_encryptfiles tar emot aktiva referenser som tillhör kontot från create_encrypt_files. Använd samma entitetskategori som vid uppladdningen och skicka in innan referensen löper ut. Varje fil bifogas i en separat begäran om styrkande handling, även om flera filer har samma handlingstyp. För ett identitetsbevis med flera filer använder du det senare arbetsflödet för bifogande av styrkande handlingar med en enda array.

Om ett senare adressbevis avvisas för en nyskapad adress ska du inte ersätta det med profilens UUID eller skapa om identiteten upprepade gånger. Stanna upp och kontrollera profilen i portalen eller med supporten. Sökvägen för återläsning/uppslag av adressbevis är fortfarande en begränsning i granskningen.

Äldre svarsformat vid lyckade och misslyckade anrop

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

Den här ändpunktens normala kod för ett lyckat anrop är strängen success, i stället för det numeriska värdet 200. Ett normalt fel i det bakomliggande systemet eller lokalt kan använda strängen error. Den numeriska koden 400 omfattar ogiltiga fält eller fel med styrkande handlingar, 404 en saknad profil eller ogiltig referens till en uppladdad fil och 500 en tom meddelandekropp eller ett land som inte kunde identifieras. Läs meddelandet och eventuella valideringsposter; betrakta inte enbart HTTP 200 som ett lyckat resultat.

Nuvarande begränsningar för uppdateringar och återställning

Ett rapporterat lyckat resultat garanterar inte att alla fält i det bakomliggande systemet ändrades. Den granskade koden kan spara den lokala profilen efter att en adressuppdatering i det bakomliggande systemet har misslyckats. Identitetsuppdateringen i det bakomliggande systemet omfattar inte email. Det har inte fastställts att den här kodvägen ändrar adresslandet eller synkroniserar adressbeskrivningen. Om du behöver dessa ändringar ska du granska resultatet i portalen och kontakta supporten i stället för att anta att registreringen i det bakomliggande systemet har uppdaterats.

Uppdateringen är inte en enda atomär transaktion: identitetsändringar och bifogande av styrkande handlingar kan ske innan ett senare fel inträffar. Ingen idempotensnyckel är tillgänglig. Kontrollera profilen och bilagorna efter ett oklart svar innan du försöker igen; upprepade inskickningar av styrkande handlingar kan skapa dubbletter. En profiluppdatering innebär inte att de styrkande handlingarna godkänns eller att ett nummer aktiveras.