Dokumentation

Grundlagen

Der Antragslebenszyklus

Statuswerte für Anlage, Signatur, Bearbeitung und Ergebnis eines Antrags.

Vier Phasen

  1. 01

    1. Anlage

    Die API validiert und speichert den Antrag. Abhängig vom Vorgang folgt preparing_signature, awaiting_signature oder direkt processing.

  2. 02

    2. Signatur

    Bei next_action.type: wait_for_signature_link wird die URL noch vorbereitet. sign_application liefert anschließend die geschützte Signatur-URL.

  3. 03

    3. Bearbeitung

    Nach der Signatur oder bei einem Vorgang ohne Signaturpflicht wechselt der Antrag zu processing.

  4. 04

    4. Ergebnis

    succeeded kennzeichnet Erfolg, failed eine fachliche Ablehnung oder einen Fehlschlag; die Behördenquittung steht dann in results.authority_status. manual_review verlangt eine manuelle Prüfung.

next_action auswerten

Wenn Ihr System handeln muss, liefert next_action den konkreten Typ. Verzweigen Sie auf next_action.type und nicht auf den Anzeigetext status_details.label. Ein fehlendes next_action-Feld bedeutet, dass die API gerade keine Clientaktion verlangt.

Terminale Zustände

StatusBedeutungWeiteres Polling
succeededAntrag erfolgreich; Ergebnis, Dokumente und Gebühren abrufen.Nur bei eigener Synchronisationsstrategie.
failedAntrag fehlgeschlagen; Ursache auswerten.Nein.

HTTP-Status und Antragsstatus

Zum Öffnen eines Treffers Enter drücken.