API-Schlüssel und programmatischer Zugriff

Wenn Sie bereits ein CRM, ein Fallverwaltungssystem oder ein eigenes Portal betreiben, müssen Sie sich nicht für jedes Formular durch das Dashboard klicken. Mit API-Schlüsseln ruft Ihr Backend die v1-API von DS160.io direkt auf – es erstellt Formulare, klont sie und erzeugt Kundenerfassungslinks nach Ihrem Zeitplan. Diese Seite führt Sie von einem neuen Schlüssel zu Ihrem ersten Formular und Kundenlink und dokumentiert anschließend jeden Endpunkt.

Bevor Sie beginnen

• Ein Business-Arbeitsbereich. API-Schlüssel gibt es in Business-Arbeitsbereichen. Jeder Schlüssel ist an einen Arbeitsbereich gebunden und kann nur in diesem handeln.
• Inhaber- oder Administratorzugriff. Nur Inhaber und Administratoren des Arbeitsbereichs können Schlüssel erstellen.
• Formularguthaben. Das Erstellen oder Klonen eines Formulars über die API verbraucht ein Formularguthaben, genau wie im Dashboard.
• Ein Secrets-Manager. Das Geheimnis des Schlüssels wird nur einmal angezeigt, beim Erstellen.
• Ratenlimit: 60 Anfragen pro Minute und Schlüssel.

Schnellstart

1. Erstellen Sie einen Schlüssel unter Arbeitsbereichseinstellungen → Team und Zugriff → API-Schlüssel mit den Berechtigungen, die Ihre Integration braucht, und kopieren Sie sein Geheimnis.
2. Authentifizieren Sie jeden Aufruf mit einem Header Authorization: Bearer <secret>, gegen https://www.ds160.io/api/v1/workspaces/<workspaceId>/….
3. Erstellen Sie ein Formular mit POST /forms und speichern Sie die zurückgegebene formId.
4. Erzeugen Sie einen Kundenerfassungslink mit POST /forms/:formId/client-links und senden Sie dessen url an den Antragsteller.
5. Fragen Sie GET /forms/:formId ab, bis der status des Formulars completed ist.

Jeder Schritt wird unten ausführlich behandelt, und das durchgängige Beispiel fügt sie zusammen.

Erwartetes Ergebnis

Ihr Backend erstellt Formulare und Kundenlinks im Arbeitsbereich, ohne dass jemand das Dashboard öffnet. Die Formulare liegen im Arbeitsbereich wie alle anderen, und die Spalte Zuletzt verwendet der Liste der API-Schlüssel zeigt, dass der Schlüssel in Gebrauch ist.

Basis-URL der API

Alle v1-Endpunkte liegen unter:

https://www.ds160.io/api/v1

Diese Dokumentation kann auf der White-Label-Domain Ihrer Agentur gehostet sein, aber API-Aufrufe gehen immer an www.ds160.io. Jedes Codebeispiel auf dieser Seite verwendet die vollständige URL, damit Sie es ohne Anpassung kopieren können.

Endpunktreferenz

/v1 ist stabil – Pfade und Feldnamen ändern sich nicht ohne eine neue Hauptversion /v2 (siehe Versionierung und Support). Die Pfade in der Tabelle unten sind relativ zum Arbeitsbereichspräfix /workspaces/:workspaceId/ angegeben; die vollständigen Anfrage- und Antwortstrukturen sind im Abschnitt des jeweiligen Endpunkts dokumentiert.

Alle Anfragekörper und Antworten sind JSON. Die Berechtigung forms:read gewährt nur lesenden Zugriff auf Formularmetadaten; forms:write gewährt Lesen und Schreiben, sodass ein Schlüssel, der nur schreibt, den Lesezugriff ohnehin hat.

1. Einen API-Schlüssel erstellen

