SAMS API

SAMS API V3 OAS1


API Docs V3

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://vcqxgn0jvc.execute-api.ap-south-1.amazonaws.com/preprod/

SAMS OAS API Services

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 Individual search on the system.
Get results REST GET https://vcqxgn0jvc.execute-api.ap-south-1.amazonaws.com/preprod/async-search-initiate/initial/'search_id'/ This service is used to fetch the Individual search results generated.

Note: Use the search_id received in the response.
Submit verdict REST POST https://vcqxgn0jvc.execute-api.ap-south-1.amazonaws.com/preprod/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.
Note: Response time for AMS result may vary based on rule engine configuration.


SAMS APIs 3

Headers
Key Value Description
Authorization Api-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90Nn This API is used to initiate single searches for individual type.
Note: Response time for AMS result may vary based on rule engine configuration.

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": "", "team": "1 (to be used only if team is created)", "country": "Pakistan$**$India$**$Afghanistan$**$Iran", "country_of_jurisdiction": "Pakistan", "address": "G-11 Markaz,Islamabad$**$D-58,Race course road,Mumbai$**$428,Akbar Khan Road,Kabul$**$Khayam Street,Tehran", "zipcode": "04403$**$400001$**$1001$**$11369", "national_id": "", "voter_id": "", "passport_number": "AM5421691", "pan": "", "phone_number": "", "sanction_field": true, "legal_field": true, "pep_field": true, "ams_field": true, "risk_rating_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": "sams_analyst", "analyst_email_id": "sams@solytics-partners.com", "other_fields": { "field1":"", "field2":"", "field3":"" } }

Headers
KeyValueDescription
AuthorizationApi-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API get result.
Body

Headers
KeyValueDescription
AuthorizationApi-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API get result.
Body

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.

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": "", "team": "1 (to be used only if team is created)", "country": "Pakistan$**$India$**$Afghanistan$**$Iran", "country_of_jurisdiction": "Pakistan", "address": "G-11 Markaz,Islamabad$**$D-58,Race course road,Mumbai$**$428,Akbar Khan Road,Kabul$**$Khayam Street,Tehran", "zipcode": "04403$**$400001$**$1001$**$11369", "national_id": "", "voter_id": "", "passport_number": "AM5421691", "pan": "", "phone_number": "", "sanction_field": true, "legal_field": true, "pep_field": true, "ams_field": true, "risk_rating_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", "other_fields": { "field1":"", "field2":"", "field3":"" } }

Headers
KeyValueDescription
AuthorizationApi-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API get result.
Body

Headers
KeyValueDescription
AuthorizationApi-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API get result.
Body

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.

Body
{ "screen_type": "initial", "deduplicate":true, "unique_id":"pan", "applicant_id": "uhi4hi-3safdsa3-asdfj", "search_type": "individual", "name": "Vinita gupta", "gender": "Female", "date_of_birth": "", "aliases": "", "email": "", "nationality": "", "team": "1 (to be used only if team is created)", "country": "Pakistan$**$India$**$Afghanistan$**$Iran", "country_of_jurisdiction": "Pakistan", "address": "G-11 Markaz,Islamabad$**$D-58,Race course road,Mumbai$**$428,Akbar Khan Road,Kabul$**$Khayam Street,Tehran", "zipcode": "04403$**$400001$**$1001$**$11369", "national_id": "", "passport_number": "", "pan": "AMJPG9496K", "phone_number": "", "sanction_field": true, "legal_field": false, "corporate_field": true, "pep_field": true, "ams_field": true, "risk_rating_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", "other_fields": { "field1":"", "field2":"", "field3":"" } }

