Dokümanlar / Uç Noktalar

Toplu Yaptırım Tarama

POST /api/v1/sanctions/screen/batch

Bu sayfada

Toplu Yaptırım Tarama
İstek
Yanıt
Reddedilen kayıt taranmamıştır
Aylık kota
Hata yanıtları
Yetki

Toplu Yaptırım Tarama

Tek çağrıda en çok 100 kaydı tarar. Müşteri portföyünü dönemsel olarak taramak için kullanın. Her kayıt, Yaptırım Tarama ile aynı kurallarla ve aynı anda aynı liste durumuna karşı taranır.

İstek

{
  "items": [
    { "name": "Ali Veli", "birthDate": "1975" },
    { "name": "Örnek Ticaret A.Ş.", "kind": "organization", "identifiers": [ { "type": "vkn", "value": "1234567890" } ] }
  ]
}

items[] — en az 1, en çok 100 kayıt. Her kayıt tekil taramanın gövdesiyle aynıdır.

100'den fazla kaydı birkaç çağrıya bölün. Çağrıları art arda değil, oran sınırınızı gözeterek gönderin.

Yanıt

{
  "outcome": "hits",
  "coverage": "full",
  "engineVersion": "1.1.0",
  "listSequence": 184220,
  "lists": [ { "code": "TR-MASAK-7", "screened": true, "covered": true, "freshness": "fresh" } ],
  "warnings": [],
  "results": [
    {
      "index": 0,
      "outcome": "hits",
      "screeningId": "0e8c7c7a-...",
      "message": null,
      "hits": [ { "entryId": "7b1d2f3e-...", "class": "high", "score": 92 } ],
      "warnings": []
    },
    {
      "index": 1,
      "outcome": "refused",
      "screeningId": null,
      "message": "'identifiers[0].value': Vergi kimlik numarası 10 rakam olmalıdır.",
      "hits": null,
      "warnings": []
    }
  ]
}

outcome — çağrının bütünü: herhangi bir kayıtta isabet varsa hits; yalnız her kayıt taranıp temiz çıktıysa ve her liste kapsandıysa noMatch; aksi hâlde incomplete. Reddedilen bir kayıt çağrının noMatch olmasını engeller.
coverage, engineVersion, listSequence, lists[] — çağrının tamamı için tek değerdir; bütün kayıtlar aynı liste durumuna karşı taranır. Alanların anlamı Yaptırım Tarama sayfasındadır.
warnings[] — çağrının tamamını ilgilendiren uyarılar: bindingListOverLimit ve indexLagging. Kayda özgü uyarılar kaydın kendi warnings[] alanındadır.
results[] — istekteki sırayla, her kayıt için bir öğe:
- index — kaydın items içindeki yeri, 0'dan başlar
- outcome — hits, noMatch, incomplete ya da refused. İlk üçü Yaptırım Tarama sayfasındaki anlamıyla; temiz sonuç yalnız noMatch'tir
- screeningId — taramanın kimliği; reddedilen kayıtta null. Yanıt, çağrının bütün tarama kayıtları kalıcı olarak yazıldıktan sonra döner
- message — neden reddedildiği (Türkçe); tamamlanan kayıtta null
- hits[] — isabetler; boş dizi tek başına temiz sonuç değildir, outcome alanına bakın
- warnings[] — uyarılar

Reddedilen kayıt taranmamıştır

Bir kayıttaki hata öteki kayıtları etkilemez: o kayıt refused olur, kalanlar taranır. Tekil taramada 400 dönen her durum burada refused olur.

outcome alanını mutlaka okuyun. Reddedilen kaydın hits alanı bilerek boş dizi değil null'dır: taranmamış bir kayıt, temiz sonuç gibi işlenmemelidir.

Aylık kota

Bir toplu çağrı, içindeki kayıt sayısı kadar sayılır. 100 kayıtlı çağrı aylık kotanızdan 100 düşer; bu, kayıtları tek tek göndermekle aynıdır. Reddedilen kayıtlar da sayılır, tekil taramada 400 yanıtının sayılması gibi.

Çağrıdaki kayıt sayısı bu ay kalan hakkınızdan fazlaysa yanıt 429 QUOTA_EXCEEDED olur, hiçbir kayıt taranmaz ve hak düşmez. error.message kalan hakkınızı söyler; daha küçük bir çağrı gönderebilirsiniz. Kalan hakkınızı X-RateLimit-Month-Remaining başlığından görürsünüz.

Hak, tarama başlamadan ayrılır. Aynı anda gönderilen çağrılar aynı kalan hakkı paylaşamaz: sığmayan 429 alır. 200 ile bitmeyen çağrının hakkı geri verilir.