Öffnen Sie Arbeitsbereichseinstellungen → Team und Zugriff → API-Schlüssel und klicken Sie auf API-Schlüssel erstellen. Wählen Sie einen aussagekräftigen Namen (wir empfehlen einen Schlüssel pro Integration, z. B. Produktiv-CRM oder Staging-Webhook-Handler) und dann die Berechtigungen, die die Integration braucht:

• forms:read – nur Formularmetadaten lesen (auflisten / abrufen)
• forms:write – Formulare erstellen; gewährt auch Lesen
• forms:clone – ein vorhandenes Formular in ein neues duplizieren
• client-links:write – Kundenerfassungslinks erzeugen

Nur Inhaber und Administratoren des Arbeitsbereichs können Schlüssel erstellen.

Wenn Sie auf Schlüssel erstellen klicken, zeigt Ihnen die Plattform das vollständige Geheimnis einmal an. Kopieren Sie es sofort in Ihren Secrets-Manager – nachdem sich dieses Fenster geschlossen hat, werden nur noch die letzten vier Zeichen angezeigt. Wenn Sie einen Schlüssel verlieren, widerrufen Sie ihn und erstellen Sie einen neuen.

2. Authentifizieren

Alle v1-Endpunkte erwarten einen Header Authorization: Bearer <secret>.

export DS160_KEY="...the secret you just copied..."
export DS160_WORKSPACE="your-workspace-id"

curl https://www.ds160.io/api/v1/workspaces/$DS160_WORKSPACE/forms \
  -H "Authorization: Bearer $DS160_KEY"

const key = process.env.DS160_KEY;
const workspaceId = process.env.DS160_WORKSPACE;

const response = await fetch(`https://www.ds160.io/api/v1/workspaces/${workspaceId}/forms`, {
    headers: { Authorization: `Bearer ${key}` },
});
const { forms } = await response.json();

import os
import requests

key = os.environ["DS160_KEY"]
workspace_id = os.environ["DS160_WORKSPACE"]

response = requests.get(
    f"https://www.ds160.io/api/v1/workspaces/{workspace_id}/forms",
    headers={"Authorization": f"Bearer {key}"},
)
forms = response.json()["forms"]

Die Arbeitsbereichs-ID steht in der URL jeder Dashboard-Seite (/workspaces/<workspaceId>/...). Der Arbeitsbereich des Schlüssels wird serverseitig gebunden – ein Aufruf des Endpunkts eines anderen Arbeitsbereichs mit dem falschen Schlüssel liefert 403 Forbidden.

Tipp: Die Sprach-Tabs sind über alle Codebeispiele dieser Seite synchronisiert. Wählen Sie Ihre Sprache einmal, und der Rest der Seite folgt.

3. Ein Formular erstellen

curl -X POST https://www.ds160.io/api/v1/workspaces/$DS160_WORKSPACE/forms \
  -H "Authorization: Bearer $DS160_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Smith / B1 — 2026-05" }'
# → { "formId": "65f2…" }

const response = await fetch(
    `https://www.ds160.io/api/v1/workspaces/${workspaceId}/forms`,
    {
        method: "POST",
        headers: {
            Authorization: `Bearer ${key}`,
            "Content-Type": "application/json",
        },
        body: JSON.stringify({ name: "Smith / B1 — 2026-05" }),
    }
);
const { formId } = await response.json();

response = requests.post(
    f"https://www.ds160.io/api/v1/workspaces/{workspace_id}/forms",
    headers={
        "Authorization": f"Bearer {key}",
        "Content-Type": "application/json",
    },
    json={"name": "Smith / B1 — 2026-05"},
)
form_id = response.json()["formId"]

Jeder Aufruf verbraucht ein Formularguthaben aus Ihrem Abrechnungsplan (genau wie das Erstellen eines Formulars im Dashboard). Hat Ihr Arbeitsbereich kein Guthaben mehr, liefert der Aufruf 402 Payment Required – laden Sie Guthaben auf, bevor Sie es erneut versuchen.

