Quickstart Guide

From an API key
to your first screening request.

Create a key in the portal and make your first screening request with any HTTP client. No SDK and no sandbox required.

1

Obtain your API Key

Sign up, then open Account, API Keys in the portal and create a key with Read on the portal.sanctions-search module (each endpoint in the API Reference lists the module and level it needs). Copy it when it is shown; it is not displayed again.

Open API keys
2

Set your key

Any HTTP client works. Keep the key out of source control: put it in an environment variable and send it as Authorization: ApiKey .... Official SDKs (Node.js, Python and Go) are in the works.

export ON8_API_KEY=on8_3f9a12bc_Ab3xK...
3

Send your first request

Run a sanctions search with fetch (Node 18+). The same call works from curl or any language.

index.js
const res = await fetch('https://api.on8.ai/api/v1/screening/sanctions', {
  method: 'POST',
  headers: {
    'Authorization': `ApiKey ${process.env.ON8_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ query: 'Vladimir Putin', schemaType: 'Person', mode: 'fuzzy' }),
});

const { success, data } = await res.json();
// success is true on a 2xx; the failure envelope carries { error }, not { data }.
console.log(success, data.isClear, data.totalHits); // true, false, 12