SAMS API

SAMS API V3 OAS1


API Docs

You can integrate SAMS smart APIs on the web in a world-class structure. Our APIs are developed in a stateless and service-oriented architecture. Following, you will find details of service types, methods, input and output parameters and their descriptions.

Starting with SAMS API

Welcome to the SAMS RESTful API. You can use our API to access SAMS functionalities. The SAMS API is organised around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, such as HTTP authentication and HTTP verbs (POST, GET, PUT, PATCH, and DELETE.), which are understood by off-the-shelf HTTP clients.

We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website’s client-side code). JSON is returned by all API responses, including errors. We have language bindings in curl, Ruby, and Python etc. You can view code examples in the example request section and you can switch the programming language of the examples with the language tab in the top right.

API Base Endpoint Addresses

Service Name Service Type Address
SAMS API services REST https://bwff51oh1j.execute-api.ap-south-1.amazonaws.com/prod/

SAMS OAS API Services

Service Name Service Type Request Type Address Description
Initiate individual, entity, vessel and aircraft REST POST https://bwff51oh1j.execute-api.ap-south-1.amazonaws.com/prod/initiate/ This service is used to perform Individual search on the system.
Submit verdict REST POST https://bwff51oh1j.execute-api.ap-south-1.amazonaws.com/prod/verdict/initial/'search_id'/ This service is used to perform a verdict submission(Accept Or Reject) for the search in queue on the system.

Note: Use the search_id received in the response.
Get and Submit Verdict REST GET https://bwff51oh1j.execute-api.ap-south-1.amazonaws.com/prod/get-search/initial/'search_id'/ This service is used to perform a verdict submission(Accept Or Reject) for the search using an interactive user interface.

Thi API can also be used to see the results that are submitted in an interactive user interface.

Note: Use the search_id received in the response.


SAMS APIs 3

raw

API to initiate the individual (initial) search and get results for the same.  |  POST   {{url}}/searches/initiate/

Headers
KeyValueDescription
AuthorizationApi-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API is used to initiate single searches for individual type.
Body
{ "screen_type": "initial", "applicant_id": "uhi4hi-3safdsa3-asdfj", "search_type": "individual", "name": "Abdul Sattar", "gender": "Male", "date_of_birth": "1964-07-26", "aliases": "", "email": "", "nationality": "", "country": "Afghanistan", "country_of_jurisdiction": "Afghanistan", "address": "Afghanistan", "national_id": "", "voter_id": "", "passport_number": "AM5421691", "pan": "", "phone_number": "", "sanction_field": true, "pep_field": true, "ams_field": true, "target_date": "2023-04-21", "end_date": "2023-11-25", "application_id": "uhi4hi-3safdsa3-asdfj", "sfdc_lead_id": "uhi4hi-3safdsa3-asdfj", "branch_name": "bangalore", "product_line": "123", "pennant_analyst_name": "manager_sams", "analyst_email_id": "sams@solytics-partners.com" }

raw

API to initiate the individual (ongoing) search and get results for the same.  |  POST   {{url}}/searches/initiate/

Headers
KeyValueDescription
AuthorizationApi-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API is used to initiate single searches for individual type.
Note: The same changes would be applicable in case of entity, vessel, and aircraft.

Body
{ "screen_type": "ongoing", "frequency": "1", "applicant_id": "uhi4hi-3safdsa3-asdfj", "search_type": "individual", "name": "Abdul Sattar", "gender": "Male", "date_of_birth": "1964-07-26", "aliases": "", "email": "", "nationality": "", "country": "Afghanistan", "country_of_jurisdiction": "Afghanistan", "address": "Afghanistan", "national_id": "", "voter_id": "", "passport_number": "AM5421691", "pan": "", "phone_number": "", "sanction_field": true, "pep_field": true, "ams_field": true, "target_date": "2023-04-21", "end_date": "2023-11-25", "application_id": "uhi4hi-3safdsa3-asdfj", "sfdc_lead_id": "uhi4hi-3safdsa3-asdfj", "branch_name": "bangalore", "product_line": "123", "pennant_analyst_name": "manager_sams", "analyst_email_id": "sams@solytics-partners.com" }

raw

API to initiate the entity search and get results for the same.  |  POST   {{url}}/searches/initiate/

Headers
KeyValueDescription
Authorization Api-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API is used to initiate single searches for entity type
Body
{ "screen_type": "initial", "applicant_id": "uhi4hi-3safdsa3-asdfj", "search_type": "entity", "name": "YUK TUNG ENERGY PTE LTD", "date_of_birth": "", "aliases": "", "email": "", "country": "", "headquarter": "", "country_of_jurisdiction": "", "cin": "", "address": "", "tin": "", "isin": "", "gst": "", "ams_field": true, "sanction_field": true, "target_date": "2023-04-21", "application_id": "uhi4hi-3safdsa3-asdfj", "sfdc_lead_id": "uhi4hi-3safdsa3-asdfj", "branch_name": "bangalore", "product_line": "123", "pennant_analyst_name": "manager_sams", "analyst_email_id": "sams@solytics-partners.com" }

