Lister les journaux d’identité

Liste les journaux de vérification d’identité, du plus récent au plus ancien. Filtres facultatifs : store, source, access (allowed ou denied) et la période start/end. Paginer avec limit et cursor facultatif. Renvoie 403 si les journaux d’identité ne sont pas activés pour l’organisation.

GET/identity-logs

Autorisation

AuthorizationJeton Bearer (clé API) · headerobligatoire

Clé API de l’organisation.

Paramètres de requête

storestring

Filtre par id de magasin.

sourcestring

Filtre par type de document (p. ex. swiss_id_card, swiss_drivers_license_old, swiss_drivers_license_qr, passport).

accessstring

Filtre par décision d’accès.

Autorisé:alloweddenied

startstring<date-time>

Début de la période logDate, inclus. UTC avec Z.

endstring<date-time>

Fin de la période logDate, incluse. UTC avec Z.

limitinteger

Taille de page (1–5000, défaut 100).

min 1 · max 5000 · default: 100

cursorstring

Identifiant opaque de document pour la page suivante. Ne pas analyser. Suivre meta.nextCursor jusqu'à son absence.

Réponses

200

Journaux d’identité avec meta

dataIdentityLog[]obligatoire

Afficher les propriétés

Tableau de IdentityLog

idstringobligatoire

logTypestring

appVersionstring

accessboolean

Indique si l’accès a été accordé.

instancestring

logDatestring<date-time>

storestring

Id du magasin

sourcestring

userstring

birthDatestring<date-time>

imageUrlstring

rawTextstring

Données brutes de la MRZ / du scan.

metaListMetaobligatoire

Métadonnées de liste. returned est la longueur de data. Les entrées de catalogue supprimées (soft delete) sont exclues des listes — returned peut être inférieur à limit même s'il reste des entrées actives.

Afficher les propriétés

totalintegerobligatoire

Avec recherche produit (q) : nombre estimé de correspondances. Sinon égal à returned. Peut être inférieur à limit lorsque des entrées supprimées ont été filtrées de la page.

returnedintegerobligatoire

Nombre d’éléments dans data. Avec includeDeleted=true (commandes), les commandes supprimées sont comptées.

limitintegerobligatoire

Taille de page appliquée.

offsetinteger

Uniquement pour la recherche produit avec q.

nextCursorstring

Curseur opaque pour la page suivante ; à transmettre tel quel dans cursor. Présent lorsque d’autres résultats peuvent exister. Les éléments supprimés logiquement sont filtrés après lecture, une page peut donc être plus courte que limit alors que nextCursor est présent. Jamais renvoyé pour les catégories, fournisseurs et magasins, qui ne sont pas paginés.

400

Paramètres ou corps invalides.

statusCodeintegerobligatoire

Code de statut HTTP

messagestringobligatoire

Message d’erreur lisible

timestampstring<date-time>obligatoire

Moment de l’erreur (UTC).

pathstringobligatoire

URL de la requête (chemin et chaîne de requête).

403

Clé API refusée (voir Forbidden), ou journaux d’identité non activés pour l’organisation (Feature not available).

statusCodeintegerobligatoire

Code de statut HTTP

messagestringobligatoire

Message d’erreur lisible

timestampstring<date-time>obligatoire

Moment de l’erreur (UTC).

pathstringobligatoire

URL de la requête (chemin et chaîne de requête).

Essayer

Serveur

URL de baseURL de base personnaliséeRemplace le serveur sélectionné si renseignée.

Autorisation

Jeton Bearer (clé API)Mémoriser sur cet appareilUtiliser mes valeurs dans les exemples

Paramètres

storequeryFiltre par id de magasin.sourcequeryFiltre par type de document (p. ex. swiss_id_card, swiss_drivers_license_old, swiss_drivers_license_qr, passport).accessqueryFiltre par décision d’accès.startqueryDébut de la période `logDate`, inclus. UTC avec `Z`.endqueryFin de la période `logDate`, incluse. UTC avec `Z`.limitqueryTaille de page (1–5000, défaut 100).cursorqueryIdentifiant opaque de document pour la page suivante. Ne pas analyser. Suivre `meta.nextCursor` jusqu'à son absence.

Requête

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

Réponse

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