Das optionale Feld name legt eine lesbare Bezeichnung für das Formular fest (bis zu 200 Zeichen). Lassen Sie es weg, um einen automatisch erzeugten Namen zu erhalten – in beiden Fällen können Sie das Formular später im Dashboard umbenennen.

4. Ein vorhandenes Formular klonen

Wenn Sie ein Vorlageformular haben, das Sie häufig erneut ausgeben (etwa das J-1-Programm desselben Arbeitgebers), klonen Sie es, statt bei null anzufangen. Optional übergeben Sie disabledSections, um bestimmte Formularseiten von der Kopie auszunehmen – alles, was Sie aufführen, wird im neuen Formular durch leere Felder ersetzt, sodass der Kunde es neu ausfüllt:

curl -X POST https://www.ds160.io/api/v1/workspaces/$DS160_WORKSPACE/forms/$SOURCE_FORM_ID/clone \
  -H "Authorization: Bearer $DS160_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "disabledSections": ["spouse-info-page", "security-background-page-5"] }'
# → { "formId": "65f3…" }

const response = await fetch(
    `https://www.ds160.io/api/v1/workspaces/${workspaceId}/forms/${sourceFormId}/clone`,
    {
        method: "POST",
        headers: {
            Authorization: `Bearer ${key}`,
            "Content-Type": "application/json",
        },
        body: JSON.stringify({
            disabledSections: ["spouse-info-page", "security-background-page-5"],
        }),
    }
);
const { formId } = await response.json();

response = requests.post(
    f"https://www.ds160.io/api/v1/workspaces/{workspace_id}/forms/{source_form_id}/clone",
    headers={
        "Authorization": f"Bearer {key}",
        "Content-Type": "application/json",
    },
    json={"disabledSections": ["spouse-info-page", "security-background-page-5"]},
)
form_id = response.json()["formId"]

Das Klonen verbraucht ein Formularguthaben, genau wie das Erstellen eines neuen Formulars.

Gültige Werte für disabledSections

Übergeben Sie ein leeres Array (oder lassen Sie das Feld ganz weg), um jede Seite zu kopieren. Andernfalls verwenden Sie eine beliebige Kombination der folgenden Bezeichner – alles andere liefert 400 Bad Request.

Nur die für die Visumkategorie des Formulars relevanten Abschnitte sind tatsächlich vorhanden; eine Seite aufzuführen, die im Quellformular nicht vorkommt, hat keine Wirkung.

5. Einen Kundenerfassungslink erzeugen

Sobald ein Formular existiert, erzeugen Sie eine URL mit Token, über die der Kunde es ausfüllen kann:

curl -X POST https://www.ds160.io/api/v1/workspaces/$DS160_WORKSPACE/forms/$FORM_ID/client-links \
  -H "Authorization: Bearer $DS160_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "expiresInDays": 7, "defaultLanguage": "en" }'

const response = await fetch(
    `https://www.ds160.io/api/v1/workspaces/${workspaceId}/forms/${formId}/client-links`,
    {
        method: "POST",
        headers: {
            Authorization: `Bearer ${key}`,
            "Content-Type": "application/json",
        },
        body: JSON.stringify({ expiresInDays: 7, defaultLanguage: "en" }),
    }
);
const { url, token, expiresAt } = await response.json();

response = requests.post(
    f"https://www.ds160.io/api/v1/workspaces/{workspace_id}/forms/{form_id}/client-links",
    headers={
        "Authorization": f"Bearer {key}",
        "Content-Type": "application/json",
    },
    json={"expiresInDays": 7, "defaultLanguage": "en"},
)
link = response.json()
# link["url"], link["token"], link["expiresAt"]

Anfragekörper

Beispielantwort (200 OK)

