Skip to content

Clarify SDK onboarding and link the Node guide #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SanctionsKit merged 1 commit into from
Oct 7, 2026
Merged

Clarify SDK onboarding and link the Node guide #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The official Node.js SDK for the [SanctionsKit API](https://www.sanctionskit.com/). Screen people and organizations against selected sanctions and watchlist sources, retrieve saved evidence, submit batches, and manage ongoing monitoring.

[Documentation](https://www.sanctionskit.com/docs) · [API reference](https://www.sanctionskit.com/docs/api-reference) · [Create an account](https://www.sanctionskit.com/signup) · [Get an API key](https://www.sanctionskit.com/dashboard/keys?environment=sandbox)
[Node.js and TypeScript guide](https://www.sanctionskit.com/integrations/typescript) · [API reference](https://www.sanctionskit.com/docs/api-reference) · [Create an account](https://www.sanctionskit.com/signup) · [Get an API key](https://www.sanctionskit.com/dashboard/keys?environment=sandbox)

## Install

Expand All @@ -14,6 +14,8 @@ Requires Node.js 22 or later. Includes TypeScript types, ESM and CommonJS export

## Your first screening

The synthetic sandbox is free and needs no card. Production screening requires a [paid plan](https://www.sanctionskit.com/pricing).

1. [Create a workspace](https://www.sanctionskit.com/signup) and open [API keys](https://www.sanctionskit.com/dashboard/keys?environment=sandbox).
2. Create a **sandbox** key with `screenings:write` and `results:read` scopes.
3. Set the key in your server environment, then save this example as `screen.mjs`.
Expand Down
Loading