Erstatt de redigerbare opplysningene i en profil
Oppdater en eksisterende registreringsprofil som tilhører kontoen, ved å bruke profilens lokale UUID fra create_document eller documents. Denne operasjonen endrer kontoopplysninger og opplysninger hos den overordnede operatøren. Den endrer ikke den lagrede identitetstypen Personal/Business og er ikke en PATCH som bare oppdaterer enkelte felt.
Forespørsel om oppdatering
Autentiser deg med den aktiverte MultiTEL API-kontoen din fra en tillatt IP-adresse. Eksemplene bruker påloggingsopplysninger i miljøvariabler og oppdiktede data. Les både status.code og status.msg i JSON 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": ""
}Eksemplet viser en profil av typen Personal; erstatt opplysningene med alle de tiltenkte opplysningene om sluttbrukeren og vedkommendes autoriserte signatur. Ikke send inn plassholdersignaturer eller tomme verdier for å forsøke å bevare data. Både JSON og skjemakodede inndata støttes.
| Felt | Virkemåte |
|---|---|
| first_name, last_name, city, postal_code, address | Obligatoriske; hvert felt kan ha høyst 64 tegn. |
| phone_number | Obligatorisk numerisk verdi på minst åtte tegn; bruk sifre i internasjonalt format, inkludert landskode. |
| signature | Obligatorisk. Portalen leverer PNG-byte kodet med Base64 uten prefikset for data-URL. |
| country | Oppgi en ISO-kode fra registreringskatalogen for landet i adressen. Behandlingskoden slår opp landet ut fra koden, selv om den gjennomgåtte adresseoppdateringen ikke endrer landtilknytningen. |
| nationality | Obligatorisk ISO-landkode for en eksisterende profil av typen Personal. |
| company_name, incorporation_country | Obligatoriske for en eksisterende profil av typen Business; selskapsnavnet kan ha høyst 64 tegn, og stiftelseslandet må oppgis som en ISO-kode. |
| Valgfri, gyldig e-postadresse på opptil 254 tegn. Utelat feltet for å bevare den lagrede kontaktadressen; send en tom verdi for å slette den lokalt. | |
| id_number, personal_tax_id, birth_date, description, company_reg_number, vat_id | Send inn de ønskede gjeldende verdiene. Utelatte verdier blir som standard tomme og kan overskrive eksisterende lagrede verdier. |
De landsspesifikke registreringsreglene kan kreve flere opplysninger eller bestemte formater. Ikke sett sammen en fullstendig oppdatering utelukkende fra get_document: det begrensede svaret utelater landvalg, email og entitets-ID-er. Ta vare på kildedataene du har tillatelse til å bruke, eller bruk dokumentredigereren i portalen.
Avansert: legg til dokumentasjon som er lastet opp på forhånd
De valgfrie matrisene identity_encryptfiles og address_encryptfiles godtar aktive referanser som tilhører kontoen, fra create_encrypt_files. Bruk samme entitetskategori som opplastingen, og send inn før referansen utløper. Hver fil legges ved i en egen dokumentasjonsforespørsel, selv om flere filer har samme dokumentasjonstype. For identitetsdokumentasjon som består av flere filer, bruker du den etterfølgende arbeidsflyten for å legge ved dokumentasjon med én matrise.
Hvis et senere adressebevis avvises for en nyopprettet adresse, må du ikke erstatte den med profil-UUID-en eller opprette identiteten på nytt gjentatte ganger. Stopp og kontroller profilen i portalen eller med kundestøtte. Banen for tilbakelesing/oppslag av adressebevis er fortsatt en begrensning i gjennomgangen.
Eldre svarformater ved suksess og feil
{
"status": {
"code": "success",
"msg": "Successfully Saved."
},
"response": ""
}Den vanlige suksesskoden for dette endepunktet er strengen success, i stedet for den numeriske verdien 200. En vanlig feil hos den overordnede operatøren eller lokalt kan bruke strengen error. Den numeriske koden 400 dekker ugyldige felt eller dokumentasjonsfeil, 404 en manglende profil eller en ugyldig referanse til en opplastet fil, og 500 en tom forespørselskropp eller et land som ikke kunne slås opp. Les meldingen og eventuelle valideringsoppføringer; ikke regn HTTP 200 alene som suksess.
Gjeldende begrensninger ved oppdatering og gjenoppretting etter feil
En rapportert suksess garanterer ikke at alle felt hos den overordnede operatøren ble endret. Den gjennomgåtte koden kan lagre den lokale profilen etter at en adresseoppdatering hos den overordnede operatøren har mislyktes. Identitetsoppdateringen hos den overordnede operatøren inkluderer ikke email. Det er ikke fastslått at denne fremgangsmåten endrer landet i adressen eller synkroniserer adressebeskrivelsen. Hvis du trenger disse endringene, må du kontrollere resultatet i portalen og kontakte kundestøtte i stedet for å anta at registreringen hos den overordnede operatøren ble oppdatert.
Oppdateringen er ikke én atomisk transaksjon: identitetsendringer og vedlegging av dokumentasjon kan skje før en senere feil. Ingen idempotensnøkkel er tilgjengelig. Etter et uklart svar må du undersøke profilen og vedleggene før du prøver på nytt; gjentatt innsending av dokumentasjon kan opprette duplikater. Oppdatering av en profil innebærer ikke at dokumentasjonen godkjennes, og aktiverer ikke et nummer.