raw

API to initiate the aircraft search and get results for the same.  |  POST   {{url}}/searches/initiate/

Headers
KeyValueDescription
Authorization Api-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API is used to initiate single searches for aircraft type
Body
{ "target_date": "2023-03-10", "screen_type": "initial", "name": "N200VR", "date_of_birth": "2010-03-09", "country_of_jurisdiction": "United States", "address": "80 SW 8th Street Suite 2000", "zipcode": "33130", "aliases": "", "country": "United States", "registered_owner": "", "manufacture_serial_number": "133", "construction_number": "", "program": "SDNTK", "aircraft_model": "Gulfstream 200", "ams_field": true, "sanction_field": true, "search_type": "aircraft", "applicant_id": "uhi4hi-3safdsa3-asdfj", "application_id": "uhi4hi-3safdsa3-asdfj", "sfdc_lead_id": "uhi4hi-3safdsa3-asdfj", "branch_name": "bangalore", "product_line": "123", "pennant_analyst_name": "manager_sams", "analyst_email_id": "sams@solytics-partners.com" }

raw

API to initiate the vessel search and get results for the same.  |  POST   {{url}}/searches/initiate/

Headers
KeyValueDescription
Authorization Api-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API is used to initiate single searches for vessel type
Body
{ "target_date": "2023-03-10", "screen_type": "initial", "name": "BEHTA", "date_of_birth": "", "nationality": "", "country_of_jurisdiction": "Iran, Islamic Republic of", "address": "", "aliases": "", "country": "Iran, Islamic Republic of", "registered_owner": "", "parent_company": "", "vessel_type": "container vessels", "imo": "9349590", "mmsi": "", "flag_state": "Iran", "ams_field": true, "sanction_field": true, "search_type": "vessel", "applicant_id": "uhi4hi-3safdsa3-asdfj", "application_id": "uhi4hi-3safdsa3-asdfj", "sfdc_lead_id": "uhi4hi-3safdsa3-asdfj", "branch_name": "bangalore", "product_line": "123", "pennant_analyst_name": "manager_sams", "analyst_email_id": "sams@solytics-partners.com" }

raw

Submit Verdict  |  POST   {{url}}/verdict/initial/f293d65b-6f1b-427a-acfd-8aa32112e66f/

Headers
KeyValueDescription
AuthorizationApi-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API is used to Submit Verdict (Accept Or Reject) Searches In queue. If successful In response we get The base 64 data that can be converted into HTML and downloaded as report for future reference.
Query
KeyValueDescription
ScreeninitialType initial screening passed in the URL route
ScreenongoingType ongoing monitoring screening passed in the URL route
Body
{ "remarks": "These are the comments added by analyst!", "status": "accept", "results": { "ams_result": [ { "id": "33812658826789563217139795306244270233320177293765036777075222670790865780084", "status": true, "Remark": "okk" } ], "pep_result": [ { "id": "6414571fe362ecaa53869ff9128c0079ec47b92224ed35f139cc4713e348a689", "status": true, "Remark": "okk" } ], "sanction_result": [ { "id": "44a12932772e9fc8725c966ad6edf910a61655b2044378fffd054102282f7a50", "status": true, "Remark": "okk" }, { "id": "df6c002deca949d96ceb7c61a659749d2c816d3bbd13f560998bf359b3fceedd", "status": false, "Remark": "Not okk" } ], "sanctioncountry_result": [] } }

raw

API to get search result and submit verdict.  |  GET HTTP RESPONSE   {{url}}/searches/get-search/initial/f293d65b-6f1b-427a-acfd-8aa32112e66f/

Headers
KeyValueDescription
Authorization Api-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnAPI to get search result and submit verdict.

raw

API to get submitted verdict using verdict or get-search API.  |  GET HTTP RESPONSE   {{url}}/searches/get-search/initial/f293d65b-6f1b-427a-acfd-8aa32112e66f/

Headers
KeyValueDescription
Authorization Api-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnAPI to get submitted verdict using verdict or get-search API.

API Request/Response Description

Request parameters

