Registrierungsprofil erstellen

Das Profil nur einmal erstellen

Diese Anfrage erstellt ein lokales Registrierungsprofil zusammen mit Identitäts- und Adressdatensätzen beim Carrier. Beginnen Sie mit den aktuellen Registrierungsländern, Nummerntypen und Anforderungen. Die Anforderungen hängen vom Land und vom Nummerntyp ab, den Sie registrieren möchten.

Eine erfolgreiche Erstellungsantwort ist weder eine behördliche Genehmigung noch eine Nummernaktivierung. Speichern Sie die Dokument-UUID, die Identitäts-ID und die Adress-ID getrennt: Sie dienen unterschiedlichen Zwecken. Diese Anfrage ändert Kontodaten und ist kein reiner Validierungsvorgang.

Erstellungsanfrage

Authentifizieren Sie sich mit Ihrem freigeschalteten MultiTEL-API-Konto und dessen zugelassener IP-Adresse. Die Beispiele verwenden HTTP-Basic-Anmeldedaten, die in Umgebungsvariablen gespeichert sind. Prüfen Sie sowohl die HTTP-Antwort als auch den JSON-Wert status.code; eine HTTP-200-Antwort allein belegt keinen Erfolg. Alle Beispielwerte sind fiktiv.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @registration-profile.json \
  https://api.multitel.net/v3/create_document

{
  "identity_type": "Personal",
  "first_name": "Example",
  "last_name": "Person",
  "phone_number": "12025550123",
  "email": "end-user@example.com",
  "city": "Example City",
  "postal_code": "00000",
  "country": "US",
  "address": "1 Example Street",
  "nationality": "US",
  "signature": "BASE64_PNG_OF_THE_AUTHORIZED_END_USER_SIGNATURE"
}

Das JSON ist ein illustratives Personal-Profil und keine einreichungsfertige echte Identität. Ersetzen Sie dessen Angaben und Signatur durch die Endnutzerdaten, die die gewählten Registrierungsregeln verlangen. Formularkodierte Eingaben werden ebenfalls unterstützt.

Felder des Registrierungsprofils
Feld	Pflicht und Format
`identity_type`	Pflichtfeld. Verwenden Sie exakt den Wert Personal oder Business; die bedingte Validierung hängt von der Groß-/Kleinschreibung ab.
`first_name, last_name`	Pflichtfelder, jeweils höchstens 64 Zeichen. Geben Sie für ein Unternehmen die vom gewählten Land verlangten Angaben zum Vertreter an.
`phone_number`	Pflichtfeld, numerischer Telefonwert mit mindestens acht Zeichen. Eine rein aus Ziffern bestehende internationale Nummer einschließlich Ländervorwahl eignet sich für diese Validierung; dies ist eine Kontaktnummer, kein Nummernkauf.
`city, postal_code, address`	Pflichtfelder, jeweils höchstens 64 Zeichen.
`country`	Pflichtfeld, ISO-Code des Adresslands aus dem Registrierungskatalog. Der Dienst löst ihn in den Länderdatensatz des Carriers auf.
`signature`	Pflichtfeld, Signaturdaten. Das aktuelle Portal liefert Base64-PNG-Bildbytes ohne das Präfix data:image/png;base64,. Beziehen Sie die Signatur des Endnutzers über Ihren autorisierten Arbeitsablauf; ein nicht leerer Platzhalter ist keine aussagekräftige Signatur.
`nationality`	Pflichtfeld für Personal, als ISO-Ländercode. Ersetzen Sie ihn nicht durch eine Länder-UUID.
`company_name, incorporation_country`	Pflichtfeld für Business. Der Firmenname darf höchstens 64 Zeichen lang sein; incorporation_country ist ein ISO-Ländercode.
`email`	Optionale Kontakt-E-Mail-Adresse des Endnutzers, höchstens 254 Zeichen. Eine ausgelassene oder leere E-Mail-Adresse übernimmt nicht die E-Mail-Adresse des Basiskontos.
`company_reg_number, vat_id, id_number, personal_tax_id, birth_date, description`	In diesem Handler optional, das gewählte Land bzw. der Carrier kann jedoch einige davon verlangen. Liefern Sie die für diese Registrierung erforderlichen Formate. Direkte API-Aufrufe wenden nicht automatisch jede vom Portal durchgeführte Normalisierung an.

