Entwickler

GET/v3/get_proof_types

Nachweiskategorien auflisten

Ermitteln Sie die IDs der Nachweiskategorien und die Entitätstypen, bevor Sie Identitäts- oder Adressnachweise vorbereiten.

Auf dieser Seite
  1. Nachweiskategorie auswählen
  2. Die tatsächlich geltenden Anforderungen erfüllen
  3. Anfrage
  4. Antwort
  5. Fehler
  6. Verfügbarkeit und Nebenwirkungen

Nachweiskategorie auswählen

Verwenden Sie die zurückgegebene Kategorie und den Entitätstyp, wenn Sie die für eine Identität erforderlichen Nachweise vorbereiten. Diese Liste beschreibt Kategorien, weder Ihre hochgeladenen Dateien noch die Genehmigung eines Nachweises.

Die tatsächlich geltenden Anforderungen erfüllen

Dass eine Kategorie aufgeführt ist, bedeutet nicht, dass sie die Anforderungen für jedes Land, jeden Rufnummerntyp oder jede Kundenidentität erfüllt. Lesen Sie vor dem Hochladen von Nachweisen die geltenden Anforderungen und behandeln Sie die zurückgegebenen IDs als undurchsichtige Kennungen, aus denen Sie keine Bedeutung ableiten.

Anfrage

Verwenden Sie die Zugangsdaten Ihres freigeschalteten API-Kontos über HTTPS. Unterstützt werden die HTTP-Basisauthentifizierung und freigeschaltete Bearer-Token für API-Konten; Kontobeschränkungen gelten weiterhin.

GET mit etwaigen dokumentierten Parametern im URL-Pfad.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_proof_types"

Antwort

Prüfen Sie sowohl status.code im JSON-Antwortkörper als auch den HTTP-Status. response ist ein Array von Objekten mit id, name und entity_type. Diese Werte stammen aus dem aktuellen Nachweiskatalog. IDs sind undurchsichtige Kennungen; kopieren Sie sie, statt selbst eine zu konstruieren oder durch Hashing zu erzeugen. Auch ein leerer Katalog kann erfolgreich zurückgegeben werden. Leiten Sie aus diesem Beispiel keine vollständige Aufzählung der Entitätstypen ab, die Sie fest im Code hinterlegen.

Beispielhafte Antwortstruktur; keine aktuellen Kontodaten und kein aktuelles Preisangebot.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "PROOF_TYPE_ID_FROM_RESPONSE",
      "name": "Example proof category",
      "entity_type": "ENTITY_TYPE_FROM_RESPONSE"
    }
  ]
}

Fehler

  • Prüfen Sie status.code und status.msg auf Authentifizierungs- oder Dienstfehler. Ein erfolgreich zurückgegebener leerer Katalog bedeutet weder die Genehmigung eines Dokuments noch eine Befreiung von der Registrierungspflicht.

Verfügbarkeit und Nebenwirkungen

  • Diese Abfrage des Katalogs bzw. der Anforderungen erstellt keine Identität, lädt keinen Nachweis hoch, registriert keine Rufnummer und gibt keine Bestellung auf.
  • Eine erfolgreiche Katalogantwort bedeutet weder die Genehmigung Ihrer Dokumente noch die Bestätigung, dass eine ausgewählte Rufnummer aktiviert werden kann.