{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI2NmMxYmQ0ZjZmNGFkNTQwMzMxNDhmYmEiLCJmb3JtSWQiOiI2NWYyYTkxMTNkZjAxYzAwMTI3YjY4MmEiLCJ3b3Jrc3BhY2VJZCI6IjY1ZjJhOTAwM2RmMDFjMDAxMjdiNjgwYSIsImV4cCI6MTc0ODA0ODI0NywiaWF0IjoxNzQ3NDQzNDQ3LCJkZWZhdWx0TGFuZ3VhZ2UiOiJlbiIsImhpZGVCcmFuZGluZyI6ZmFsc2V9.SiGNATuRe",
    "url": "https://intake.your-agency.com/client-intake/65f2a9113df01c00127b682a?token=eyJhbGciOi…",
    "shortUrl": "https://intake.your-agency.com/c/Ab3dE7gH9jKm?s=api",
    "expiresAt": "2026-05-24T01:50:46.000Z"
}

Senden Sie die url an Ihren Kunden. Das Token in der URL dient nur diesem Zweck und läuft zu expiresAt ab – der Kunde braucht keine weitere Authentifizierung, um das Formular auszufüllen. Oder senden Sie die shortUrl, die denselben Link öffnet.

Einen Kundenerfassungslink widerrufen

Es gibt keinen v1-Endpunkt zum Widerrufen ausgegebener Kundenlinks – widerrufen Sie im Dashboard (Arbeitsbereich → Formular → Teilen → Link widerrufen). Der Widerruf wirkt sofort und dauerhaft: Die nächste Anfrage des Links liefert 401. Besteht der Verdacht auf ein Datenleck und ist niemand verfügbar, der in der Oberfläche widerrufen kann, ist die sicherste Lösung, den Link ablaufen zu lassen (begrenzen Sie expiresInDays entsprechend).

Gültige Werte für defaultLanguage

defaultLanguage bestimmt die Sprache der Kundenerfassungsoberfläche, wenn der Empfänger den Link zum ersten Mal öffnet. Verwenden Sie einen der folgenden Codes – alles andere liefert 400 Bad Request. Die Kurzcodes (en, cn, …) sind die internen Sprachkennungen von DS160.io; die Spalte BCP-47 zeigt, was wir in <html lang>, hreflang und den Intl.*-APIs ausgeben. Verwenden Sie in API-Anfragen den Kurzcode; die BCP-47-Form dient nur zur Information.

Behandeln Sie Kundenlinks wie Passwörter

Die url ist ein Inhaber-Zugangsnachweis – wer sie besitzt, kann das Formular bis zum Ablauf ausfüllen, ohne zweiten Faktor.

• Senden Sie sie über einen vertrauenswürdigen Kanal; veröffentlichen Sie sie nicht an Orten, an denen sie durchsickern könnte (öffentliche Chats, von Suchmaschinen indexierte Seiten, geteilte Bundles).
• Schwärzen Sie ?token= in Logs. Der Claim jti allein kann sicher protokolliert werden.
• Widerrufen Sie bei Verdacht auf ein Leck – der Widerruf wirkt sofort und dauerhaft.
• expiresInDays ist eine Abwägung: kürzer = kleineres Zeitfenster für ein Leck, länger = weniger Aufwand für Neuausgaben.

6. Formulare auflisten oder abrufen

# All forms in the workspace
curl https://www.ds160.io/api/v1/workspaces/$DS160_WORKSPACE/forms \
  -H "Authorization: Bearer $DS160_KEY"

# A single form by id
curl https://www.ds160.io/api/v1/workspaces/$DS160_WORKSPACE/forms/$FORM_ID \
  -H "Authorization: Bearer $DS160_KEY"

// All forms in the workspace
const listResponse = await fetch(`https://www.ds160.io/api/v1/workspaces/${workspaceId}/forms`, {
    headers: { Authorization: `Bearer ${key}` },
});
const { forms } = await listResponse.json();

// A single form by id
const formResponse = await fetch(`https://www.ds160.io/api/v1/workspaces/${workspaceId}/forms/${formId}`, {
    headers: { Authorization: `Bearer ${key}` },
});
const form = await formResponse.json();

