Endpunkte

Leads anlegen, Daten lesen und signierte PDFs herunterladen.

Create lead

POST /api/leads

Nach dem Anlegen leitet das Fremdsystem den Kunden auf signing_url. Details: Signing.

Pflichtfelder

Feld Typ Regel
name string max. 128 Zeichen
anschrift string max. 256 Zeichen
emailadresse string gültige E-Mail, max. 256 Zeichen
haltername string max. 128 Zeichen
halteranschrift string max. 256 Zeichen
eigenesKennzeichen string max. 128 Zeichen
hersteller string max. 128 Zeichen
modellundtyp string max. 128 Zeichen
motorisierung string max. 64 Zeichen
unfallDatum date YYYY-MM-DD
gegnerischesKennzeichen string max. 128 Zeichen

Optionale Felder

Feld Typ Regel
vorname string max. 128 Zeichen
rufnummer string max. 20 Zeichen
bankverbindung string max. 256 Zeichen
vorsteuerabzugsberechtigung boolean ja oder nein
istFahrzeugGeleast boolean ja oder nein
bankname string max. 128 Zeichen
leasingnummer string max. 128 Zeichen
vin string genau 17 Zeichen, VIN
hsn string genau 4 Zeichen
tsn string genau 3 Zeichen
kilometerstand number min. 1
erstzulassung date YYYY-MM-DD
anzahlVorbesitzer number min. 0
reifen string max. 64 Zeichen
motorart string E-Motor, Diesel oder Otto
garantieBis date YYYY-MM-DD
letzterService date YYYY-MM-DD
naechsterService date YYYY-MM-DD
vollkaskoVersicherung boolean ja oder nein
nameDerVKVersicherung string max. 128 Zeichen
polUnfallaufnahme boolean ja oder nein
unfallort string max. 128 Zeichen
unfallschilderung string max. 1000 Zeichen
warenSieFahrer boolean ja oder nein
fahrerdaten string max. 256 Zeichen
zeugenVorhanden boolean ja oder nein
zeugenName string max. 128 Zeichen
zeugenAnschrift string max. 256 Zeichen
verletzungen boolean ja oder nein
order_rechtsanwalt boolean ja oder nein
order_rechtsanwalt_id string UUID eines gelisteten Partners
order_gutachten boolean ja oder nein
order_gutachten_id string UUID eines gelisteten Partners
order_werkstatt boolean ja oder nein
order_werkstatt_id string UUID eines gelisteten Partners
webhook_url url gültige URL, nur dieser Lead

webhook_url gilt nur für diesen Lead. Ohne Override gilt die URL aus Integrationen. Siehe Webhooks.

Example request

{
  "name": "Mustermann",
  "vorname": "Max",
  "anschrift": "Musterstrasse 123, 10115 Berlin",
  "rufnummer": "+49123456789",
  "emailadresse": "max.mustermann@example.com",
  "haltername": "Max Mustermann",
  "halteranschrift": "Musterstrasse 123, 10115 Berlin",
  "eigenesKennzeichen": "B-MM-1234",
  "vin": "WVWZZZ1JZXW123456",
  "hsn": "0603",
  "tsn": "AGZ",
  "hersteller": "Volkswagen",
  "modellundtyp": "Golf 8",
  "motorisierung": "110",
  "erstzulassung": "2022-01-01",
  "anzahlVorbesitzer": 0,
  "unfallDatum": "2026-06-01",
  "gegnerischesKennzeichen": "M-AB-5678",
  "order_gutachten": true,
  "order_gutachten_id": "9b52d3f2-0000-4000-9000-000000000002"
}

Success response 201

{
  "success": true,
  "message": "Lead created successfully",
  "data": {
    "id": "9b52d3f2-0000-4000-9000-000000000010",
    "status": "pending",
    "signing_url": "https://blinkos.de/signieren/9b52d3f2-0000-4000-9000-000000000010"
  }
}

id is the UUID primary key of the lead.

On success BlinkOS also:

  1. Creates a pending contract for the token user.
  2. Creates additional pending contracts for ordered collaborator types.
  3. Sends database notifications to involved partners.
  4. Queues ApiLeadCreated to the customer email.
  5. Assigns additional contracts for involved partners.
  6. Records billing usage after commit.
  7. Queues webhook lead.created when a webhook URL is available.

Get lead

GET /api/leads/{lead}

Returns the case when the token user owns the lead or is a contract / additional-contract partner. Unknown or invisible leads return 404.

The payload includes customer, holder, vehicle, accident data, contract status, additional contracts, signing_url, and documents (only after PDFs exist).

Download document

GET /api/leads/{lead}/documents/{media}

Downloads a signed PDF belonging to that lead. Same visibility rules as GET /api/leads/{lead}. Use the download_url from the lead payload.