Headers
KeyValueDescription
AuthorizationApi-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": "RELIANCE", "date_of_birth": "", "aliases": "", "email": "", "headquarter": "", "team": "1 (to be used only if team is created)", "country": "Pakistan$**$India$**$Afghanistan$**$Iran", "country_of_jurisdiction": "Pakistan", "address": "G-11 Markaz,Islamabad$**$D-58,Race course road,Mumbai$**$428,Akbar Khan Road,Kabul$**$Khayam Street,Tehran", "zipcode": "04403$**$400001$**$1001$**$11369", "cin": "", "tin": "", "isin": "", "gst": "", "pep_field": true, "ams_field": true, "sanction_field": true, "legal_field": true, "corporate_field": true, "bag_of_words": [ "embezzlement", "assets", "crime", "fraud", "misconduct", "tax evasion", "money laundering", "identity theft", "corruption", "sanctions", "cyber", "terrorism", "bribery", "cartel", "AML Penalties", "Penalty", "Whistleblower", "Politically exposed person", "illegal transaction", "fraudulent transaction", "aml fine", "debarred", "trafficking", "kingpin", "risk", "scam", "phishing", "sentenced" ], "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" }

Headers
KeyValueDescription
AuthorizationApi-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API get result.
Body

Headers
KeyValueDescription
AuthorizationApi-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API get result.
Body

Headers
KeyValueDescription
AuthorizationApi-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": "", "team": "1 (to be used only if team is created)", "country_of_jurisdiction": "Iran, Islamic Republic of", "country": "Pakistan$**$India$**$Afghanistan$**$Iran", "address": "G-11 Markaz,Islamabad$**$D-58,Race course road,Mumbai$**$428,Akbar Khan Road,Kabul$**$Khayam Street,Tehran", "zipcode": "04403$**$400001$**$1001$**$11369", "aliases": "", "registered_owner": "", "parent_company": "", "vessel_type": "container vessels", "imo": "9349590", "mmsi": "", "flag_state": "Iran", "ams_field": true, "sanction_field": true, "legal_field": false, "corporate_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" }

Headers
KeyValueDescription
AuthorizationApi-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API get result.
Body

Headers
KeyValueDescription
AuthorizationApi-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API get result.
Body

Headers
KeyValueDescription
AuthorizationApi-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", "aliases": "", "team": "1 (to be used only if team is created)", "country": "United States$**$India$**$Afghanistan$**$Iran", "address": "8th Street Suite 2000$**$D-58,Race course road,Mumbai$**$428,Akbar Khan Road,Kabul$**$Khayam Street,Tehran", "zipcode": "33130$**$400001$**$1001$**$11369", "registered_owner": "", "manufacture_serial_number": "133", "construction_number": "", "program": "SDNTK", "aircraft_model": "Gulfstream 200", "ams_field": true, "sanction_field": true, "legal_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" }

Headers
KeyValueDescription
AuthorizationApi-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API get result.
Body

Headers
KeyValueDescription
AuthorizationApi-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API get result.
Body

Headers
KeyValueDescription
AuthorizationApi-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API is used to submit Match/No Match for Sanction/PEP/AMS result. If successful, in response we get updated risk category for the available Risk Rating parameters.
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": [] } }

Headers
KeyValueDescription
AuthorizationApi-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API is used to Update risk rating parameters.
Body
{ "previous_search_id": "f293d65b-6f1b-427a-acfd-8aa32112e66f", "missed_payment": " 6", "country": "Pakistan", "address": "Pakistan", "age": "26", "zipcode": "", "income":"1000000", "onboarding_duration": "10", "occupation": "Accountants and Auditors", "onboarding_type": "Face-to-face Onboarding", "product": "Savings Account Plus" }

Headers
KeyValueDescription
AuthorizationApi-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API is used to get the history of risk rating parameters.
Params
KeyValueDescription
review_idcfd9ab28-8821-4043-b2c1-8d5b0290bce0This Param act as an input to get history according to the review id.

Headers
KeyValueDescription
AuthorizationApi-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API is used to Submit Verdict (Accept Or Reject) with Risk Rating Searches. If successful, in response we receive confirmation of the submited verdict along with the base 64 data that can be converted into HTML and downloaded as a PDF 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": [], "risk_type": "low", "risk_rating": 15.0, "risk_rating_result": [ { "name": "address", "classification": "low", "value": "Not Available" }, { "name": "country", "classification": "low", "value": "Not Available" }, { "name": "zipcode", "classification": "low", "value": "Not Available" }, { "name": "product", "classification": "low", "value": "Savings Account Plus" }, { "name": "age", "classification": "low", "value": "30" }, { "name": "income", "classification": "medium", "value": "25000" }, { "name": "occupation", "classification": "high", "value": "Accountants and Auditors" }, { "name": "onboarding_duration", "classification": "low", "value": 32 }, { "name": "onboarding_type", "classification": "low", "value": "Face-to-face Onboarding" }, { "name": "sanctions", "classification": "low", "value": "No" }, { "name": "ams", "classification": "low", "value": "No" }, { "name": "pep", "classification": "low", "value": "No" } ] } }