# All forms in the workspace
forms = requests.get(
    f"https://www.ds160.io/api/v1/workspaces/{workspace_id}/forms",
    headers={"Authorization": f"Bearer {key}"},
).json()["forms"]

# A single form by id
form = requests.get(
    f"https://www.ds160.io/api/v1/workspaces/{workspace_id}/forms/{form_id}",
    headers={"Authorization": f"Bearer {key}"},
).json()

Diese Lese-Endpunkte akzeptieren die Berechtigung forms:read (nur Lesen) oder forms:write (die auch Lesen gewährt).

Paginierung

GET /v1/workspaces/:workspaceId/forms ist paginiert. Übergeben Sie die Query-Parameter ?limit= und ?cursor=, um durch die Ergebnisse zu blättern:

Jede Antwort enthält ein Feld nextCursor. Gibt es keine weiteren Seiten, ist nextCursor null. Beispiel:

{
    "forms": [
        { "id": "65f2a911…", "name": "Smith / B1", "status": "in_progress", "workspaceId": "65f2a900…", "userId": "65f2a8f0…", "preferredConsulate": null, "createdAt": "2026-05-14T09:12:33.000Z", "archivedAt": null },
        { "id": "65f2a8a3…", "name": "Garcia / F1", "status": "completed", "workspaceId": "65f2a900…", "userId": "65f2a8f0…", "preferredConsulate": "MAD", "createdAt": "2026-05-13T18:01:09.000Z", "archivedAt": null }
    ],
    "nextCursor": "65f2a8a3…"
}

Blättern Sie weiter, indem Sie bei der nächsten Anfrage ?cursor=65f2a8a3…&limit=50 senden. Formulare sind nach id absteigend sortiert, das neueste zuerst, sodass ein Cursor Ihre Leseposition festhält, auch wenn zwischen den Aufrufen neue Formulare erstellt werden – Sie sehen keine Duplikate und verpassen nichts, was zu Beginn des Blätterns existierte.

Werte für den Formular-status

Das Feld status in jeder Antwort mit Formularmetadaten hat einen dieser Werte:

Das Übertragungsformat verwendet Unterstriche (in_progress, nicht in-progress). Ein Vergleich mit den obigen Zeichenketten in genau dieser Form funktioniert immer.

Zugriff auf personenbezogene Daten über die API

Die v1-Endpunkte für Formularmetadaten (GET /workspaces/:workspaceId/forms und GET /workspaces/:workspaceId/forms/:formId) liefern nur betriebliche Metadaten: id, name, status, workspaceId, userId, preferredConsulate, createdAt, archivedAt und beim Endpunkt für ein einzelnes Formular applicantConsent (die neueste Einwilligung des Kunden über einen Link, der sie verlangt hat: acceptedAt, withdrawnAt und noticeVersion, oder null). Sie geben die Antworten des Antragstellers nicht preis – keine Namen, Geburtsdaten, Passnummern, Reisehistorie oder sonstigen DS-160-Felder sind über /v1 erreichbar.

Ausgefüllte DS-160-PDFs und vollständige Felddaten sind nur über das Dashboard zugänglich, unter dem Eigentümer des Antragstellers mit Prüfprotokoll. Wenn Ihre Integration vom Antragsteller eingegebene Daten lesen muss, tun Sie das über Ihren eigenen Erfassungsprozess (Ihr CRM erfasst die Daten zuerst, Sie übertragen sie in DS160.io) – gehen Sie nie davon aus, dass die API sie zurückgibt.

Ratenlimits

Jeder Schlüssel ist auf 60 Anfragen pro Minute begrenzt. Jede Antwort enthält:

Überschreiten Sie das Limit, liefert die API 429 Too Many Requests mit einem Header Retry-After. Braucht Ihre Integration berechtigterweise eine höhere Obergrenze, wenden Sie sich an den Support – wir können das Limit für bestimmte Schlüssel anheben.

