Screening

Screen a person or entity

Screen a single name against the configured sanctions, PEP, and watchlist sources available to your plan.

POST/v1/screen

Request body

namestringrequired

Person or entity name to screen.

typestring

Filter to "person" or "entity". Improves precision.

countrystring

ISO 3166-1 alpha-2 country hint. Reduces false positives on common names.

date_of_birthstring

YYYY-MM-DD or YYYY. Increases confidence on person matches.

modestring

"exact" for strict direct-name matching, "broad" for fuzzy and phonetic.

thresholdstring

"strict", "balanced", or "broad" confidence profile.

explainboolean

When true, returns v3 feature-engineering explainability data for each match: calibrated confidence, per-field contributions, threshold reasoning, and evidence summary. Adds per-match computation; the values actually used are returned inside the response.

Example request

curl -X POST https://api.verifex.dev/v1/screen \
  -H "Authorization: Bearer vfx_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Alejandro García López",
    "type": "person",
    "country": "MX",
    "mode": "broad"
  }'

Live Playground

No API key required — uses public sandbox