Fields Description Datatype Max. Length Mandatory/Non-Mandatory
screen_type Describes whether the search is Initial Screening or Ongoing Monitoring String 10 Mandatory
search_type Describes for whom the search is done-Individual or Entity or Aircraft or Vessel String 100 Mandatory
applicant_id Unique ID from client for each name being screened String 10 Mandatory
name Name of the person/organization being screened String Max Mandatory
date_of_birth Date of birth of individual/ Date of establishment String 30 Non-Mandatory
aliases Different Aliases for the screened individual/Entity/Aircraft/Vessel String Max Non-Mandatory
email Email ID of the individual/Entity owner String 100 Non-Mandatory
nationality Nationality of the individual being screened String Max Non-Mandatory
country Country of the individual/entity/aircraft/vessel being screened String Max Non-Mandatory
country_of_jurisdiction Jurisdiction Country for the individual/entity/aircraft/vessel being screened String Max Non-Mandatory
address Address of the individual/entity/aircraft/vessel being screened String Max Non-Mandatory
national_id National ID details of the individual;e.g. Aadhar Card,etc String 50 Non-Mandatory
passport_number Passport number of the individual being screened String 50
voter_id Voter ID of the individual being screened String 50
driving_licence Driving Licence of the individual being screened String 50
phone_number Phone no. of the individual being screened String 50 Non-Mandatory
sanction_field Describes if Sanctions screening is to be done for this search Boolean NA Mandatory
target_date Due date for Analyst to complete the actions on the search in SFDC String 30 Mandatory
end_date The last date until which the search should reinitiate by system (Applicable for Ongoing and should be greater and qual to the current date) String 30 Non-Mandatory
frequency Defines the interval (in days) at which the names are screened if the screentype is Ongoing Monitoring. It will be required when we will integrate Pennant Integer 3 Mandatory for Ongoing Monitoring
application_id Application ID for the respective application from SFDC String 50 Mandatory
sfdc_lead_id Lead ID for SFDC String 30 Non-Mandatory
branch_name Allocated Branch Name for the respective search String Max Non-Mandatory
product_line Product Line name as assigned String Max Non-Mandatory
pennant_analyst_name Analyst assigned for the respective search in Pennant String Max Non-Mandatory
analyst_email_id Analyst email ID to which the excel is to be sent in Email (for Pennant) String Max Non-Mandatory
gender Gender of the person being screened String Max Non-Mandatory
pep_field Describes if PEP screening is to be done for this search false in case if Entity Boolean NA Mandatory
ams_field Describes if AMS screening is to be done Boolean NA Mandatory
pan PAN of the individual/entity being screened String 50 Non-Mandatory
headquarter Address for the Entity's headqaurters String Max Non-Mandatory
cin CIN of the entity being screened String 50 Non-Mandatory
tin PAN of the entity being screened (Currently we are using pan here in place of TIN) String 50
isin International Securities Identification Number for an entity String 50
gst GSTIN of the entity being screened String 50
parent_company Mention the Parent company of the vessel being searched String 50
country Country for the vessel being screened String 50
flag_state Desribes the Flag state of the vessel being screened String 50
registered_owner Describes the name of the registered owner of the vessel String 50
imo Describes the IMO of the vessel String 50
mmsi Describes the MMSI of the vessel String 50
tonnage Tonnage value for the vessel being screened received from the Sanction source String 50
aircraft_model Model of the Aircraft being screened String 50
manufacture_serial_number Manufacturing serial number for the aircraft being screened String 50
operator Operator for the screened aircraft String 50
program Program for the screened aircraft String 50
construction_number Construction number for the screened aircraft String 50
zipcode Zipcode for the screened entity String 50

Response parameters

Data Field-Individual Description Data type
Match Describes if there is a match or not against the screened name String
URL URL link to review case on SAMS portal; redirects the user to the respective search String
Search_ID Unique ID from Solytics Partner assigned to every search String
Analyst_Assigned_to Describes the user assigned to the case String
Analyst_Target_Date Due date for Analyst to complete the actions on the search String
Analyst_Assigned_Date Date on which the search was assigned to the user String
Applicant_ID Unique ID from client for each name being screened (should be available in payload) String
Applicant_name Name of the applicant String
Pennant_Analyst_Name Analyst assigned for the respective search in Pennant String
Status Status of the search String
Search_type Describes for whom the search is done-Individual or Entity or Aircraft or Vessel String
Analyst_Email_ID Analyst email ID to which the search is to be sent String
SFDC_Lead_ID Lead ID for the respective application from SFDC String
Application_ID Application ID for the respective application from SFDC String
Review_ID Review id that refers each search String
Branch_Name Allocated Branch Name for the respective search String
Product-Line Product Line name as assigned String
Pennant_Lead_ID Lead ID for the respective application from Pennant (Optional for Now) String
Driving_License Driving Licence of the individual being screened String
Voters_ID Voter ID of the individual being screened String
Sanctions_Result Contain below fields in Sanctions category result. List
status Status of the search String
comments Commnets by analyst if any (generally null) String
name Name received from the Sanction source String
private Describes if the Sanction is from Internal/Private Sanction of the bank Boolean
id Unique ID for search result in Solytics' Database String
source_type Describes the source type of result; Sanctions in this case String
gender Gender detail received from the Sanction source String
source_name Name of the organisation issuing the Sanction result String
source_link URL for theorganisation issuing the Sanction result String
source_description Brief desciption about the organisation issuing the Sanction result String
alias_names Describes Alias names received for the Sanction result from the Sanction source List
associated_country Describes the details of Associated Country for the name in the result List
sanctioned_country Describes the details of Sanctioned Country for the name in the result List
date_of_birth Date of birth received from the Sanction source String
analyst Analysts who reviewed the search List
zipcode Zipcode of the entity. String
country_of_jurisdiction Country of jurisdiction of the entity. String
call_sign Call sign of the vessel. String
sams_score SAMS Score is assigned based on the Name, Address, Date of Birth and ID matches; Dict
        name_match_score Describes the name matching score between the screened name and the result integer
        dob_match_score Describes the Date of Birth match score for Screened name and the Date of Birth received in the result String
        address_match_score Describes the Address match score for screened name and the addresses available in the result String
        overall_score Solytics defined weighted average of Name matching score,Date of Birth score, Address match score and the ID match integer
        matched_id Describes the ID match found between the screened name and the result received from Sanction source List