Idempotenz und Wiederholungen

Die v1-API unterstützt keinen Header Idempotency-Key. Konkret:

• POST /forms und POST /forms/:formId/clone sind nicht idempotent und verbrauchen bei jedem Aufruf ein Formularguthaben. Eine naive Wiederholung nach einer Netzwerk-Zeitüberschreitung erstellt ein doppeltes Formular und verbraucht ein zweites Guthaben.
• POST /forms/:formId/client-links ist ebenfalls nicht idempotent, verbraucht aber kein Guthaben – ein wiederholter Aufruf erstellt einfach einen zweiten Link mit eigenem jti und expiresAt.
• Alle GET-Endpunkte können bedenkenlos wiederholt werden.

Empfohlenes Wiederholungsmuster für Erstellen/Klonen: Wenn bei POST /forms (oder /clone) eine Zeitüberschreitung auftritt oder ein 5xx geliefert wird, wiederholen Sie nicht blind. Rufen Sie stattdessen GET /workspaces/:workspaceId/forms auf (Formulare sind das neueste zuerst sortiert) und prüfen Sie, ob in den letzten Sekunden ein Formular mit dem von Ihnen angegebenen name erstellt wurde. Falls ja, betrachten Sie den ursprünglichen Aufruf als erfolgreich und überspringen Sie die Wiederholung. Falls nicht, ist der ursprüngliche Schreibvorgang sicher nicht angekommen, und eine Wiederholung ist unbedenklich.

Möglicherweise unterstützen wir Idempotency-Key in einer künftigen Nebenversion; Integrationen sollten das einplanen, sich heute aber nicht darauf verlassen.

Einen Schlüssel widerrufen

Wenn ein Schlüssel offengelegt wurde, ausgedient hat oder einfach nicht genutzt wird, widerrufen Sie ihn unter Arbeitsbereichseinstellungen → Team und Zugriff → API-Schlüssel → Widerrufen. Der Widerruf wirkt sofort – die nächste Anfrage des Schlüssels liefert 401 Unauthorized. Widerrufene Schlüssel bleiben zu Prüfzwecken in der Liste, können aber nicht reaktiviert werden; erstellen Sie einen neuen, wenn die Integration weiterlaufen soll.

Bewährte Vorgehensweisen

• Ein Schlüssel pro Integration. So lässt er sich gezielt widerrufen, wenn ein System außer Betrieb geht, und die Spalte Last used im Dashboard zeigt Ihnen, welche Integrationen noch aktiv sind.
• Minimale Berechtigungen. Ein Schlüssel, der nur Kundenlinks erzeugt, sollte kein forms:clone haben. Kleinere Berechtigungen bedeuten geringeren Schaden, falls das Geheimnis durchsickert.
• Bewahren Sie Geheimnisse in einem Tresor auf. Committen Sie sie nie in die Versionsverwaltung und betten Sie sie nie in ein Frontend-Bundle ein – jeder Browser-Tab würde sie offenlegen.
• Rotieren Sie regelmäßig. Erstellen Sie einen neuen Schlüssel, stellen Sie die Integration um und widerrufen Sie dann den alten. Das Dashboard zeigt, wann ein Schlüssel zuletzt verwendet wurde, sodass Sie die Umstellung vor dem Widerruf bestätigen können.

Fehler

Alle Antworten außerhalb von 2xx haben dieselbe JSON-Struktur:

{ "error": "human-readable message" }

Der Wert von error ist eine Zeichenkette. Bei 400 Bad Request aus der Schemaprüfung ist es ein serialisiertes JSON-Array, das jede verletzte Bedingung beschreibt; in allen anderen Fällen ist es eine kurze Meldung, die Sie direkt anzeigen oder protokollieren können.

Durchgängiges Beispiel

Ein vollständiger Erfassungsablauf – ein Formular erstellen, einen Kundenlink erzeugen, ihn senden und auf den Abschluss prüfen – mit curl. Echte Integrationen verwenden ihren eigenen HTTP-Client; die Struktur ist in jeder Sprache dieselbe.