Headers
KeyValueDescription
AuthorizationApi-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis 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.

Body
{ "auth_type":"api_key", "feature":"search_results", "webhook_details": { "webhook_url":"https://webhook-url.com", "api_key":"webhook-api-key" } }

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": "Pakistan", "country_of_jurisdiction": "Pakistan", "address": "Pakistan", "national_id": "", "voters_id": "", "passport_number": "AM5421691", "pan": "", "phone_number": "", "sanction_field": true, "pep_field": true, "ams_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", "webhook": "true" }

Headers
Key Value Description
Authorization Api-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90Nn This API is used to move the search from IS to OM.
Body
{ "search_id": "6376b72b-20d4-4079-a83b-566a4ca32f94", "other_fields": { "field1":"", "field2":"", "field3":"" } }

Headers
Key Value Description
Authorization Api-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90Nn API to get search result and submit verdict.

Headers
Key Value Description
Authorization Api-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90Nn API to get submitted verdict using verdict or get-search API.

API Request/Response Codes

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

Request parameters

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:
  1. search_results: Provides search details in JSON format.
  2. search_results_html: Provides search details in String format.
  3. verdict: Provides the verdict given in SAMS WebApp to the client webhook.
  4. OM: Provides updated results for an existing record as part of ongoing monitoring.
String 20 Mandatory
webhook_details
webhook_url Webhook URL(client side) where the search related data is to be sent. String Mandatory
api_key API Key(to be shared by client) for authentication of webhook. String Mandatory
headers Headers for the webhook provided by the client. dictionary /key-value pair Non-Mandatory
dictionary/key-value pair Mandatory

Request parameters

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
deduplicate Describes whether the perticular search undergoes deduplication. Boolean true/false Non-Mandatory
unique_id Value should only be given when dedupe is true. String Non-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 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
zipcode zipcode of the individual/entity/aircraft/vessel being screened String 50 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
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
legal_field Describes if legal_field is to be done for this search Boolean NA Mandatory
corporate_field Describes if corporate_field is to be done for this search Boolean NA Mandatory
risk_rating_field Describes if Risk rating 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 End date for Analyst to complete the actions on the search in SFDC String 30 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 String 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 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
Other Fields
Field1 Other Additional field. Provisioned for custom requirements String 50
Field2 Other Additional field. Provisioned for custom requirements String 50
Field3 Other Additional field. Provisioned for custom requirements String 50

Response parameters

Data Field-Individual Description
Match Describes if there is a match or not against the screened name
URL URL link to review case on SAMS portal; redirects the user to the respective search
Search_ID Unique ID from Solytics Partner assigned to every search
Analyst_Assigned_to Describes the user assigned to the case
Analyst_Target_Date Due date for Analyst to complete the actions on the search
Analyst_Assigned_Date Date on which the search was assigned to the user
Applicant_ID Unique ID from client for each name being screened (should be available in payload)
Sanctions_Result Contain below fields in Sanctions category result.
name Name received from the Sanction source
private Describes if the Sanction is from Internal/Private Sanction of the bank
id Unique ID for search result in Solytics' Database
source_type Describes the source type of result; Sanctions in this case
gender Gender detail received from the Sanction source
source_name Name of the organisation issuing the Sanction result
source_link URL for theorganisation issuing the Sanction result
source_description Brief desciption about the organisation issuing the Sanction result
alias_name Describes Alias names received for the Sanction result from the Sanction source
associated_country Describes the details of Associated Country for the name in the result
sanctioned_country Describes the details of Sanctioned Country for the name in the result
date_of_birth Date of birth received from the Sanction source
sams_score SAMS Score is assigned based on the Name, Address, Date of Birth and ID matches;
        name_match_score Describes the name matching score between the screened name and the result
        dob_match_score Describes the Date of Birth match score for Screened name and the Date of Birth received in the result
        address_match_score Describes the Address match score for screened name and the addresses available in the result
        overall_score Solytics defined weighted average of Name matching score,Date of Birth score, Address match score and the ID match
        matched_id Describes the ID match found between the screened name and the result received from Sanction source
