VerifexDocs
Get an API key

Get started

Quickstart

Authenticate with a Bearer token, POST a name and type, read the structured verdict, and retrieve the Evidence Capsule. Four steps to your first screening decision.

1

Get an API key

Sign in to the dashboard and create a key. Free accounts include 50 screens each month; no card required.

2

Call POST /v1/screen

Send the subject name, its type (person or entity), an optional country, and a mode.

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"
  }'
3

Read the verdict

The response carries a structured verdict, the coverage status, whether the candidate set is complete, and the recorded matches. It is decision evidence, not a score.

Contract

A risk level is not a clearance.

A subject is only safely clear when clearance_eligible is true, coverage_status is complete, the candidate set is complete, and there are zero matches. See the verdicts & clearance contract.

4

Retrieve the Evidence Capsule

Every decision produces a retrievable Evidence Capsule — the sources checked, list versions, matched candidates and the decision record — so you can replay and defend the call later. See Evidence Capsule.