Zum Inhalt springen
scango.ch
Deutsch
Esc
navigierenöffnen⌘JVorschau

List blocked identities

List blocked identities for the organization. Returns 403 if identity logs are not enabled for the organization.

GET/identity-logs/blocked
Autorisierung
AutorisierungBearer-Token (API key) · headererforderlich
Organisations-API-Key.
Query-Parameter
limitinteger
Page size (1–5000, default 100).
min 1 · max 5000 · default: 100
cursorstring
Opaque document id for the next page. Do not parse. Follow `meta.nextCursor` until it is absent.
Antworten
200Blocked identities with meta
dataBlockedIdentity[]erforderlich
Eigenschaften anzeigen
Array of BlockedIdentity
idstring
datestring<date-time>
Birth date stored on the blocked entry. Absent when no birth date was provided at create time.
commentstring
rawMrzstring
first_namestring
last_namestring
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 aktiver Einträge in `data` (soft-gelöschte ausgeschlossen).
limitintegererforderlich
Angewendete Seitengrösse.
offsetinteger
Nur bei Produktsuche mit `q`.
nextCursorstring
Opaker Cursor für die nächste Seite. Gesetzt, wenn weitere Ergebnisse möglich sind. Unverändert als `cursor` übergeben. Bei Soft-Delete- oder `store`-Filter bedeutet `returned < limit` nicht, dass die Liste zu Ende ist.
403Unauthorized, or identity logs not enabled for this organization
statusCodeintegererforderlich
HTTP-Statuscode
messagestringerforderlich
Lesbare Fehlermeldung
timestampstring<date-time>erforderlich
pathstringerforderlich
Request-Pfad
Anfrage
curl -X GET "https://dashboard.scango.ch/api/v1/identity-logs/blocked" \
  -H "Authorization: Bearer YOUR_TOKEN"
Antwort
{
  "data": [
    {
      "id": "string",
      "date": "2019-08-24T14:15:22Z",
      "comment": "string",
      "rawMrz": "string",
      "first_name": "string",
      "last_name": "string"
    }
  ],
  "meta": {
    "total": 0,
    "returned": 0,
    "limit": 0,
    "offset": 0,
    "nextCursor": "string"
  }
}