matched_address Describes the Address matched between the uploaded address and the address received from the search result
Documents Describes the various documents received from the Sanctions Source;
passport Describes the passport details received from the Sanctions Source
id Unique ID for search result in Database
heading Describes the heading for the article received in the result
url Describes the URL of the article received in the result
source Describes the URL of the website for the article received in the result
summary Describes the summary for the article in the result
content Describes the content of the article
publish_date Describes the date on which the respective article was published
name Describes the name for which the article is shown in the results
name_matching_score Describes the name matching score between the screened name and the result
sentiment_score Sentiment score is the score assigned to the article by Solytics based on below points;
        score Describes the overall sentiment score of the article in the result
        sign Describes the tone of the overall article in terms of Positive, Negative or Neutral
source_credibility_score Describes the credibility of the source for the article received in the results
overall_score Solytics defined weighted Average of the Name matching score, Sentiment score and Source Crediblity score
tags Describes the different words that are searched in the artciles. E.g., Penalty, terrorism, etc.
PEP_Result Contain below fields in PEP results received from different sources
name Name received from the PEP source
id Unique ID for search result in Database
source_type Describes the source type for the result; PEP in this case
gender Gender detail received from the PEP source
source_name Name of the organisation publishing the PEP details
source_link URL for the organisation publishing the PEP details
soruce_description Brief description about the organisation publishing the PEP details
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
address Address of the individual as available from the PEP source
date_of_birth Date of birth information available with the PEP source
alias_name Available Aliases for the individual as per the organisation publishing the PEP details
passport_number Passport details available for the individual as per the PEP source
family-tree Family details about the Individual as per the PEP source
parent Details about the parents of the individual as per the PEP source
sibling Sibling details of the individual as per the PEP source
children Details about children of the individual as per the PEP source
spouse Spouse details of the individual as per the PEP source
sams_score SAMS Score is assigned based on the Name, Address, Date of Birth and ID matches;
        name_matching_score Describes the name matching score between the screened name and the result
        dob_match_score Describes the Date of Birth match score for the screened name and the Date of Birth received in the result
        address_match_score Describes the Address match score for screened name and the addresses available in the result
        overall_score Solytics defined weighted Average of the Name score, Address score, Date of Birth score and ID match
        matched_id Describes the ID match found between the screened name and the result received from PEP source
Sanctions_Country_Result Contain below fields in Sanctions Country results received from different sources
ID Unique ID for search result in Solytics' Database
listName Name of the source which has Sactioned the country
country Name of the sanctioned country
sourceURL1 Describes the URL of the source which placed sanctions on the country
Description Brief desciption about the sanctions placed by the source authority
bannedSubjects List of banned items,actions that are restricted by the Sanction source
AMS_Result Contain below fields for Adverse Media News results received from different articles
id Unique ID for search result in Database
heading Describes the heading for the article received in the result
url Describes the URL of the article received in the result
source Describes the URL of the website for the article received in the result
summary Describes the summary for the article in the result
content Describes the content of the article
publish_date Describes the date on which the respective article was published
name Describes the name for which the article is shown in the results
name_matching_score Describes the name matching score between the screened name and the result
sentiment_score Sentiment score is the score assigned to the article by Solytics based on below points;
        score Describes the overall sentiment score of the article in the result
        sign Describes the tone of the overall article in terms of Positive, Negative or Neutral
source_credibility_score Describes the credibility of the source for the article received in the results
overall_score Solytics defined weighted Average of the Name matching score, Sentiment score and Source Crediblity score
Exemptions List of exempted items,actions that are published by the Sanction source
SFDC_Lead_Id Lead ID for the respective application from SFDC
Application_ID Application ID for the respective application from SFDC
Review_ID Review id that refers each search
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)
Driving_License Driving Licence of the individual being screened
Voter_ID Voter ID of the individual being screened
Legal_Result Contain below fields for Legal results
id Unique ID for search result in Database
tid Unique ID for for the article received in the result
url Describes the URL of the article received in the result
title Describes the Tilte of the website for the article received in the result
author Describes the author for the article in the result
covers Describes the content of the article
docsize Describes the size Of The Document
doctype Describes the type of document
fragment Describes the name matching score between the screened name and the result
headline Describes The Headline Of the Article
lastname Describes the queryName associated with articles
numcites Describes the tone of the overall article in terms of Positive, Negative or Neutral
covertids Describes the other tids associated with article
docsource Describes The source of the article
firstname Describes the queryName associated with articles.
queryName Describes the name searched
numcitedby Describes the different words that are searched in the artciles. E.g., Penalty, terrorism, etc.
secondname Describes the queryName associated with articles.
covertitles Describes the other titles of other articles associated with article
publishdate Describes the date when article was published
authorEncoded Describes the encoded value of author for the article in the result .
analyst Describes the Name of analyst who reviewed the article.
Data Field-Entity Description
Match Describes if there is a match or not against the screened entity
URL URL link to review case on SAMS portal; redirects the user to the respective search
Search_ID Unique ID from Solytics Partner assigned to every search
Analyst_Assigned_to Describes the user assigned to the case
Analyst_Target_Date Due date for Analyst to complete the actions on the search
Analyst_Assigned_Date Date on which the search was assigned to the user
Applicant_ID Unique ID from client for each name being screened (should be available in payload)
TIN PAN entered for the entity
Sanctions_Result Contain below fields in Sanctions category result.
Name Name received from the Sanction source
Private Describes if the Sanction is from Internal/Private Sanction of the bank
ID Unique ID for search result in Solytics' Database
source_type Describes the source type of result; Sanctions in this case
source_name Name of the organisation issuing the Sanction result
source_link URL for the organisation issuing the Sanction result
source_description Brief desciption about the organisation issuing the Sanction result
alias_name Describes Alias names received for the Sanction result from the Sanction source
assciated_country Describes the details of Associated Country for the screened Entity name
date_of_birth Date of Estabilishment for the entity in the search result
sanctioned_country Describes the details of Sanctioned Country for the entity in the result
sams_score SAMS Score is assigned based on the Name, Address, Date of Birth and ID matches;
        name_match_score Describes the name matching score between the screened name and the result
        dob_match_score Describes the Date of Estabilishment match score for screened name and the Date of estabilishment received in the result
        address_match_score Describes the Address match score for screened name and the addresses available in the result
        overall_score Solytics defined weighted Average of the Name matching score, Date of Birth, Address match and the ID match
        matched_id Describes the ID match found between the screened name and the result received from Sanction source
matched_address Describes the Address matched between the uploaded address and the address received from the search result
Documents Describes the various documents details received from the Sanctions Source;
Organisation Describes any organisation related document received from the Sanction source
isin Describes the ISIN details received from the Sanctions Source
cin Describes the CIN details received from the Sanctions Source
GST GSTIN of the entity being screened
AMS_Result Contain below fields for Adverse Media News results received from different articles
id Unique ID for search result in Database
heading Describes the heading for the article received in the result
url Describes the URL of the article received in the result
source Describes the URL of the website for the article received in the result
summary Describes the summary for the article in the result
content Describes the content of the article
publish_date Describes the date on which the respective article was published
name Describes the name for which the article is shown in the results
name_matching_score Describes the name matching score between the screened name and the result
sentiment_score Sentiment score is the score assigned to the article by Solytics based on below points;
        score Describes the overall sentiment score of the article in the result
        sign Describes the tone of the overall article in terms of Positive, Negative or Neutral
