Block identity

Add a blocked identity. Requires a Write key. Returns 403 if identity logs are not enabled for the organization.

POST/identity-logs/blocked

Authorization

AuthorizationBearer token (API key) · headerrequired

Organization API key.

Request body

requiredapplication/json

commentstringrequired

Reason for the block. Leading and trailing spaces are trimmed; must not be blank.

min length 1

first_namestringrequired

min length 1

last_namestringrequired

min length 1

rawMrzstring

Optional machine-readable zone of the scanned document.

min length 1

birthDatestring

Optional birth date: YYYY-MM-DD, or ISO 8601 datetime with Z or a numeric offset (e.g. 1990-01-01T00:00:00.000Z, 1990-01-01T12:00:00+02:00). Timezone-less datetimes are rejected. Omitted or empty means no birth date is stored.

Responses

200

Created

successbooleanrequired

idstringrequired

400

Invalid parameters or body.

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

403

API key rejected (see Forbidden), or identity logs are not enabled for the organization (Feature not available).

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

When the error occurred (UTC).

pathstringrequired

Request URL (path and query string).

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (API key)Remember on this deviceInclude my values in samples

Bodyapplication/json

commentstring*Reason for the block. Leading and trailing spaces are trimmed; must not be blank.first_namestring*last_namestring*rawMrzstringOptional machine-readable zone of the scanned document.birthDatestringOptional birth date: `YYYY-MM-DD`, or ISO 8601 datetime with `Z` or a numeric offset (e.g. `1990-01-01T00:00:00.000Z`, `1990-01-01T12:00:00+02:00`). Timezone-less datetimes are rejected. Omitted or empty means no birth date is stored.

Request

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

Response

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