Dakikalık oran sınırı ise çağrı sayar: toplu çağrı dakikalık sınırdan 1 düşer ve kendi sayacını kullanır, tekil tarama sayacını etkilemez.

Hata yanıtları

400 VALIDATION_ERROR — items yok, boş ya da 100'den fazla. Hiçbir kayıt taranmadı.
429 QUOTA_EXCEEDED — yukarıda.
503 SANCTIONS_NOT_READY — sonuç verilmedi; nedenleri Yaptırım Tarama sayfasındadır. Hiçbir kaydın sonucu yoktur; bu yanıt "eşleşme yok" demek değildir. Retry-After kadar bekleyip çağrıyı yineleyin. Sayılmaz.

Yetki

Api.Sanctions.Screen iznini gerektirir; tekil taramayla aynı izindir ve aynı aylık kotadan düşer.

Parametreler

İsim	Konum	Tip	Zorunlu	Açıklama
`items`	Body	`array`	Evet	Taranacak kayıtlar; her biri tekil taramanın gövdesiyle aynıdır. En az 1, en çok 100 öğe.

Yanıtlar

200 — outcome ve coverage (çağrının bütünü), engineVersion, listSequence, lists[], warnings[] ve istekle aynı sırada results[]: index, outcome (hits, noMatch, incomplete ya da refused), screeningId, hits[], warnings[], message. Reddedilen kaydın hits alanı null'dır: taranmamıştır.

400 — items boş ya da 100'den fazla öğe içeriyor (VALIDATION_ERROR).

429 — Çağrıdaki kayıt sayısı bu ay kalan hakkınızdan fazla (QUOTA_EXCEEDED). Hiçbir kayıt taranmamıştır; daha küçük bir çağrı gönderebilirsiniz.

503 — Sonuç verilmedi (SANCTIONS_NOT_READY). Hiçbir kaydın sonucu yoktur ve hak düşmez; bu yanıt 'eşleşme yok' anlamına gelmez.

⚠️ Sunucudan sunucuya — API anahtarınızı tarayıcıda paylaşmayın. Neden?

curl -X POST \
  "https://api.regvion.com/api/v1/sanctions/screen/batch" \
  -H "X-API-Key: rgv_live_REPLACE_WITH_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "items": [
    { "name": "Ali Veli", "birthDate": "1975" },
    { "name": "Örnek Ticaret A.Ş.", "kind": "organization" }
  ]
}'

const url = 'https://api.regvion.com/api/v1/sanctions/screen/batch';
const headers = {
  'X-API-Key': 'rgv_live_REPLACE_WITH_YOUR_KEY'
  , 'Content-Type': 'application/json'
};