matched_address Describes the Address matched between the uploaded address and the address received from the search result String
documents Describes the various documents received from the Sanctions Source; Dict
        passport Passport number of the entity. string
        ssn Social Security Number. string
        organisation Name of the organization. string
        isin International Securities Identification Number. string
        cin Corporate Identification Number. string
        imo International Maritime Organization number. string
        mmsi Maritime Mobile Service Identity number. string
        manufacture_serial_number Serial number assigned by the manufacturer. string
        construction_number Construction number of the entity. string
        pan Permanent Account Number (India). string
        gst Goods and Services Tax Identification Number. string
        voter_id Voter Identification Number. string
        driving_license Driver's License Number. string
        national_id National Identification Number. string
        phone_number Contact phone number. string
        email Email address. string
        tail_number Aircraft tail number. string
        model Model number or name. string
id Unique ID for search result in Database String
heading Describes the heading for the article received in the result String
url Describes the URL of the article received in the result String
source Describes the URL of the website for the article received in the result String
summary Describes the summary for the article in the result String
content Describes the content of the article String
publish_date Describes the date on which the respective article was published String
name Describes the name for which the article is shown in the results String
name_match_score Describes the name matching score between the screened name and the result integer
overall_score Solytics defined weighted Average of the Name matching score, Sentiment score and Source Crediblity score integer
PEP_Result Contain below fields in PEP results received from different sources List
analyst Analyst who reviewed the search List
status status marked as true/false by the analyst String
name Name received from the PEP source String
id Unique ID for search result in Database String
source_type Describes the source type for the result; PEP in this case String
gender Gender detail received from the PEP source String
source_name Name of the organisation publishing the PEP details String
source_link URL for the organisation publishing the PEP details String
other_urls Other URL for the organisation publishing the PEP details String
soruce_description Brief description about the organisation publishing the PEP details String
citizenship Citizenship of the entity. List
associates Associates of the entity. Dict
pep_type Type of PEP entity. List
nationality Nationality of the entity. List
designation Designation of the individual as available from the PEP source below are listed fields List
       designation_pep_level    Level Of The PEP Designation String
       designation    Designation of the individual as available from the PEP source String
       designation_start_date    Starting date Of The Designation String
       designation_end_date    Ending Date of The Designation String
       designation_pep_type    PEP Type Of Designation String
organisation Organisation associated with individual as available from the PEP source String
address Address of the individual as available from the PEP source List
date_of_birth Date of birth information available with the PEP source String
place_of_birth Place of birth information available with the PEP source List
alias_names Available Aliases for the individual as per the organisation publishing the PEP details List
passport_number Passport details available for the individual as per the PEP source String
family-tree Family details about the Individual as per the PEP source Dict
        parent Details about the parents of the individual as per the PEP source List
        sibling Sibling details of the individual as per the PEP source List
        children Details about children of the individual as per the PEP source List
        spouse Spouse details of the individual as per the PEP source List
        son Son details of the individual as per the PEP source List
sams_score SAMS Score is assigned based on the Name, Address, Date of Birth and ID matches; Dict
        name_matching_score Describes the name matching score between the screened name and the result integer
        dob_match_score Describes the Date of Birth match score for the screened name and the Date of Birth received in the result String
        address_match_score Describes the Address match score for screened name and the addresses available in the result String
        overall_score Solytics defined weighted Average of the Name score, Address score, Date of Birth score and ID match integer
        matched_id Describes the ID match found between the screened name and the result received from PEP source List
