开发者参考

企业核实

通过 DomScan API,校验银行信息、VAT 号码和西班牙身份号码,核实美国医疗服务提供者,并对照制裁名单筛查名称。每个答案都来自官方登记系统、名单或公开标准,且每条结果都会说明来源。

企业核实

校验银行信息、VAT 号码和西班牙身份号码,核实美国医疗服务提供者,并对照制裁名单筛查名称。每个答案都来自官方登记系统、名单或公开标准,且每条结果都会说明来源。

未知结果: 当登记系统不可用、繁忙或响应太慢时,结果为未知并附上原因,绝不会显示为无效或未找到,且该请求会退还额度。
隐私: 银行信息和西班牙身份号码均离线校验。银行信息和被筛查的名称不会保留在请求日志中。
POST /v1/bank/validate 积分: 1

正文参数

参数 类型 必需
iban string 可选
bic string 可选
routing_number string 可选

响应字段

字段 类型
valid boolean
iban object
iban.valid boolean
iban.errors[] string[]
iban.iban string | null
iban.iban_print string | null
iban.country_code string | null
iban.format_country_code string | null
iban.registry_status string | null
iban.check_digits string | null
iban.bban string | null
iban.bank_code string | null
iban.branch_code string | null
iban.account_number string | null
iban.sepa boolean | null
iban.length integer
iban.expected_length integer | null
iban.checks object
iban.checks.characters string
iban.checks.country_supported string
iban.checks.length string
iban.checks.structure string
iban.checks.checksum string
bic object
bic.valid boolean
bic.errors[] string[]
bic.bic string | null
bic.bic8 string | null
bic.institution_code string | null
bic.country_code string | null
bic.location_code string | null
bic.branch_code string | null
bic.primary_office boolean | null
bic.test_bic boolean | null
bic.passive_participant boolean | null
routing_number object
routing_number.valid boolean
routing_number.errors[] string[]
routing_number.routing_number string | null
routing_number.type string | null
routing_number.federal_reserve_district integer | null
routing_number.federal_reserve_bank string | null
routing_number.checks object
routing_number.checks.format string
routing_number.checks.prefix string
routing_number.checks.checksum string
bic_iban_country_relation string | null
signals[] string[]

请求示例

curl -X POST "https://domscan.net/v1/bank/validate" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "iban": "DE89 3704 0044 0532 0130 00",
  "bic": "COBADEFFXXX"
}'
const response = await fetch("https://domscan.net/v1/bank/validate", {
  method: "POST",
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "iban": "DE89 3704 0044 0532 0130 00",
    "bic": "COBADEFFXXX"
  }),
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.post(
    "https://domscan.net/v1/bank/validate",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
    json={
        "iban": "DE89 3704 0044 0532 0130 00",
        "bic": "COBADEFFXXX",
    },
)
print(response.json())
package main

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

func main() {
	body := strings.NewReader(`{
	  "iban": "DE89 3704 0044 0532 0130 00",
	  "bic": "COBADEFFXXX"
	}`)
	req, err := http.NewRequest(http.MethodPost, "https://domscan.net/v1/bank/validate", 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/bank/validate")
request = Net::HTTP::Post.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
  "iban" => "DE89 3704 0044 0532 0130 00",
  "bic" => "COBADEFFXXX"
})

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

响应示例

{
  "valid": true,
  "iban": {
    "valid": true,
    "errors": [],
    "iban": "DE89370400440532013000",
    "iban_print": "DE89 3704 0044 0532 0130 00",
    "country_code": "DE",
    "format_country_code": "DE",
    "registry_status": "swift_registry",
    "check_digits": "89",
    "bban": "370400440532013000",
    "bank_code": "37040044",
    "branch_code": null,
    "account_number": "0532013000",
    "sepa": true,
    "length": 22,
    "expected_length": 22,
    "checks": {
      "characters": "pass",
      "country_supported": "pass",
      "length": "pass",
      "structure": "pass",
      "checksum": "pass"
    }
  },
  "bic": {
    "valid": true,
    "errors": [],
    "bic": "COBADEFFXXX",
    "bic8": "COBADEFF",
    "institution_code": "COBA",
    "country_code": "DE",
    "location_code": "FF",
    "branch_code": "XXX",
    "primary_office": true,
    "test_bic": false,
    "passive_participant": false
  },
  "routing_number": null,
  "bic_iban_country_relation": "same",
  "signals": []
}

