quickstart

First screening call in five minutes

The API is plain REST with JSON responses. Everything below runs against the live index — 25 searches are free, no card required.

1

Get a key

Book a call or email hr@satyapan.xyz and we issue a sandbox key the same day. Send it with every request as the X-API-Key header.

2

Screen a name

One GET request. name is the only required parameter.

curl "https://praman-labs.xyz/api/v1/entities?name=Vladimir%20Putin&limit=5" \
  -H "X-API-Key: YOUR_KEY"
3

Read the response

Matches come ranked, with structured evidence on every record — sanctions listings with issuing authority and active status, PEP positions with class, and source attributions traceable to the issuing feed.

{
  "total": 6290,
  "results": [{
    "name": "Vladimir Vladimirovich Putin",
    "entity_type": "person",
    "match_score": 0.99,
    "risk": ["sanction", "pep"],
    "countries": ["RU"],
    "links": { "details_url": "/api/v1/entities?id=..." }
  }]
}
4

Narrow with filters

All filters are optional and combinable. DOB and country act as discriminators — a record missing those fields is never silently excluded.

parametervaluesnotes
namefree textRequired. Names, aliases, transliterations
entity_typeperson · organization · vessel · aircraftExact filter
countriesISO codes, repeatableBoosts and filters by country
dob1952 · 10-1952 · 1952-10-07Any precision; discriminator, not a gate
fuzziness0 · 1 · 2 · AUTOEdit distance; AUTO adapts to name length
limit / offset1–100 / 0+Pagination
5

Fetch full details

Every result links to its full profile — aliases, identifiers, listings, positions, relationships and addresses.

curl "https://praman-labs.xyz/api/v1/entities?id=ENTITY_ID&include=summary" \
  -H "X-API-Key: YOUR_KEY"
6

Go to production

Batch screening accepts up to 500 queries per request on Scale plans, and full database snapshots ship as JSON or CSV flat files for on-premise matching. See pricing and the full schema reference.