Press play to start · Space pauses · ← → skip 5 seconds · C toggles captions
Chapters
What Developer API is for
Developer is the console for LinkinLegal's Sanctions API. Create the API keys your systems use, follow every call in usage charts and a request log, and see your API plan and invoices — so your own onboarding and KYC tools can screen names against the same sanctions and PEP data as the app.
Who it's for
Engineering teams
Create keys, run the quick start and trace any call by its request ID.
Compliance and operations leads
Follow call volumes, key activity and the API plan in one place.
What it solves
Screening inside your own onboarding
Call search and match from your servers, so new customers and counterparties are screened in the systems your team already uses.
Keys you stay in control of
Give each system its own key with an expiry, see when it was last used, and revoke it the moment it's no longer needed.
Every call on record
Usage by day, endpoint and key, plus a log of every request with its status, duration and request ID.
How to use Developer API
Each step shows the real screen. Hover a numbered marker — or the matching note — to see what every control does.
Get API access
Open Developer from the account menu. Until your account has an API plan, the console shows how to get one: our team agrees the APIs, the price and a monthly or yearly plan with you, and access starts when the first invoice is paid.
- Only the owner of a recurring LinkinLegal subscription can hold an API plan — not seat members or Day and Week Pass holders.
- Each plan gives unlimited calls to its API, within a fair-use limit of 120 requests per minute.
- The API plan is separate from your LinkinLegal subscription and billed by invoice.
On this screen
Find your way around the console
With an API plan, Developer opens on Overview: your plan, calls this month, active keys and the rate limit. The menu on the left leads to API keys, Usage, Billing and the API docs.
- Quick start is a ready-to-run curl call — add your key and send it.
- Calls per day covers the last 30 days, in UTC.
- Further down, Recent requests lists your latest calls with their status.
On this screen
Create and manage API keys
Under API keys, click Create key, give the key a name you'll recognize — such as the system that uses it — and choose when it expires. Each key is listed with its first characters, its expiry and when it was last used.
- Expiry runs from 1 hour to 1 year, or No expiration — and can't be changed later.
- Up to 20 active keys per account; names up to 60 characters.
- Revoke stops a key at once. Revoked keys stay in the list, faded.
On this screen
Tip: Use one key per system — your onboarding service, a nightly job — so a leaked key costs you one key, not all of them.
Save your key — it's shown only once
After Create key, the dialog shows the full key. This is the only time you'll see it, so copy it into your secret manager before you click Done. Your server then sends it as a Bearer token in the Authorization header.
- Base URL: https://api.linkinlegal.com/v1 — for example GET /sanctions/search or POST /sanctions/match.
- POST /sanctions/match/batch screens up to 100 subjects in one call.
- Lost a key? Revoke it and create a new one.
On this screen
Follow usage and every request
Usage charts calls per day over 7, 30 or 90 days and breaks them down by endpoint and by key. Below, the request log lists every call — select a row to see its request ID and the request you sent.
- Filter the log by status (Success or Errors) or by key.
- Green statuses succeeded; red ones are errors, such as 402 without a plan or 429 over the rate limit.
- The log shows 25 requests per page.
On this screen
Tip: When you contact support about a call, include its request ID — Copy ID puts it on your clipboard.
Check your API plan and invoices
Billing shows each API on your plan with its price and renewal date, your next invoice, and every payment with a link to its invoice. To add or cancel an API, contact our team.
- Invoices are emailed by Stripe; access starts when the first invoice is paid.
- If a payment fails, Overview warns you before access stops.
- A canceled plan keeps working until the end of the period you paid for.
On this screen
Step 01 / 06
Everything Developer API can do
The building blocks behind the walkthrough, and what each one does for you.
Sanctions and PEP screening
Search records by name, or score a person or company with match — up to 100 subjects in one batch call.
Keys per system
Name each key after the system that uses it, choose its expiry, and revoke it when it's no longer needed.
Usage at a glance
Calls per day over 7, 30 or 90 days, by endpoint and by key.
A log of every request
Filter by status or key, and open any call for its request ID and request.
Quick start
A ready-to-copy curl call that sends your key as a Bearer token.
Fair-use rate limit
120 requests per minute per account, shared by all your keys.
Billing by invoice
Your plan, its renewal date and every invoice or credit note.
Full API docs
Quickstart, authentication, errors and a full reference at docs.linkinlegal.com.
Tips for getting it right
Keep keys on your server
Never put a key in browser or mobile app code. Read it from an environment variable or a secret store.
Copy the key straight away
It's shown in full only once. If you lose it, revoke it and create a new one.
Choose the expiry deliberately
There's no default and it can't be changed later. To rotate, create the new key, deploy it, then revoke the old one.
Batch your bulk screening
POST /sanctions/match/batch screens up to 100 subjects and counts as one request against the rate limit.
Log the request ID
Every response carries an X-Request-Id header. With it, support can find your exact call.
Don't retry 401, 402 or 403
Those are about the key, the plan or the subscription, so the same call fails again. Retry only 429 and 503.
Statuses you'll see
Work that runs in the background always shows where it stands — here is what each label means.
- ActiveThe API plan is live and renews on the date shown.
- Invoice sentOur team has set up the plan. API access starts when the emailed invoice is paid.
- Payment failedThe last API plan payment failed. Access stops if no payment succeeds.
- RevokedThe key no longer works; calls with it are refused.
- ExpiredThe key passed its expiry date. Create a new one.
- 429Over 120 requests a minute. Wait for the Retry-After time, then retry.
The owner of a recurring LinkinLegal app subscription. Seat members of a workspace don't see the Developer link, and Day or Week Pass holders can't get API access.
Contact our team from the console. We agree the APIs, the price and a monthly or yearly plan with you, and Stripe emails the invoice. Access starts when it's paid.
A plan gives unlimited calls to its API. A fair-use rate limit of 120 requests per minute applies to the whole account and is shared by all keys.
No. Only a hash of the key is stored, so the full key is shown once, when you create it. Revoke the lost key and create a new one.
401: the key is missing, unknown, revoked or expired. 402: the account has no live plan for that API. 429: you passed 120 requests a minute — wait for the Retry-After time, then retry.
Choose API docs in the console's menu, or go to docs.linkinlegal.com for the quickstart, authentication, rate limits, errors and the full reference.
Keep exploring
Related features
- Where to find it
- Account menu → Developer