Referencja API

API API weryfikacji sankcyjnej

Sprawdź nazwę osoby lub firmy na międzynarodowych listach sankcyjnych. Użyj tej referencji, aby wybrać operację i zintegrować jej udokumentowany kontrakt odpowiedzi.

Operacje

POST /v1/sanctions/screen Otwórz referencję API

POST /v1/sanctions/screen

Operacja: screenSanctions Kredyty i uwierzytelnianie: 2 Wymagane uwierzytelnianie
POST /v1/sanctions/screen Kredyty: 2

Parametry treści

Parametr Typ wymagane
name string wymagane
type string
Dozwolone wartości anypersonorganizationvesselaircraft
Domyślnie any
opcjonalne
country string opcjonalne
date_of_birth string opcjonalne
lists string[]
Dozwolone wartości ofac_sdnofac_consolidateduneuuk
opcjonalne
threshold number
Domyślnie 0.85
opcjonalne
limit integer
Domyślnie 10
opcjonalne

Pola odpowiedzi

Pole Typ
status string
reason string | null
query object
query.name string
query.type string
query.country string | null
query.date_of_birth string | null
query.lists[] string[]
query.threshold number
query.limit integer
matches[] object[]
matches[] object
matches[].list string
matches[].entry_id string
matches[].score number
matches[].name_score number
matches[].match_type string
matches[].matched_name string
matches[].matched_name_kind string
matches[].alias_strength string | null
matches[].entity_type string
matches[].primary_name string
matches[].aliases[] string[]
matches[].programs[] string[]
matches[].countries[] string[]
matches[].birth_dates[] object[]
matches[].birth_dates[] object
matches[].birth_dates[].date string | null
matches[].birth_dates[].year integer | null
matches[].birth_dates[].year_from integer | null
matches[].birth_dates[].year_to integer | null
matches[].birth_dates[].approximate boolean
matches[].birth_places[] string[]
matches[].listed_on string | null
matches[].source_url string | null
matches[].remarks string | null
matches[].signals object
matches[].signals.date_of_birth string
matches[].signals.country string
total_matches integer
lists[] object[]
lists[] object
lists[].id string
lists[].name string
lists[].authority string
lists[].status string
lists[].entries integer | null
lists[].published_at string | null
lists[].fetched_at string | null
lists[].source_url string
checked_at string

Przykładowe żądanie

curl -X POST "https://domscan.net/v1/sanctions/screen" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "name": "Vladimir Putin",
  "type": "person",
  "country": "RU",
  "date_of_birth": "1952-10-07"
}'
const response = await fetch("https://domscan.net/v1/sanctions/screen", {
  method: "POST",
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "name": "Vladimir Putin",
    "type": "person",
    "country": "RU",
    "date_of_birth": "1952-10-07"
  }),
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.post(
    "https://domscan.net/v1/sanctions/screen",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
    json={
        "name": "Vladimir Putin",
        "type": "person",
        "country": "RU",
        "date_of_birth": "1952-10-07",
    },
)
print(response.json())
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{
	  "name": "Vladimir Putin",
	  "type": "person",
	  "country": "RU",
	  "date_of_birth": "1952-10-07"
	}`)
	req, err := http.NewRequest(http.MethodPost, "https://domscan.net/v1/sanctions/screen", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	data, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(resp.Status, string(data))
}
require "json"
require "net/http"

uri = URI("https://domscan.net/v1/sanctions/screen")
request = Net::HTTP::Post.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
  "name" => "Vladimir Putin",
  "type" => "person",
  "country" => "RU",
  "date_of_birth" => "1952-10-07"
})

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end
puts JSON.pretty_generate(JSON.parse(response.body))

Przykładowa odpowiedź

{
  "status": "potential_match",
  "reason": null,
  "query": {
    "name": "Vladimir Putin",
    "type": "person",
    "country": "RU",
    "date_of_birth": "1952-10-07",
    "lists": [
      "ofac_sdn",
      "ofac_consolidated",
      "un",
      "eu",
      "uk"
    ],
    "threshold": 0.85,
    "limit": 10
  },
  "matches": [
    {
      "list": "ofac_sdn",
      "entry_id": "35096",
      "score": 1,
      "name_score": 1,
      "match_type": "exact",
      "matched_name": "PUTIN, Vladimir Vladimirovich",
      "matched_name_kind": "primary",
      "alias_strength": null,
      "entity_type": "person",
      "primary_name": "PUTIN, Vladimir Vladimirovich",
      "aliases": [],
      "programs": [
        "RUSSIA-EO14024"
      ],
      "countries": [
        "RU"
      ],
      "birth_dates": [
        {
          "date": "1952-10-07",
          "year": 1952,
          "year_from": null,
          "year_to": null,
          "approximate": false
        }
      ],
      "birth_places": [
        "Leningrad, Russia"
      ],
      "listed_on": null,
      "source_url": null,
      "remarks": "President of the Russian Federation.",
      "signals": {
        "date_of_birth": "match",
        "country": "match"
      }
    }
  ],
  "total_matches": 1,
  "lists": [
    {
      "id": "ofac_sdn",
      "name": "Specially Designated Nationals and Blocked Persons List",
      "authority": "US Treasury OFAC",
      "status": "checked",
      "entries": 19457,
      "published_at": "2026-10-16",
      "fetched_at": "2026-10-18T04:05:12.000Z",
      "source_url": "https://sanctionslistservice.ofac.treas.gov/api/publicationpreview/exports/sdn.csv"
    }
  ],
  "checked_at": "2026-10-18T04:20:00.000Z"
}

Kody statusu HTTP

  • 200 OK
  • 400 Nieprawidłowe żądanie
  • 401 Nieautoryzowany
  • 402 Wymagana płatność
  • 409 HTTP 409
  • 422 HTTP 422
  • 429 Zbyt wiele żądań

Materiały referencyjne