Elenca i log di identità

Elenca i log di verifica dell’identità, dal più recente. Filtri facoltativi: store, source, access (allowed o denied) e l’intervallo start/end. Paginare con limit e cursor facoltativo. Restituisce 403 se i log di identità non sono attivi per l’organizzazione.

GET/identity-logs

Autorizzazione

AuthorizationToken Bearer (chiave API) · headerobbligatorio

Chiave API dell'organizzazione.

Parametri query

storestring

Filtro per id negozio.

sourcestring

Filtro per tipo di documento (ad es. swiss_id_card, swiss_drivers_license_old, swiss_drivers_license_qr, passport).

accessstring

Filtro per esito dell’accesso.

Consentiti:alloweddenied

startstring<date-time>

Inizio dell’intervallo logDate, incluso. UTC con Z.

endstring<date-time>

Fine dell’intervallo logDate, inclusa. UTC con Z.

limitinteger

Dimensione della pagina (1–5000, predefinito 100).

min 1 · max 5000 · default: 100

cursorstring

Id documento opaco per la pagina successiva. Non analizzare. Seguire meta.nextCursor finché assente.

Risposte

200

Log di identità con meta

dataIdentityLog[]obbligatorio

Mostra proprietà

Array di IdentityLog

idstringobbligatorio

logTypestring

appVersionstring

accessboolean

Indica se l’accesso è stato concesso.

instancestring

logDatestring<date-time>

storestring

Id del negozio

sourcestring

userstring

birthDatestring<date-time>

imageUrlstring

rawTextstring

Dati grezzi MRZ / della scansione.

metaListMetaobbligatorio

Metadati dell'elenco. returned è la lunghezza di data. Le voci di catalogo eliminate (soft delete) sono escluse dagli elenchi — returned può essere minore di limit anche se esistono altre voci attive.

Mostra proprietà

totalintegerobbligatorio

Con ricerca prodotti (q): conteggio stimato dei risultati. Altrimenti uguale a returned. Può essere minore di limit quando voci eliminate sono state filtrate dalla pagina.

returnedintegerobbligatorio

Numero di elementi in data. Con includeDeleted=true (ordini) contano anche gli ordini eliminati.

limitintegerobbligatorio

Dimensione della pagina applicata.

offsetinteger

Solo per la ricerca prodotti con q.

nextCursorstring

Cursore opaco per la pagina successiva; passarlo invariato come cursor. Presente quando possono esistere altri risultati. Gli elementi eliminati (soft-delete) vengono filtrati dopo la lettura, quindi una pagina può essere più corta di limit anche con nextCursor presente. Mai restituito per categorie, fornitori e negozi, che non sono paginati.

400

Parametri o body non validi.

statusCodeintegerobbligatorio

Codice di stato HTTP

messagestringobbligatorio

Messaggio di errore leggibile

timestampstring<date-time>obbligatorio

Momento dell’errore (UTC).

pathstringobbligatorio

URL della richiesta (percorso e query string).

403

Chiave API rifiutata (vedi Forbidden) oppure log di identità non attivi per l’organizzazione (Feature not available).

statusCodeintegerobbligatorio

Codice di stato HTTP

messagestringobbligatorio

Messaggio di errore leggibile

timestampstring<date-time>obbligatorio

Momento dell’errore (UTC).

pathstringobbligatorio

URL della richiesta (percorso e query string).

Prova

Server

URL di baseURL di base personalizzatoSostituisce il server selezionato se impostato.

Autorizzazione

Token Bearer (chiave API)Ricorda su questo dispositivoUsa i miei valori negli esempi

Parametri

storequeryFiltro per id negozio.sourcequeryFiltro per tipo di documento (ad es. swiss_id_card, swiss_drivers_license_old, swiss_drivers_license_qr, passport).accessqueryFiltro per esito dell’accesso.startqueryInizio dell’intervallo `logDate`, incluso. UTC con `Z`.endqueryFine dell’intervallo `logDate`, inclusa. UTC con `Z`.limitqueryDimensione della pagina (1–5000, predefinito 100).cursorqueryId documento opaco per la pagina successiva. Non analizzare. Seguire `meta.nextCursor` finché assente.

Richiesta

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

Risposta

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