const response = await fetch(url, {
  method: 'POST',
  headers,
  body: JSON.stringify({
  "items": [
    { "name": "Ali Veli", "birthDate": "1975" },
    { "name": "Örnek Ticaret A.Ş.", "kind": "organization" }
  ]
})
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const body = await response.json();
console.log(body.data);
console.log('Request ID:', body.meta.requestId);

import requests

url = "https://api.regvion.com/api/v1/sanctions/screen/batch"
headers = {"X-API-Key": "rgv_live_REPLACE_WITH_YOUR_KEY"}
payload = {
  "items": [
    { "name": "Ali Veli", "birthDate": "1975" },
    { "name": "Örnek Ticaret A.Ş.", "kind": "organization" }
  ]
}
response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
body = response.json()
print(body["data"])
print("Request ID:", body["meta"]["requestId"])

using System.Net.Http;
using System.Net.Http.Json;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-API-Key", "rgv_live_REPLACE_WITH_YOUR_KEY");

var payload = new StringContent("""{
  "items": [
    { "name": "Ali Veli", "birthDate": "1975" },
    { "name": "Örnek Ticaret A.Ş.", "kind": "organization" }
  ]
}""", Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://api.regvion.com/api/v1/sanctions/screen/batch", payload);
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadFromJsonAsync<JsonElement>();
Console.WriteLine(body.GetProperty("meta").GetProperty("requestId").GetString());

<?php
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

$options = [
    'headers' => [
        'X-API-Key' => 'rgv_live_REPLACE_WITH_YOUR_KEY',
    ],
    'json' => [
  "items" => [
    [ "name" => "Ali Veli", "birthDate" => "1975" ],
    [ "name" => "Örnek Ticaret A.Ş.", "kind" => "organization" ]
  ]
],
];

$response = $client->request('POST', 'https://api.regvion.com/api/v1/sanctions/screen/batch', $options);
$body = json_decode($response->getBody(), true);
echo 'Request ID: ' . $body['meta']['requestId'];

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();

HttpRequest.Builder b = HttpRequest.newBuilder()
    .uri(URI.create("https://api.regvion.com/api/v1/sanctions/screen/batch"))
    .header("X-API-Key", "rgv_live_REPLACE_WITH_YOUR_KEY")
    .header("Content-Type", "application/json")
    .POST(BodyPublishers.ofString("{\n  \"items\": [\n    { \"name\": \"Ali Veli\", \"birthDate\": \"1975\" },\n    { \"name\": \"Örnek Ticaret A.Ş.\", \"kind\": \"organization\" }\n  ]\n}"));

HttpResponse<String> response = client.send(b.build(), HttpResponse.BodyHandlers.ofString());
System.out.println("Status: " + response.statusCode());
System.out.println(response.body());

package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "net/http"
)

func main() {
    body := bytes.NewReader([]byte("{\n  \"items\": [\n    { \"name\": \"Ali Veli\", \"birthDate\": \"1975\" },\n    { \"name\": \"Örnek Ticaret A.Ş.\", \"kind\": \"organization\" }\n  ]\n}"))
    req, _ := http.NewRequest("POST", "https://api.regvion.com/api/v1/sanctions/screen/batch", body)
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("X-API-Key", "rgv_live_REPLACE_WITH_YOUR_KEY")

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

    var envelope struct {
        Data interface{} `json:"data"`
        Meta struct { RequestId string `json:"requestId"` } `json:"meta"`
    }
    json.NewDecoder(resp.Body).Decode(&envelope)
    fmt.Println("Request ID:", envelope.Meta.RequestId)
}

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://api.regvion.com/api/v1/sanctions/screen/batch')
request = Net::HTTP::Post.new(uri)
request['X-API-Key'] = 'rgv_live_REPLACE_WITH_YOUR_KEY'
request['Content-Type'] = 'application/json'
request.body = '{\n  "items": [\n    { "name": "Ali Veli", "birthDate": "1975" },\n    { "name": "Örnek Ticaret A.Ş.", "kind": "organization" }\n  ]\n}'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end

body = JSON.parse(response.body)
puts "Request ID: #{body['meta']['requestId']}"

import okhttp3.*
import okhttp3.MediaType.Companion.toMediaType
import okhttp3.RequestBody.Companion.toRequestBody

val client = OkHttpClient()

val builder = Request.Builder()
    .url("https://api.regvion.com/api/v1/sanctions/screen/batch")
    .addHeader("X-API-Key", "rgv_live_REPLACE_WITH_YOUR_KEY")
    .post("{\n  \"items\": [\n    { \"name\": \"Ali Veli\", \"birthDate\": \"1975\" },\n    { \"name\": \"Örnek Ticaret A.Ş.\", \"kind\": \"organization\" }\n  ]\n}".toRequestBody("application/json".toMediaType()))

client.newCall(builder.build()).execute().use { response ->
    println("Status: ${'$'}{response.code}")
    println(response.body?.string())
}

import Foundation

var request = URLRequest(url: URL(string: "https://api.regvion.com/api/v1/sanctions/screen/batch")!)
request.httpMethod = "POST"
request.setValue("rgv_live_REPLACE_WITH_YOUR_KEY", forHTTPHeaderField: "X-API-Key")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpBody = "{\n  \"items\": [\n    { \"name\": \"Ali Veli\", \"birthDate\": \"1975\" },\n    { \"name\": \"Örnek Ticaret A.Ş.\", \"kind\": \"organization\" }\n  ]\n}".data(using: .utf8)

let (data, response) = try await URLSession.shared.data(for: request)
if let http = response as? HTTPURLResponse { print("Status: \(http.statusCode)") }
print(String(data: data, encoding: .utf8) ?? "")

use reqwest::blocking::Client;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let mut req = client.post("https://api.regvion.com/api/v1/sanctions/screen/batch")
        .header("X-API-Key", "rgv_live_REPLACE_WITH_YOUR_KEY")
        .header("Content-Type", "application/json")
        .body("{\n  \"items\": [\n    { \"name\": \"Ali Veli\", \"birthDate\": \"1975\" },\n    { \"name\": \"Örnek Ticaret A.Ş.\", \"kind\": \"organization\" }\n  ]\n}")
        ;
    let res = req.send()?;
    println!("Status: {}", res.status());
    println!("{}", res.text()?);
    Ok(())
}

$headers = @{
    'X-API-Key' = 'rgv_live_REPLACE_WITH_YOUR_KEY'
}

$body = @'
{
  "items": [
    { "name": "Ali Veli", "birthDate": "1975" },
    { "name": "Örnek Ticaret A.Ş.", "kind": "organization" }
  ]
}
'@

$response = Invoke-RestMethod -Uri 'https://api.regvion.com/api/v1/sanctions/screen/batch' -Method Post `
    -Headers $headers -Body $body -ContentType 'application/json'

$response.data
Write-Host "Request ID:" $response.meta.requestId