Identität sperren

Identität sperren. Erfordert einen Write-Key. Liefert 403, wenn Identitätsprotokolle für die Organisation nicht aktiviert sind.

POST/identity-logs/blocked

Autorisierung

AuthorizationBearer-Token (API-Key) · headererforderlich

Organisations-API-Key.

Request-Body

erforderlichapplication/json

commentstringerforderlich

Grund der Sperre. Leerzeichen am Anfang und Ende werden entfernt; darf nicht leer sein.

min length 1

first_namestringerforderlich

min length 1

last_namestringerforderlich

min length 1

rawMrzstring

Optionale maschinenlesbare Zone (MRZ) des gescannten Ausweises.

min length 1

birthDatestring

Optionales Geburtsdatum: YYYY-MM-DD oder ISO-8601-Datum-Zeit mit Z oder numerischem Offset (z. B. 1990-01-01T00:00:00.000Z, 1990-01-01T12:00:00+02:00). Datum-Zeit-Werte ohne Zeitzone werden abgelehnt. Fehlt es oder ist es leer, wird kein Geburtsdatum gespeichert.

Antworten

200

Erstellt

successbooleanerforderlich

idstringerforderlich

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

Bodyapplication/json

commentstring*Grund der Sperre. Leerzeichen am Anfang und Ende werden entfernt; darf nicht leer sein.first_namestring*last_namestring*rawMrzstringOptionale maschinenlesbare Zone (MRZ) des gescannten Ausweises.birthDatestringOptionales Geburtsdatum: `YYYY-MM-DD` oder ISO-8601-Datum-Zeit mit `Z` oder numerischem Offset (z. B. `1990-01-01T00:00:00.000Z`, `1990-01-01T12:00:00+02:00`). Datum-Zeit-Werte ohne Zeitzone werden abgelehnt. Fehlt es oder ist es leer, wird kein Geburtsdatum gespeichert.

Anfrage

curl -X POST 'https://dashboard.scango.ch/api/v1/identity-logs/blocked' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "comment": "Blocked at door",
  "first_name": "Ada",
  "last_name": "Lovelace",
  "rawMrz": "P<CHELOVELACE<<ADA<<<<<<<<<<<<<<<<<<<",
  "birthDate": "1990-01-01"
}'

const response = await fetch("https://dashboard.scango.ch/api/v1/identity-logs/blocked", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"comment\": \"Blocked at door\",\n  \"first_name\": \"Ada\",\n  \"last_name\": \"Lovelace\",\n  \"rawMrz\": \"P<CHELOVELACE<<ADA<<<<<<<<<<<<<<<<<<<\",\n  \"birthDate\": \"1990-01-01\"\n}"
});

import requests

response = requests.post(
    "https://dashboard.scango.ch/api/v1/identity-logs/blocked",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"comment\": \"Blocked at door\",\n  \"first_name\": \"Ada\",\n  \"last_name\": \"Lovelace\",\n  \"rawMrz\": \"P<CHELOVELACE<<ADA<<<<<<<<<<<<<<<<<<<\",\n  \"birthDate\": \"1990-01-01\"\n}",
)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://dashboard.scango.ch/api/v1/identity-logs/blocked',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "comment": "Blocked at door",
  "first_name": "Ada",
  "last_name": "Lovelace",
  "rawMrz": "P<CHELOVELACE<<ADA<<<<<<<<<<<<<<<<<<<",
  "birthDate": "1990-01-01"
}',
]);

$response = curl_exec($curl);

Antwort

{
  "success": true,
  "id": "blk_01"
}

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