Dieser direkte v3-Handler verlangt Adressfelder und erstellt eine Adresse. Gehen Sie nicht davon aus, dass die Option des Portals zum Aufschieben der Adresse darüber verfügbar ist.

Alle drei Kennungen aufbewahren

Nachfolgend sind ausgewählte Antwortfelder dargestellt; die tatsächliche Antwort enthält außerdem die übermittelten Profilangaben und Signaturdaten. Behandeln Sie die vollständige Antwort als vertraulich.

{
  "status": {
    "code": 200,
    "msg": "Success Create Registration Detail."
  },
  "response": {
    "uuid": "11111111111111111111111111111111",
    "identity_id": "22222222222222222222222222222222",
    "address_id": "33333333333333333333333333333333",
    "country_iso": "US",
    "email": "end-user@example.com"
  }
}

response.uuid identifiziert das lokale Profil. Verwenden Sie sie mit get_document. In den Antworten von documents und get_document heißt dieselbe Profilkennung id.
response.identity_id identifiziert die Identität für spätere Identitätsnachweise und Belegdokumente.
response.address_id identifiziert die erstellte Adresse. Bewahren Sie sie getrennt auf; die UUID des lokalen Profils ist keine Adress-ID. Die Kompatibilität späterer Adressnachweis-Anhänge für neu erstellte Profile wird noch geprüft.

Die beiden Endpunkte zum Rücklesen des Profils geben weder identity_id noch address_id zurück; bewahren Sie daher die ursprüngliche erfolgreiche Erstellungsantwort auf. Falls sie verloren gegangen ist, verwenden Sie die Dokumentansicht im Portal oder wenden Sie sich an den Support, bevor Sie einen Ersatz erstellen.

Erweitert: vorab hochgeladene Nachweise bei der Erstellung anhängen

Sie können identity_encryptfiles und address_encryptfiles als Arrays von IDs angeben, die von create_encrypt_files zurückgegeben wurden. Laden Sie mit einem Nachweistyp für die passende Entitätskategorie hoch und senden Sie dann vor Ablauf der etwa 20-minütigen Gültigkeit der Dateireferenz ab. Der Erstellungs-Handler prüft Konto, Kategorie und Ablauf jeder angegebenen Referenz.

Diese Felder haben andere Namen als das Feld encrypted_file_ids des späteren Anhang-Endpunkts. Bei der Erstellung wird jede Datei als separate Nachweisanfrage gesendet, auch wenn mehrere Dateien denselben Nachweistyp teilen. Für einen Identitätsnachweis, der mehrere Dateien zusammen enthalten muss, verwenden Sie die spätere create_proof-Anfrage mit einem einzigen Array. Eine erfolgreiche Profilerstellung allein liefert keine individuellen Ergebnisse der Nachweisprüfung.

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.

Fehler und unvollständige Erstellung

API-Code 400 deckt Feldvalidierung, Fehler bei der Erstellung beim Carrier und lokale Speicherfehler ab. Validierungsfehler können als feldbezogene Einträge in response erscheinen. Code 500 wird für ein nicht verfügbares/ungültiges Registrierungsland verwendet und Code 404 für fehlende oder abgelaufene vorab hochgeladene Referenzen. Lesen Sie status.msg zusätzlich zum Code.

Das lokale Profil und die vorgelagerten Carrier-Vorgänge bilden keine einzige atomare Transaktion. Eine fehlgeschlagene Anfrage kann vorgelagerten Zustand hinterlassen, selbst wenn kein lokales Profil aufgeführt wird. Es wird kein Client-Idempotenzschlüssel bereitgestellt. Prüfen Sie nach einem Timeout oder einem unklaren Fehler die vorhandenen Profile und wenden Sie sich an den Support, bevor Sie die Erstellung wiederholen; eine leere documents-Liste ist kein Beweis dafür, dass vorgelagert nichts erstellt wurde.