Sanctions_Country_Result Contain below fields in Sanctions Country results received from different sources List
id Unique ID for search result in Solytics' Database String
Exemptions List of exempted items,actions that are published by the Sanction source List
listName Name of the source which has Sactioned the country String
country Name of the sanctioned country String
sourceURL1 Describes the URL of the source which placed sanctions on the country String
sourceURL2 Describes the URL of the source which placed sanctions on the country String
other_urls Describes the URL of the source which placed sanctions on the country String
Description Brief desciption about the sanctions placed by the source authority String
bannedSubjects List of banned items,actions that are restricted by the Sanction source String
analyst Analyst who reviewed the search String
AMS_Result Contain below fields for Adverse Media News results received from different articles List
status status marked as true/false by the analyst String
analyst Analyst who reviewed the search List
tags Describes the different words that are searched in the artciles. E.g., Penalty, terrorism, etc. List
id Unique ID for search result in Database String
heading Describes the heading for the article received in the result String
url Describes the URL of the article received in the result String
source Describes the URL of the website for the article received in the result String
summary Describes the summary for the article in the result String
content Describes the content of the article String
publish_date Describes the date on which the respective article was published String
name Describes the name for which the article is shown in the results String
name_match_score Describes the name matching score between the screened name and the result integer
sentiment_score Sentiment score is the score assigned to the article by Solytics based on below points; Dict
        score Describes the overall sentiment score of the article in the result integer
        sign Describes the tone of the overall article in terms of Positive, Negative or Neutral String
source_credibility_score Describes the credibility of the source for the article received in the results integer
overall_score Solytics defined weighted Average of the Name matching score, Sentiment score and Source Crediblity score integer
Data Field-Entity Description Data type
Match Describes if there is a match or not against the screened entity String
URL URL link to review case on SAMS portal; redirects the user to the respective search String
Search_ID Unique ID from Solytics Partner assigned to every search String
Analyst_Assigned_to Describes the user assigned to the case String
Analyst_Target_Date Due date for Analyst to complete the actions on the search String
Analyst_Assigned_Date Date on which the search was assigned to the user String
Applicant_ID Unique ID from client for each name being screened (should be available in payload) String
TIN PAN entered for the entity String
Applicant_name Name of the applicant String
Pennant_Analyst_Name Analyst assigned for the respective search in Pennant String
Status Status of the search String
Search_type Describes for whom the search is done-Individual or Entity or Aircraft or Vessel String
Analyst_Email_ID Analyst email ID to which the search is to be sent String
SFDC_Lead_ID Lead ID for the respective application from SFDC String
Application_ID Application ID for the respective application from SFDC String
Branch_Name Allocated Branch Name for the respective search String
Product_Line Product Line name as assigned String
Pennant_Lead_ID Lead ID for the respective application from Pennant (Optional For Now) String
Sanctions_Result Contain below fields in Sanctions category result. List
analyst Analyst who reviewed the search List
comments Commnets by analyst if any (generally null) String
zipcode Zipcode of the entity. List
country_of_jurisdiction Country of jurisdiction of the entity. List
call_sign Call sign of the vessel. List
model Model number or name. List
status status marked as true/false by the analyst String
name Name received from the Sanction source String
private Describes if the Sanction is from Internal/Private Sanction of the bank Boolean
id Unique ID for search result in Solytics' Database String
source_type Describes the source type of result; Sanctions in this case String
source_name Name of the organisation issuing the Sanction result String
source_link URL for the organisation issuing the Sanction result String
source_description Brief desciption about the organisation issuing the Sanction result String
alias_names Describes Alias names received for the Sanction result from the Sanction source List
assciated_country Describes the details of Associated Country for the screened Entity name List
date_of_birth Date of Estabilishment for the entity in the search result String
sanctioned_country Describes the details of Sanctioned Country for the entity in the result List
sams_score SAMS Score is assigned based on the Name, Address, Date of Birth and ID matches; Dict
        name_match_score Describes the name matching score between the screened name and the result integer
        dob_match_score Describes the Date of Estabilishment match score for screened name and the Date of estabilishment received in the result String
        address_match_score Describes the Address match score for screened name and the addresses available in the result String
        overall_score Solytics defined weighted Average of the Name matching score, Date of Birth, Address match and the ID match integer
        matched_id Describes the ID match found between the screened name and the result received from Sanction source List