# 0. credentials (set once)
export DS160_KEY="..."
export DS160_WORKSPACE="65f2a900..."

# 1. Create a form. Capture the formId from the response.
FORM_ID=$(curl -s -X POST \
  https://www.ds160.io/api/v1/workspaces/$DS160_WORKSPACE/forms \
  -H "Authorization: Bearer $DS160_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Smith / B1 — 2026-05" }' \
  | jq -r .formId)

# 2. Mint a client intake link valid for 14 days.
LINK_JSON=$(curl -s -X POST \
  https://www.ds160.io/api/v1/workspaces/$DS160_WORKSPACE/forms/$FORM_ID/client-links \
  -H "Authorization: Bearer $DS160_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "expiresInDays": 14, "defaultLanguage": "en" }')

CLIENT_URL=$(echo "$LINK_JSON" | jq -r .url)

# 3. Send $CLIENT_URL to the applicant through your usual channel
#    (email, secure portal, etc.). The applicant fills in the form.

# 4. Poll for completion. Status transitions:
#    not_started → in_progress → completed
curl -s https://www.ds160.io/api/v1/workspaces/$DS160_WORKSPACE/forms/$FORM_ID \
  -H "Authorization: Bearer $DS160_KEY" \
  | jq .status
# → "completed" when the applicant has finished

# 5. Download the DS-160 PDF from the dashboard
#    (no v1 endpoint for this today).

Einige Hinweise zu diesem Ablauf:

• Abfrageintervall: alle 5–15 Minuten genügt völlig. Mit einer Obergrenze von 60 Anfragen/Min. kann ein einzelner Schlüssel problemlos Tausende laufender Formulare abfragen.
• Webhooks sind noch nicht verfügbar. Wenn Sie Push-Benachrichtigungen beim Abschluss brauchen, behalten Sie diese Seite im Blick oder wenden Sie sich an den Support – sie stehen auf der Roadmap.
• Schritt 5 (das ausgefüllte PDF herunterladen) erfordert heute eine Dashboard-Sitzung. Die v1-API gibt Antworten des Antragstellers bewusst nicht preis – siehe Zugriff auf personenbezogene Daten über die API.

Versionierung und Support

Stabilität. /v1 ist die stabile API-Oberfläche. Innerhalb von /v1 fügen wir neue optionale Felder, neue Endpunkte und neue Enum-Werte hinzu, ohne die Hauptversion zu erhöhen, aber wir benennen keine bestehenden Felder um, entfernen sie nicht und ändern nicht ihren Typ. Sollte je eine inkompatible Änderung nötig sein, erscheint sie unter /v2, und /v1 funktioniert daneben mindestens 12 Monate weiter.

Abwärtskompatible Ergänzungen, die Sie einplanen sollten:

• Mit der Zeit kommen neue optionale Anfragefelder hinzu. Bestehende Anfragen, die sie nicht senden, funktionieren weiter.
• Es können neue Antwortfelder hinzukommen. Behandeln Sie unbekannte Felder als ignorierbar – brechen Sie nicht ab, wenn ein künftiges Feld auftaucht.
• Es werden neue Enum-Werte für status, defaultLanguage und disabledSections hinzukommen. Stürzen Sie bei unbekannten Werten nicht ab; protokollieren Sie sie und fahren Sie fort.

Support:

• Höhere Ratenlimits, eigene Domains, früher Zugang zu Webhooks und Fragen zur Integration: Wenden Sie sich an Ihren Account Manager oder an support@ds160.io.
• Fehlermeldungen zur v1-API: dieselbe Adresse. Jede Antwort enthält einen Header x-request-id – geben Sie ihn in Ihrer Meldung an, damit wir den genauen Aufruf in unseren Logs finden.

Fehlerbehebung

Die error-Meldung jedes Fehlers und was zu tun ist: