Screening API v2.3 | Monitoring API v3.1
Base URL: https://api.sanctions.io
The sanctions.io API gives you seamless access to both our Screening API and Monitoring API, enabling you to automate Sanctions, PEP (Politically Exposed Persons), and global Watchlist checks directly within your own systems.
\nWith our APIs, you can:
\nScreen individuals or entities against global lists in real time.
\nContinuously monitor entities and receive alerts when new matches or updates occur.
\nRate limit: Up to 300 requests per minute. This applies to all HTTP requests across all endpoints.
\nResponse time: Varies by query complexity and system load, and reflects only server-side processing time, not network transfer time between client and server—80% < 350ms, 90% < 580ms, 95% < 850ms.
\nOptimized for low-latency, real-time screening scenarios.
\nTo begin using the API, simply sign up for a free trial and retrieve your API key from the sanctions.io portal.
\nTrial accounts include access to both the Screening API and Monitoring API, covering Sanctions, HRJ (High-Risk Jurisdiction), and PEP screening.
\nAdverse Media screening is not included in the trial. If you'd like to test Adverse Media, please contact us at help@sanctions.io.
\nReach our Customer Support Team directly at help@sanctions.io.
\nFor your compliance team, our compliance guides and Best Practices for Screening Parameters cover core screening concepts, configuration guidance, and name-matching best practices.
\nThe desired API version must be specified using the Accept header for both the Screening API and the Monitoring API.
Screening API: v2.3
Monitoring API: v3.1
The header should be sent in the following format:
\nThe API can only be accessed with a valid API token which needs to be passed along using the Authorization header. The token can be found in the sanctions.io user portal.
\n(For the time being, the token can also be sent in the URL parameters. Please note this is less secure, and hence we encourage you to use the Authorization header.)
\nThe parameters below configure how sanctions screening operates across all screening modes. They work consistently in Real-time screening, Batch screening, and Monitoring workflows. When submitting batch screening requests, include all applicable parameters in the JSON payload according to your screening requirements and use case.
\nApplies to: Real-Time Screening • Batch Screening • Monitoring API
\nmin_scoreType: float
Example: 0.88
Range: 0.8 - 1.0
Required: Yes
\nDescription: Specifies the minimum match confidence score required for a result to be considered a valid match and trigger an alert. Higher values reduce false positives but may increase the risk of missing borderline matches. If min_score isn't explicitly included in your request, the API defaults to 0.80.
Recommended starting value:
\n0.88 → balanced sensitivity and precision for most use casesTypical range:
\n0.88 → higher sensitivity (more matches)
0.93 → stricter matching (fewer matches)
data_sourceType: string (comma-separated)
Example: \"sdn,nonsdn, uk-sanctions\"
Required: Yes
\nDescription: Defines the set of watchlist data sources used for monitoring. Each short code corresponds to a specific list. Multiple sources can be provided as a comma-separated list.
\nAlternatively, Screening Collections can be used to simplify configuration. These allow you to screen against a predefined group of watchlists without specifying individual source short codes.
\nRefer to the documentation for a complete overview of screening data sources:
\nWatchlists & Short Codes (API Access)
Review all available watchlists and their corresponding short codes required for the data_source field when configuring screening requests. Use the List Data Sources endpoint to dynamically retrieve:
Available data sources
\nCorresponding short codes
\nCoverage Overview
Visit the sanctions.io Watchlist Coverage page for a complete overview of all available sources.
nameType: string
Example: \"Walter White\"
Required: Yes
\nConstraints: Maximum of 15 words
\nDescription: The primary name of the entity being monitored. This is the main search input and is required for screening.
\nFor individuals: use full legal name when available.
\nFor organizations: use registered entity name.
\nentity_typeType: string
Example: \"individual\"
Accepted values: individual, entity, vessel, aircraft
Required: Optional, but strongly recommended
\nDescription: Defines whether the entity is an individual or an organization. This determines which attributes are applicable (e.g., date of birth for individuals) and helps target the correct subset of watchlists during the screening process. It is recommended to specify this value to improve performance and match accuracy.
\ncountryType: string (ISO 3166-1 alpha-2 code)
Example: \"US\"
Required: Optional
\nDescription: The country associated with the monitored entity. Used as an additional matching attribute to increase precision and reduce false positives.
\nFor individuals: usually nationality or residence.
\nFor organizations: usually incorporation or operating country.
\nIf unknown, this field may be omitted, but matching may become less accurate.
\ndate_of_birthType: string (YYYY-MM-DD)
Example: \"1956-01-01\"
Required: Optional. Including this field is strongly recommended when available, particularly for PEP screening.
\nDescription: Date of birth of the monitored individual. Strongly improves match quality by helping distinguish between people with similar names.
\nentity_type = \"individual\"identifierType: string
Example: \"126Q5637GFR\"
Required: Optional
\nConstraints: Accepts a single identifier with a maximum length of 120 characters.
\nDescription: An additional identifier associated with the entity that enables parallel screening alongside the main name-based search. When included, sanctions.io performs simultaneous searches using both name and identifier parameters. A high confidence score (1.0) indicates the identifier was found in sanctions data—not that it is a genuine positive match. Identifier effectiveness depends on strength; strong, standardized identifiers provide supporting confirmation, while weak or generic identifiers can broaden results and trigger false positives.
\nHow It Works:
\nMain Search: Standard name-based screening using name and demographic parameters
\nParallel Identifier Search: Independent search targeting the identifier field against sanctioned records
\nResult: Identifier matches are weighted into your overall screening result to provide additional supporting evidence
\nAccepted values:
\nPassport number
\nNational ID
\nTax ID
\nEmail address
\nCompany domain
\nSWIFT code (for financial institution verification)
\nIMO number (vessel identification)
\nAircraft registration number
\nWallet address
\nexternal_identifierType: string
Example: \"ABC123\"
Required: Optional
\nDescription: A client-defined identifier used to reference this monitoring entry in your own systems. This value is stored and returned in results so you can map alerts back to your internal entity records.
\nMust be unique per screened entity within your environment (recommended).
\nUseful for syncing screened entries with CRM/KYC/customer databases.
\nname_match_boosting_thresholdType: float
Example: 0.94
Required: Optional
\nRange: 0.88 - 1.0
Recommended: 0.93 - 0.95
Description: An optional score threshold used to boost high-confidence name matches in the overall confidence score calculation. When a name match meets or exceeds this threshold, its weight is increased in the final scoring, surfacing stronger name-based matches more prominently in the results.
\nThreshold Sensitivity
\nBelow 0.93 → boosting is applied too broadly, increasing noise in results0.93 - 0.95 → recommended range for balanced accuracy
Above 0.95 → boosting becomes too restrictive, potentially missing valid matches
--
\n⚠️ Warning: Adding this parameter increases the number of results that pass your _min_score_ cutoff — because more records with a weak match on other fields (country, date of birth) will have their overall confidence score overwritten by a high name-only score, pulling them above the line. This raises the likelihood of false positive matches: records that look high-confidence in the response but only matched well on name. If you're seeing more results than expected after adding or lowering this parameter, review whether the boosted matches are genuinely relevant before acting on them.
💡 Hint: This is particularly useful in scenarios where the country is uncertain and cannot be omitted from your screening request.
\nScreening collections make it easy to screen against an entire category of lists at once, without having to specify each individual source short code. This is particularly useful when your compliance needs require broad or global coverage.
\nThe following collections are available:
\nFor example, if you need global sanctions coverage combined with PEP and criminal screening, you can pass multiple collection codes in the data_source field as a comma-separated list, instead of adding each individual list code to your request.
[ \n {\n \"external_identifier\": \"customer-identifier-1\",\n \"name\": \"Walther White\",\n \"min_score\": \"0.88\",\n \"entity_type\": \"individual\",\n \"data_source\": \"sanctions-lists,pep,crime\"\n }\n]\n\nEach collection maps to a specific set of watchlists. You can see exactly which lists are included by checking the Screening Collection column on our Watchlist Coverage page.
\n","_postman_id":"2b291eea-0dd0-4f9c-871c-12b179d986f6"},{"name":"List Data Sources","id":"722ba9b4-bbda-4008-a0e8-8e4f752bd823","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{api_version}}"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.sanctions.io/sources/","description":"The sources endpoint returns a paginated list of all sanctions and watchlist sources available for screening. Use the short_name value from each result as the short code in the data_source parameter when querying the screening endpoint. Multiple values can be passed as a comma-separated list.
Results are paginated — use the page query parameter to navigate through pages (e.g., ?page=2).
Some sources may include a notes field with additional usage guidance, such as recommending that a source be used in combination with another.
Page number to retrieve. Use this parameter to paginate through the full list of available sources.
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"60d9c0df-42b1-439d-abea-777696274d11","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=2.2","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.sanctions.io/sources/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 49,\n \"next\": \"https://api.sanctions.io/sources/?page=2\",\n \"previous\": null,\n \"results\": [\n {\n \"short_name\": \"AUL\",\n \"name\": \"Australian Sanctions List\"\n },\n {\n \"short_name\": \"BEL\",\n \"name\": \"Belgium Sanctions List\"\n },\n {\n \"short_name\": \"CANADA-SEMA\",\n \"name\": \"Special Economic Measures Act\"\n },\n {\n \"short_name\": \"CAP\",\n \"name\": \"Capta List (CAP) - Treasury Department\"\n },\n {\n \"short_name\": \"CCMC\",\n \"name\": \"Non-SDN Communist Military Companies Sanctions List (CCMC) - Treasury Department\"\n },\n {\n \"short_name\": \"CFSP\",\n \"name\": \"EU Consolidated List of Sanctions\"\n },\n {\n \"short_name\": \"CMIC\",\n \"name\": \"Non-SDN Chinese Military-Industrial Complex Companies List (CMIC) - Treasury Department\"\n },\n {\n \"short_name\": \"CNASNU\",\n \"name\": \"Morocco - CNASNU Local List\"\n },\n {\n \"short_name\": \"DPL\",\n \"name\": \"Denied Persons List (DPL) - Bureau of Industry and Security\"\n },\n {\n \"short_name\": \"DTC\",\n \"name\": \"ITAR Debarred (DTC) - State Department\"\n },\n {\n \"short_name\": \"EL\",\n \"name\": \"Entity List (EL) - Bureau of Industry and Security\"\n },\n {\n \"short_name\": \"FATF\",\n \"name\": \"Financial Action Task Force\"\n },\n {\n \"short_name\": \"FBI\",\n \"name\": \"FBI Most Wanted\"\n },\n {\n \"short_name\": \"FINCEN\",\n \"name\": \"Financial Crimes Enforcement Network - 311\"\n },\n {\n \"short_name\": \"FR-GELS\",\n \"name\": \"Ministry of Economy, Finance and Recovery France - Asset Freezes\"\n },\n {\n \"short_name\": \"FSE\",\n \"name\": \"Foreign Sanctions Evaders (FSE) - Treasury Department\"\n },\n {\n \"short_name\": \"HM TREASURY\",\n \"name\": \"UK Sanctions List (HM Treasury)\"\n },\n {\n \"short_name\": \"HRJ-EU-NCJT\",\n \"name\": \"EU - List of non-cooperative jurisdictions for tax purposes\"\n },\n {\n \"short_name\": \"HRJ-EU-RESTRICTIVE\",\n \"name\": \"EU - Restrictive measures\"\n },\n {\n \"short_name\": \"HRJ-FR-NCST\",\n \"name\": \"France - List of noncooperative states and territories (NCSTs)\"\n },\n {\n \"short_name\": \"HRJ-FR-SRG\",\n \"name\": \"France - Sanctions Regimes Geographic\"\n },\n {\n \"short_name\": \"HRJ-UK-SRG\",\n \"name\": \"UK - Sanctions Regimes Geographic\"\n },\n {\n \"short_name\": \"HRJ-UN-SCSR\",\n \"name\": \"UN - United Nations Security Council Sanctions Regimes\"\n },\n {\n \"short_name\": \"INTERPOL\",\n \"name\": \"Interpol Red Notices\"\n },\n {\n \"short_name\": \"IN-TERRORIST\",\n \"name\": \"India Terrorist Organizations list\",\n \"notes\": \"This source should be searched together with the \\\"UN\\\" data source\"\n }\n ]\n}"},{"id":"ce6d320f-db18-42f1-becb-8cba0d83e06c","name":"Error message when there is no token provided.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=2.2","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text","disabled":true}],"url":"https://api.sanctions.io/sources/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"detail\": \"Authentication credentials were not provided.\"}"},{"id":"f0018608-5050-421c-90ea-8208164cd894","name":"OK - typing","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=2.2","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.sanctions.io/sources/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"int\",\n \"next\": \"str url\",\n \"previous\": \"str url\",\n \"results\": [\n {\n \"short_name\": \"str\",\n \"name\": \"str\"\n }\n ]\n}"},{"id":"dbb2bc91-1aa0-4374-b4fc-54b8303bcc58","name":"Error - typing","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=2.2","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text","disabled":true}],"url":{"raw":"https://api.sanctions.io/search/?min_score=0.85&data_source=sanctions-lists&name=Luckashenko","host":["https://api.sanctions.io"],"path":["search",""],"query":[{"key":"min_score","value":"0.85","description":"Minimum confidence score filter (0.1 = low confidence, 1.0 = high confidence)."},{"key":"data_source","value":"sanctions-lists","description":"(Required) The `short_name` of the data source/s (comma separated) you'd like to include for your search. This parameter is mandatory in API version 2.1 and onward. See a list of all supported sources [here](https://docs.sanctions.io/sanctions-and-watchlists).\n**CRIME** includes FBI and INTERPOL data sources.\n**SANCTIONS-LISTS** includes all our Sanctions lists (excluding FBI and Interpol).\n**HIGH-RISK-JURISDICTIONS*** covers all jurisdiction lists.\n**PEP-LISTS*** Politically Exposed Persons list."},{"key":"name","value":"Luckashenko","description":"(Required) Name of a person or entity"},{"key":"name_scoring_weight","value":"9","type":"text","description":"Relative weight (1 to 10) of the name for the confidence_score calculation (default is 9).","disabled":true},{"key":"name_match_boosting_threshold","value":"0.9","type":"text","description":"If the name-matching score is higher than the defined threshold, the overall confidence score will be overwritten with the name-matching score. The threshold can be freely defined between 0.7 and 1.0.","disabled":true},{"key":"identifier","value":"www.website.com","type":"text","description":"Filter records with matching identifiers.","disabled":true},{"key":"identifier_scoring_weight","value":"3","type":"text","description":"Relative weight (1 to 10) of the identifier in the score calculation (default is 3).","disabled":true},{"key":"identifier_match_boosting_threshold","value":"0.9","type":"text","description":"If the identifier-matching score is higher than the defined threshold, the overall confidence score will be overwritten with the identifier-matching score. The threshold can be freely defined between 0.7 and 1.0.","disabled":true},{"key":"entity_type","value":"entity","type":"text","description":"Type of entity (individual, entity, vessel, aircraft).","disabled":true},{"key":"entity_type_scoring_weight","value":"3","type":"text","description":"Relative weight (1 to 10) of the entity_type in the score calculation (default is 3).","disabled":true},{"key":"country_residence","value":"RU","type":"text","description":"Country of residency (ISO2)","disabled":true},{"key":"country_residence_scoring_weight","value":"3","type":"text","description":"Relative weight (1 to 10) of the country_residence in the score calculation (default is 3).","disabled":true},{"key":"date_of_birth","value":"sanctions.io provides comprehensive global coverage across Sanctions lists, Politically Exposed Persons (PEP) databases, Criminal watchlists, and regional sources. Designed to power accurate, up-to-date AML and compliance screening workflows. All lists are automatically updated every 60 minutes to reflect the latest designations and regulatory changes.
\nUse the List Data Sources endpoint below to retrieve the full list programmatically, including the short codes required in the data_source field.
Or visit the sanctions.io Watchlist Coverage page for a complete overview of all available sources.
\n","_postman_id":"aa905794-3bc6-4985-bab4-7d0cbf495c2a"},{"name":"Screening API","item":[{"name":"Real-Time Screening","item":[{"name":"Create Screening Request","id":"6419840d-fcfb-4b14-a921-64b09bade7b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{api_version}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.sanctions.io/search/","description":"The search endpoint allows queries across our Sanctions, Criminal Watchlists, and PEP databases.
Note: Before integrating, familiarize yourself with our search functionality and confidence scoring model. Consult our Implementation Guide and Best Practices for more details on which parameter settings are recommended for the screening of Individuals, Entities, Vessels, or Wallets.
\nFull data definition of the API response here
\n","urlObject":{"path":["search",""],"host":["https://api.sanctions.io"],"query":[{"disabled":true,"description":{"content":"Minimum confidence score (0.0–1.0) a result must meet to be returned. Recommended default: 0.88.
\n","type":"text/plain"},"key":"min_score","value":"One or more sanctions/watchlist sources to screen against. Accepts comma-separated values of source short codes (e.g., SDN, CFSP, UK-SANCTIONS) or wildcard collections that group multiple lists together (e.g., SANCTIONS-LISTS, PEP, CRIME), or a mix of both.
\n","type":"text/plain"},"key":"data_source","value":"Full name of the individual or legal entity to screen.
\n","type":"text/plain"},"key":"name","value":"Type of entity being screened. Must be one of: individual, entity, vessel, aircraft.
\n","type":"text/plain"},"key":"entity_type","value":"Date of birth of the individual. Formarts: YYYY-MM-DD / YYYY-MM / YYYY
\n","type":"text/plain"},"key":"date_of_birth","value":"ISO-2 country code indicating the place of residence, registration, or activity.
\n","type":"text/plain"},"key":"country","value":"Unique identifier (e.g., passport number, email address, company domain, business ID) used to supplement name matching.
\n","type":"text/plain"},"key":"identifier","value":"Optional score threshold to boost high-confidence name matches in the overall confidence calculation.
\n","type":"text/plain"},"key":"name_match_boosting_threshold","value":"Use Case: Real-Time Screening at Customer Onboarding or Transaction Processing
\nOrganizations can use the /search/ endpoint to perform real-time sanctions checks during critical workflows - such as when onboarding new customers, vendors, or partners, or when evaluating financial transactions.
By submitting a single search request including a name and optional identifiers (e.g., date of birth, nationality), the API returns potential matches from global sanctions, PEP, and watchlists within ~600ms. This allows businesses to stop or flag risky interactions before proceeding, ensuring compliance without slowing down operations.
\n","_postman_id":"26bac308-ad2a-4b9c-b76c-76bfec6666a4"},{"name":"Batch Screening","item":[{"name":"Create Batch Screening","id":"808b5822-7d80-4e27-9cd0-659078a576ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json; version={{api_version}}"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"[ \n {\"external_identifier\": \"customer-identifier-1\", \"name\": \"Walther White\", \"min_score\": \"0.88\", \"entity_type\": \"individual\", \"data_source\": \"FSL\"}, \n {\"external_identifier\": \"customer-identifier-2\", \"name\": \"Pied Piper\", \"entity_type\": \"entity\", \"min_score\": \"0.88\", \"data_source\": \"FSL\"}, \n {\"external_identifier\": \"customer-identifier-3\", \"name\": \"Emilio Escobar\", \"entity_type\": \"individual\", \"min_score\": \"0.88\", \"data_source\": \"sanctions-lists\"}\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.sanctions.io/search/batch/","description":"To create a new Batch Screening, submit a JSON payload containing a list of objects to be screened. Configure each record as you would for a standard search. Note that the external_identifier field is mandatory for each record; use this field to correlate the screened items with your own system.
Post-Validation:
\nUpon successful payload validation, all valid records will be processed, and the Retrieve Batch Screening endpoint becomes available immediately.
If any record cannot be processed, an error file will specify the issues. These records won't be processed and won't count against your API call quota.
\nA summary of all Batch Screenings from your account is displayed, featuring simplified payload information for each. For more detailed insights on any Batch Screening, consult the Retrieve Batch Screening endpoint below.
Note: Batch Screening objects and related files are automatically deleted 30 days after creation.
\n","urlObject":{"path":["search","batch",""],"host":["https://api.sanctions.io"],"query":[{"disabled":true,"key":"processed","value":"Filter by searches after (including) the datetime string representation provided, format YYYY-MM-DDTHH:MM:SS.MSZ0:00, when a partial timestamp is provided, it defaults to 0 hours, 0 minutes 0 seconds, and utc timezone.
\n","type":"text/plain"},"key":"from_timestamp","value":"Filter by searches before (excluding) the datetime string representation provided, format YYYY-MM-DDTHH:MM:SS.MSZ0:00, when a partial timestamp is provided, it defaults to 0 hours, 0 minutes 0 seconds, and utc timezone.
\n","type":"text/plain"},"key":"to_timestamp","value":"Returns your Batch Screening results. Each search in the batch generates a BatchResult. The response also includes links to result files, encompassing any parsing errors in your payload or file.
| Note: If the Batch Screening is still in progress, a \"processing results\" message will be displayed, as shown in the example.
\n","urlObject":{"path":["search","batch","In a Batch Screening, the number of BatchResult objects corresponds to the internal queries processed. Each BatchResult includes the external_identifier along with the search results.
Removes the selected Batch Screening and all associated result files from our system. If it was a Manual Batch Screening, the uploaded file will also be deleted.
\nNote: This action is irreversible; all data and files related to the Batch Screening will be permanently deleted.
\n","urlObject":{"path":["search","batch","Use Case: High-Volume Screenings for Customer or Vendor Databases
\nThe /batch/ endpoint enables organizations to screen up to 10,000 names in a single API request, making it ideal for large-scale compliance checks - such as periodic customer base audits, bulk vendor onboarding, or regulatory reporting exercises.
Users can submit structured data with optional parameters (e.g., name, DOB, nationality, entity type), and receive results for each entry, including potential matches and confidence scores. This supports efficient, auditable bulk screening and is often paired with webhook alerts or monitoring for ongoing compliance.
\nEndpoints:
\nList Batch Screening: View the status of your current Batch Screening requests. Records are auto-deleted after 30 days.
\nCreate Batch Screening: Initiate a new Batch Screening via a JSON payload containing the records to be scanned.
\nRetrieve Batch Screening: Access details and result files for completed Batch Screenings. Includes a list of Batch Results with matching records.
\nDelete Batch Screening: Manually remove processed Batch Screenings. Be aware, this action is irreversible and all related data will be permanently deleted.
\nRetrieve Batch Result: Obtain details for individual queries within a Batch Screening request, including any potential matches.
\nSearches adverse media for a person or entity.
\nResponse notes
A successful response returns matching adverse media results. Saved examples indicate common outcomes for 200 OK, 401 Unauthorized when no token is provided, and 403 Forbidden when the plan does not include access to this endpoint.
Name of the person or entity to search for. Required. Minimum 2 characters, maximum 15 words. Single-token names are rejected for individuals unless country is one of a small allow-listed set (e.g. ID, MM).
Keywords (comma separated) used to filter news by topic. Accepted values: OrganizedCrime, InsiderTrading, RegulatoryEnforcement, ESGRisk, HumanRightsAbuse, Corruption, DrugTrafficking, LawEnforcementAction, CrimeGeneral, TerrorismFinancing, TaxEvasion, Sanctions, IllegalGambling, EnvironmentalCrime, CryptoCurrency, HumanTrafficking, Cybercrime, SexualOffenses, AntitrustViolation, BankruptcyInsolvency, ViolentCrime, JudicialAction, Fraud, FinancialCrime (case-insensitive).
\n","type":"text/plain"},"key":"keyword","value":"Country (ISO2 code(s), comma separated) you want to search news from.
\n","type":"text/plain"},"key":"country","value":"Language (ISO2 code(s), comma separated).
\n","type":"text/plain"},"key":"language","value":"Restrict the search to a specific subject type: \"Individual\" or \"Entity\". If omitted, both are searched.
\n","type":"text/plain"},"key":"entity_type","value":"Minimum confidence score for a result to be included. Range from 0.88 to 1. Defaults to 0.8 if not provided.
\n","type":"text/plain"},"key":"min_score","value":"Filter by news published on or after this date/time. Accepted formats: YYYY, YYYY-MM, YYYY-MM-DD, or a full ISO 8601 datetime.
\n","type":"text/plain"},"key":"from_datetime","value":"Filter by news published on or before this date/time. Accepted formats: YYYY, YYYY-MM, YYYY-MM-DD, or a full ISO 8601 datetime.
\n","type":"text/plain"},"key":"to_datetime","value":"Page number of results to return.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Number of results per page. Defaults to 25, maximum 100.
\n","type":"text/plain"},"key":"page_size","value":"25"}],"variable":[]}},"response":[{"id":"6eb5edeb-93f0-46d1-9c17-d875e71caf00","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{media-version}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":{"raw":"https://api.sanctions.io/search/media/?name=aleksandr ermakov","host":["https://api.sanctions.io"],"path":["search","media",""],"query":[{"key":"name","value":"aleksandr ermakov","description":"Name of the person or entity to search for."},{"key":"keyword","value":"","description":"Keywords (comma separated) used to filter news by topic. Accepted values: OrganizedCrime, InsiderTrading, RegulatoryEnforcement, ESGRisk, HumanRightsAbuse, Corruption, DrugTrafficking, LawEnforcementAction, CrimeGeneral, TerrorismFinancing, TaxEvasion, Sanctions, IllegalGambling, EnvironmentalCrime, CryptoCurrency, HumanTrafficking, Cybercrime, SexualOffenses, AntitrustViolation, BankruptcyInsolvency, ViolentCrime, JudicialAction, Fraud, FinancialCrime (case-insensitive).","disabled":true},{"key":"country","value":"API Version: 3.2The Adverse Media API endpoint empowers users to search sanctions.io's indexed adverse media dataset for news articles related to specific individuals or entities, using custom keywords. This feature is designed to enhance due diligence and AML compliance efforts by providing insights into potential risks or noteworthy information associated with business partners, clients, or any subjects of interest.
\nKey Features:
\nCustom Keyword Searches: Tailor your search to include specific keywords, ensuring that the results are highly relevant to your compliance or investigative needs.
\nComprehensive News Coverage: Access a wide array of news sources for thorough screening, helping you stay informed about any pertinent information that may affect your compliance posture.
\nDate Range Filtering: Narrow results down to a specific publication date range using from_datetime / to_datetime.
Please use application/json; version=3.2 in the Accept header for calling this endpoint.
Requests without the required Accept header version may be rejected or default to a different API version.
If your account has an Adverse Media search configuration set up (country / language / keyword / minimum score / time horizon defaults), those settings are merged into (and, for min_score and the time horizon, always take priority over) the parameters you provide. When this happens, the response includes a search.message field noting that company settings were applied.
To enable adverse media screening, the request must include the short code ADV-MEDIA in the data_source parameter.
{\n \"data_source\": \"ADV-MEDIA\"\n}\n\nReal-Time Screening (/search/) is a stateless, point-in-time check — nothing is stored server-side, and the response is your only copy of the result. Batch Screening (/search/batch/) results are stored for 30 days after creation (and auto-deleted afterward), but neither mode attaches a status to a match — there's no field you can update to mark something as reviewed. So even though Batch results persist for a while, there's still nothing built in to suppress an already-reviewed match on your next screening.
Whitelisting in Real-Time and Batch Screening is therefore implemented on your side, using three fields specifically designed to support this: external_identifier, si_identifier, and data_hash.
\n\n⚠️
\nexternal_identifieris mandatory on Batch Screening, but optional on Real-Time Screening. This whole pattern depends on it — if you skip it on a Real-Time request, there's no way to scope a whitelist decision to the right customer, and you risk suppressing a match that actually belongs to someone else with the same watchlist match. Always passexternal_identifieron Real-Time requests if you plan to whitelist.
Tip: If you’d prefer a built-in, server-side whitelisting solution instead of implementing this yourself, the Monitoring API already provides one natively via its status field (New / False Positive / Real Positive) on persistent Monitoring Results.
Used together, they let you distinguish between:
\nThe same customer, matched to the same record, unchanged → safe to suppress (\"we already reviewed this exact record for this customer\")
\nThe same customer, matched to the same record, but updated → should not be auto-suppressed, since the reviewed decision no longer reflects the record's current data
\n\n\nWhy not use the response's own
\nid(Batch) orsearch.id(Real-Time)? Those identifiers are generated fresh per screening event — every time you re-screen the same customer, you get a brand-new one. That makes them useless as a whitelist key, since there's nothing stable to match against next time.external_identifieris the one field you control and keep constant across repeated screenings of the same customer, which is exactly what a whitelist lookup needs.
Real-Time (/search/) and Batch (/search/batch/) both return matches with si_identifier and data_hash in each result, so matching is straightforward across both solutions; same fields, same shape, either way. The external_identifier you submitted with the request is also echoed back in the response, so you can tie each match back to the customer/entity you screened without any extra lookup.
Real-Time (/search/) — external_identifier is echoed back under search.params, alongside the matches:
{\n \"count\": 1,\n \"results\": [\n {\n \"name\": \"John Smith\",\n \"si_identifier\": \"EUCSLSDN-ILLICIT-56357\",\n \"data_hash\": \"nNfsIvu6t6ELF3kFhXBJrsuCD9XDuxZSbVgN0Rb38lM=\",\n \"confidence_score\": 1.0\n }\n ],\n \"search\": {\n \"params\": {\n \"name\": \"John Smith\",\n \"external_identifier\": \"customer-identifier-1\"\n }\n }\n}\n\nBatch (/search/batch/) — external_identifier sits at the top level of each batch result, alongside the results array of matches:
{\n \"external_identifier\": \"customer-identifier-1\",\n \"results\": {\n \"results\": [\n {\n \"name\": \"John Smith\",\n \"si_identifier\": \"EUCSLSDN-ILLICIT-56357\",\n \"data_hash\": \"nNfsIvu6t6ELF3kFhXBJrsuCD9XDuxZSbVgN0Rb38lM=\",\n \"confidence_score\": 1.0\n }\n ]\n }\n}\n\nWhen a compliance analyst reviews a match and confirms it's a false positive (or a confirmed hit), store the decision in your own database, keyed by both:
\nexternal_identifier — the customer/entity you screened (scopes the decision to a specific customer, not just the watchlist record)
si_identifier — the watchlist record that was matched
Also store the data_hash at the time of review, and the request's min_score/data_source context if useful for your audit trail.
Example whitelist store:
\nWhy key on external_identifier and si_identifier together? The same watchlist record can legitimately match multiple different customers. A false-positive decision for \"John Smith from Company A\" should not silently suppress a real match for \"John Smith from Company B.\"
Each time you re-screen (real-time or batch), check each returned result against your whitelist store using the same two keys:
\nNote: the pseudocode below uses screening_response.results as a stand-in, adjust to your actual response shape.
for each result in screening_response.results:\n lookup = whitelist_store.get(external_identifier, result.si_identifier)\n if lookup is None:\n → new alert, requires review\n else if lookup.data_hash == result.data_hash:\n → same record, already reviewed → suppress (auto-apply stored decision)\n else if lookup.data_hash != result.data_hash:\n → underlying watchlist record has changed since last review\n → do NOT auto-suppress — surface for re-review, since the previous\n decision was made against outdated record data\n\nThis last branch is the reason data_hash matters: it protects you from silently carrying forward a stale \"false positive\" decision onto a record that has since been updated (for example, an entity added a new alias, address, or identifier since your last review).
Because Real-Time and Batch Screening return the same result object shape (si_identifier, data_hash, confidence_score, etc.), the exact same whitelist-lookup logic works for both — whether you're checking one entity synchronously via /search/ or a list of entities via /search/batch/.
This endpoint allows access to a full export of our Sanctions & Crime database as a .csv file.
\nA specific plan subscription is needed to access this endpoint. Please contact us if you require further information about it.
\n","urlObject":{"path":["exporter",""],"host":["https://api.sanctions.io"],"query":[],"variable":[]}},"response":[{"id":"5083ab0c-2be8-4f7a-af56-c87e8222c839","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=2.2","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.sanctions.io/exporter/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"name;alt_names;entity_type;title;position;address;country_residence;email;date_of_birth;year_of_birth;place_of_birth;nationality;citizenship;passport_details;vessel_call_sign;vessel_imo;vessel_type;vessel_gross_tonnage;vessel_gross_registered_tonnage;vessel_flag;vessel_owner;aircraft_serial_identification;aircraft_mode_s_transponder_code;aircraft_model;aircraft_manufacture_date;aircraft_operator;wallet_address;data_source;source_list_url;source_information_url;start_date;program;regime;remarks;federal_register_notice;standard_order;license_requirement;license_policy;si_identifier;additional_information;entity_number;data_hash\nSanaullah AL MUHAJIR;\"Shahab MAHAJAR; Sanaullah MAHAJAR; Shihab GHAFARI; Shahab GHAFARI; ثناء اللہ غفاری; Sanaullah GHAFARI; Shihab AL MUHAJIR; Shahab AL MUHAJIR; Shihab MUHAJER; Shahab MUHAJER; Sanaullah MUHAJER; Shihab MOHAJIR; Shahab MOHAJIR; Sanaullah MOHAJIR; Shihab MAHAJAR\";Individual;Doctor;;Kunduz;AF;;1994-10-28;1994;;;;;;;;;;;;;;;;;;HM TREASURY;;;2021-12-22;;;Position: ISIL-K Leader, Regime: ISIL (Da''esh) and Al-Qaida, Date designated: 21/12/2021, Other information: (UK Sanctions List Ref):AQD0374 (UN Ref):QDi.431 Sanaullah Ghafari, also known as Shahab al-Muhajir, is the overall emir of ISIL-K. He was appointed by the ISIS core to lead ISIL-K in June 2020. Ghafari is responsible for approving all ISIL-K operations throughout Afghanistan and arranging funding to conduct operations. As the leader of ISIL-K, he has been responsible for multiple terrorist attacks resulting in hundreds of deaths in 2021.;;;;;HMTREASURY-HM-14169;;14169;yCyQY2SkKTATPoHcZSxL1q5/2zb6qRWZN0i/W5oh6B0=\nAkrin Saleh AKRIN;\"Qu’ren Salih Qu’ren AL QADHAFI; Egreen SALAH; QUREN SALIH QUREN AL QADHAFI; Qurayn Salih Qurayn AL QADHAFI; أقرين صالح أقرين\";Individual;;;;;;;;;;;;;;;;;;;;;;;;;HM TREASURY;;;2022-01-19;;;Position: Libyan Ambassador to Chad, Regime: Libya, Date designated: 18/01/2022, Other information: (UK Sanctions List Ref):LIB0076 (UN Ref):LYi.004 (UK Statement of Reasons):Quren Salih Quren Al Qadhafi was the former Libyan ambassador to Chad under the regime of Muammar Qadhafi and there are reasonable grounds to suspect that he has been involved in activities carried out on behalf of the former regime of Muammar Qadhafi implementing or connected to the repressive policies of that regime through his involvement in the procurement and coordination of foreign armed mercenary personnel on behalf of that regime. There are reasonable grounds to suspect this involvement was in violation of the arms embargo imposed under paragraph 9 of United Nations Security Council Resolution 1970. In addition/in the alternative, there are reasonable grounds to suspect that Quren Salih Quren Al Qadhafi’s alleged attempts to spread disinformation in Libya and opposition to the UN and UN-led political process in Libya threatens the peace, stability and security of Libya or which undermines its transition to a democratic, peaceful and independent country. In addition/in the alternative, there are reasonable grounds to suspect that Quren Salih Quren Al Qadhafi is associated with Saif-al Islam Qadhafi and Saadi Qadhafi who are or have been involved in activities carried out on behalf of the former regime of Muammar Qadhafi implementing or connected to the repressive policies of that regime or any other activity which threatens the peace, stability and security of Libya or undermines its transition to a democratic, peaceful and independent country. (Gender):Male;;;;;HMTREASURY-HM-14172;;14172;TOrcZtjd3tGxPfUF62PpdV91Mc4K3m908rdX0gSvnK4=\nBAOBEILONG;Shilong ZHANG;Individual;;;;;;1981-09-10;1981;;;;;;;;;;;;;;;;;;HM TREASURY;;;2020-07-31;;;Regime: Cyber, Date designated: 31/12/2020, Other information: (UK Sanctions List Ref):CYB0002 (UK Statement of Reasons):Zhang Shilong was involved in relevant cyber activity through his employment with Huaying Haitai, and therefore being responsible for, engaging in, providing support for, or promoting the commission, planning or preparation of relevant cyber activity. (Gender):Male;;;;;HMTREASURY-HM-13904;;13904;/6xaNjwSREsFds2vDQsiZbdx8OunZpb9O1f+cILKv+A=\nFISHERXP;Qiang GAO;Individual;;;Room 1102 Guanfu Mansion 46 Xinkai Road Hedong District Tianjin;CN;;1983-10-04;1983;Shandong Province;;;;;;;;;;;;;;;;;HM TREASURY;;;2020-07-31;;;Regime: Cyber, Date designated: 31/12/2020, Other information: (UK Sanctions List Ref):CYB0001 (UK Statement of Reasons):Gao Qiang was involved in relevant cyber activity through his employment with Huaying Haitai and setting up command and control infrastructure used to conduct relevant cyber activity. He was therefore responsible for, engaged in, provided support for, or promoted the commission, planning or preparation of relevant cyber activity. (Gender):Male;;;;;HMTREASURY-HM-13903;;13903;zENMvgv24/eirVin07+keb62+3pD1aKv3CS36g+T6XM=\nCHANGGWANG SINYONG CORPORATION;\"DPRKN MINING DEVELOPMENT TRADING COOPERATION; EXTERNAL TECHNOLOGY GENERAL CORPORATION; KOREA MINING DEVELOPMENT TRADING CORPORATION; KOMID\";Entity;;;Central District Pyongyang;;;;;;;;;;;;;;;;;;;;;;HM TREASURY;;;2009-04-27;;;Regime: Democratic People''s Republic of Korea, Date designated: 24/04/2009, Other information: (UK Sanctions List Ref):DPR0157 (UN Ref):KPe.001 Primary arms dealer and main exporter of goods and equipment related to ballistic missiles and conventional weapons.;;;;;HMTREASURY-HM-10892;;10892;11HJZvv4jVgckPfqy8us/8x3EiVLdrSH1xxqAfTWd8s='"},{"id":"6373914a-363b-4a57-9860-e0bdd393c31a","name":"Error message when there is no token provided.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=2.2","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text","disabled":true}],"url":"https://api.sanctions.io/exporter/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Authentication credentials were not provided.\"\n}"},{"id":"0180da3c-c762-4f30-afb1-a5d9137df8c2","name":"Error message when you don't have the appropriate plan.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=2.2","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.sanctions.io/exporter/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"You do not have permission to perform this action.\"\n}"},{"id":"7f3858be-18e8-4a24-a5f0-6923b8d199eb","name":"We update our database from all sources every 60 minutes hence only one request per hour is supported.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=2.2","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.sanctions.io/exporter/"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"You do not have permission to perform this action more than once per hour.\"\n}"}],"_postman_id":"c551b3d0-9a7c-40a2-a9c2-9a6284fa62ea"}],"id":"60d0ffc1-b11e-4bc8-a31b-a5ead8d17337","description":"Version: 2.3April 27, 2026
\nSet your API version explicitly: If your integration does not include a version in the API request header, you are currently being served v2.1 by default, sanctions.io will be updating the default version in an upcoming release later this year (2026), which means your integration is at risk of receiving an incompatible response structure, causing failures.
\nTo avoid disruption, add the following header to all your API calls now:
\nAccept: application/json; version=2.3
The sanctions.io Screening API supports both real-time screenings - ideal for onboarding and transaction-based checks - and batch screenings for high-volume processing, such as periodic reviews of large customer or vendor databases.
\nTo get the most out of the API, start by reviewing the Compliance Essentials section. It explains how our search algorithm and confidence scoring model work.
\nAll API requests must include the desired version in the Accept header, using the following format:
\n\n⚠️ Warning: If the
\nAcceptheader is omitted, the request will default to the legacy API version 2.1. It is strongly recommended to always specify the desired version explicitly.
The API can only be accessed with a valid API token which needs to be passed along using the Authorization header. The token can be found in the sanctions.io user portal.
\n(For the time being, the token can also be sent in the URL parameters. Please note this is less secure, and hence we encourage you to use the Authorization header.)
\nThe following recommendations are a 'starting point' with the bare minimum parameters that might not be optimal for your use case.
\nScreening for Individuals:
\nname
country
entity_type \"Individual\".
Screening for Entities:
\nname
country
entity_type \"Entity\"
Screening for Vessels, Aircraft, and Crypto Wallets:
\nidentifier field.Screening against High-Risk Jurisdictions:
\nsanctions.io also allows you to screen your customers/business partners against sanctioned jurisdictions, either comprehensively (embargo) or sectoral, or defined by organizations such as FATF or FinCen as high-risk jurisdictions. See our list of all supported Targeted Sanctions Lists and High-Risk Jurisdictions Lists here.
\nUse country field to include your business partner's country of residence.
Include desired data sources in the data_source field (e.g., OFAC-COMPREHENSIVE, FATF).
Note: Using HRJ lists in your screening will create matches whenever the Country of Residence of any business partner matches with any of the countries on those lists.
\n","event":[{"listen":"prerequest","script":{"id":"d6a3db29-a7a1-46c0-a94b-6dcc738a30ea","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"22fe01f0-488c-49cf-bebf-7aee22780a6d","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"60d0ffc1-b11e-4bc8-a31b-a5ead8d17337"},{"name":"Monitoring API","item":[{"name":"Monitoring Entry","item":[{"name":"Create Monitoring Entry","event":[{"listen":"test","script":{"id":"cf469e16-812c-43db-b26c-fac255fd1619","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"998712ed-5ec1-4b35-b486-384be97a0ba6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json; version={{api_version}}"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"min_score\": 0.88,\n \"data_source\": \"sdn,nonsdn\",\n \"name\": \"Walter White\",\n \"country\": \"US\",\n \"entity_type\": \"individual\",\n \"date_of_birth\": \"1956-01-01\",\n \"external_identifier\": \"ABC123\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sanctions.io/monitoring/","description":"Creates a new monitoring entry for an entity, placing it under continuous screening against your selected watchlists. Once created, the entry is automatically re-screened every time our data updates (hourly). Whenever a new match is found, a Monitoring Result (alert) is generated — no manual re-screening required.
\nProvide the entity details and matching criteria as a JSON object. name,min_score, and data_source are required fields; all other parameters refine matching precision. See the Monitoring Parameters section for a full description of every field, accepted values, and recommendations.
Returns the newly created monitoring entry, including its system-generated id (unique identifier. Store this id — you'll need it to retrieve, update, or delete the entry later.
The entry progresses through two states during its lifecycle:
\nThe entry is created with status PROCESSING immediately after submission. During this state:
Screening against watchlists is in progress
\nresults array is empty
new_matches, false_positives, and real_positives are all 0
A monitoring_entry.created webhook is triggered (if configured)
Once the initial screening completes (typically within seconds), the status changes to PROCESSED:
Screening is complete
\nresults array is populated with any matches found
new_matches, false_positives, and real_positives reflect actual counts
A monitoring_entry.processed webhook is triggered (if configured)
Removes a monitoring entry by its id, stopping all ongoing screening for that entity.
DELETE /monitoring/{monitoring_entry_id}/
Once deleted, the entity is no longer re-screened when watchlist data updates, and no further alerts will be generated for it. This action cannot be undone — to resume monitoring the same entity, create a new monitoring entry.
\nRetrieves the full details of a single monitoring entry by its id (the UID returned when the entry was created).
GET /monitoring/{id}/
Use this endpoint to inspect an entry's configuration and its complete match history. The response includes everything from the list view plus the results array — every Monitoring Result (alert) generated for this entry, each with its own id, confidence_score, status, and the matched watchlist record. Individual results can then be reviewed and resolved via the Monitoring Result endpoints.
The Monitoring Entry API allows users to manage their monitoring entries efficiently. This API is designed to handle the creation, listing, retrieval, and deletion of monitoring entries, ensuring that users can maintain a comprehensive log of their monitoring activities.
\nList and Create Monitoring Entries
\nEndpoint: /monitoring/
Methods:
\nGET: Retrieve a list of all monitoring entries associated with the authenticated user.
POST: Create a new monitoring entry for the authenticated user.
Request Headers:
\nRequest Body (POST):
\nResponse:
\nGET: Returns a list of monitoring entries in JSON format.
POST: Returns the created monitoring entry data with a 201 Created status if successful, or error details with a 400 Bad Request status if validation fails.
Retrieve and Delete Monitoring Entry
\nEndpoint: /monitoring/{id}/
Methods:
\nGET: Retrieve details of a specific monitoring entry by its ID.
DELETE: Remove a specific monitoring entry by its ID.
Request Headers:
\nResponse:
\nGET: Returns the details of the specified monitoring entry in JSON format.
DELETE: Returns a confirmation of deletion with a 204 No Content status if successful.
Retrieves all monitoring entries associated with your account. Use this endpoint to review everything currently under continuous monitoring, together with per-entry match counters — useful for building compliance dashboards or reconciling against your internal records.
\nResults are paginated. The response contains:
\nEach entry includes its configuration (name, entity_type, min_score, data_source, external_identifier, …) plus live monitoring counters:
new_matches — alerts not yet reviewed
false_positives — matches dismissed after review
real_positives — matches confirmed after review
Retrieves monitoring entries matching a free-text search, with explicit control over pagination and the inclusion of inactive (deleted) entries.
\nGET /monitoring/?search=john → entries matching the search term.
GET /monitoring/?show_inactives=true → include deleted entries.
GET /monitoring/?page=2&page_size=50 → second page, 50 entries per page.
These parameters can be combined with each other and with the alert/review-status filters (alerts, new_matches, false_positives, real_positives).
The response format is identical to Get List: paginated (count, next, previous) with the matching entries in results.
Free-text search across your monitoring entries (e.g. by name or external identifier). Matching is handled by the search index, so partial terms are supported.
\n","type":"text/plain"},"key":"search","value":"john"},{"disabled":true,"description":{"content":"Set to true to include deleted (inactive) monitoring entries in the results. Defaults to false, which returns only active entries.
Page number to retrieve.
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Number of entries per page. Maximum: 100.
Retrieves monitoring entries filtered by whether they have triggered alerts. This is the quickest way to separate entries that require attention from those with a clean screening history.
\nGET /monitoring/?alerts=True → entries with alerts (require review or were already reviewed).
GET /monitoring/?alerts=False → entries with no matches at all.
The response format is identical to Get List: paginated (count, next, previous) with the filtered entries in results, including the per-entry counters new_matches, false_positives and real_positives.
Set to True to return only monitoring entries that have at least one match (alert). \nSet to False to return only entries without any matches.
All list filters can be combined in a single request. This example retrieves the entries with alerts pending review that match a free-text search, paginated 10 per page:
\nGET /monitoring/?new_matches=True&search=john doe&page_size=10&page=1
Results are paginated with a maximum of 100 items per page. If your account has more entries than page_size, iterate using the next URL returned in the response (or increment page) until next is null.
Same format as Get List: count, next, previous and the matching entries in results.
Return only entries with unreviewed matches pending review.
\n","type":"text/plain"},"key":"new_matches","value":"True"},{"disabled":true,"description":{"content":"Free-text search across your monitoring entries. Spaces are URL-encoded automatically (john%20doe).
Number of entries per page. Maximum: 100.
Page number to retrieve.
\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"15cba071-b11e-42a0-8c88-3729c13ddfb6","name":"OK - Pending review + search, 10 per page","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{api_version}}"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":{"raw":"https://api.sanctions.io/monitoring/?new_matches=True&search=john doe&page_size=10&page=1","protocol":"https","host":["api","sanctions","io"],"path":["monitoring",""],"query":[{"key":"new_matches","value":"True"},{"key":"search","value":"john doe"},{"key":"page_size","value":"10"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"563f73e6-af53-4d2f-b95a-bf7f7cab043d\",\n \"name\": \"John Doe\",\n \"identifier\": null,\n \"country\": [\n \"US\"\n ],\n \"date_of_birth\": \"\",\n \"entity_type\": \"Individual\",\n \"external_identifier\": \"uid-customer-999\",\n \"min_score\": 0.88,\n \"data_source\": [\n \"FSL\",\n \"SANCTIONS-LISTS\"\n ],\n \"new_matches\": 2,\n \"false_positives\": 0,\n \"real_positives\": 0,\n \"status\": \"PROCESSED\",\n \"timestamp\": \"2025-02-17T11:54:05.020324Z\",\n \"modified_at\": \"2025-02-17T11:54:17.753462Z\"\n }\n ]\n}"}],"_postman_id":"257cca34-72aa-49e0-9416-7d12e69ce80b"},{"name":"Get Monitoring List - Filter by Review Status","event":[{"listen":"test","script":{"id":"56e9c96c-8034-432f-8ae8-2e11ca34b9ae","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"b0503981-73f1-4a6c-a823-23e5f74388f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{api_version}}"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.sanctions.io/monitoring/","description":"Retrieves monitoring entries filtered by the review status of their matches. Use these filters to build review queues and compliance dashboards — for example, listing only the entries with alerts still pending review, or auditing entries with confirmed matches.
\nGET /monitoring/?new_matches=True → entries with alerts pending review.
GET /monitoring/?false_positives=True → entries with dismissed matches.
GET /monitoring/?real_positives=True → entries with confirmed matches.
| Note: Please make sure you enable the parameter you need in the Params tab.
\nThe response format is identical to Get List: paginated (count, next, previous) with the filtered entries in results.
Set to True to return only entries with unreviewed matches pending review.
Set to True to return only entries with at least one match dismissed as a false positive.
Set to True to return only entries with at least one confirmed (real positive) match.
The Monitoring List API allow users to retrieve and manage their monitoring entries efficiently. These endpoint enable users to browse all entities under continuous monitoring, filter and search through them, and leverage pagination for large-scale compliance operations.
\nThe Monitoring List provides comprehensive access to your monitored entities with support for:
\nListing all monitored entries with key status counters
\nSearching through entries by name, identifier, or custom fields
\nFiltering by alerts to focus on entries with new or unreviewed matches
\nFiltering by review status to organize compliance workflows
\nCombining multiple filters and search parameters with pagination for advanced queries
\nEach monitoring entry includes real-time counters that track the lifecycle of matches:
\nnew_matches — Alerts detected but not yet reviewed
false_positives — Matches dismissed after review (not actual matches)
real_positives — Matches confirmed after review (actual matches)
These counters help you prioritize review work and maintain a clean compliance audit trail.
\nEach entry in the list includes:
\nCore entity data: name, entity_type, identifier, country, date_of_birth
Configuration: min_score, data_source
Tracking: external_identifier (your internal reference), status (PROCESSING or PROCESSED)
Timestamps: timestamp (created), modified_at (last updated)
The Monitoring List API has a single primary endpoint:GET /monitoring/
This endpoint returns all monitoring entries associated with your account. You can apply filters and search parameters to narrow results.
\nThe monitoring list endpoints support the following query parameters:
\nsearch= — Search across entries by name, identifier, external_identifier, or other text fields
new_matches= — Filter entries with unreviewed matches pending review (new_matches > 0)
false_positives= — Filter entries with at least one match dismissed as a false positive (false_positives > 0)
real_positives= — Filter entries with at least one confirmed match (real_positives > 0)
alerts= — Filter entries by alert status (true for entries with unreviewed alerts, false to exclude them)
status= — Filter entries by processing status (PROCESSING or PROCESSED)
show_inactives= — Include deleted/inactive entries (true) or exclude them (false)
page= — Page number for pagination (starts at 1)
page_size= — Number of results per page (default: 20, max: 100)
Retrieves the full details of a single Monitoring Result (alert) by its id. A result is generated automatically whenever ongoing monitoring finds a match above the entry's min_score threshold.
GET /monitoring/result/{id}/
Use this endpoint to review an alert before deciding whether it is a real match. The response includes:
\n","urlObject":{"protocol":"https","path":["monitoring","result","{{monitoring_result_id}}",""],"host":["api","sanctions","io"],"query":[{"disabled":true,"description":{"content":"Optional. A collection's read-only access key. Using this query parameter does not require an API key to call the endpoint.
\n","type":"text/plain"},"key":"","value":""}],"variable":[]}},"response":[{"id":"115c6319-deb6-4b5a-ba9a-5e5ffe61ccb2","name":"OK - Get Result","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=3.1"}],"url":{"raw":"https://api.sanctions.io/monitoring/result/548bb54e-25c2-49f4-91ff-c31fef63c48f/","protocol":"https","host":["api","sanctions","io"],"path":["monitoring","result","548bb54e-25c2-49f4-91ff-c31fef63c48f",""],"query":[{"key":"","value":"","description":"Optional. A collection's read-only access key. Using this query parameter does not require an API key to call the endpoint.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 17 Feb 2025 12:03:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1005"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, PUT, PATCH, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Cookie, Origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"f2f131ab-2a5e-4597-8dc2-10f4ced7e143\",\n \"confidence_score\": 0.88353481,\n \"status\": \"New\",\n \"text\": \"New Result Found\",\n \"data_entry\": {\n \"name\": \"KONONOV, Vladimir\",\n \"program\": [\n \"UKRAINE-EO13660\"\n ],\n \"alt_names\": [\n \"KONONOV, Volodimir\",\n \"KONONOV, Vladimir Petrovich\",\n \"KONONOV, Vladimir P.\",\n \"Vladimir KONONOV\",\n \"Volodimir KONONOV\",\n \"Vladimir Petrovich KONONOV\",\n \"Vladimir P. KONONOV\"\n ],\n \"data_source\": \"SDN\",\n \"entity_type\": \"Individual\",\n \"last_update\": \"2024-05-20T12:27:40.668736+00:00\",\n \"first_import\": \"2023-03-26T18:01:59.768599+00:00\",\n \"date_of_birth\": [\n \"1974-10-14\"\n ],\n \"entity_number\": 20139,\n \"si_identifier\": \"EUCSLSDN-UKRAINE-20139\",\n \"year_of_birth\": [\n 1974\n ],\n \"source_list_url\": \"https://home.treasury.gov/policy-issues/financial-sanctions/consolidated-sanctions-list-non-sdn-lists\",\n \"additional_information\": {\n \"secondary_sanctions_risk\": \"Ukraine-/Russia-Related Sanctions Regulations, 31 CFR 589.201 and/or 589.209\"\n }\n },\n \"timestamp\": \"2025-02-17T11:54:12.801189Z\",\n \"modified_at\": \"2025-02-17T11:54:17.656986Z\",\n \"llm_reasoning\": null,\n \"risk\": \"high\"\n}"},{"id":"bb9b713e-4271-4b88-a45f-cfa500d30c1f","name":"Error - Result not found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{api_version}}"}],"url":{"raw":"https://api.sanctions.io/monitoring/result/{{monitoring_result}}/","protocol":"https","host":["api","sanctions","io"],"path":["monitoring","result","{{monitoring_result}}",""],"query":[{"key":"","value":"","description":"Optional. A collection's read-only access key. Using this query parameter does not require an API key to call the endpoint.","disabled":true}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 17 Feb 2025 12:18:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"57"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, PUT, PATCH, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Cookie, Origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"No MonitoringResult matches the given query.\"\n}"},{"id":"34aa4d7d-0c6b-4833-8a6d-9d0185ad4e3e","name":"Error - No credentials provided","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=3.1"}],"url":{"raw":"https://api.sanctions.io/monitoring/result/548bb54e-25c2-49f4-91ff-c31fef63c48f/","protocol":"https","host":["api","sanctions","io"],"path":["monitoring","result","548bb54e-25c2-49f4-91ff-c31fef63c48f",""],"query":[{"key":"","value":"","description":"Optional. A collection's read-only access key. Using this query parameter does not require an API key to call the endpoint.","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 17 Feb 2025 12:18:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"58"},{"key":"Connection","value":"keep-alive"},{"key":"WWW-Authenticate","value":"Bearer"},{"key":"Allow","value":"GET, PUT, PATCH, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Cookie, Origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Authentication credentials were not provided.\"\n}"}],"_postman_id":"033911e2-c251-4036-8b8a-bad20d69e13f"},{"name":"Update Monitoring Result","event":[{"listen":"test","script":{"id":"b845362e-6b63-447a-8758-ec709efd9733","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"a6f808b2-47d6-4fbb-b97c-245b62104a96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json; version={{api_version}}"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"Real Positive\",\n \"text\": \"Entity matches with sanctions record\"\n}"},"url":"https://api.sanctions.io/monitoring/result/{{monitoring_result_id}}/","description":"Updates the review status of a Monitoring Result — this is how you resolve an alert after investigating it, confirming or dismissing the match. Keeping result statuses up to date maintains a clean audit trail and ensures your new_matches counters reflect only unreviewed alerts.
PUT /monitoring/result/{id}/
Example:
\n{\n \"status\": \"Real Positive\",\n \"text\": \"Entity matches with sanctions record\"\n}\n\nReturns the complete updated Monitoring Result, including the matched watchlist record (data_entry) and the new modified_at timestamp.
Optional. A collection's read-only access key. Using this query parameter does not require an API key to call the endpoint.
\n","type":"text/plain"},"key":"","value":""}],"variable":[]}},"response":[{"id":"40b49dce-c9e3-41a9-928a-7743c59c3f65","name":"Ok - Updated result","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json; version=2.3009"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"Real Positive\",\n \"text\": \"Entity matched with sanctions record\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.sanctions.io/monitoring/result/548bb54e-25c2-49f4-91ff-c31fef63c48f/","protocol":"https","host":["api","sanctions","io"],"path":["monitoring","result","548bb54e-25c2-49f4-91ff-c31fef63c48f",""],"query":[{"key":"","value":"","description":"Optional. A collection's read-only access key. Using this query parameter does not require an API key to call the endpoint.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 17 Feb 2025 12:05:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1032"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, PUT, PATCH, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Cookie, Origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"f2f131ab-2a5e-4597-8dc2-10f4ced7e143\",\n \"confidence_score\": 0.88353481,\n \"status\": \"False Positive\",\n \"text\": \"Entity doesn't match with sanctions record\",\n \"data_entry\": {\n \"name\": \"KONONOV, Vladimir\",\n \"program\": [\n \"UKRAINE-EO13660\"\n ],\n \"alt_names\": [\n \"KONONOV, Volodimir\",\n \"KONONOV, Vladimir Petrovich\",\n \"KONONOV, Vladimir P.\",\n \"Vladimir KONONOV\",\n \"Volodimir KONONOV\",\n \"Vladimir Petrovich KONONOV\",\n \"Vladimir P. KONONOV\"\n ],\n \"data_source\": \"SDN\",\n \"entity_type\": \"Individual\",\n \"last_update\": \"2024-05-20T12:27:40.668736+00:00\",\n \"first_import\": \"2023-03-26T18:01:59.768599+00:00\",\n \"date_of_birth\": [\n \"1974-10-14\"\n ],\n \"entity_number\": 20139,\n \"si_identifier\": \"EUCSLSDN-UKRAINE-20139\",\n \"year_of_birth\": [\n 1974\n ],\n \"source_list_url\": \"https://home.treasury.gov/policy-issues/financial-sanctions/consolidated-sanctions-list-non-sdn-lists\",\n \"additional_information\": {\n \"secondary_sanctions_risk\": \"Ukraine-/Russia-Related Sanctions Regulations, 31 CFR 589.201 and/or 589.209\"\n }\n },\n \"timestamp\": \"2025-02-17T11:54:12.801189Z\",\n \"modified_at\": \"2025-02-17T12:05:23.790667Z\",\n \"llm_reasoning\": null,\n \"risk\": \"high\"\n}"},{"id":"c9546fde-4b05-4a6f-b0c3-d230d45f3bae","name":"Error - parameter error","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json; version={{api_version}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \" Positive\",\n \"text\": \"considered the country residence\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.sanctions.io/monitoring/result/{{monitoring_result}}/","protocol":"https","host":["api","sanctions","io"],"path":["monitoring","result","{{monitoring_result}}",""],"query":[{"key":"","value":"","description":"Optional. A collection's read-only access key. Using this query parameter does not require an API key to call the endpoint.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 17 Feb 2025 12:06:40 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"87"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, PUT, PATCH, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Cookie, Origin"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": [\n \"Unknown status must be one of ['New', 'False Positive', 'Real Positive']\"\n ]\n}"}],"_postman_id":"a6f808b2-47d6-4fbb-b97c-245b62104a96"}],"id":"bbb0212a-9567-45f5-be2a-5dff25e86664","description":"The Monitoring Result endpoint allows users to check the details about the matches (alerts) found by the system, and also update the Result status.
\nIn status, the following values are used:
\"New\" is used when the system detects a match for the first time.
\"False Positive\" is used when, after review, the user confirms the match IS NOT an actual match.
\"Real Positive\" is used when, after review, the user confirms the match IS a real match.
In text the user can add additional information as free text, like a short description of why that decision was taken.
Retrieve Monitoring Result details
\nEndpoint: /monitoring/result/
Methods:
\nGET: Retrieve details about the monitoring Result.
PUT / PATCH: Update the monitoring Result, by confirming or rejecting the Result as an actual match.
Request Headers:
\nRequest Body (PUT/PATCH):
\nResponse:
\nGET: Returns details of a result.
PUT/PATCH: Returns the updated monitoring result.
Version: 3.1The sanctions.io Monitoring API allows you to integrate ongoing sanctions, PEP, and watchlist monitoring directly into your compliance systems - automating continuous checks and alerting you to new risks in real time.
\nUnlike single-time screening, which only checks against the current watchlist data at the time of the request, monitoring continuously re-screens your entries whenever our data updates (hourly). If a new match appears, the API will automatically generate an alert, helping you stay compliant without manual intervention.
\nTo get started, sign up for an account to retrieve your API key. Please note: monitoring access must be activated by our team. Reach out to help@sanctions.io and we’ll enable this functionality for you.
\nAll API requests must include the desired version in the Accept header, using the following format:
The API can only be accessed with a valid API token which needs to be passed along using the Authorization header. The token can be found in the sanctions.io user portal.
\n(For the time being, the token can also be sent in the URL parameters. Please note this is less secure, and hence we encourage you to use the Authorization header.)
\n","_postman_id":"2d3b6243-ca17-4046-a868-ab05d3aec739"},{"name":"Webhooks in sanctions.io","item":[{"name":"Manage Webhook Endpoints","item":[{"name":"Create a Webhook","id":"dbf2637c-b796-4f3f-ac02-ab3fbc3a848e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json; version={{api_version}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://example.com/webhook\",\n \"name\": \"Production webhook\",\n \"is_sandbox\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sanctions.io/company/webhooks/","description":"Registers a new webhook endpoint for your company. Events will be delivered as POST requests to the given url.
Returns the newly created webhook, including a hash_secret.
⚠️ hash_secret is only ever returned in this response. Store it immediately — it cannot be retrieved again. If it's lost, you'll need to create a new webhook. See Verifying Webhook Responses for how to use it to validate incoming events.
Lists the webhooks registered for your company.
\nAll filters are optional and can be combined.
\nReturns a paginated object with a count and a results array. hash_secret is never included in list results — it is only returned once, at creation.
Updates an existing webhook. Both PUT and PATCH are accepted and both are treated as partial updates.
Only the following fields can be changed:
\nname cannot be updated after creation.
Returns the updated webhook. As with List, hash_secret is not included.
Permanently deletes a webhook. The webhook stops receiving events immediately.
\nSends a test event to the webhook's configured URL, so you can confirm your endpoint is reachable and responding correctly without waiting for a real event.
\nThis is safe to run repeatedly — pings never count toward the 5-failure auto-disable limit.
\nReturns whether the ping was delivered successfully.
\n","urlObject":{"path":["company","webhooks","Endpoints for creating, listing, updating, deleting, and testing webhook endpoints registered to your company.
\nEvery call below requires your API token in the Authorization header:
sanctions.io sends the following security headers:
\nx-sanctions-origin
x-sanctions-api-token (obfuscated form of your token)
x-sanctions-sandbox (if the event is from sandbox)
This configuration enhances webhook delivery security by verifying the authenticity of incoming events from sanctions.io to our customers, utilizing a cryptographic security key and a SHA-256 hash.
\nWhen you create a webhook via your API, our system returns a JSON response that includes:
\n{\n\"id\": \"5650aeae-1b73-476c-a736-5d3fa6166e42\",\n\"url\": \"\",\n\"is_sandbox\": false,\n\"disabled\": false,\n\"hash_secret\": \"0bb1a096771b4afd8b2faa90c8cfa2b0\"\n}\n\nhash_secret: A unique secret key used for verifying the authenticity of webhook payloads.
⚠️ This key cannot be retrieved again later. If you lose it, you must create a new webhook.
\nWhenever an event is sent to the customer's webhook URL, it includes:
\n{\n\"object_type\": \"company_webhook\",\n\"action\": \"created\",\n\"data\": {/* ... */},\n\"timestamp\": \"2025-07-11T18:50:11.807868+00:00\"\n}\n\nx-sanctions-security: FfYokIWZilQt3CKV0qiRLtYz7/K7Slj3yQoZT+2JhDM=
This header is a SHA-256-based security signature used to validate the event.
\nTo ensure that a webhook request was genuinely sent by sanctions.io (and has not been modified in transit), you should validate the signature included in the request headers.
\nConstruct a string using the following format:
\n{object_type}:{action}:{timestamp}:{hash_secret}\n\nExample values:
\nobject_type: company_webhook
action: created
timestamp: 2025-07-11T18:50:11.807868+00:00
hash_secret: 0bb1a096771b4afd8b2faa90c8cfa2b0
Resulting string:
\ncompany_webhook:created:2025-07-11T18:50:11.807868+00:00:0bb1a096771b4afd8b2faa90c8cfa2b0\n\nGenerate a SHA-256 hash of the string and encode the result in Base64:
\nimport base64\nimport hashlib\nhasher = hashlib.sha256()\nhasher.update(repr(\"company_webhook:created:2025-07-11T18:50:11.807868+00:00:0bb1a096771b4afd8b2faa90c8cfa2b0\").encode())\nprint(base64.b64encode(hasher.digest()).decode())\n\nExpected output:
\nFfYokIWZilQt3CKV0qiRLtYz7/K7Slj3yQoZT+2JhDM=
Compare the computed value against the x-sanctions-security header included in the webhook request:
x-sanctions-security: FfYokIWZilQt3CKV0qiRLtYz7/K7Slj3yQoZT+2JhDM=\n\nIf the values match exactly, the webhook request can be trusted as originating from sanctions.io.
\n","_postman_id":"234fd213-bbfc-4da1-b815-a49cf6032263"},{"name":"Webhook Events","item":[{"name":"Access & Authentication","item":[],"id":"46ddc0fd-8e50-48e9-aabb-15ecd77b3219","description":"Sent when a new API token is created.
\nWhen an API token is added for a user.
\nUsed to confirm that a new API token has been successfully generated.
\n{\n \"object_type\": \"api_token\",\n \"action\": \"created\",\n \"data\": {\n \"key\": \"998181dc03ae4e46a9e8c820bb4c8c98\",\n \"timestamp\": \"2026-02-06T11:32:26.649915+00:00\",\n \"is_deleted\": false,\n \"is_sandbox\": false\n },\n \"timestamp\": \"2026-02-06T11:32:26.733402+00:00\"\n}\n\nSent when an API token is deleted.
\nWhen an API token is removed or deactivated.
\nUsed to confirm that an API token has been successfully deleted.
\n{\n \"object_type\": \"api_token\",\n \"action\": \"deleted\",\n \"data\": {\n \"key\": \"378da874500645a49f50a7b03bc5d9ee\",\n \"timestamp\": \"2026-02-06T11:32:51.527351+00:00\",\n \"is_deleted\": true,\n \"is_sandbox\": false\n },\n \"timestamp\": \"2026-02-06T11:32:51.564652+00:00\"\n}\n\nSent when an existing API token is updated.
\nWhen an API token is modified (for example, status or environment changes).
\nUsed to confirm that an API token update has been applied.
\n{\n \"object_type\": \"api_token\",\n \"action\": \"updated\",\n \"data\": {\n \"key\": \"378da874500645a49f50a7b03bc5d9ee\",\n \"timestamp\": \"2026-02-06T11:32:51.527351+00:00\",\n \"is_deleted\": false,\n \"is_sandbox\": false\n },\n \"timestamp\": \"2026-02-06T11:32:51.564652+00:00\"\n}\n\nSent when company information is updated.
\nWhen any company details or configuration settings are modified.
\nUsed to confirm that company profile or configuration changes have been applied.
\n{\n \"object_type\": \"company\",\n \"action\": \"updated\",\n \"data\": {\n \"name\": \"sanctions.io\",\n \"vat\": \"123456789\",\n \"address_line_1\": \"West Street\",\n \"address_line_2\": \"Suite 1200\",\n \"city\": \"Wilmington\",\n \"postal_code\": \"19801\",\n \"state\": \"Delaware\",\n \"country\": \"US\",\n \"company_config\": {\n \"weekly_consumption_report\": false,\n \"reports_recipients\": [],\n \"webhook_url\": \"https://webhook.site/9223ce5b-968c-4ce7-9f9c-281332\",\n \"sandbox_webhook_url\": null\n }\n },\n \"timestamp\": \"2026-02-06T11:55:28.871175+00:00\"\n}\n\n{\n \"object_type\": \"company_config\",\n \"action\": \"updated\",\n \"data\": {\n \"weekly_consumption_report\": false,\n \"reports_recipients\": [\n \"two@descent.com\",\n \"two@descent.com\"\n ],\n \"webhook_url\": \"https://webhook.site/e32b353d-e285-4a35-84ac-b041c5da6900\",\n \"sandbox_webhook_url\": \"https://webhook.site/sandbox-path-2\"\n },\n \"timestamp\": \"2026-02-20T00:43:49.060294+00:00\"\n}\n\nSent when a batch query finishes processing all its searches.
\nAfter all searches included in a batch query have been processed.
\nUsed to confirm that a batch screening process has completed and to review summary results.
\n{\n \"object_type\": \"batch_query\",\n \"action\": \"processed\",\n \"data\": {\n \"id\": \"91159624-d18b-4d8c-892e-d3e5a49d45ea\",\n \"timestamp\": \"2026-02-19T19:20:21.533121Z\",\n \"processed\": true,\n \"results_count\": 2,\n \"url\": \"/search/batch/91159624-d18b-4d8c-892e-d3e5a49d45ea/\"\n },\n \"timestamp\": \"2026-02-19T19:20:36.197013+00:00\"\n}\n\nSent when a search request finishes processing and results are available.
\nAfter a screening search has completed and matching entities have been evaluated.
\nUsed to review search results, validate matches, and inspect the input parameters used for the search.
\n{\n \"object_type\": \"search_result\",\n \"action\": \"processed\",\n \"data\": {\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"confidence_score\": 1,\n \"name\": \"John Doe\",\n \"alt_names\": [\n \"JD\",\n \"John M Doe\",\n \"Jonny Doe\"\n ],\n \"entity_type\": \"Individual\",\n \"address\": [\n \"1000 Market Street, San Francisco, United States\"\n ],\n \"date_of_birth\": [\n \"1980-12-15\"\n ],\n \"year_of_birth\": [\n 1980\n ],\n \"nationality\": [\n \"US\"\n ],\n \"data_source\": {\n \"name\": \"Fictional Sanctions List\",\n \"short_name\": \"FSL\"\n },\n \"remarks\": \"Engaged in cyber operations targeting critical infrastructure in...\",\n \"si_identifier\": \"FSL-NONE-024\",\n \"first_import\": \"2025-06-05T09:09:01.421094+00:00\",\n \"last_update\": \"2025-06-16T15:42:32.798925+00:00\",\n \"data_hash\": \"byv+mnwnmumDkauxceknnlKwQAsn/TqFNIEurokWpd0=\"\n }\n ],\n \"search\": {\n \"params\": {\n \"min_score\": \"0.7\",\n \"data_source\": \"FSL\",\n \"name\": \"John Doe\"\n },\n \"timestamp\": \"2026-02-09T11:59:15.937565+00:00\",\n \"api_version\": \"2.3\",\n \"id\": \"98f9a72a-428f-4ca2-b688-cfd73f3eb404\"\n }\n },\n \"timestamp\": \"2026-02-09T11:59:16.072836+00:00\"\n}\n\nSent when a new webhook endpoint is created for a company.
\nWhen a webhook URL is added to a company configuration.
\nUsed to confirm that a webhook endpoint has been successfully created and is active.
\n{\n \"object_type\": \"company_webhook\",\n \"action\": \"created\",\n \"data\": {\n \"id\": \"728fbab6-350d-4986-8c68-80355ca48620\",\n \"url\": \"https://webhook.site/9223ce5b-968c-4ce7-9f9c-281332af1efc\",\n \"is_sandbox\": false,\n \"disabled\": false\n },\n \"timestamp\": \"2026-02-06T11:19:57.746689+00:00\"\n}\n\nSent when a previously disabled webhook endpoint is re-enabled.
\nAfter a webhook endpoint has been automatically disabled due to delivery failures and is manually reenabled by the user.
\nThis event is not sent for generic updates or URL changes.
\nUsed to confirm that a webhook endpoint has been successfully reactivated and will start receiving events again.
\n{\n \"object_type\": \"company_webhook\",\n \"action\": \"updated\",\n \"data\": {\n \"id\": \"53abdf03-39d6-402f-9242-4cf4cab3006f\",\n \"url\": \"https://webhook.site/9223ce5b-968c-4ce7-9f9c-281332af1efc\",\n \"is_sandbox\": false,\n \"disabled\": false\n },\n \"timestamp\": \"2026-02-06T12:03:32.491484+00:00\"\n}\n\nSent when a webhook endpoint is removed or disabled for a company.
\nWhen a webhook URL is deleted or deactivated.
\nUsed to confirm that a webhook endpoint is no longer active.
\n{\n \"object_type\": \"company_webhook\",\n \"action\": \"deleted\",\n \"data\": {\n \"id\": null,\n \"url\": \"https://webhook.site/9223ce5b-968c-4ce7-9f9c-281332af1efc\",\n \"is_sandbox\": false,\n \"disabled\": true\n },\n \"timestamp\": \"2026-02-06T12:03:05.582666+00:00\"\n}\n\nMonitoring in sanctions.io provides real-time status updates and event tracking for your monitoring entries. You can access this information through the Monitoring Portal (dashboard) or via the Monitoring API.
\nUse external_identifier to link entries with internal records: This enables clear traceability and simplifies case management across your systems.
Track entry lifecycle via status fields: Monitor transitions from PROCESSING to PROCESSED to ensure entries are fully ingested and screened.
Leverage real-time webhooks: Receive instant alerts when a new match is detected, enabling prompt review and action.
\nSent when a new monitoring entry is created.
\nWhen an entry is added to continuous monitoring.
\nUsed to confirm that a monitoring entry has been successfully created and processing has started.
\n{\n \"object_type\": \"monitoring_entry\",\n \"action\": \"created\",\n \"data\": {\n \"id\": \"40091792-e16a-4581-9098-58d5634c62a5\",\n \"name\": \"John Doe\",\n \"identifier\": null,\n \"country\": [\n \"US\"\n ],\n \"date_of_birth\": \"1980-12-15\",\n \"entity_type\": \"Individual\",\n \"external_identifier\": \"123456\",\n \"min_score\": 0.8,\n \"data_source\": [\n \"FSL\"\n ],\n \"new_matches\": 0,\n \"false_positives\": 0,\n \"real_positives\": 0,\n \"results\": [],\n \"status\": \"PROCESSING\",\n \"timestamp\": \"2026-02-09T12:13:19.105274Z\",\n \"modified_at\": \"2026-02-09T12:13:19.105277Z\"\n },\n \"timestamp\": \"2026-02-09T12:13:19.332000+00:00\"\n}\n\nSent when a monitoring entry is deleted.
\nWhen an entry is removed from continuous monitoring.
\nUsed to confirm that a monitoring entry has been successfully removed and will no longer be monitored.
\n{\n \"object_type\": \"monitoring_entry\",\n \"action\": \"deleted\",\n \"data\": {\n \"id\": \"40091792-e16a-4581-9098-58d5634c62a5\",\n \"name\": \"John Doe\",\n \"identifier\": null,\n \"country\": [\n \"US\"\n ],\n \"date_of_birth\": \"1980-12-15\",\n \"entity_type\": \"Individual\",\n \"external_identifier\": \"123456\",\n \"min_score\": 0.8,\n \"data_source\": [\n \"FSL\"\n ],\n \"new_matches\": 1,\n \"false_positives\": 0,\n \"real_positives\": 0,\n \"results\": [\n {\n \"id\": \"a1530afb-db87-4327-adf1-028673433184\",\n \"confidence_score\": 1,\n \"status\": \"New\",\n \"text\": \"New Result Found\",\n \"timestamp\": \"2026-02-09T12:13:19.630816Z\",\n \"modified_at\": \"2026-02-09T12:13:19.651276Z\",\n \"risk\": null\n }\n ],\n \"status\": \"PROCESSED\",\n \"timestamp\": \"2026-02-09T12:13:19.105274Z\",\n \"modified_at\": \"2026-02-09T12:16:17.755787Z\"\n },\n \"timestamp\": \"2026-02-09T12:16:17.881713+00:00\"\n}\n\nSent when a monitoring entry finishes processing and results are available.
\nAfter the monitoring engine completes a screening cycle for the monitored entry.
\nUsed to review new matches detected for a monitored entry and confirm processing completion.
\n{\n \"object_type\": \"monitoring_entry\",\n \"action\": \"processed\",\n \"data\": {\n \"id\": \"40091792-e16a-4581-9098-58d5634c62a5\",\n \"name\": \"John Doe\",\n \"identifier\": null,\n \"country\": [\n \"US\"\n ],\n \"date_of_birth\": \"1980-12-15\",\n \"entity_type\": \"Individual\",\n \"external_identifier\": \"123456\",\n \"min_score\": 0.8,\n \"data_source\": [\n \"FSL\"\n ],\n \"new_matches\": 1,\n \"false_positives\": 0,\n \"real_positives\": 0,\n \"results\": [\n {\n \"id\": \"a1530afb-db87-4327-adf1-028673433184\",\n \"confidence_score\": 1,\n \"status\": \"New\",\n \"text\": \"New Result Found\",\n \"timestamp\": \"2026-02-09T12:13:19.630816Z\",\n \"modified_at\": \"2026-02-09T12:13:19.651276Z\",\n \"risk\": null\n }\n ],\n \"status\": \"PROCESSED\",\n \"timestamp\": \"2026-02-09T12:13:19.105274Z\",\n \"modified_at\": \"2026-02-09T12:13:19.730428Z\"\n },\n \"timestamp\": \"2026-02-09T12:13:19.812938+00:00\"\n}\n\nSent when a new monitoring result is created for a monitoring entry.
\nWhen a new match is detected during the monitoring process.
\nUsed to inspect the details of a newly detected match and review the underlying data entry.
\n{\n \"object_type\": \"monitoring_result\",\n \"action\": \"created\",\n \"data\": {\n \"id\": \"a1530afb-db87-4327-adf1-028673433184\",\n \"confidence_score\": 1,\n \"status\": \"New\",\n \"text\": \"New Result Found\",\n \"timestamp\": \"2026-02-09T12:13:19.630816Z\",\n \"modified_at\": \"2026-02-09T12:13:19.651276Z\",\n \"risk\": null,\n \"data_entry\": {\n \"confidence_score\": 0,\n \"name\": \"John Doe\",\n \"alt_names\": [\n \"JD\",\n \"John M Doe\",\n \"Jonny Doe\"\n ],\n \"entity_type\": \"Individual\",\n \"address\": [\n \"1000 Market Street, San Francisco, United States\"\n ],\n \"date_of_birth\": [\n \"1980-12-15\"\n ],\n \"year_of_birth\": [\n 1980\n ],\n \"nationality\": [\n \"US\"\n ],\n \"data_source\": \"FSL\",\n \"remarks\": \"Engaged in cyber operations targeting critical infrastructure in...\",\n \"si_identifier\": \"FSL-NONE-024\",\n \"first_import\": \"2025-06-05T09:09:01.421094+00:00\",\n \"last_update\": \"2025-06-16T15:42:32.798925+00:00\",\n \"data_hash\": \"byv+mnwnmumDkauxceknnlKwQAsn/TqFNIEurokWpd0=\"\n },\n \"monitoring_entry\": {\n \"id\": \"4ad05a37-b261-4800-88aa-e28558f8b22b\",\n \"external_identifier\": \"MY-EXTERNAL-UID-0001\",\n \"timestamp\": \"2026-02-09T12:13:19.519317Z\"\n }\n },\n \"timestamp\": \"2026-02-09T12:13:19.749742+00:00\"\n}\n\nSent when an existing monitoring result is updated.
\nWhen the status or text of a monitoring result changes (for example, from 'New' to 'Real Positive' or 'False Positive' or edited comments).
Used to track analyst decisions and status changes applied to a monitoring result.
\n{\n \"object_type\": \"monitoring_result\",\n \"action\": \"updated\",\n \"data\": {\n \"id\": \"03e1dd57-f8a3-42b3-aa3a-687f6c17f5c8\",\n \"confidence_score\": 1,\n \"status\": \"Real Positive\",\n \"text\": \"New Result Found\",\n \"timestamp\": \"2026-02-09T12:16:58.042717Z\",\n \"modified_at\": \"2026-02-09T12:17:25.316543Z\",\n \"risk\": null,\n \"data_entry\": {\n \"name\": \"John Doe\",\n \"address\": [\n \"1000 Market Street, San Francisco, United States\"\n ],\n \"remarks\": \"Engaged in cyber operations targeting critical infrastructure in...\",\n \"alt_names\": [\n \"JD\",\n \"John M Doe\",\n \"Jonny Doe\"\n ],\n \"data_hash\": \"byv+mnwnmumDkauxceknnlKwQAsn/TqFNIEurokWpd0=\",\n \"data_source\": \"FSL\",\n \"entity_type\": \"Individual\",\n \"last_update\": \"2025-06-16T15:42:32.798925+00:00\",\n \"nationality\": [\n \"US\"\n ],\n \"first_import\": \"2025-06-05T09:09:01.421094+00:00\",\n \"date_of_birth\": [\n \"1980-12-15\"\n ],\n \"si_identifier\": \"FSL-NONE-024\",\n \"year_of_birth\": [\n 1980\n ],\n \"confidence_score\": 0\n },\n \"monitoring_entry\": {\n \"id\": \"4ad05a37-b261-4800-88aa-e28558f8b22b\",\n \"external_identifier\": \"MY-EXTERNAL-UID-0001\",\n \"timestamp\": \"2026-03-15T23:05:37.519317Z\"\n }\n },\n \"timestamp\": \"2026-02-09T12:17:25.432330+00:00\"\n },\n}\n\nThis document provides a complete reference for all webhook events emitted by the system. For each event, it explains when it is triggered and details the payload data included in the webhook request.
\n","_postman_id":"f183ca25-6b34-42b3-9d4f-b362dadc8333"}],"id":"179f9497-d51f-4368-86be-22c8e3630380","description":"Webhooks in sanctions.io enable real-time integration by notifying your application instantly when specific events occur - such as when batch screening results are ready or monitoring alerts are generated. This allows you to automate workflows and keep your systems in sync without polling the API.
\n","_postman_id":"179f9497-d51f-4368-86be-22c8e3630380"},{"name":"Sandbox Environment","item":[{"name":"Setting up Your Sandbox Environment","item":[],"id":"7cabfa8b-2f9b-47d5-aa80-60854a9bce00","description":"Generate a Sandbox token
\nFrom the dashboard
Go to your sanctions.io account → API Settings and create a new Sandbox token directly from the UI.
Via the API
Call the /token/ endpoint programmatically. View the endpoint reference: Create API Tokens
Use the same endpoints
No URL changes needed. Sandbox shares the same API endpoints as production. Just swap the token in your Authorization header.
Load the test dataset
Download the CSV with Sandbox Dataset and use those record IDs in your requests. Requests using data outside this set won't behave as expected.
The Sandbox is a fully isolated environment that mirrors production. Use it to build and validate your integration before going live. No real data, no subscription usage.
\nNote: Sandbox environment applies only to the Screening API.
\nSafe testing - Experiment freely without affecting your live data or consuming API calls from your subscription.
\nProduction-identical endpoints - The Sandbox uses the same API endpoints as production, so no URL changes are needed when you go live.
\nPredictable results - Testing is done against a fixed dataset we provide, ensuring consistent and reproducible behavior.
\n\n\n⚠ Sandbox vs production tokens are not interchangeable. Production tokens will not authenticate against the Sandbox environment and vice versa.
\n
The Sandbox only processes records from the provided test dataset. It does not accept real-world data.
\n","_postman_id":"f950f7af-70b4-48a7-9716-8fbbd702d59e"},{"name":"Account Management","item":[{"name":"Tokens","item":[{"name":"List API Tokens","id":"3ff8ca7d-b354-42cf-bd33-90fcf1ae7699","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{api_version}}"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.sanctions.io/tokens/","description":"Displays all tokens associated with your account.
\nNote on Sandbox Tokens:
\nLimited access to certain endpoints.
\nSearches yield incomplete and unreliable data.
\nCan only perform actions on other sandbox tokens, not on production tokens.
\nFilter by tokens that are sandbox.
\n","type":"text/plain"},"key":"is_sandbox","value":"Filter by tokens that are deleted.
\n","type":"text/plain"},"key":"is_deleted","value":"Generates a new API token for immediate use. All tokens are tied to the same account and share permissions.
\nToken Types:
\nRemoves the specified token, identified by the key in the URL.
\nNote:
\nSandbox tokens cannot delete production tokens.
\nA token cannot be used to delete itself.
\nAPI tokens are a critical security component, so please be aware that creating or deleting tokens can directly affect the stability and functionality of your systems.
\nIf a token is deleted, it becomes immediately invalid - any system still using it will experience request failures until the token is replaced.
\nThere are two types of tokens:
\nProduction tokens provide full access to live data and all platform features. Requests made with production tokens count against your annual API quota.
\nSandbox tokens are restricted to our test environment and only access dummy data. These requests do not count toward your API quota.
\nWe strongly recommend implementing a token rotation policy within your systems. Please consult your security team to define an appropriate rotation schedule aligned with your organization's best practices.
\n","_postman_id":"5e8eb3df-1dad-488d-a0f9-9e539b1cc0b3"},{"name":"Company","item":[{"name":"Company","id":"e077d779-56fd-455a-bfc7-feff3a1b78c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{api_version}}"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.sanctions.io/company/","description":"Provide your company's contact details.
\n","urlObject":{"path":["company",""],"host":["https://api.sanctions.io"],"query":[],"variable":[]}},"response":[{"id":"180e23ef-b978-4bae-8878-73e892d993bf","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=2.2","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.sanctions.io/tokens"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Descent llc.\",\n \"vat\": \"12-234234B\",\n \"address_line_1\": \"422 Walnut St\",\n \"address_line_2\": \"5, 234\",\n \"city\": \"Sewickley\",\n \"postal_code\": \"35004\",\n \"state\": \"Pennsylvania\",\n \"country\": \"US\",\n \"company_config\": {\n \"weekly_consumption_report\": false,\n \"reports_recipients\": [\n \"one@descent.com\",\n \"two@descent.com\"\n ],\n \"webhook_url\": null,\n \"sandbox_webhook_url\": null\n }\n}"},{"id":"694a887b-8086-4ce7-bba4-8ecea0917568","name":"Error message when there is no token provided.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{api_version}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text","disabled":true}],"url":"https://api.sanctions.io/tokens"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"detail\": \"Authentication credentials were not provided.\"}"},{"id":"075c8f4c-5e4c-45c7-88ef-0ba736e75eed","name":"OK - typing","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{api_version}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.sanctions.io/tokens"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"str\",\n \"vat\": \"str\",\n \"address_line_1\": \"str\",\n \"address_line_2\": \"str\",\n \"city\": \"str\",\n \"postal_code\": \"str\",\n \"state\": \"str\",\n \"country\": \"str\",\n \"company_config\": \"object\"\n}"},{"id":"9defd252-24cf-4895-a58b-7d1b49112ce5","name":"Error - typing","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{api_version}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text","disabled":true}],"url":{"raw":"https://api.sanctions.io/search/?min_score=0.85&data_source=sanctions-lists&name=Luckashenko","host":["https://api.sanctions.io"],"path":["search",""],"query":[{"key":"min_score","value":"0.85","description":"Minimum confidence score filter (0.1 = low confidence, 1.0 = high confidence)."},{"key":"data_source","value":"sanctions-lists","description":"(Required) The `short_name` of the data source/s (comma separated) you'd like to include for your search. This parameter is mandatory in API version 2.1 and onward. See a list of all supported sources [here](https://docs.sanctions.io/sanctions-and-watchlists).\n**CRIME** includes FBI and INTERPOL data sources.\n**SANCTIONS-LISTS** includes all our Sanctions lists (excluding FBI and Interpol).\n**HIGH-RISK-JURISDICTIONS*** covers all jurisdiction lists.\n**PEP-LISTS*** Politically Exposed Persons list."},{"key":"name","value":"Luckashenko","description":"(Required) Name of a person or entity"},{"key":"name_scoring_weight","value":"9","description":"Relative weight (1 to 10) of the name for the confidence_score calculation (default is 9).","type":"text","disabled":true},{"key":"name_match_boosting_threshold","value":"0.9","description":"If the name-matching score is higher than the defined threshold, the overall confidence score will be overwritten with the name-matching score. The threshold can be freely defined between 0.7 and 1.0.","type":"text","disabled":true},{"key":"identifier","value":"www.website.com","description":"Filter records with matching identifiers.","type":"text","disabled":true},{"key":"identifier_scoring_weight","value":"3","description":"Relative weight (1 to 10) of the identifier in the score calculation (default is 3).","type":"text","disabled":true},{"key":"identifier_match_boosting_threshold","value":"0.9","description":"If the identifier-matching score is higher than the defined threshold, the overall confidence score will be overwritten with the identifier-matching score. The threshold can be freely defined between 0.7 and 1.0.","type":"text","disabled":true},{"key":"entity_type","value":"entity","description":"Type of entity (individual, entity, vessel, aircraft).","type":"text","disabled":true},{"key":"entity_type_scoring_weight","value":"3","description":"Relative weight (1 to 10) of the entity_type in the score calculation (default is 3).","type":"text","disabled":true},{"key":"country_residence","value":"RU","description":"Country of residency (ISO2)","type":"text","disabled":true},{"key":"country_residence_scoring_weight","value":"3","description":"Relative weight (1 to 10) of the country_residence in the score calculation (default is 3).","type":"text","disabled":true},{"key":"date_of_birth","value":"Update your company contact details.
\nBoth PUT and PATCH rest verbs are accepted.
Will provide your company's configuration settings.
\n","urlObject":{"path":["company","config",""],"host":["https://api.sanctions.io"],"query":[],"variable":[]}},"response":[{"id":"07fd31d9-602f-4420-b62b-a00ad24959fc","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=2.2","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.sanctions.io/tokens"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"weekly_consumption_report\": false,\n \"reports_recipients\": [\n \"one@descent.com\",\n \"two@descent.com\"\n ],\n \"webhook_url\": null,\n \"sandbox_webhook_url\": null\n }"},{"id":"5115cf53-cfdd-46cd-8160-657af30ad5fa","name":"Error message when there is no token provided.","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=2.2","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text","disabled":true}],"url":"https://api.sanctions.io/tokens"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"detail\": \"Authentication credentials were not provided.\"}"},{"id":"ac7a2dbc-511f-47a4-9e61-ed1e09941365","name":"Error - typing","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=2.2","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text","disabled":true}],"url":{"raw":"https://api.sanctions.io/search/?min_score=0.85&data_source=sanctions-lists&name=Luckashenko","host":["https://api.sanctions.io"],"path":["search",""],"query":[{"key":"min_score","value":"0.85","description":"Minimum confidence score filter (0.1 = low confidence, 1.0 = high confidence)."},{"key":"data_source","value":"sanctions-lists","description":"(Required) The `short_name` of the data source/s (comma separated) you'd like to include for your search. This parameter is mandatory in API version 2.1 and onward. See a list of all supported sources [here](https://docs.sanctions.io/sanctions-and-watchlists).\n**CRIME** includes FBI and INTERPOL data sources.\n**SANCTIONS-LISTS** includes all our Sanctions lists (excluding FBI and Interpol).\n**HIGH-RISK-JURISDICTIONS*** covers all jurisdiction lists.\n**PEP-LISTS*** Politically Exposed Persons list."},{"key":"name","value":"Luckashenko","description":"(Required) Name of a person or entity"},{"key":"name_scoring_weight","value":"9","type":"text","description":"Relative weight (1 to 10) of the name for the confidence_score calculation (default is 9).","disabled":true},{"key":"name_match_boosting_threshold","value":"0.9","type":"text","description":"If the name-matching score is higher than the defined threshold, the overall confidence score will be overwritten with the name-matching score. The threshold can be freely defined between 0.7 and 1.0.","disabled":true},{"key":"identifier","value":"www.website.com","type":"text","description":"Filter records with matching identifiers.","disabled":true},{"key":"identifier_scoring_weight","value":"3","type":"text","description":"Relative weight (1 to 10) of the identifier in the score calculation (default is 3).","disabled":true},{"key":"identifier_match_boosting_threshold","value":"0.9","type":"text","description":"If the identifier-matching score is higher than the defined threshold, the overall confidence score will be overwritten with the identifier-matching score. The threshold can be freely defined between 0.7 and 1.0.","disabled":true},{"key":"entity_type","value":"entity","type":"text","description":"Type of entity (individual, entity, vessel, aircraft).","disabled":true},{"key":"entity_type_scoring_weight","value":"3","type":"text","description":"Relative weight (1 to 10) of the entity_type in the score calculation (default is 3).","disabled":true},{"key":"country_residence","value":"RU","type":"text","description":"Country of residency (ISO2)","disabled":true},{"key":"country_residence_scoring_weight","value":"3","type":"text","description":"Relative weight (1 to 10) of the country_residence in the score calculation (default is 3).","disabled":true},{"key":"date_of_birth","value":"Update your company's configuration settings.
\nBoth PUT and PATCH rest verbs are accepted.
Returns a paginated list of all active users in the authenticated user's company, ordered by account_type then date_joined (most recent first).
Requires: owner or admin role. Non-sandbox token.
Page number of the paginated results.
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Number of results per page. Default 25, max 100.
\n","type":"text/plain"},"key":"page_size","value":"25"}],"variable":[]}},"response":[{"id":"5a3ddc29-e1cb-45ba-b216-5d0c019d9627","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{api_version}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":{"raw":"https://api.sanctions.io/user/?page=1&page_size=25","host":["https://api.sanctions.io"],"path":["user",""],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"25"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane@company.com\",\n \"account_type\": \"admin\",\n \"is_active\": true,\n \"date_joined\": \"2024-01-15T10:30:00Z\",\n \"enable_monitoring\": false,\n \"sso_enabled\": false\n },\n {\n \"uuid\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"email\": \"john@company.com\",\n \"account_type\": \"compliance\",\n \"is_active\": true,\n \"date_joined\": \"2024-03-20T09:00:00Z\",\n \"enable_monitoring\": false,\n \"sso_enabled\": false\n }\n ],\n \"extra_data\": {\n \"max_users_allowed\": 10\n }\n}"},{"id":"feceb40b-d669-43f4-945a-7d62c4350ae6","name":"Error message when no token provided","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{api_version}}","type":"text"}],"url":"https://api.sanctions.io/user/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"detail\": \"Authentication credentials were not provided.\"}"},{"id":"22766ea1-b94d-483f-b7ea-000952e3a82b","name":"Error message when insufficient permissions","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{api_version}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.sanctions.io/user/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"detail\": \"You are not allowed to get list of accounts.\"}"},{"id":"f819a74c-1d66-4ba1-a3d8-255a77bd917e","name":"OK - Response typing","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{api_version}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.sanctions.io/user/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": \"int\",\n \"next\": \"null / str url\",\n \"previous\": \"null / str url\",\n \"results\": [\n {\n \"uuid\": \"str uuid\",\n \"first_name\": \"str\",\n \"last_name\": \"str\",\n \"email\": \"str\",\n \"account_type\": \"str (owner | admin | integration | compliance | auditor)\",\n \"is_active\": \"bool\",\n \"date_joined\": \"str datetime\",\n \"enable_monitoring\": \"bool\",\n \"sso_enabled\": \"bool\"\n }\n ],\n \"extra_data\": {\n \"max_users_allowed\": \"int\"\n }\n}"},{"id":"9fe3b4fd-6cef-4b3c-8df9-8706fac4bfaa","name":"Error - Response typing","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{api_version}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.sanctions.io/user/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"detail\": \"Creates a new user account within the authenticated user's company and sends an activation email. The new user remains inactive until they click the activation link.
\nRequires: Non-sandbox token. owner or admin role.
account_type accepted values: admin | integration | compliance | auditor
Validations:
\nadmin cannot invite another admin).Retrieves details for a specific user within the authenticated user's company. The target user must belong to the same company.
\n","urlObject":{"path":["user","{{user_uuid}}"],"host":["https://api.sanctions.io"],"query":[],"variable":[]}},"response":[{"id":"66cf11cc-1301-4029-802d-efbb2277542c","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{api_version}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.sanctions.io/user/3fa85f64-5717-4562-b3fc-2c963f66afa6"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane@company.com\",\n \"account_type\": \"compliance\",\n \"is_active\": true,\n \"date_joined\": \"2024-01-15T10:30:00Z\",\n \"enable_monitoring\": false,\n \"sso_enabled\": false\n}"},{"id":"334b8d5f-04fb-41b1-bbc8-ca4dd3634180","name":"Error message when no token provided","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{api_version}}","type":"text"}],"url":"https://api.sanctions.io/user/{{user_uuid}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"detail\": \"Authentication credentials were not provided.\"}"},{"id":"f1471b5d-dd0b-4a06-b4d4-8fbbf70420f4","name":"Error message when user not found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{api_version}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.sanctions.io/user/{{user_uuid}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"detail\": \"Not found.\"}"},{"id":"41613b1e-6a64-4686-8437-c0b383b7b1ea","name":"OK - Response typing","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{api_version}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.sanctions.io/user/{{user_uuid}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"uuid\": \"str uuid\",\n \"first_name\": \"str\",\n \"last_name\": \"str\",\n \"email\": \"str\",\n \"account_type\": \"str (owner | admin | integration | compliance | auditor)\",\n \"is_active\": \"bool\",\n \"date_joined\": \"str datetime\",\n \"enable_monitoring\": \"bool\",\n \"sso_enabled\": \"bool\"\n}"},{"id":"2e59275f-a7e8-40f0-a5e3-cb842c00c406","name":"Error - Response typing","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version={{api_version}}","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.sanctions.io/user/{{user_uuid}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"detail\": \"Updates one or more fields for a user within the company. Both PUT and PATCH are accepted.
Editable fields:
\nfirst_name (string)last_name (string)account_type (string): admin | integration | compliance | auditorenable_monitoring (string \"true\" / \"false\"): requires a monitoring-enabled subscriptionRestrictions:
\naccount_type or enable_monitoring.account_type values lower than their own.enable_monitoring requires the company's active subscription plan to include monitoring.Removes a user from the company. All active API tokens for the deleted user are automatically disabled.
\nRestrictions:
\nBehaviour:
\n204 No Content.200 with a detail message.Endpoints for managing users within a company account. These endpoints allow owners and admins to invite new users, update their roles, and remove them from the platform.
\nBase URL: https://api.sanctions.io
Role hierarchy: owner > admin > integration > compliance > auditor
Common restrictions across all endpoints:
\nThis endpoint provides information on the status of your subscriptions.
\n","urlObject":{"path":["plans",""],"host":["https://api.sanctions.io"],"query":[{"disabled":true,"description":{"content":"Filter by plans that are for Transaction screening.
\n","type":"text/plain"},"key":"is_sanctions","value":"Filter by plans that are for PEP screening.
\n","type":"text/plain"},"key":"is_pep","value":"Filter by plans that are adtive.
\n","type":"text/plain"},"key":"is_active","value":"This endpoint will provide the count of queries performed, filtered by the parameters provided. We do not store the parameters of your request for data privacy reasons but we use a hash algorithm (one direction only) that enables us to store how you searched, but not what you searched for.
\n","urlObject":{"path":["searches","count"],"host":["https://api.sanctions.io"],"query":[{"disabled":true,"description":{"content":"Filter by api call type, choices: normal, sandbox
\n","type":"text/plain"},"key":"api_call_type","value":"Filter by searches after (including) the datetime string representation provided, format YYYY-MM-DDTHH:MM:SS.MSZ0:00, when a partial timestamp is provided, it defaults to 0 hours, 0 minutes 0 seconds, and utc timezone.
\n","type":"text/plain"},"key":"from_timestamp","value":"Filter by searches before (not including) the datetime string representation provided, format YYYY-MM-DDTHH:MM:SS.MSZ0:00, when a partial timestamp is provided, it defaults to 0 hours, 0 minutes 0 seconds, and utc timezone.
\n","type":"text/plain"},"key":"to_timestamp","value":"Filter by searches that were sanctions searches.
\n","type":"text/plain"},"key":"is_sanctions","value":"Filter by searches that were PEP searches.
\n","type":"text/plain"},"key":"is_pep","value":"Filter by searches that were media searches.
\n","type":"text/plain"},"key":"is_media","value":"Filter by searches that returned that amount of results in the response.
\n","type":"text/plain"},"key":"result_count","value":"Filter by searches which's hashed name is coincident.
\n","type":"text/plain"},"key":"name_hash","value":"Filter by searches that used that parameter in the request.
\n","type":"text/plain"},"key":"page","value":"Each API request is stored with its own UUID, the stored UUID is returned in the response when you search for them, if you specify a UUID in this request you can get 1 result at most.
\n","type":"text/plain"},"key":"uuid","value":"Filter by searches using the provided token. format [0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}
\n","type":"text/plain"},"key":"used_token","value":"