source_credibility_score Describes the credibility of the source for the article received in the results
overall_score Solytics defined weighted Average of the Name matching score, Sentiment score and Source Crediblity score
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
ID Unique ID for search result in Solytics' Database
listName Name of the source which has Sactioned the country
country Name of the sanctioned country
sourceURL1 Describes the URL of the source which placed sanctions on the country
Description Brief desciption about the sanctions placed by the source authority
bannedSubjects List of banned items,actions that are restricted by the Sanction source
Exemptions List of exempted items,actions that are published by the Sanction source
SFDC_Lead_Id Lead ID for the respective application from SFDC
Application_ID Application ID for the respective application from SFDC
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)
Legal_Result Contain below fields for Legal results
id Unique ID for search result in Database
tid Unique ID for for the article received in the result
url Describes the URL of the article received in the result
title Describes the Tilte of the website for the article received in the result
author Describes the author for the article in the result
covers Describes the content of the article
docsize Describes the size Of The Document
doctype Describes the type of document
fragment Describes the name matching score between the screened name and the result
headline Describes The Headline Of the Article
lastname Describes the queryName associated with articles
numcites Describes the tone of the overall article in terms of Positive, Negative or Neutral
covertids Describes the other tids associated with article
docsource Describes The source of the article
firstname Describes the queryName associated with articles.
queryName Describes the name searched
numcitedby Describes the different words that are searched in the artciles. E.g., Penalty, terrorism, etc.
secondname Describes the queryName associated with articles.
covertitles Describes the other titles of other articles associated with article
publishdate Describes the date when article was published
authorEncoded Describes the encoded value of author for the article in the result .
analyst Describes the Name of analyst who reviewed the article.
Corporate_Result Contain below fields for Corporate results
id Unique ID for search result in Database
Cin Company Identification No for for the article received in the result
Charges Describes the List Of Charges Commitied by Company
PAN Describes the Permanent account number Of Entity for the article received in the result
ROC Describes the Entity Region Of Regestration for the article in the result
CIRP Describes the list of insolvency fileing
City Describes the City Of registered Entity
File Describes the List Of file Associated With the entity
Class Describes the type of Entity
Email Describes The Email of Entity
State Describes the State registered to Entity
Country Describes the Country where Company was registered
Pincode Describes the Pincode where Company was registered
old_cin Describes The Other Cin of Company
Category Describes the Category where Company was registered.
LAST_AGM Describes the Last Date Of AGM
NICCode1 Describes the NICCode1
NICCode2 Describes the NICCode2.
NICCode3 Describes the NICCode3
PREVIOUS_FIRM Describes the previous actions of Company
COMPANY_STATUS Describes the Company Status .
LISTING_STATUS Describes the Current LISTING_STATUS Of Company.
directors_history Describes the About The Current Director Of Company.
AUTHORIZED_CAPITAL Describes the last AUTHORIZED_CAPITAL.
SUSPENDED_AT_STOCK Describes the The Last SUSPENDED_AT_STOCK.
F_COMPANY_SHARE_CAP Describes the Last F_COMPANY_SHARE_CAP.
ACTIVITY_DESCRIPTION Describes the Describes of activities.
DATE_OF_REGISTRATION Describes the DATE_OF_REGISTRATION.
ADDRESS_OTHER_THAN_RO Describes the other Address.
REGISTERED_OFFICE_ADDRESS Describes the main Office Address.
analyst Describes the Analyst Who reviewed the Data.
Data Field-Aircraft Description
Match Describes if there is a match or not against the screened entity
URL URL link to review case on SAMS portal; redirects the user to the respective search
Search_ID Unique ID from Solytics Partner assigned to every search
Analyst_Assigned_to Describes the user assigned to the case
Analyst_Target_Date Due date for Analyst to complete the actions on the search
Analyst_Assigned_Date Date on which the search was assigned to the user
Applicant_ID Unique ID from client for each name being screened (should be available in payload)
Sanctions_Result Contain below fields in Sanctions category result.
Name Name received from the Sanction source
Private Describes if the Sanction is from Internal/Private Sanction of the bank
ID Unique ID for search result in Solytics' Database
source_type Describes the source type of result; Sanctions in this case
source_name Name of the organisation issuing the Sanction result
source_link URL for the organisation issuing the Sanction result
source_description Brief desciption about the organisation issuing the Sanction result
alias_name Describes Alias names received for the Sanction result from the Sanction source
assciated_country Describes the details of Associated Country for the screened aircraft name
date_of_birth Date of Estabilishment for the entity in the search result
sanctioned_country Describes the details of Sanctioned Country for the entity in the result
sams_score SAMS Score is assigned based on the Name, Address, Date of Birth and ID matches;
        name_match_score Describes the name matching score between the screened name and the result
        dob_match_score Describes the Date of Estabilishment match score for screened name and the Date of estabilishment received in the result
        address_match_score Describes the Address match score for screened name and the addresses available in the result
        overall_score Solytics defined weighted Average of the Name matching score, Date of Birth, Address match and the ID match
        matched_id Describes the ID match found between the screened name and the result received from Sanction source
