Ein ergänzendes Dokument anhängen

Ein auf einer Vorlage basierendes ergänzendes Dokument anhängen

Verwenden Sie eine Vorlage aus get_supporting_document_templates und eine Identität, die bereits Ihrem Konto gehört. Laden Sie die zugehörigen Dateien über create_encrypt_files hoch und verwenden Sie dabei supporting_template_id. Gewöhnliche Uploads von Identitäts- oder Adressnachweisen gehören zu einer anderen Kategorie und können nicht als Ersatz verwendet werden.

Das ergänzende Dokument erstellen

Verwenden Sie ein aktiviertes MultiTEL-Konto für die API und die dafür zugelassene IP-Adresse. Die Beispiele verwenden Zugangsdaten für HTTP Basic aus Umgebungsvariablen; beachten Sie die Authentifizierungsvorgaben für Ihren Kontotyp. Senden Sie Anfragen über HTTPS. Prüfen Sie sowohl die HTTP-Antwort als auch das folgende Feld im JSON-Objekt: status.code; Anwendungsfehler können auch mit HTTP 200 zurückgegeben werden. Die folgenden Beispiele sind fiktiv.

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

{
  "identity_id": "33333333333333333333333333333333",
  "template_id": "55555555555555555555555555555555",
  "encrypted_file_ids": [
    "66666666666666666666666666666666"
  ]
}

Anfragefelder
Feld	Bedeutung
`identity_id`	Erforderliche ID der Ihrem Konto zugeordneten Identität. Mit dieser Anfrage wird das Dokument einer Identität zugeordnet, nicht direkt einer Adresse oder Telefonnummer.
`template_id`	Erforderliche Vorlagen-ID für das ergänzende Dokument; verwenden Sie dieselbe ausgewählte Vorlage wie beim Upload der ergänzenden Dateien. Das Feld zum Anhängen heißt template_id, das Feld beim Upload hingegen supporting_template_id.
`encrypted_file_ids`	Erforderliches, nicht leeres JSON-Array mit den zurückgegebenen Upload-IDs. Jeder zugehörige Upload muss zum aktuellen Konto gehören, noch gültig sein und die Kategorie supporting_documents haben.

Auch Formulardaten mit wiederholten encrypted_file_ids[] Feldern werden akzeptiert. Senden Sie keine Dateibytes an diesen Endpunkt zum Anhängen.

Erstelltes ergänzendes Dokument

{
  "status": {
    "code": 200,
    "msg": "Supporting document created successfully."
  },
  "response": {
    "id": "77777777777777777777777777777777",
    "template_id": "55555555555555555555555555555555",
    "identity_id": "33333333333333333333333333333333",
    "template_name": "Example supporting template"
  }
}

Dies bestätigt die Erstellung des ergänzenden Dokuments, nicht eine behördliche Genehmigung oder die Aktivierung einer Rufnummer. Die Bezeichnung „dauerhaft“ in der vorgelagerten Ressource stellt gegenüber Kunden keine Garantie hinsichtlich der Speicherdauer oder der Löschrichtlinie dar.

Fehler und Wiederholungsversuche

Der API-Code 500 steht für fehlende Eingaben, Fehler des Telekommunikationsanbieters oder eine ungültige Antwort des Telekommunikationsanbieters. Code 404 steht für eine Identität, die dem Konto nicht zugeordnet ist, eine ungültige Vorlage, fehlende oder abgelaufene Uploads, Uploads der falschen Kategorie oder eine leere Menge verwendbarer Dateien. Prüfen Sie status.msg; HTTP 200 allein reicht nicht aus.

Laden Sie die Dateien innerhalb der zurückgegebenen Gültigkeitsdauer der Dateiverweise hoch und hängen Sie sie innerhalb dieses Zeitraums an. Prüfen Sie nach einer Antwort mit unklarem Ergebnis die ergänzenden Dokumente der Identität im Portal, bevor Sie die Anfrage wiederholen. Dieser Handler stellt keinen Idempotenzschlüssel bereit.