ruby

SanctionsKit API example in Ruby

Send a screening request with Ruby 3.3 or later and Net::HTTP. No extra gems.

Run

Create an account, then create a sandbox API key with the screenings:write scope.

From the repository root:

export SANCTIONSKIT_API_KEY='YOUR_SANDBOX_KEY'
export REQUEST_KEY="$(ruby -rsecurerandom -e 'puts SecureRandom.uuid')"
ruby ruby/screen.rb

The example screens the fictional Alex Morgan against sandbox@1, a package of synthetic records. It prints the full JSON response to standard output. Read data.status, data.matches, and data.coverage to understand the result.

HTTP errors print the status and response body to standard error and exit with a nonzero code. Network operations use a 30-second timeout. The script does not follow redirects or retry automatically. If you retry after a timeout, reuse the same REQUEST_KEY and unchanged request body. Generate a new key for a new screening.

Keep the API key on your server or in a trusted terminal. For a local mock server, set SANCTIONSKIT_BASE_URL to its API base URL; the script appends /screenings.

Documentation

• Quickstart
• Screening requests and results
• Errors and rate limits
• Idempotency
• All examples