matched_address Describes the Address matched between the uploaded address and the address received from the search result
Documents Describes the various documents details received from the Sanctions Source;
manufacture_serial_number Describes the manufacture serial number from the Sanction source
construction_number Describes the construction number from the Sanction source
AMS_Result Contain below fields for Adverse Media News results received from different articles
id Unique ID for search result in Database
heading Describes the heading for the article received in the result
url Describes the URL of the article received in the result
source Describes the URL of the website for the article received in the result
summary Describes the summary for the article in the result
content Describes the content of the article
publish_date Describes the date on which the respective article was published
name Describes the name for which the article is shown in the results
name_matching_score Describes the name matching score between the screened name and the result
sentiment_score Sentiment score is the score assigned to the article by Solytics based on below points;
        score Describes the overall sentiment score of the article in the result
        sign Describes the tone of the overall article in terms of Positive, Negative or Neutral
source_credibility_score Describes the credibility of the source for the article received in the results
overall_score Solytics defined weighted Average of the Name matching score, Sentiment score and Source Crediblity score
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
ID Unique ID for search result in Solytics' Database
listName Name of the source which has Sactioned the country
country Name of the sanctioned country
sourceURL1 Describes the URL of the source which placed sanctions on the country
Description Brief desciption about the sanctions placed by the source authority
bannedSubjects List of banned items,actions that are restricted by the Sanction source
Exemptions List of exempted items,actions that are published by the Sanction source
SFDC_Lead_Id Lead ID for the respective application from SFDC
Application_ID Application ID for the respective application from SFDC
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)
Legal_Result Contain below fields for Legal results
id Unique ID for search result in Database
tid Unique ID for for the article received in the result
url Describes the URL of the article received in the result
title Describes the Tilte of the website for the article received in the result
author Describes the author for the article in the result
covers Describes the content of the article
docsize Describes the size Of The Document
doctype Describes the type of document
fragment Describes the name matching score between the screened name and the result
headline Describes The Headline Of the Article
lastname Describes the queryName associated with articles
numcites Describes the tone of the overall article in terms of Positive, Negative or Neutral
covertids Describes the other tids associated with article
docsource Describes The source of the article
firstname Describes the queryName associated with articles.
queryName Describes the name searched
numcitedby Describes the different words that are searched in the artciles. E.g., Penalty, terrorism, etc.
secondname Describes the queryName associated with articles.
covertitles Describes the other titles of other articles associated with article
publishdate Describes the date when article was published
authorEncoded Describes the encoded value of author for the article in the result .
analyst Describes the Name of analyst who reviewed the article.
Data Field-Vessel Description
Match Describes if there is a match or not against the screened entity
URL URL link to review case on SAMS portal; redirects the user to the respective search
Search_ID Unique ID from Solytics Partner assigned to every search
Analyst_Assigned_to Describes the user assigned to the case
Analyst_Target_Date Due date for Analyst to complete the actions on the search
Analyst_Assigned_Date Date on which the search was assigned to the user
Applicant_ID Unique ID from client for each name being screened (should be available in payload)
Sanctions_Result Contain below fields in Sanctions category result.
Name Name received from the Sanction source
Private Describes if the Sanction is from Internal/Private Sanction of the bank
ID Unique ID for search result in Solytics' Database
tonnage Tonnage value for the vessel being screened received from the Sanction source
flag_state Flag state for vessel being screened received from the Sanction source
parent_company Name of the Parent company who owns the vessel received from the Sanction source
registered_owner Name of the registered owner of vessel received from the Sanction source
source_type Describes the source type of result; Sanctions in this case
source_name Name of the organisation issuing the Sanction result
source_link URL for the organisation issuing the Sanction result
source_description Brief desciption about the organisation issuing the Sanction result
alias_name Describes Alias names received for the Sanction result from the Sanction source
assciated_country Describes the details of Associated Country for the screened vessel name
date_of_birth Date of Estabilishment for the entity in the search result
sanctioned_country Describes the details of Sanctioned Country for the entity in the result
sams_score SAMS Score is assigned based on the Name, Address, Date of Birth and ID matches;
        name_match_score Describes the name matching score between the screened name and the result
        dob_match_score Describes the Date of Estabilishment match score for screened name and the Date of estabilishment received in the result
        address_match_score Describes the Address match score for screened name and the addresses available in the result
        overall_score Solytics defined weighted Average of the Name matching score, Date of Birth, Address match and the ID match
        matched_id Describes the ID match found between the screened name and the result received from Sanction source
