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.
\nTo begin using the API, simply sign up for a free trial and retrieve your API key from the dashboard. This key grants you access to all API features during your trial period.
\nFor integration guides, usage examples, and troubleshooting support, please refer to:
\nOur comprehensive Knowledge Base
\nOur Implementation Guide and our Best Practices
\nOur dedicated Customer Support Team is available to assist you at help@sanctions.io
\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.)
\nThese parameters are supported across both Real-time and Batch screening. For batch requests, they must be included in the JSON payload.
\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.
\nRecommended 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
\nDescription: The primary name of the entity being monitored. This is the main search input and is required for screening.
\nConstraints: Maximum of 15 words
\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 country 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
\nDescription: An additional identifier associated with the entity. This is used to strengthen matching and reduce ambiguity. Helpful especially for high-risk entities with common names.
\nConstraints: Accepts a single identifier with a maximum length of 120 characters.
\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.8 - 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.
\nIf omitted, no boosting is applied to the confidence score calculation.
\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
The following example demonstrates the effect of name_match_boosting_threshold on screening results for the same request.
Both requests use identical parameters (name, entity_type, country, min_score, and data_source) with the only difference being the presence of name_match_boosting_threshold.
In this example, the screened individual is a sanctioned person based in Myanmar (MM), but the request is submitted with country=US.
curl --location 'https://api.sanctions.io/search?min_score=0.88&data_source=sanctions-lists&name=John Michael Carter&entity_type=individual&country=US' \\\n --header 'Authorization: Bearer {{token}}' \\\n --header 'Accept: application/json; version=2.3'\n\nResult: 0 matches.
\nWithout boosting, the country=US parameter weighs heavily against the entity's known country of residence (MM), suppressing all results below the min_score threshold.
{\n \"count\": 0,\n \"next\": null,\n \"previous\": null,\n \"results\": [],\n \"search\": {\n \"params\": {\n \"min_score\": \"0.88\",\n \"data_source\": \"sanctions-lists\",\n \"name\": \"John Michael Carter\",\n \"entity_type\": \"individual\",\n \"country\": \"US\"\n },\n \"timestamp\": \"2026-04-25T23:21:02.529849+00:00\",\n \"api_version\": \"2.3\",\n \"id\": \"558c6c42-d104-4aa7-afbe-2ec9ee3d33da\"\n }\n}\n\ncurl --location 'https://api.sanctions.io/search?min_score=0.88&data_source=sanctions-lists&name=Jawhar Majid Al-Duri&entity_type=individual&country=US&name_match_boosting_threshold=0.94' \\\n --header 'Authorization: Bearer {{token}}' \\\n --header 'Accept: application/json; version=2.3'\n\nResult: 2 matches with confidence_score between 0.97 and 0.99
With name_match_boosting_threshold=0.94, matches where the name scores at or above 0.94 have their weight boosted in the overall confidence calculation. This surfaces strong name-based matches even when other parameters, such as country,do not align.
{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"confidence_score\": 0.99,\n \"name\": \"JOHN MICHAEL CARTER\",\n \"alt_names\": [\n \"ဂျွန် မိုက်ကယ် ကာတာ\"\n ],\n \"entity_type\": \"Individual\",\n \"country_residence\": [\n \"MM\"\n ],\n \"year_of_birth\": [\n 1942\n ],\n \"place_of_birth\": [\n \"Mandalay, MM\"\n ],\n \"data_source\": {\n \"name\": \"FSL / Fictional Sanctions List\",\n \"short_name\": \"FSL\"\n },\n \"source_list_url\": \"https://www.example.gov/international-relations/security/sanctions/consolidated-list\",\n \"program\": [\n \"AU-1518\"\n ],\n \"remarks\": \"Listing Information: Listed by the 1518 Committee. Additional Information: MMi.068 Instrument of Designation: Charter of the United Nations (Sanctions \\u2014 Myanmar) Regulations 2008. \",\n \"additional_information\": {\n \"committees\": \"1518 (Myanmar)\",\n \"control_date\": \"2025-12-11\",\n \"targeted_financial_sanction\": \"True\"\n },\n \"si_identifier\": \"FSL-AU1518-713\",\n \"entity_number\": 713,\n \"first_import\": \"2023-03-26T17:14:26.132264+00:00\",\n \"last_update\": \"2025-12-24T13:32:49.993728+00:00\",\n \"data_hash\": \"7giTb4XR/JrqQW6ijbH+zrlrIj+iMcm4DKJN/QB1P5U=\"\n },\n {\n \"confidence_score\": 0.97,\n \"name\": \"JOHN M CARTER\",\n \"alt_names\": [\n \"JOHN CARTER\"\n ],\n \"entity_type\": \"Individual\",\n \"country_residence\": [\n \"MM\"\n ],\n \"date_of_birth\": [\n \"1942\"\n ],\n \"data_source\": {\n \"name\": \"FSL / Fictional Sanctions List\",\n \"short_name\": \"FSL\"\n },\n \"source_list_url\": \"https://scsanctions.fsl.org/resources/xml/en/consolidated.xml\",\n \"start_date\": \"2004-04-07\",\n \"program\": [\n \"MYANMAR\"\n ],\n \"federal_register_notice\": \"MMi.068\",\n \"additional_information\": {\n \"list_type\": \"UN List\",\n \"version_number\": \"1\"\n },\n \"si_identifier\": \"UNSCSIND-MYANMAR-6908115MMI068\",\n \"entity_number\": 6908115,\n \"first_import\": \"2022-06-15T22:07:09.699354+00:00\",\n \"last_update\": \"2023-08-12T00:05:12.055577+00:00\",\n \"data_hash\": \"wp9mwSGK/Qku2xLgYALT1yqTaxq2Edrx4l7FYEHTh7k=\"\n }\n ],\n \"search\": {\n \"params\": {\n \"min_score\": \"0.88\",\n \"data_source\": \"sanctions-lists\",\n \"name\": \"John Michael Carter\",\n \"entity_type\": \"individual\",\n \"country\": \"US\",\n \"name_match_boosting_threshold\": \"0.94\"\n },\n \"timestamp\": \"2026-04-25T23:21:14.340065+00:00\",\n \"api_version\": \"2.3\",\n \"id\": \"a54954d5-23fb-421e-8b26-3c28f373b76c\"\n }\n}\n\n\n\n","_postman_id":"377bda49-a115-4850-a035-9aec7afe4f3f"},{"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":"💡 This is particularly useful in scenarios where the country is uncertain and cannot be omitted from your screening request.
\n
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":"List Batch Screenings","id":"70299919-02da-4eb9-9aa7-823ca44e8dcd","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/search/batch/","description":"A 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":"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.
\nReturns 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","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","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.
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.
\nDisplays 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.
This 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 a list 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":"