De bewerkbare gegevens van een profiel vervangen
Werk een bestaand registratieprofiel van uw account bij met de lokale UUID uit create_document of documents. Deze bewerking wijzigt gegevens binnen uw account en bij de achterliggende telecomaanbieder. Het opgeslagen identiteitstype Personal/Business verandert niet en de bewerking is geen PATCH voor het gedeeltelijk bijwerken van velden.
Bijwerkverzoek
Authenticeer met uw ingeschakelde MultiTEL API-account vanaf een toegestaan IP-adres. De voorbeelden gebruiken inloggegevens in omgevingsvariabelen en fictieve gegevens. Lees naast het HTTP-antwoord ook de JSON-velden status.code en 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": ""
}Het voorbeeld toont een Personal-profiel; vervang de voorbeeldgegevens door alle gewenste gegevens van de eindgebruiker en diens handtekening waarvoor toestemming is verleend. Dien geen tijdelijke voorbeeldhandtekeningen of lege waarden in om bestaande gegevens te behouden. Invoer in JSON-formaat en als gecodeerde formuliergegevens wordt ondersteund.
| Velden | Gedrag |
|---|---|
| first_name, last_name, city, postal_code, address | Verplicht; elk maximaal 64 tekens. |
| phone_number | Verplichte numerieke waarde van minimaal acht tekens; gebruik cijfers in internationaal nummerformaat, inclusief landcode. |
| signature | Verplicht. Het portaal levert PNG-bytes in Base64 zonder het voorvoegsel van een data-URL. |
| country | Geef een ISO-code voor het adresland uit de registratiecatalogus op. De verwerkingscode bepaalt het bijbehorende land, hoewel de beoordeelde adresupdate de koppeling met het land niet wijzigt. |
| nationality | Verplichte ISO-landcode voor een bestaand Personal-profiel. |
| company_name, incorporation_country | Verplicht voor een bestaand Business-profiel; de bedrijfsnaam mag maximaal 64 tekens bevatten en het land van oprichting moet een ISO-code zijn. |
| Optioneel geldig e-mailadres van maximaal 254 tekens. Laat het veld weg om het opgeslagen contactadres te behouden; stuur een lege waarde om het lokaal te wissen. | |
| id_number, personal_tax_id, birth_date, description, company_reg_number, vat_id | Stuur de gewenste actuele waarden. Weggelaten waarden worden standaard leeg en kunnen bestaande opgeslagen waarden overschrijven. |
De landspecifieke registratieregels kunnen aanvullende informatie of bepaalde formaten vereisen. Stel geen volledige update samen op basis van alleen get_document: het beperkte antwoord bevat geen landselectievelden, email of entiteits-ID's. Bewaar de brongegevens waarvoor u toestemming hebt of gebruik de documenteditor van het portaal.
Geavanceerd: vooraf geüploade bewijsstukken toevoegen
De optionele arrays identity_encryptfiles en address_encryptfiles accepteren actieve verwijzingen van uw eigen account uit create_encrypt_files. Zorg dat de entiteitscategorie overeenkomt met die van de upload en dien het verzoek in voordat de verwijzing verloopt. Elk bestand wordt in een afzonderlijk bewijsverzoek bijgevoegd, ook als meerdere bestanden hetzelfde bewijstype hebben. Gebruik voor een identiteitsbewijs dat uit meerdere bestanden bestaat de latere procedure voor het bijvoegen van bewijsstukken met één array.
Als een later adresbewijs voor een nieuw aangemaakt adres wordt afgewezen, gebruik dan niet de profiel-UUID als vervanging en maak de identiteit niet herhaaldelijk opnieuw aan. Stop en controleer het profiel in het portaal of bij de ondersteuning. Het pad voor het teruglezen en opzoeken van adresbewijzen blijft een beperking van de beoordeling.
Verouderde antwoorden bij succes en fouten
{
"status": {
"code": "success",
"msg": "Successfully Saved."
},
"response": ""
}De gebruikelijke succescode van dit eindpunt is de tekenreeks success, in plaats van het getal 200. Bij een gebruikelijke fout bij de achterliggende aanbieder of een lokale fout kan de tekenreeks error worden gebruikt. De numerieke code 400 duidt op ongeldige velden of fouten met bewijsstukken, 404 op een ontbrekend profiel of een ongeldige verwijzing naar een geüpload bestand, en 500 op een lege verzoekinhoud of een land dat niet kon worden bepaald. Lees de melding en eventuele validatiegegevens; beschouw alleen HTTP 200 niet als bewijs van succes.
Huidige beperkingen bij het bijwerken en herstel na fouten
Een succesmelding garandeert niet dat elk veld bij de achterliggende aanbieder is gewijzigd. De beoordeelde code kan het lokale profiel opslaan nadat het bijwerken van het adres bij die aanbieder is mislukt. Het bijwerken van de identiteitsgegevens bij de aanbieder omvat geen email. Voor deze werkwijze is niet vastgesteld dat wijzigingen van het adresland en synchronisatie van de adresomschrijving plaatsvinden. Als u deze wijzigingen nodig hebt, controleer dan het resultaat in het portaal en neem contact op met de ondersteuning in plaats van aan te nemen dat de registratie bij de aanbieder is bijgewerkt.
De update is geen enkele atomaire transactie: identiteitsgegevens kunnen al zijn gewijzigd en bewijsstukken al zijn bijgevoegd voordat er later een fout optreedt. Er wordt geen idempotentiesleutel aangeboden. Controleer na een antwoord met een onduidelijke uitkomst eerst het profiel en de bijlagen voordat u het opnieuw probeert; herhaald indienen van bewijsstukken kan duplicaten opleveren. Het bijwerken van een profiel betekent niet dat bewijsstukken zijn goedgekeurd en activeert geen nummer.