matched_address Describes the Address matched between the uploaded address and the address received from the search result
Documents Describes the various documents details received from the Sanctions Source;
imo Describes the IMO details received from the Sanctions Source
mmsi Describes the MMSI details received from the Sanctions Source
AMS_Result Contain below fields for Adverse Media News results received from different articles
id Unique ID for search result in Database
heading Describes the heading for the article received in the result
url Describes the URL of the article received in the result
source Describes the URL of the website for the article received in the result
summary Describes the summary for the article in the result
content Describes the content of the article
publish_date Describes the date on which the respective article was published
name Describes the name for which the article is shown in the results
name_matching_score Describes the name matching score between the screened name and the result
sentiment_score Sentiment score is the score assigned to the article by Solytics based on below points;
        score Describes the overall sentiment score of the article in the result
        sign Describes the tone of the overall article in terms of Positive, Negative or Neutral
source_credibility_score Describes the credibility of the source for the article received in the results
overall_score Solytics defined weighted Average of the Name matching score, Sentiment score and Source Crediblity score
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
ID Unique ID for search result in Solytics' Database
listName Name of the source which has Sactioned the country
country Name of the sanctioned country
sourceURL1 Describes the URL of the source which placed sanctions on the country
Description Brief desciption about the sanctions placed by the source authority
bannedSubjects List of banned items,actions that are restricted by the Sanction source
Exemptions List of exempted items,actions that are published by the Sanction source
SFDC_Lead_Id Lead ID for the respective application from SFDC
Application_ID Application ID for the respective application from SFDC
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)
Legal_Result Contain below fields for Legal results
id Unique ID for search result in Database
tid Unique ID for for the article received in the result
url Describes the URL of the article received in the result
title Describes the Tilte of the website for the article received in the result
author Describes the author for the article in the result
covers Describes the content of the article
docsize Describes the size Of The Document
doctype Describes the type of document
fragment Describes the name matching score between the screened name and the result
headline Describes The Headline Of the Article
lastname Describes the queryName associated with articles
numcites Describes the tone of the overall article in terms of Positive, Negative or Neutral
covertids Describes the other tids associated with article
docsource Describes The source of the article
firstname Describes the queryName associated with articles.
queryName Describes the name searched
numcitedby Describes the different words that are searched in the artciles. E.g., Penalty, terrorism, etc.
secondname Describes the queryName associated with articles.
covertitles Describes the other titles of other articles associated with article
publishdate Describes the date when article was published
authorEncoded Describes the encoded value of author for the article in the result .
analyst Describes the Name of analyst who reviewed the article.
Data Field-Verdict Description
pep_result
status status marked as true/false by the analyst
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 overall remark of the analyst
ID Unique ID for search result in Database
ams_result
status accept/reject
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