Entwickler

POST/v3/update_document/{uuid}

Registrierungsprofil aktualisieren

Übermitteln Sie die vollständigen bearbeitbaren Profildaten und verarbeiten Sie das bisherige Erfolgsformat.

Auf dieser Seite
  1. Bearbeitbare Profildaten ersetzen
  2. Aktualisierungsanfrage
  3. Erweitert: bereits hochgeladene Nachweise hinzufügen
  4. Erfolgs- und Fehlerantworten im bisherigen Format
  5. Aktuelle Einschränkungen bei Aktualisierungen und Fehlerbehebung

Bearbeitbare Profildaten ersetzen

Aktualisieren Sie ein bestehendes Registrierungsprofil Ihres Kontos anhand seiner lokalen UUID aus create_document oder documents. Dieser Vorgang ändert Daten im Konto und beim vorgeschalteten Netzbetreiber. Er ändert nicht den gespeicherten Identitätstyp Personal/Business und ist kein PATCH für einzelne Felder.

Aktualisierungsanfrage

Authentifizieren Sie sich von einer zugelassenen IP-Adresse aus mit Ihrem freigeschalteten MultiTEL-API-Konto. Die Beispiele verwenden Zugangsdaten in Umgebungsvariablen und fiktive Daten. Lesen Sie neben der HTTP-Antwort auch die JSON-Felder status.code und 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": ""
}

Das Beispiel zeigt ein Profil vom Typ Personal; ersetzen Sie die Beispieldaten durch die vollständigen vorgesehenen Angaben und die autorisierte Unterschrift des Endnutzers. Übermitteln Sie keine Platzhalterunterschriften oder leeren Werte, um Daten beizubehalten. Eingaben im JSON-Format und formularcodierte Eingaben werden unterstützt.

Feldanforderungen für die Aktualisierung
FelderVerhalten
first_name, last_name, city, postal_code, addressErforderlich; jeweils höchstens 64 Zeichen.
phone_numberErforderlicher numerischer Wert mit mindestens acht Zeichen; verwenden Sie Ziffern im internationalen Format einschließlich Ländervorwahl.
signatureErforderlich. Das Portal liefert Base64-codierte PNG-Bytes ohne das Daten-URL-Präfix.
countryGeben Sie einen ISO-Code für das Land der Adresse aus dem Registrierungskatalog an. Die Verarbeitungsroutine ermittelt das zugehörige Land, obwohl die überprüfte Adressaktualisierung die Länderzuordnung nicht ändert.
nationalityErforderlicher ISO-Ländercode für ein bestehendes Profil vom Typ Personal.
company_name, incorporation_countryErforderlich für ein bestehendes Profil vom Typ Business; der Firmenname darf höchstens 64 Zeichen enthalten, und das Gründungsland muss als ISO-Code angegeben werden.
emailOptionale gültige E-Mail-Adresse mit bis zu 254 Zeichen. Lassen Sie das Feld weg, um die gespeicherte Kontakt-E-Mail-Adresse beizubehalten; senden Sie einen leeren Wert, um sie lokal zu löschen.
id_number, personal_tax_id, birth_date, description, company_reg_number, vat_idSenden Sie die vorgesehenen aktuellen Werte. Für weggelassene Werte wird standardmäßig ein leerer Wert verwendet, der vorhandene gespeicherte Werte überschreiben kann.

Die länderspezifischen Registrierungsregeln können zusätzliche Angaben oder Formate verlangen. Stellen Sie eine vollständige Aktualisierung nicht allein anhand von get_document zusammen: Die eingeschränkte Antwort enthält weder Felder zur Länderauswahl noch email oder Entitäts-IDs. Bewahren Sie Ihre autorisierten Quelldaten auf oder verwenden Sie den Dokumenteneditor des Portals.

Erweitert: bereits hochgeladene Nachweise hinzufügen

Die optionalen Arrays identity_encryptfiles und address_encryptfiles akzeptieren aktive, Ihrem Konto gehörende Referenzen aus create_encrypt_files. Achten Sie darauf, dass die Entitätskategorie mit der des Uploads übereinstimmt, und übermitteln Sie die Anfrage, bevor die Referenz abläuft. Jede Datei wird in einer separaten Nachweisanfrage angehängt, auch wenn mehrere Dateien denselben Nachweistyp haben. Verwenden Sie für einen Identitätsnachweis aus mehreren Dateien den späteren Ablauf zum Anhängen von Nachweisen mit einem einzigen Array.

Wenn ein späterer Adressnachweis für eine neu erstellte Adresse abgelehnt wird, ersetzen Sie nicht die Profil-UUID und erstellen Sie die Identität nicht wiederholt neu. Halten Sie an und prüfen Sie das Profil im Portal oder mit dem Support. Der Pfad zum Rücklesen/Nachschlagen von Adressnachweisen bleibt eine Einschränkung der Prüfung.

Erfolgs- und Fehlerantworten im bisherigen Format

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

Der reguläre Erfolgscode dieses Endpunkts ist die Zeichenfolge success, nicht der numerische Wert 200. Für einen regulären Fehler beim vorgeschalteten System oder im lokalen System kann die Zeichenfolge error verwendet werden. Der numerische Code 400 steht für ungültige Felder oder Fehler bei Nachweisen, 404 für ein fehlendes Profil oder eine ungültige Referenz auf eine hochgeladene Datei und 500 für einen leeren Anfrageinhalt oder ein nicht ermitteltes Land. Lesen Sie die Meldung und gegebenenfalls vorhandene Validierungseinträge; werten Sie HTTP 200 allein nicht als Erfolg.

Aktuelle Einschränkungen bei Aktualisierungen und Fehlerbehebung

Ein gemeldeter Erfolg garantiert nicht, dass jedes Feld im vorgeschalteten System geändert wurde. Der überprüfte Code kann das lokale Profil speichern, nachdem eine Adressaktualisierung im vorgeschalteten System fehlgeschlagen ist. Die Identitätsaktualisierung im vorgeschalteten System enthält email nicht. Änderungen des Adresslandes und die Synchronisierung der Adressbeschreibung sind für diesen Verarbeitungspfad nicht nachgewiesen. Wenn Sie diese Änderungen benötigen, prüfen Sie das Ergebnis im Portal und wenden Sie sich an den Support, statt davon auszugehen, dass die Registrierung beim vorgeschalteten Netzbetreiber aktualisiert wurde.

Die Aktualisierung ist keine einzelne atomare Transaktion: Identitätsänderungen und das Anhängen von Nachweisen können vor einem späteren Fehler erfolgen. Es wird kein Idempotenzschlüssel bereitgestellt. Prüfen Sie nach einer uneindeutigen Antwort das Profil und die Anhänge, bevor Sie die Anfrage wiederholen; wiederholte Übermittlungen von Nachweisen können Duplikate erzeugen. Die Aktualisierung eines Profils bewirkt weder die Genehmigung von Nachweisen noch die Aktivierung einer Rufnummer.