Bloquer une identité

Ajoute une identité bloquée. Nécessite une clé Write. Renvoie 403 si les journaux d’identité ne sont pas activés pour l’organisation.

POST/identity-logs/blocked

Autorisation

AuthorizationJeton Bearer (clé API) · headerobligatoire

Clé API de l’organisation.

Corps de la requête

obligatoireapplication/json

commentstringobligatoire

Motif du blocage. Les espaces de début et de fin sont supprimés ; ne doit pas être vide.

min length 1

first_namestringobligatoire

min length 1

last_namestringobligatoire

min length 1

rawMrzstring

Zone lisible par machine (MRZ) facultative du document scanné.

min length 1

birthDatestring

Date de naissance facultative : YYYY-MM-DD, ou date-heure ISO 8601 avec Z ou un décalage numérique (p. ex. 1990-01-01T00:00:00.000Z, 1990-01-01T12:00:00+02:00). Les date-heures sans fuseau horaire sont refusées. Absente ou vide, aucune date de naissance n’est enregistrée.

Réponses

200

Créé

successbooleanobligatoire

idstringobligatoire

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

Bodyapplication/json

commentstring*Motif du blocage. Les espaces de début et de fin sont supprimés ; ne doit pas être vide.first_namestring*last_namestring*rawMrzstringZone lisible par machine (MRZ) facultative du document scanné.birthDatestringDate de naissance facultative : `YYYY-MM-DD`, ou date-heure ISO 8601 avec `Z` ou un décalage numérique (p. ex. `1990-01-01T00:00:00.000Z`, `1990-01-01T12:00:00+02:00`). Les date-heures sans fuseau horaire sont refusées. Absente ou vide, aucune date de naissance n’est enregistrée.

Requête

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

Réponse

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