matched_address Describes the Address matched between the uploaded address and the address received from the search result String
documents Describes the various documents details received from the Sanctions Source; Dict
        passport Passport number of the entity. string
        ssn Social Security Number. string
        organisation Name of the organization. string
        isin International Securities Identification Number. string
        cin Corporate Identification Number. string
        imo International Maritime Organization number. string
        mmsi Maritime Mobile Service Identity number. string
        manufacture_serial_number Serial number assigned by the manufacturer. string
        construction_number Construction number of the entity. string
        pan Permanent Account Number (India). string
        gst Goods and Services Tax Identification Number. string
        voter_id Voter Identification Number. string
        driving_license Driver's License Number. string
        national_id National Identification Number. string
        phone_number Contact phone number. string
        email Email address. string
        tail_number Aircraft tail number. string
        model Model number or name. string
Organisation Describes any organisation related document received from the Sanction source String
isin Describes the ISIN details received from the Sanctions Source String
cin Describes the CIN details received from the Sanctions Source String
GST GSTIN of the entity being screened String
AMS_Result Contain below fields for Adverse Media News results received from different articles List
id Unique ID for search result in Database String
status status marked as true/false by the analyst String
analyst Analyst who reviewed the search List
tags Describes the different words that are searched in the artciles. E.g., Penalty, terrorism, etc. List
heading Describes the heading for the article received in the result String
url Describes the URL of the article received in the result String
source Describes the URL of the website for the article received in the result String
summary Describes the summary for the article in the result String
content Describes the content of the article String
publish_date Describes the date on which the respective article was published String
name Describes the name for which the article is shown in the results String
name_match_score Describes the name matching score between the screened name and the result integer
sentiment_score Sentiment score is the score assigned to the article by Solytics based on below points; Dict
        score Describes the overall sentiment score of the article in the result integer
        sign Describes the tone of the overall article in terms of Positive, Negative or Neutral String
source_credibility_score Describes the credibility of the source for the article received in the results integer
overall_score Solytics defined weighted Average of the Name matching score, Sentiment score and Source Crediblity score integer
tags Describes the different words that are searched in the artciles. E.g., Penalty, terrorism, etc. List
Sanctions_Country_Result Contain below fields in Sanctions Country results received from different sources List
id Unique ID for search result in Solytics' Database String
listName Name of the source which has Sactioned the country String
country Name of the sanctioned country List
analyst Analyst who reviewed the search List
sourceURL1 Describes the URL of the source which placed sanctions on the country String
sourceURL2 Describes the URL of the source which placed sanctions on the country String
Description Brief desciption about the sanctions placed by the source authority String
bannedSubjects List of banned items,actions that are restricted by the Sanction source List
Exemptions List of exempted items,actions that are published by the Sanction source List
Data Field-Aircraft Description Data type
Match Describes if there is a match or not against the screened entity String
URL URL link to review case on SAMS portal; redirects the user to the respective search String
Search_ID Unique ID from Solytics Partner assigned to every search String
Analyst_Assigned_to Describes the user assigned to the case String
Analyst_Target_Date Due date for Analyst to complete the actions on the search String
Analyst_Assigned_Date Date on which the search was assigned to the user String
Applicant_ID Unique ID from client for each name being screened (should be available in payload) String
Applicant_name Name of the applicant String
Pennant_Analyst_Name Analyst assigned for the respective search in Pennant String
Status Status of the search String
Search_type Describes for whom the search is done-Individual or Entity or Aircraft or Vessel String
Analyst_Email_ID Analyst email ID to which the search is to be sent String
SFDC_Lead_ID Lead ID for the respective application from SFDC String
Application_ID Application ID for the respective application from SFDC String
Branch_Name Allocated Branch Name for the respective search String
Product_Line Product Line name as assigned String
Pennant_Lead_ID Lead ID for the respective application from Pennant (Optional For Now) String
Sanctions_Result Contain below fields in Sanctions category result. List
status status marked as true/false by the analyst String
comments Commnets by analyst if any (generally null) String
name Name received from the Sanction source String
private Describes if the Sanction is from Internal/Private Sanction of the bank Boolean
id Unique ID for search result in Solytics' Database String
source_type Describes the source type of result; Sanctions in this case String
source_name Name of the organisation issuing the Sanction result String
source_link URL for the organisation issuing the Sanction result String
source_description Brief desciption about the organisation issuing the Sanction result String
alias_names Describes Alias names received for the Sanction result from the Sanction source List
assciated_country Describes the details of Associated Country for the screened aircraft name List
date_of_birth Date of Estabilishment for the entity in the search result String
sanctioned_country Describes the details of Sanctioned Country for the entity in the result List
analyst Analyst who reviewed the search List
zipcode Zipcode of the entity. String
country_of_jurisdiction Country of jurisdiction of the entity. String
citizenship Citizenship of the entity. List
nationality Nationality of the entity. List
headquarters Headquarters of the entity. String
sams_score SAMS Score is assigned based on the Name, Address, Date of Birth and ID matches; Dict
        name_match_score Describes the name matching score between the screened name and the result integer
        dob_match_score Describes the Date of Estabilishment match score for screened name and the Date of estabilishment received in the result String
        address_match_score Describes the Address match score for screened name and the addresses available in the result String
        overall_score Solytics defined weighted Average of the Name matching score, Date of Birth, Address match and the ID match integer
        matched_id Describes the ID match found between the screened name and the result received from Sanction source List
