API overview
The LinkinLegal API screens names against sanctions and PEP data over HTTPS. Read what the API does, where the base URL is, and where to start.
The LinkinLegal API gives your own software the sanctions and PEP data that the LinkinLegal app uses. You send an HTTPS request with an API key. You get JSON back.
The first API is the Sanctions API. More APIs follow later.
What you can do
There are two jobs. Pick the one that fits your screen.
| Job | Endpoint | Use it when |
|---|---|---|
| Search | GET /sanctions/search | A person types a name and reads a list. |
| Match | POST /sanctions/match | Your system screens a customer and needs a score. |
search looks for your text inside the caption of a record. It is a list view: it pages, it sorts and it filters.
match compares a full subject (name, birth date, country, identifiers) against every name and alias in the data. It gives each candidate a score from 0 to 1 and tells you if the score passes your threshold.
Four more endpoints support this work: one entity by id, the listing history of an entity, the dataset list, the country list and the schema list.
Base URL
https://api.linkinlegal.com/v1Every path in these pages is relative to that URL. All requests need an Authorization header. All responses are JSON in UTF-8.
Start here
Quickstart
Get a key and run your first search and match call.
Authentication
How to send your key and how to keep it safe.
Match
Screen one subject, or up to 100 in one call.
API reference
Every endpoint, parameter and response field.
Before you build
- Errors — the error body, the codes and what to do about each one.
- Rate limits — 120 requests per minute, and how to handle a 429.
- Plans and billing — who can buy an API and what stops access.
- Limits — what the sanctions data cannot do for you.
Last updated on