SAMS API V1 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 REST POST https://bwff51oh1j.execute-api.ap-south-1.amazonaws.com/prod/initiate-search/ This service is used to perform Individual search on the system.
Initiate entity REST POST https://bwff51oh1j.execute-api.ap-south-1.amazonaws.com/prod/initiate-search/ This service is used to perform an Entity search on the system.
Submit verdict REST POST https://bwff51oh1j.execute-api.ap-south-1.amazonaws.com/prod/verdict/?screen=initial/ This service is used to perform a (Accept Or Reject) search in queue on the system.


SAMS APIs 4

raw

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

Headers
KeyValueDescription
AuthorizationApi-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API is used to initiate single searches for individual type.
Body
{ "screenType": "initial", "applicant_id": "40", "search_type": "individual", "name": "Hemanth Pujari", "gender": "", "date_of_birth": "", "aliases": "", "email": "", "nationality": "", "country": "", "country_of_jurisdiction": "", "address": "", "national_id": "", "passport_number": "", "pan": "", "phone_number": "", "pep_field": true, "nns_field": false, "sanction_field": true, "analyst_assigned_to": "piramal_poc", "analyst_target_date": "2021-04-21", "application_id": "50", "sdfc_lead_id": "100", "branch_name": "bangalore", "product_line": "123", "pennant_analyst_name": "sams_analyst1", "analyst_email_id": "sams@solyticspartners@gmail.com" }

raw

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

Headers
KeyValueDescription
AuthorizationApi-Key yXjWl6CK.HVqoBIc9BTFvzAjaRiojkLxsEogr90NnThis API is used to initiate single searches for entity type.
Body
{ "screenType": "initial", "applicant_id": "41", "search_type": "entity", "name": "YUK TUNG ENERGY PTE LTD", "date_of_birth": "", "aliases": "", "email": "", "country": "", "headquarter": "", "country_of_jurisdiction": "", "cin": "", "address": "", "tin": "", "isin": "", "gst": "", "nns_field": false, "sanction_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" ], "analyst_assigned_to": "piramal_poc", "analyst_target_date": "2022-01-21", "application_id": "51", "sdfc_lead_id": "100", "branch_name": "bangalore", "product_line": "4646", "pennant_analyst_name": "sams_analyst1", "analyst_email_id": "sams@solyticspartners@gmail.com" }

raw

Submit Verdict  |  POST   {{url}}/verdict/

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
screeninitial
Body
{ "pep_result":[ { "status":false, "Remark":"not okk", "id":"92515d238fe08e106e996f6e35319f369f66b92a048a22b0d1f3e1e4140ba5fc" }, { "status":true, "Remark":"not okk", "id":"732c995e8cfdbc5e63058f120233ec5cded6040dbce522da724e29a9172ab775" }, { "status":true, "Remark":"not okk", "id":"78a7f5182d4bca8cb10e11113dcbcbb432a494f26e9bd176ad997630f7d75c99" }, { "status":false, "Remark":"not okk", "id":"de16fbce9e7ac5d8707f11f5354e2ff417690d7f91e58878a69a41fdab026b2d" }, { "status":true, "Remark":"not okk", "id":"da3e9de994eab074a3705f4eed8bc0cbcbafea54e025cb5ff08e05b79423d171" }, { "status":false, "Remark":"not okk", "id":"71a3497475339bdfef2b2fe198539d6b42c44c205d79b4d357ec28196081a8d1" }, { "status":true, "Remark":"not okk", "id":"5ebf9102e7816ac61dd55132544074744da509e09d66b37b77467df2923f907f" } ], "sanctions_result":[ { "status":true, "Remark":"not okk", "id":"9a386452597370c09050e48e660bf818ad52130a463c347ff287fedb2399b191" } ], "verdict_submitted_by":"piramal_poc", "id":"1921-0919-10087620", "verdict":"accept", "remarks":"ok" }

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 String 100 Mandatory
Applicant ID Unique ID from Piramal 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 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 being screened Text Max Non-Mandatory
Country_of_jurisdiction Jurisdiction Country for the individual/entity being screened Text Max Non-Mandatory
Address Address of the individual/entity 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
Analyst Assigned to Analyst Assigned for the respective search in SFDC String 50 Mandatory
analyst target date Due 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 Non-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 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
GSTIN GSTIN of the entity being screened 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 Piramal for each name being screened (should be available in payload)
PAN PAN entered for the individual
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
ID Score Describes the ID match score for Screened name
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
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
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 Piramal 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
ID Score Describes the ID match score for Screened Entity
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
NNS 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.
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
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 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 Piramal 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 piramal 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 piramal team


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



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