matched_address Describes the Address matched between the uploaded address and the address received from the search result String
call_sign Call sign of the vessel. String
model Model number or name. String
documents Describes the various documents details received from the Sanctions Source; Dict
        passport Passport number of the entity. string
        ssn Social Security Number. string
        organisation Name of the organization. string
        isin International Securities Identification Number. string
        cin Corporate Identification Number. string
        imo International Maritime Organization number. string
        mmsi Maritime Mobile Service Identity number. string
        manufacture_serial_number Serial number assigned by the manufacturer. string
        construction_number Construction number of the entity. string
        pan Permanent Account Number (India). string
        gst Goods and Services Tax Identification Number. string
        voter_id Voter Identification Number. string
        driving_license Driver's License Number. string
        national_id National Identification Number. string
        phone_number Contact phone number. string
        email Email address. string
        tail_number Aircraft tail number. string
        model Model number or name. string
manufacture_serial_number Describes the manufacture serial number from the Sanction source String
construction_number Describes the construction number from the Sanction source String
AMS_Result Contain below fields for Adverse Media News results received from different articles List
status status marked as true/false by the analyst String
analyst Analyst who reviewed the search List
tags Describes the different words that are searched in the artciles. E.g., Penalty, terrorism, etc. List
id Unique ID for search result in Database String
heading Describes the heading for the article received in the result String
url Describes the URL of the article received in the result String
source Describes the URL of the website for the article received in the result String
summary Describes the summary for the article in the result String
content Describes the content of the article String
publish_date Describes the date on which the respective article was published String
name Describes the name for which the article is shown in the results String
name_match_score Describes the name matching score between the screened name and the result integer
sentiment_score Sentiment score is the score assigned to the article by Solytics based on below points; Dict
        score Describes the overall sentiment score of the article in the result integer
        sign Describes the tone of the overall article in terms of Positive, Negative or Neutral String
source_credibility_score Describes the credibility of the source for the article received in the results integer
overall_score Solytics defined weighted Average of the Name matching score, Sentiment score and Source Crediblity score integer
tags Describes the different words that are searched in the artciles. E.g., Penalty, terrorism, etc. List
Sanctions_Country_Result Contain below fields in Sanctions Country results received from different sources List
id Unique ID for search result in Solytics' Database String
listName Name of the source which has Sactioned the country String
country Name of the sanctioned country List
analyst Analyst who reviewed the search List
sourceURL1 Describes the URL of the source which placed sanctions on the country String
sourceURL2 Describes the URL of the source which placed sanctions on the country String
Description Brief desciption about the sanctions placed by the source authority String
bannedSubjects List of banned items,actions that are restricted by the Sanction source String
Exemptions List of exempted items,actions that are published by the Sanction source List
Data Field-Vessel Description Data type
Match Describes if there is a match or not against the screened entity String
URL URL link to review case on SAMS portal; redirects the user to the respective search String
Search_ID Unique ID from Solytics Partner assigned to every search String
Analyst_Assigned_to Describes the user assigned to the case String
Analyst_Target_Date Due date for Analyst to complete the actions on the search String
Analyst_Assigned_Date Date on which the search was assigned to the user String
Applicant_ID Unique ID from client for each name being screened (should be available in payload) String
Applicant_name Name of the applicant String
Pennant_Analyst_Name Analyst assigned for the respective search in Pennant String
Status Status of the search String
Search_type Describes for whom the search is done-Individual or Entity or Aircraft or Vessel String
Analyst_Email_ID Analyst email ID to which the search is to be sent String
SFDC_Lead_ID Lead ID for the respective application from SFDC String
Application_ID Application ID for the respective application from SFDC String
Branch_Name Allocated Branch Name for the respective search String
Product_Line Product Line name as assigned String
Pennant_Lead_ID Lead ID for the respective application from Pennant (Optional For Now) String
Sanctions_Result Contain below fields in Sanctions category result. List
status status marked as true/false by the analyst String
name Name received from the Sanction source String
private Describes if the Sanction is from Internal/Private Sanction of the bank Boolean
id Unique ID for search result in Solytics' Database String
tonnage Tonnage value for the vessel being screened received from the Sanction source String
flag_state Flag state for vessel being screened received from the Sanction source String
parent_company Name of the Parent company who owns the vessel received from the Sanction source String
registered_owner Name of the registered owner of vessel received from the Sanction source String
source_type Describes the source type of result; Sanctions in this case String
source_name Name of the organisation issuing the Sanction result String
source_link URL for the organisation issuing the Sanction result String
source_description Brief desciption about the organisation issuing the Sanction result String
alias_names Describes Alias names received for the Sanction result from the Sanction source List
assciated_country Describes the details of Associated Country for the screened vessel name List
date_of_birth Date of Estabilishment for the entity in the search result String
sanctioned_country Describes the details of Sanctioned Country for the entity in the result List
analyst Analyst who reviewed the search List
comments Commnets by analyst if any (generally null) String
zipcode Zipcode of the entity. String
country_of_jurisdiction Country of jurisdiction of the entity. String
call_sign Call sign of the vessel. String
model Model number or name. string
sams_score SAMS Score is assigned based on the Name, Address, Date of Birth and ID matches; Dict
        name_match_score Describes the name matching score between the screened name and the result integer
        dob_match_score Describes the Date of Estabilishment match score for screened name and the Date of estabilishment received in the result String
        address_match_score Describes the Address match score for screened name and the addresses available in the result String
        overall_score Solytics defined weighted Average of the Name matching score, Date of Birth, Address match and the ID match integer
        matched_id Describes the ID match found between the screened name and the result received from Sanction source List
