List identity logs

List identity verification logs, newest first. Optional filters: store, source, access (allowed or denied), and ISO date range start/end. Use limit and optional cursor for pagination. Returns 403 if identity logs are not enabled for the organization.

GET/identity-logs

Authorization

AuthorizationBearer token (API key) · headerrequired

Organization API key.

Query parameters

storestring

Store id filter.

sourcestring

Document source filter (e.g. swiss_id_card, swiss_drivers_license_old, swiss_drivers_license_qr, passport).

accessstring

Access decision filter.

Allowed:alloweddenied

startstring<date-time>

Start of the logDate range, inclusive. UTC with Z suffix.

endstring<date-time>

End of the logDate range, inclusive. UTC with Z suffix.

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.

Responses

200

Identity logs with meta

dataIdentityLog[]required

Show properties

Array of IdentityLog

idstringrequired

logTypestring

appVersionstring

accessboolean

Whether access was granted.

instancestring

logDatestring<date-time>

storestring

Store id

sourcestring

userstring

birthDatestring<date-time>

imageUrlstring

rawTextstring

Raw MRZ / scan payload.

metaListMetarequired

List metadata. returned is the length of data. Soft-deleted catalog rows are omitted from list results, so returned may be less than limit even when more active items exist. When nextCursor is present, more pages may exist — keep paging until nextCursor is absent.

Show properties

totalintegerrequired

With product search (q) without store: estimated match count. With store: equals returned after store visibility filtering. Otherwise equals returned. Soft-deleted items are omitted, so a page may be shorter than limit even when more active items exist.

returnedintegerrequired

Number of items in data. With includeDeleted=true (orders), deleted orders count too.

limitintegerrequired

Applied page size.

offsetinteger

Only for product search with q.

nextCursorstring

Opaque cursor for the next page; pass it unchanged as cursor. Present when more results may exist. Soft-deleted rows are filtered out after reading, so a page can be shorter than limit while nextCursor is set. Never returned for categories, suppliers and stores, which are not paginated.

400

Invalid parameters or body.

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

403

API key rejected (see Forbidden), or identity logs are not enabled for the organization (Feature not available).

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (API key)Remember on this deviceInclude my values in samples

Parameters

storequeryStore id filter.sourcequeryDocument source filter (e.g. swiss_id_card, swiss_drivers_license_old, swiss_drivers_license_qr, passport).accessqueryAccess decision filter.startqueryStart of the `logDate` range, inclusive. UTC with `Z` suffix.endqueryEnd of the `logDate` range, inclusive. UTC with `Z` suffix.limitqueryPage size (1–5000, default 100).cursorqueryOpaque document id for the next page. Do not parse. Follow `meta.nextCursor` until it is absent.

Request

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);

Response

{
  "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"
}