Blocca identità

Aggiunge un’identità bloccata. Richiede una chiave Write. Restituisce 403 se i log di identità non sono attivi per l’organizzazione.

POST/identity-logs/blocked

Autorizzazione

AuthorizationToken Bearer (chiave API) · headerobbligatorio

Chiave API dell'organizzazione.

Corpo della richiesta

obbligatorioapplication/json

commentstringobbligatorio

Motivo del blocco. Gli spazi iniziali e finali vengono rimossi; non può essere vuoto.

min length 1

first_namestringobbligatorio

min length 1

last_namestringobbligatorio

min length 1

rawMrzstring

Zona a lettura ottica (MRZ) facoltativa del documento scansionato.

min length 1

birthDatestring

Data di nascita facoltativa: YYYY-MM-DD oppure data-ora ISO 8601 con Z o un offset numerico (ad es. 1990-01-01T00:00:00.000Z, 1990-01-01T12:00:00+02:00). Le date-ora senza fuso orario vengono rifiutate. Se assente o vuota, non viene salvata alcuna data di nascita.

Risposte

200

Creato

successbooleanobbligatorio

idstringobbligatorio

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

Bodyapplication/json

commentstring*Motivo del blocco. Gli spazi iniziali e finali vengono rimossi; non può essere vuoto.first_namestring*last_namestring*rawMrzstringZona a lettura ottica (MRZ) facoltativa del documento scansionato.birthDatestringData di nascita facoltativa: `YYYY-MM-DD` oppure data-ora ISO 8601 con `Z` o un offset numerico (ad es. `1990-01-01T00:00:00.000Z`, `1990-01-01T12:00:00+02:00`). Le date-ora senza fuso orario vengono rifiutate. Se assente o vuota, non viene salvata alcuna data di nascita.

Richiesta

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

Risposta

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