5-minute Quickstart
Create an API key, run a screening request, and verify usage metering. No SDK required—just HTTP.
In your dashboard, go to Settings → API Keys and create a key. Copy it and store it as an environment variable—never embed in client-side code.
export MATCHAUDIT_API_KEY="sk_live_..."$env:MATCHAUDIT_API_KEY="sk_live_..."Use POST /api/v1/screen with your API key in the Authorization header. The example below screens a single name as an individual.
curl -sS -X POST https://your-domain.com/api/v1/screen \
-H "Authorization: Bearer $MATCHAUDIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "names": ["Vladimir Putin"], "entityTypes": ["individual"] }' | jqconst res = await fetch("https://your-domain.com/api/v1/screen", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.MATCHAUDIT_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
names: ["Vladimir Putin"],
entityTypes: ["individual"]
})
});
console.log(await res.json());import os, requests, json
resp = requests.post(
"https://your-domain.com/api/v1/screen",
headers={"Authorization": f"Bearer {os.getenv('MATCHAUDIT_API_KEY')}",
"Content-Type": "application/json"},
json={"names":["Vladimir Putin"], "entityTypes":["individual"]}
)
print(json.dumps(resp.json(), indent=2)){
"results": [/* matches */],
"policyMatches": [],
"scannedSources": ["OFAC","EU","UN","UK","CH","CA","AU"],
"unavailableSources": [],
"meta": { "tookMs": 123, "tenantId": "org_...", "planKey": "pro" }
}Check your current-month usage with GET /api/v1/usage/summary. This endpoint requires a server-only secret: API_AUTH_SECRET.
export API_AUTH_SECRET="wh-sec-..."curl -s 'https://your-domain.com/api/v1/usage/summary?tenantId=YOUR_ORG_ID&planKey=pro' \
-H "Authorization: Bearer $API_AUTH_SECRET" | jqCommon responses include 401 unauthorized (missing or invalid key), 429 rate_limited (per-second),429 limit_exceeded (monthly cap), and 400 too_many_names (batch cap).
curl -X POST https://your-domain.com/api/v1/screen \
-H "Authorization: Bearer bad_key" -H "Content-Type: application/json" \
-d '{ "names": ["Test"], "entityTypes": ["individual"] }'free: 50, pro: 200, business: 500, enterprise: 2000. Batch larger than your cap returns 400 too_many_names.