Quickstart

Run your first server-side sanctions search with an API key.

This flow requires an approved API account and a sak_... API key that is displayed only once.

1. Store the key safely

Keep the key in a backend environment variable or secret manager. Do not place it in a repository, frontend bundle, mobile binary, URL or log.

export SANCTIONS_API_KEY="sak_xxx"

2. Send your first search

POST /public/search is recommended for multiple sources and identifier filters.

curl -X POST "https://api.sanctions.tr/public/search" \
  -H "content-type: application/json" \
  -H "x-api-key: $SANCTIONS_API_KEY" \
  -d '{"name":"AEROCARIBBEAN AIRLINES","sources":["OFAC"],"pageSize":5}'

3. Interpret the response

A successful response includes status, total, results and meta. Evaluate score, matchQuality, scoreDetails and matchedFields together.

4. Make an operational decision

A match is not an automatic sanctions or legal-compliance conclusion. Send medium and weak candidates to human review with official-source references and customer context.

Code examples

curl -X POST "https://api.sanctions.tr/public/search" \
  -H "content-type: application/json" \
  -H "x-api-key: $SANCTIONS_API_KEY" \
  -d '{"name":"AEROCARIBBEAN AIRLINES","sources":["OFAC"],"pageSize":5}'

Decision boundary

An API result is a candidate match. A final sanctions or compliance decision requires official-source verification and human review.