curl --request POST \
--url https://api.limitguard.ai/v1/entity/deep-check \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"entity_name": "<string>",
"country": "<string>",
"kvk_number": "<string>",
"credit_report_identifier": "<string>"
}
'import requests
url = "https://api.limitguard.ai/v1/entity/deep-check"
payload = {
"entity_name": "<string>",
"country": "<string>",
"kvk_number": "<string>",
"credit_report_identifier": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entity_name: '<string>',
country: '<string>',
kvk_number: '<string>',
credit_report_identifier: '<string>'
})
};
fetch('https://api.limitguard.ai/v1/entity/deep-check', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.limitguard.ai/v1/entity/deep-check",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'entity_name' => '<string>',
'country' => '<string>',
'kvk_number' => '<string>',
'credit_report_identifier' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.limitguard.ai/v1/entity/deep-check"
payload := strings.NewReader("{\n \"entity_name\": \"<string>\",\n \"country\": \"<string>\",\n \"kvk_number\": \"<string>\",\n \"credit_report_identifier\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.limitguard.ai/v1/entity/deep-check")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entity_name\": \"<string>\",\n \"country\": \"<string>\",\n \"kvk_number\": \"<string>\",\n \"credit_report_identifier\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.limitguard.ai/v1/entity/deep-check")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entity_name\": \"<string>\",\n \"country\": \"<string>\",\n \"kvk_number\": \"<string>\",\n \"credit_report_identifier\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"entity_name": "<string>",
"country": "<string>",
"sources_returned": [
"<string>"
],
"pep_extended": {
"screened": true,
"pep_exposure": true,
"match_count": 1,
"retrieved_at": "<string>",
"matches": [
{
"caption": "<string>",
"schema_type": "<string>",
"topics": [
"<string>"
],
"score": 0.5,
"datasets": [
"<string>"
],
"countries": [
"<string>"
],
"birth_date": "<string>"
}
],
"truncated": false
},
"processing_time_ms": 1,
"quality": "deep",
"adverse_media": {
"screened": true,
"adverse_media_found": true,
"match_count": 1,
"retrieved_at": "<string>",
"category_hits": {},
"articles": [
{
"headline": "<string>",
"source_link": "<string>",
"category": "<string>",
"published_at": "<string>",
"language": "<string>",
"snippet": "<string>"
}
],
"truncated": false
},
"insolvency_records": {
"screened": true,
"applicable": true,
"found": true,
"truncated": true,
"retrieved_at": "<string>",
"jurisdiction": "NL",
"query_by": "<string>",
"match_count": 1,
"records": [
{
"publication_id": "<string>",
"insolvency_number": "<string>",
"court": "<string>",
"subject_type": "<string>",
"latest_publication": {
"code": "<string>",
"description": "<string>",
"date": "<string>"
}
}
]
},
"kvk_register_flags": {
"status": "ok",
"active": true,
"insolvency_code": "FAIL",
"insolvency_label": "<string>",
"legal_form_code": "<string>",
"retrieved_at": "<string>",
"from_store": false,
"error": "<string>",
"attribution": "<string>"
},
"findings": [
{
"action": "<string>",
"why": "<string>",
"expected_result": "<string>"
}
],
"credit_report": {
"screened": true,
"applicable": true,
"country": "<string>",
"retrieved_at": "<string>",
"risk_score": "<string>",
"risk_band_available": false,
"provider": "<string>",
"organization_name": "<string>",
"identifier_type": "<string>"
},
"disclaimers": [
"<string>"
],
"sandbox": false,
"version": "1.0"
}{
"detail": [
{
"field": "<string>",
"message": "<string>"
}
],
"type": "https://docs.limitguard.ai/errors#validation-error",
"title": "Validation Error",
"status": 422,
"instance": "<string>",
"errorCode": "validation_error",
"note": "Nothing was charged."
}{
"title": "<string>",
"status": 123,
"type": "about:blank",
"detail": "<string>",
"instance": "<string>"
}Entity Deep Check
Deep check: extended PEP/RCA exposure screening, the Dutch insolvency register on every tier, adverse media on the extended tier, an Italian credit report on the credit tier.
pep_extended is the source the base check does not return. /v1/entity/check
queries the same OpenSanctions collection but filters to sanctions/enforcement
datasets and reduces the answer to a boolean (app/services/sanctions.py); the
role.pep/role.rca detail is fetched and discarded. This endpoint keeps it.
insolvency_records is the Centraal Insolventieregister (NL only; for any other
country the field says applicable: false). It is queried by kvk_number when
the body carries one (exact), else by entity_name (trade-name search).
kvk_register_flags is KVK’s own register status for a Dutch BV or NV:
actief and insolventieCode from KVK’s Open Dataset Basisbedrijfsgegevens. It
is null while KVK_REGISTER_FLAGS_ENABLED is off, for any country other than NL and
without kvk_number. not_covered means the dataset has no entry (not a BV or
NV). not_available means KVK did not answer. not_applicable means
kvk_number is not 8 digits, so no call is made. None of these is a clean
answer, and none turns the call into a 503. findings lists the actions these flags
give, with exactly one finding when KVK and the insolvency register disagree.
credit_report is an Openapi.com credit score, Italy only, available when
OPENAPI_CREDIT_API_KEY is configured — see /health. For any other country, or
a supported one with no credit_report_identifier (VAT number, tax code or
company ID) in the body, the field says applicable: false rather than being
omitted or erroring, the same pattern insolvency_records uses for non-NL, and
the credit tier’s premium is never billed for it (app/middleware/x402.py
probes the country before pricing the call).
Three tiers, resolved from X-Response-Quality by the x402 middleware: fresh
(default; the deep tier, 0.88)returnspepextendedandinsolvencyrecords;‘enhanced‘(the‘extended‘tier,1.71) adds adverse_media from dilisense;
credit ($2.45, Italy only, available when enabled) adds credit_report
instead. There is no cache-only branch, so cached is quoted, charged and
served as fresh. If a source of the requested tier cannot be reached the
answer is a 503 (pep_source_unavailable, insolvency_source_unavailable,
adverse_media_source_unavailable or credit_report_source_unavailable),
never a fabricated clean screen, and the x402 gate settles only on a 2xx so the
call is not charged.
curl --request POST \
--url https://api.limitguard.ai/v1/entity/deep-check \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"entity_name": "<string>",
"country": "<string>",
"kvk_number": "<string>",
"credit_report_identifier": "<string>"
}
'import requests
url = "https://api.limitguard.ai/v1/entity/deep-check"
payload = {
"entity_name": "<string>",
"country": "<string>",
"kvk_number": "<string>",
"credit_report_identifier": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entity_name: '<string>',
country: '<string>',
kvk_number: '<string>',
credit_report_identifier: '<string>'
})
};
fetch('https://api.limitguard.ai/v1/entity/deep-check', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.limitguard.ai/v1/entity/deep-check",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'entity_name' => '<string>',
'country' => '<string>',
'kvk_number' => '<string>',
'credit_report_identifier' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.limitguard.ai/v1/entity/deep-check"
payload := strings.NewReader("{\n \"entity_name\": \"<string>\",\n \"country\": \"<string>\",\n \"kvk_number\": \"<string>\",\n \"credit_report_identifier\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.limitguard.ai/v1/entity/deep-check")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entity_name\": \"<string>\",\n \"country\": \"<string>\",\n \"kvk_number\": \"<string>\",\n \"credit_report_identifier\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.limitguard.ai/v1/entity/deep-check")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entity_name\": \"<string>\",\n \"country\": \"<string>\",\n \"kvk_number\": \"<string>\",\n \"credit_report_identifier\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"entity_name": "<string>",
"country": "<string>",
"sources_returned": [
"<string>"
],
"pep_extended": {
"screened": true,
"pep_exposure": true,
"match_count": 1,
"retrieved_at": "<string>",
"matches": [
{
"caption": "<string>",
"schema_type": "<string>",
"topics": [
"<string>"
],
"score": 0.5,
"datasets": [
"<string>"
],
"countries": [
"<string>"
],
"birth_date": "<string>"
}
],
"truncated": false
},
"processing_time_ms": 1,
"quality": "deep",
"adverse_media": {
"screened": true,
"adverse_media_found": true,
"match_count": 1,
"retrieved_at": "<string>",
"category_hits": {},
"articles": [
{
"headline": "<string>",
"source_link": "<string>",
"category": "<string>",
"published_at": "<string>",
"language": "<string>",
"snippet": "<string>"
}
],
"truncated": false
},
"insolvency_records": {
"screened": true,
"applicable": true,
"found": true,
"truncated": true,
"retrieved_at": "<string>",
"jurisdiction": "NL",
"query_by": "<string>",
"match_count": 1,
"records": [
{
"publication_id": "<string>",
"insolvency_number": "<string>",
"court": "<string>",
"subject_type": "<string>",
"latest_publication": {
"code": "<string>",
"description": "<string>",
"date": "<string>"
}
}
]
},
"kvk_register_flags": {
"status": "ok",
"active": true,
"insolvency_code": "FAIL",
"insolvency_label": "<string>",
"legal_form_code": "<string>",
"retrieved_at": "<string>",
"from_store": false,
"error": "<string>",
"attribution": "<string>"
},
"findings": [
{
"action": "<string>",
"why": "<string>",
"expected_result": "<string>"
}
],
"credit_report": {
"screened": true,
"applicable": true,
"country": "<string>",
"retrieved_at": "<string>",
"risk_score": "<string>",
"risk_band_available": false,
"provider": "<string>",
"organization_name": "<string>",
"identifier_type": "<string>"
},
"disclaimers": [
"<string>"
],
"sandbox": false,
"version": "1.0"
}{
"detail": [
{
"field": "<string>",
"message": "<string>"
}
],
"type": "https://docs.limitguard.ai/errors#validation-error",
"title": "Validation Error",
"status": 422,
"instance": "<string>",
"errorCode": "validation_error",
"note": "Nothing was charged."
}{
"title": "<string>",
"status": 123,
"type": "about:blank",
"detail": "<string>",
"instance": "<string>"
}Body
Request for POST /v1/entity/deep-check.
Takes entity fields rather than an entity_id from a prior check: the audit
trail is keyed by sha256(entity_name) and is one-way, so an id could not be
resolved back to the name the screens have to query. kvk_number is optional
and consulted by the insolvency source: the Centraal
Insolventieregister keys searchUndertaking on the KvK number, which is an
exact lookup where a trade-name search is a fuzzy one. While
KVK_REGISTER_FLAGS_ENABLED is on, it also drives the KVK register flags lookup. credit_report_identifier
is only consulted by the credit tier's source: Openapi.com's Italian
credit-score lookup keys on a VAT number, tax code or company ID rather than a
name, and reports back in identifier_type which one it matched.
Response
Successful Response
Response from /v1/entity/deep-check.
sources_returned is built from payment.DEEP_CHECK_TIER_ADDS[tier] -- the same
table enhanced_check_hint advertises -- so what was promised and what was delivered
are one value. A name may only join that table together with the field that fills
it on that tier.
Result of the pep_extended source. screened is never False on a 200.
There is no code path that returns this model without having queried OpenSanctions: app/services/pep.py raises rather than fabricating a clean screen, and the router turns that into a 503 so the payment is never settled.
Show child attributes
Show child attributes
Populated only on the credit tier. None means the tier did not include it -- never that a screen ran and found no credit risk. applicable: false inside it (never omission) means the tier was requested but the country has no provider or no identifier was sent.
Show child attributes
Show child attributes