Identitätsprotokolle auflisten

Protokolle der Identitätsprüfung auflisten, neueste zuerst. Optionale Filter: store, source, access (allowed oder denied) und der Zeitraum start/end. Mit limit und optionalem cursor paginieren. Liefert 403, wenn Identitätsprotokolle für die Organisation nicht aktiviert sind.

GET/identity-logs

Autorisierung

AuthorizationBearer-Token (API-Key) · headererforderlich

Organisations-API-Key.

Query-Parameter

storestring

Filter nach Filial-ID.

sourcestring

Filter nach Ausweistyp (z. B. swiss_id_card, swiss_drivers_license_old, swiss_drivers_license_qr, passport).

accessstring

Filter nach Zutrittsentscheid.

Erlaubt:alloweddenied

startstring<date-time>

Beginn des logDate-Zeitraums, inklusive. UTC mit Z.

endstring<date-time>

Ende des logDate-Zeitraums, inklusive. UTC mit Z.

limitinteger

Seitengrösse (1–5000, Standard 100).

min 1 · max 5000 · default: 100

cursorstring

Opake Dokument-ID für die nächste Seite. Nicht parsen. meta.nextCursor folgen, bis es fehlt.

Antworten

200

Identitätsprotokolle mit Meta

dataIdentityLog[]erforderlich

Eigenschaften anzeigen

Array von IdentityLog

idstringerforderlich

logTypestring

appVersionstring

accessboolean

Ob der Zutritt gewährt wurde.

instancestring

logDatestring<date-time>

storestring

Filial-ID

sourcestring

userstring

birthDatestring<date-time>

imageUrlstring

rawTextstring

Rohdaten der MRZ bzw. des Scans.

metaListMetaerforderlich

Listen-Metadaten. returned ist die Länge von data. Soft-gelöschte Katalogeinträge fehlen in Listen — returned kann kleiner als limit sein, auch wenn noch aktive Einträge existieren.

Eigenschaften anzeigen

totalintegererforderlich

Bei Produktsuche (q): geschätzte Trefferanzahl. Sonst gleich returned. Kann kleiner als limit sein, wenn soft-gelöschte Einträge von der Seite gefiltert wurden.

returnedintegererforderlich

Anzahl Einträge in data. Mit includeDeleted=true (Bestellungen) zählen gelöschte Bestellungen mit.

limitintegererforderlich

Angewendete Seitengrösse.

offsetinteger

Nur bei Produktsuche mit q.

nextCursorstring

Opaker Cursor für die nächste Seite; unverändert als cursor übergeben. Vorhanden, wenn weitere Ergebnisse existieren können. Soft-gelöschte Einträge werden nach dem Lesen herausgefiltert, daher kann eine Seite kürzer als limit sein, obwohl nextCursor gesetzt ist. Bei Kategorien, Lieferanten und Filialen nie vorhanden, da diese nicht paginiert sind.

400

Ungültige Parameter oder ungültiger Body.

statusCodeintegererforderlich

HTTP-Statuscode

messagestringerforderlich

Lesbare Fehlermeldung

timestampstring<date-time>erforderlich

Zeitpunkt des Fehlers (UTC).

pathstringerforderlich

Request-URL (Pfad und Query-String).

403

API-Key abgelehnt (siehe Forbidden) oder Identitätsprotokolle sind für die Organisation nicht aktiviert (Feature not available).

statusCodeintegererforderlich

HTTP-Statuscode

messagestringerforderlich

Lesbare Fehlermeldung

timestampstring<date-time>erforderlich

Zeitpunkt des Fehlers (UTC).

pathstringerforderlich

Request-URL (Pfad und Query-String).

Ausprobieren

Server

Basis-URLEigene Basis-URLÜberschreibt den gewählten Server, wenn gesetzt.

Autorisierung

Bearer-Token (API-Key)Auf diesem Gerät merkenMeine Werte in Beispielen verwenden

Parameter

storequeryFilter nach Filial-ID.sourcequeryFilter nach Ausweistyp (z. B. swiss_id_card, swiss_drivers_license_old, swiss_drivers_license_qr, passport).accessqueryFilter nach Zutrittsentscheid.startqueryBeginn des `logDate`-Zeitraums, inklusive. UTC mit `Z`.endqueryEnde des `logDate`-Zeitraums, inklusive. UTC mit `Z`.limitquerySeitengrösse (1–5000, Standard 100).cursorqueryOpake Dokument-ID für die nächste Seite. Nicht parsen. `meta.nextCursor` folgen, bis es fehlt.

Anfrage

curl -X GET 'https://dashboard.scango.ch/api/v1/identity-logs' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://dashboard.scango.ch/api/v1/identity-logs", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://dashboard.scango.ch/api/v1/identity-logs",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://dashboard.scango.ch/api/v1/identity-logs',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
  ],
]);

$response = curl_exec($curl);

Antwort

{
  "data": [
    {
      "id": "log_01",
      "logType": "identity_check",
      "access": true,
      "store": "wattwil",
      "source": "passport",
      "logDate": "2024-04-20T12:00:00.000Z"
    }
  ],
  "meta": {
    "total": 1,
    "returned": 1,
    "limit": 1,
    "nextCursor": "log_02"
  }
}

{
  "statusCode": 400,
  "message": "Validation failed for Field: name, Error: Required",
  "timestamp": "2024-04-20T12:00:00.000Z",
  "path": "/api/v1/suppliers"
}

{
  "statusCode": 403,
  "message": "Feature not available",
  "timestamp": "2024-04-20T12:00:00.000Z",
  "path": "/api/v1/identity-logs"
}