matched_address Describes the Address matched between the uploaded address and the address received from the search result String
documents Describes the various documents details received from the Sanctions Source; Dict
        passport Passport number of the entity. string
        ssn Social Security Number. string
        organisation Name of the organization. string
        isin International Securities Identification Number. string
        cin Corporate Identification Number. string
        imo International Maritime Organization number. string
        mmsi Maritime Mobile Service Identity number. string
        manufacture_serial_number Serial number assigned by the manufacturer. string
        construction_number Construction number of the entity. string
        pan Permanent Account Number (India). string
        gst Goods and Services Tax Identification Number. string
        voter_id Voter Identification Number. string
        driving_license Driver's License Number. string
        national_id National Identification Number. string
        phone_number Contact phone number. string
        email Email address. string
        tail_number Aircraft tail number. string
        model Model number or name. string
        call_sign Call sign of the vessel. String
        model Model number or name. String
        imo Describes the IMO details received from the Sanctions Source String
        mmsi Describes the MMSI details received from the Sanctions Source String
AMS_Result Contain below fields for Adverse Media News results received from different articles List
status status marked as true/false by the analyst String
analyst Analyst who reviewed the search List
tags Describes the different words that are searched in the artciles. E.g., Penalty, terrorism, etc. List
id Unique ID for search result in Database String
heading Describes the heading for the article received in the result String
url Describes the URL of the article received in the result String
source Describes the URL of the website for the article received in the result String
summary Describes the summary for the article in the result String
content Describes the content of the article String
publish_date Describes the date on which the respective article was published String
name Describes the name for which the article is shown in the results String
name_match_score Describes the name matching score between the screened name and the result integer
overall_score Solytics defined weighted Average of the Name matching score, Sentiment score and Source Crediblity score integer
Sanctions_Country_Result Contain below fields in Sanctions Country results received from different sources List
id Unique ID for search result in Solytics' Database String
listName Name of the source which has Sactioned the country String
country Name of the sanctioned country List
sourceURL1 Describes the URL of the source which placed sanctions on the country String
sourceURL2 Describes the URL of the source which placed sanctions on the country String
sourceURL2 Describes the URL of the source which placed sanctions on the country String
Description Brief desciption about the sanctions placed by the source authority String
bannedSubjects List of banned items,actions that are restricted by the Sanction source String
Exemptions List of exempted items,actions that are published by the Sanction source String
Data Field-Verdict Description
pep_result List of matched results List
status status marked as true/false by the analyst String
analyst Analyst who reviewed the search List
Remark individual remark given by the analyst
ID Unique ID for search result in Database
sanctions_result
status status marked as true or false by the analyst
Remark individual remark given by the analyst
ID Unique ID for search result in Database
ams_result
status status marked as true or false by the analyst
Remark individual remark given by the analyst
ID Unique ID for search result in Database
search_id Unique ID from Solytics Partner assigned to every search
applicant_id Unique ID from client for each name being screened (should be available in payload)
lead_id Lead ID for the respective application from SFDC
product_id Product ID name as assigned by Piraml team
application_id Application ID for the respective application from SFDC
document_name document name as saved by client team
base64_data Base64 link for generating HTML report
verdict_submitted_by Describes the user who submit the verdict
branch_name Mention branch name as uploaded by client team


Note: For Complex queries (Not recommended), the response time will increase to 10-15 seconds.



© 2023 Solytics-Partners. All rights reserved.
PEP only Estimated time for % of searches
Searches 90% (ms) 95% (ms) 99% (ms)
1135001425014850
10450004750049500
50900009500099000
100180000190000198000