HTTP 状态码

  • 200 成功
  • 400 请求错误
  • 401 未授权
  • 402 需要付款
  • 409 HTTP 409
  • 422 HTTP 422
  • 429 请求过多
GET /v1/vat/validate 积分: 1

查询参数

参数 类型 必需
vat string 必需
country string
允许的值 ATBEBGCYCZDEDKEEELGRESFIFRHRHUIEITLTLULVMTNLPLPTROSESISKXIGBUKCHNOAU
可选
requester string 可选

响应字段

字段 类型
input string
vat_number string
number string
country_code string
status string
valid boolean | null
reason string
format_valid boolean
checksum string
registered_name string | null
registered_address string | null
name_disclosed boolean | null
consultation_number string | null
upstream_code string | null
source object
source.id string
source.authority string
source.url string | null
source.checked_at string
details object
details.organization_number string
details.organization_form object
details.organization_form.code string
details.organization_form.description string | null
details.vat_registered boolean | null
details.vat_registered_since string | null
details.deleted boolean
details.deleted_on string | null
details.bankrupt boolean | null
details.under_liquidation boolean | null
details.under_forced_liquidation boolean | null

请求示例

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/vat/validate?vat=example&country=AT&requester=example"
const response = await fetch("https://domscan.net/v1/vat/validate?vat=example&country=AT&requester=example", {
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY },
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.get(
    "https://domscan.net/v1/vat/validate?vat=example&country=AT&requester=example",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
)
print(response.json())
package main

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

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://domscan.net/v1/vat/validate?vat=example&country=AT&requester=example", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))

	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/vat/validate?vat=example&country=AT&requester=example")
request = Net::HTTP::Get.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")

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

响应示例

{
  "input": "NO923609016MVA",
  "vat_number": "NO923609016MVA",
  "number": "923609016",
  "country_code": "NO",
  "status": "valid",
  "valid": true,
  "reason": "active_vat_registration",
  "format_valid": true,
  "checksum": "valid",
  "registered_name": "EQUINOR ASA",
  "registered_address": "Forusbeen 50, 4035 STAVANGER, Norge",
  "name_disclosed": true,
  "consultation_number": null,
  "upstream_code": null,
  "source": {
    "id": "brreg",
    "authority": "bronnoysund_register_centre",
    "url": "https://data.brreg.no/enhetsregisteret/api/enheter/923609016",
    "checked_at": "2026-10-18T03:58:55.722Z"
  },
  "details": {
    "organization_number": "923609016",
    "organization_form": {
      "code": "ASA",
      "description": "Allmennaksjeselskap"
    },
    "vat_registered": true,
    "vat_registered_since": "1989-07-01",
    "deleted": false,
    "deleted_on": null,
    "bankrupt": false,
    "under_liquidation": false,
    "under_forced_liquidation": false
  }
}

HTTP 状态码

  • 200 成功
  • 400 请求错误
  • 401 未授权
  • 402 需要付款
  • 429 请求过多
GET /v1/national-id/validate 积分: 1

查询参数

参数 类型 必需
id string 必需
country string
允许的值 ES
默认值 ES
可选

响应字段

字段 类型
country string
input string
normalized string | null
valid boolean
type string | null
entity_type string | null
holder string | null
checks object
checks.format boolean
checks.control boolean | null
expected_control string | null
errors[] string[]

请求示例

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/national-id/validate?id=example-id&country=ES"
const response = await fetch("https://domscan.net/v1/national-id/validate?id=example-id&country=ES", {
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY },
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.get(
    "https://domscan.net/v1/national-id/validate?id=example-id&country=ES",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
)
print(response.json())
package main

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

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://domscan.net/v1/national-id/validate?id=example-id&country=ES", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))

	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/national-id/validate?id=example-id&country=ES")
request = Net::HTTP::Get.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")

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

响应示例

{
  "country": "ES",
  "input": "B-58378431",
  "normalized": "B58378431",
  "valid": true,
  "type": "cif",
  "entity_type": "sociedad_responsabilidad_limitada",
  "holder": null,
  "checks": {
    "format": true,
    "control": true
  },
  "expected_control": null,
  "errors": []
}

HTTP 状态码

  • 200 成功
  • 400 请求错误
  • 401 未授权
  • 402 需要付款
  • 429 请求过多
GET /v1/npi 积分: 1

查询参数

参数 类型 必需
number string 必需
name string 可选
state string 可选
taxonomy string 可选

响应字段

字段 类型
npi string
status string
checksum_valid boolean | null
reason string | null
notes[] string[]
provider object
provider.npi string
provider.type string
provider.enumeration_type string
provider.name string
provider.individual object
provider.individual.prefix string | null
provider.individual.first_name string | null
provider.individual.middle_name string | null
provider.individual.last_name string | null
provider.individual.suffix string | null
provider.individual.credential string | null
provider.individual.sex string
provider.organization object
provider.organization.name string | null
provider.organization.subpart boolean | null
provider.organization.authorized_official object
provider.organization.authorized_official.prefix string | null
provider.organization.authorized_official.first_name string | null
provider.organization.authorized_official.middle_name string | null
provider.organization.authorized_official.last_name string | null
provider.organization.authorized_official.suffix string | null
provider.organization.authorized_official.credential string | null
provider.organization.authorized_official.title string | null
provider.organization.authorized_official.telephone string | null
provider.record_status string | null
provider.active boolean
provider.enumeration_date string | null
provider.certification_date string | null
provider.last_updated string | null
provider.sole_proprietor boolean | null
provider.taxonomies[] object[]
provider.taxonomies[] object
provider.taxonomies[].code string
provider.taxonomies[].description string | null
provider.taxonomies[].primary boolean
provider.taxonomies[].state string | null
provider.taxonomies[].license string | null
provider.taxonomies[].group string | null
provider.primary_taxonomy object
provider.primary_taxonomy.code string
provider.primary_taxonomy.description string | null
provider.primary_taxonomy.primary boolean
provider.primary_taxonomy.state string | null
provider.primary_taxonomy.license string | null
provider.primary_taxonomy.group string | null
provider.addresses object
provider.addresses.location object
provider.addresses.location.purpose string | null
provider.addresses.location.address_type string | null
provider.addresses.location.line1 string | null
provider.addresses.location.line2 string | null
provider.addresses.location.city string | null
provider.addresses.location.state string | null
provider.addresses.location.postal_code string | null
provider.addresses.location.country_code string | null
provider.addresses.location.country_name string | null
provider.addresses.location.telephone string | null
provider.addresses.location.fax string | null
provider.addresses.mailing object
provider.addresses.mailing.purpose string | null
provider.addresses.mailing.address_type string | null
provider.addresses.mailing.line1 string | null
provider.addresses.mailing.line2 string | null
provider.addresses.mailing.city string | null
provider.addresses.mailing.state string | null
provider.addresses.mailing.postal_code string | null
provider.addresses.mailing.country_code string | null
provider.addresses.mailing.country_name string | null
provider.addresses.mailing.telephone string | null
provider.addresses.mailing.fax string | null
provider.practice_locations[] object[]
provider.practice_locations[] object
provider.practice_locations[].purpose string | null
provider.practice_locations[].address_type string | null
provider.practice_locations[].line1 string | null
provider.practice_locations[].line2 string | null
provider.practice_locations[].city string | null
provider.practice_locations[].state string | null
provider.practice_locations[].postal_code string | null
provider.practice_locations[].country_code string | null
provider.practice_locations[].country_name string | null
provider.practice_locations[].telephone string | null
provider.practice_locations[].fax string | null
provider.identifiers[] object[]
provider.identifiers[] object
provider.identifiers[].code string | null
provider.identifiers[].description string | null
provider.identifiers[].identifier string | null
provider.identifiers[].issuer string | null
provider.identifiers[].state string | null
provider.endpoints[] object[]
provider.endpoints[] object
provider.endpoints[].endpoint string | null
provider.endpoints[].type string | null
provider.endpoints[].type_description string | null
provider.endpoints[].description string | null
provider.endpoints[].use string | null
provider.endpoints[].use_description string | null
provider.endpoints[].use_other_description string | null
provider.endpoints[].content_type string | null
provider.endpoints[].content_type_description string | null
provider.endpoints[].affiliation boolean | null
provider.endpoints[].affiliation_name string | null
provider.other_names[] object[]
provider.other_names[] object
provider.other_names[].type string | null
provider.other_names[].code string | null
provider.other_names[].name string
provider.other_names[].prefix string | null
provider.other_names[].first_name string | null
provider.other_names[].middle_name string | null
provider.other_names[].last_name string | null
provider.other_names[].suffix string | null
provider.other_names[].credential string | null
provider.other_names[].organization_name string | null
verification object
verification.name object
verification.name.status string
verification.name.matched_on string | null
verification.state object
verification.state.status string
verification.state.matched_on string | null
verification.taxonomy object
verification.taxonomy.status string
verification.taxonomy.matched_on string | null
verification.fields_checked integer
verification.verified boolean
upstream_error_code string | null
source object
source.name string
source.url string
source.checked_at string
source.latency_ms integer | null

请求示例

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/npi?number=example&name=example&state=example&taxonomy=example"
const response = await fetch("https://domscan.net/v1/npi?number=example&name=example&state=example&taxonomy=example", {
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY },
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.get(
    "https://domscan.net/v1/npi?number=example&name=example&state=example&taxonomy=example",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
)
print(response.json())
package main

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

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://domscan.net/v1/npi?number=example&name=example&state=example&taxonomy=example", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))

	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/npi?number=example&name=example&state=example&taxonomy=example")
request = Net::HTTP::Get.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")

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

响应示例

{
  "npi": "1003000126",
  "status": "found",
  "checksum_valid": true,
  "reason": null,
  "notes": [],
  "provider": {
    "npi": "1003000126",
    "type": "individual",
    "enumeration_type": "NPI-1",
    "name": "ARDALAN ENKESHAFI",
    "individual": {
      "prefix": null,
      "first_name": "ARDALAN",
      "middle_name": null,
      "last_name": "ENKESHAFI",
      "suffix": null,
      "credential": "M.D.",
      "sex": "M"
    },
    "organization": null,
    "record_status": "A",
    "active": true,
    "enumeration_date": "2007-08-31",
    "certification_date": "2025-05-28",
    "last_updated": "2025-05-28",
    "sole_proprietor": false,
    "taxonomies": [
      {
        "code": "208M00000X",
        "description": "Hospitalist",
        "primary": true,
        "state": "DC",
        "license": "MD600003480",
        "group": null
      }
    ],
    "primary_taxonomy": {
      "code": "208M00000X",
      "description": "Hospitalist",
      "primary": true,
      "state": "DC",
      "license": "MD600003480",
      "group": null
    },
    "addresses": {
      "location": {
        "purpose": "location",
        "address_type": "DOM",
        "line1": "6410 ROCKLEDGE DR STE 304",
        "line2": null,
        "city": "BETHESDA",
        "state": "MD",
        "postal_code": "20817-1841",
        "country_code": "US",
        "country_name": "United States",
        "telephone": "443-602-6207",
        "fax": null
      },
      "mailing": null
    },
    "practice_locations": [],
    "identifiers": [],
    "endpoints": [],
    "other_names": []
  },
  "verification": {
    "name": {
      "status": "match",
      "matched_on": "name"
    },
    "state": {
      "status": "match",
      "matched_on": "location"
    },
    "taxonomy": {
      "status": "not_requested",
      "matched_on": null
    },
    "fields_checked": 2,
    "verified": true
  },
  "upstream_error_code": null,
  "source": {
    "name": "nppes_npi_registry",
    "url": "https://npiregistry.cms.hhs.gov/api/?version=2.1&number=1003000126",
    "checked_at": "2026-10-18T03:58:55.722Z",
    "latency_ms": 286
  }
}

HTTP 状态码

  • 200 成功
  • 400 请求错误
  • 401 未授权
  • 402 需要付款
  • 429 请求过多
GET /v1/npi/search 积分: 1

查询参数

参数 类型 必需
first_name string 可选
last_name string 可选
organization_name string 可选
city string 可选
state string 可选
postal_code string 可选
taxonomy_description string 可选
limit integer
默认值 10
可选
skip integer
默认值 0
可选

响应字段

字段 类型
status string
reason string | null
field string | null
query object
query.first_name string | null
query.last_name string | null
query.organization_name string | null
query.city string | null
query.state string | null
query.postal_code string | null
query.taxonomy_description string | null
query.limit integer
query.skip integer
results[] object[]
results[] object
results[].npi string
results[].type string
results[].enumeration_type string
results[].name string
results[].individual object
results[].individual.prefix string | null
results[].individual.first_name string | null
results[].individual.middle_name string | null
results[].individual.last_name string | null
results[].individual.suffix string | null
results[].individual.credential string | null
results[].individual.sex string
results[].organization object
results[].organization.name string | null
results[].organization.subpart boolean | null
results[].organization.authorized_official object
results[].organization.authorized_official.prefix string | null
results[].organization.authorized_official.first_name string | null
results[].organization.authorized_official.middle_name string | null
results[].organization.authorized_official.last_name string | null
results[].organization.authorized_official.suffix string | null
results[].organization.authorized_official.credential string | null
results[].organization.authorized_official.title string | null
results[].organization.authorized_official.telephone string | null
results[].record_status string | null
results[].active boolean
results[].enumeration_date string | null
results[].certification_date string | null
results[].last_updated string | null
results[].sole_proprietor boolean | null
results[].taxonomies[] object[]
results[].taxonomies[] object
results[].taxonomies[].code string
results[].taxonomies[].description string | null
results[].taxonomies[].primary boolean
results[].taxonomies[].state string | null
results[].taxonomies[].license string | null
results[].taxonomies[].group string | null
results[].primary_taxonomy object
results[].primary_taxonomy.code string
results[].primary_taxonomy.description string | null
results[].primary_taxonomy.primary boolean
results[].primary_taxonomy.state string | null
results[].primary_taxonomy.license string | null
results[].primary_taxonomy.group string | null
results[].addresses object
results[].addresses.location object
results[].addresses.location.purpose string | null
results[].addresses.location.address_type string | null
results[].addresses.location.line1 string | null
results[].addresses.location.line2 string | null
results[].addresses.location.city string | null
results[].addresses.location.state string | null
results[].addresses.location.postal_code string | null
results[].addresses.location.country_code string | null
results[].addresses.location.country_name string | null
results[].addresses.location.telephone string | null
results[].addresses.location.fax string | null
results[].addresses.mailing object
results[].addresses.mailing.purpose string | null
results[].addresses.mailing.address_type string | null
results[].addresses.mailing.line1 string | null
results[].addresses.mailing.line2 string | null
results[].addresses.mailing.city string | null
results[].addresses.mailing.state string | null
results[].addresses.mailing.postal_code string | null
results[].addresses.mailing.country_code string | null
results[].addresses.mailing.country_name string | null
results[].addresses.mailing.telephone string | null
results[].addresses.mailing.fax string | null
results[].practice_locations[] object[]
results[].practice_locations[] object
results[].practice_locations[].purpose string | null
results[].practice_locations[].address_type string | null
results[].practice_locations[].line1 string | null
results[].practice_locations[].line2 string | null
results[].practice_locations[].city string | null
results[].practice_locations[].state string | null
results[].practice_locations[].postal_code string | null
results[].practice_locations[].country_code string | null
results[].practice_locations[].country_name string | null
results[].practice_locations[].telephone string | null
results[].practice_locations[].fax string | null
results[].identifiers[] object[]
results[].identifiers[] object
results[].identifiers[].code string | null
results[].identifiers[].description string | null
results[].identifiers[].identifier string | null
results[].identifiers[].issuer string | null
results[].identifiers[].state string | null
results[].endpoints[] object[]
results[].endpoints[] object
results[].endpoints[].endpoint string | null
results[].endpoints[].type string | null
results[].endpoints[].type_description string | null
results[].endpoints[].description string | null
results[].endpoints[].use string | null
results[].endpoints[].use_description string | null
results[].endpoints[].use_other_description string | null
results[].endpoints[].content_type string | null
results[].endpoints[].content_type_description string | null
results[].endpoints[].affiliation boolean | null
results[].endpoints[].affiliation_name string | null
results[].other_names[] object[]
results[].other_names[] object
results[].other_names[].type string | null
results[].other_names[].code string | null
results[].other_names[].name string
results[].other_names[].prefix string | null
results[].other_names[].first_name string | null
results[].other_names[].middle_name string | null
results[].other_names[].last_name string | null
results[].other_names[].suffix string | null
results[].other_names[].credential string | null
results[].other_names[].organization_name string | null
result_count integer
has_more boolean
upstream_error_code string | null
source object
source.name string
source.url string
source.checked_at string
source.latency_ms integer | null

请求示例

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/npi/search?first_name=example&last_name=example&organization_name=example&city=example&state=example&postal_code=example&taxonomy_description=example&limit=25&skip=0"
const response = await fetch("https://domscan.net/v1/npi/search?first_name=example&last_name=example&organization_name=example&city=example&state=example&postal_code=example&taxonomy_description=example&limit=25&skip=0", {
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY },
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.get(
    "https://domscan.net/v1/npi/search?first_name=example&last_name=example&organization_name=example&city=example&state=example&postal_code=example&taxonomy_description=example&limit=25&skip=0",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
)
print(response.json())
package main

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

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://domscan.net/v1/npi/search?first_name=example&last_name=example&organization_name=example&city=example&state=example&postal_code=example&taxonomy_description=example&limit=25&skip=0", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))

	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/npi/search?first_name=example&last_name=example&organization_name=example&city=example&state=example&postal_code=example&taxonomy_description=example&limit=25&skip=0")
request = Net::HTTP::Get.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")

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

响应示例

{
  "status": "ok",
  "reason": null,
  "field": null,
  "query": {
    "first_name": null,
    "last_name": null,
    "organization_name": "mayo clinic*",
    "city": null,
    "state": "MN",
    "postal_code": null,
    "taxonomy_description": null,
    "limit": 1,
    "skip": 0
  },
  "results": [
    {
      "npi": "1003000126",
      "type": "individual",
      "enumeration_type": "NPI-1",
      "name": "ARDALAN ENKESHAFI",
      "individual": {
        "prefix": null,
        "first_name": "ARDALAN",
        "middle_name": null,
        "last_name": "ENKESHAFI",
        "suffix": null,
        "credential": "M.D.",
        "sex": "M"
      },
      "organization": null,
      "record_status": "A",
      "active": true,
      "enumeration_date": "2007-08-31",
      "certification_date": "2025-05-28",
      "last_updated": "2025-05-28",
      "sole_proprietor": false,
      "taxonomies": [
        {
          "code": "208M00000X",
          "description": "Hospitalist",
          "primary": true,
          "state": "DC",
          "license": "MD600003480",
          "group": null
        }
      ],
      "primary_taxonomy": {
        "code": "208M00000X",
        "description": "Hospitalist",
        "primary": true,
        "state": "DC",
        "license": "MD600003480",
        "group": null
      },
      "addresses": {
        "location": {
          "purpose": "location",
          "address_type": "DOM",
          "line1": "6410 ROCKLEDGE DR STE 304",
          "line2": null,
          "city": "BETHESDA",
          "state": "MD",
          "postal_code": "20817-1841",
          "country_code": "US",
          "country_name": "United States",
          "telephone": "443-602-6207",
          "fax": null
        },
        "mailing": null
      },
      "practice_locations": [],
      "identifiers": [],
      "endpoints": [],
      "other_names": []
    }
  ],
  "result_count": 1,
  "has_more": true,
  "upstream_error_code": null,
  "source": {
    "name": "nppes_npi_registry",
    "url": "https://npiregistry.cms.hhs.gov/api/?version=2.1",
    "checked_at": "2026-10-18T03:58:55.722Z",
    "latency_ms": 286
  }
}

HTTP 状态码

  • 200 成功
  • 400 请求错误
  • 401 未授权
  • 402 需要付款
  • 429 请求过多
POST /v1/sanctions/screen 积分: 2

正文参数

参数 类型 必需
name string 必需
type string
允许的值 anypersonorganizationvesselaircraft
默认值 any
可选
country string 可选
date_of_birth string 可选
lists string[]
允许的值 ofac_sdnofac_consolidateduneuuk
可选
threshold number
默认值 0.85
可选
limit integer
默认值 10
可选

响应字段

字段 类型
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

请求示例

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

响应示例

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

HTTP 状态码

  • 200 成功
  • 400 请求错误
  • 401 未授权
  • 402 需要付款
  • 409 HTTP 409
  • 422 HTTP 422
  • 429 请求过多