
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.
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.
| Service Name | Service Type | Address |
|---|---|---|
| SAMS API services | REST | https://vcqxgn0jvc.execute-api.ap-south-1.amazonaws.com/preprod/ |
| Service Name | Service Type | Request Type | Address | Description |
|---|---|---|---|---|
| Add webhook details | REST | POST/GET/PUT | https://vcqxgn0jvc.execute-api.ap-south-1.amazonaws.com/preprod/webhooks/ | This service is used to submit, update or fetch the webhook details. |
| Initiate individual, entity, vessel and aircraft | REST | POST | https://vcqxgn0jvc.execute-api.ap-south-1.amazonaws.com/preprod/async-search-initiate/ | This service is used to perform search on the system. |
| Key | Value | Description |
|---|---|---|
| Authorization | Api-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90Nn | This API is used to add, update and fetch webhook details. |
Note: Webhook types are classified by features. Currently we support 2 features (search_results, search_results_html) other new features will be added soon.
| Key | Value | Description |
|---|---|---|
| Authorization | Api-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90Nn | This API is used to initiate single searches for individual type. |
| Code | Status | Description |
|---|---|---|
| 500 | Error | Internal Server Error |
| 502 | Error | Bad Gateway Error |
| 504 | Error | Gateway Timeout Error |
| 401 | Error | Unauthorized Error |
| 404 | Error | Not Found Error |
| 200 | Success | OK - Success |
| 201 | Success | Created - Success |
| Fields | Description | Datatype | Max. Length | Mandatory/Non-Mandatory | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Webhook | ||||||||||||||||
| auth_type | Describes the type of authentication required for the webhook
Note: We only support API Key("api_key") based authentication for now! |
String | 10 | Mandatory | ||||||||||||
| feature | Describes the type of webhook feature you want to subscribe to.
Types:
|
String | 20 | Mandatory | ||||||||||||
| webhook_details |
|
dictionary/key-value pair | Mandatory |
| Fields | Description | Datatype | Max. Length | Mandatory/Non-Mandatory |
|---|---|---|---|---|
| Initiate | ||||
| webhook | Describes if this searh cycle should trigger the webhook | Boolean | 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 | Text | 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 | text | Non-Mandatory |
| Email ID of the individual/Entity owner | String | 100 | Non-Mandatory | |
| nationality | Nationality of the individual being screened | Text | Max | Non-Mandatory |
| country | Country of the individual/entity/aircraft/vessel being screened | Text | Max | Non-Mandatory |
| country_of_jurisdiction | Jurisdiction Country for the individual/entity/aircraft/vessel being screened | Text | Max | Non-Mandatory |
| address | Address of the individual/entity/aircraft/vessel being screened | Text | 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 | |
| voters_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 |
| 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 | Text | Max | Non-Mandatory |
| product_line | Product Line name as assigned | Text | Max | Non-Mandatory |
| pennant_lead_id | Pennant ID (For Pennant) | String | 30 | Non-Mandatory |
| pennant_analyst_name | Analyst assigned for the respective search in Pennant | Text | Max | Non-Mandatory |
| analyst_email_id | Analyst email ID to which the excel is to be sent in Email (for Pennant) | Text | Max | Non-Mandatory |
| gender | Gender of the person being screened | Text | Max | Non-Mandatory |
| pep_field | Describes if PEP screening is to be done for this search false in case if Entity | Boolean | NA | Mandatory |
| pan | PAN of the individual/entity being screened | String | 50 | Non-Mandatory |
| headquarter | Address for the Entity's headqaurters | Text | 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 |
| Data Field-Individual | Description | Data type | |
|---|---|---|---|
| Status | Status of the webhook request | String | |
| Topic | Type of topic. e.g: search_results, search_results_html, ongoing_monitoring | String | |
| Identifier | Unique identifier for the webhook request. e.g: search id | String | |
| Data | The Topic response | Json | |
| 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 |
| Sanctions_Result | Contain below fields in Sanctions category result. | List |
| 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_name | 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 |
| 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 | Describes the passport details received from the Sanctions Source | 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_matching_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 |
| PEP_Result | Contain below fields in PEP results received from different sources | List |
| 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 |
| soruce_description | Brief description about the organisation publishing the PEP details | String |
| 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 | Null |
| designation_start_date | Starting date Of The Designation | String | Null |
| designation_end_date | Ending Date of The Designation | String | Null |
| designation_pep_type | PEP Type Of Designation | String | Null |
| 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 |
| alias_name | 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 |
| 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 |
| 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 |
| 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 | List |
| AMS_Result | Contain below fields for Adverse Media News results received from different articles | 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_matching_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 |
| Exemptions | List of exempted items,actions that are published by the Sanction source | List |
| 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 |
| 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 |
| Sanctions_Result | Contain below fields in Sanctions category result. | List |
| 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_name | 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 |
| ID Score | Describes the ID match score for Screened Entity | String |
| 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 |
| 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 |
| 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_matching_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 |
| sourceURL1 | 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 |
| 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 | |
| Product_Line | Product Line name as assigned | |
| Pennant_Lead_ID | Lead ID for the respective application from Pennant (Optional For Now) |
| 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 |
| Sanctions_Result | Contain below fields in Sanctions category result. | List |
| 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_name | 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 |
| 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 |
| 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 |
| 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_matching_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. | |
| 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 |
| 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 |
| 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 |
| 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 |
| Sanctions_Result | Contain below fields in Sanctions category result. | List |
| 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_name | 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 |
| 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 |
| 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 |
| 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_matching_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. | |
| 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 |
| 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 |
| 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 |
| PEP only | Estimated time for % of searches | ||
|---|---|---|---|
| Searches | 90% (ms) | 95% (ms) | 99% (ms) |
| 1 | 13500 | 14250 | 14850 |
| 10 | 45000 | 47500 | 49500 |
| 50 | 90000 | 95000 | 99000 |
| 100 | 180000 | 190000 | 198000 |