Search Methods | Sanction Scanner Developer Portal

Sanction Scanner Search By Name

Required input informations of SearchByName Restful Service should be prepared in RESTful (JSON) format and sent the following address with GET method.

https://api.sanctionscanner.com/api/Search/SearchByName?name=Name

This service is used to find out if the name of the person entered is on the national and international search list. The information required to perform the service call is the name of the person to be interrogated. The “GET” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information.

This service can be used to perform a search for "individuals, corporates, vessels, aircraft or any" types by using names. The individual type is for real people, the corporate type is for legal entities, companies or organizations, the vessel type is for ships, the aircraft type is for aircraft, any type is for all these types is used to search within.

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
name	String	Yes	Name of entity to scan (Number of characters entered must not be less than 3)
searchType	int	No	Only one of the following values can be sent (Default Value: 1); 0:Any 1:Individual 2:Corporate 3:Vessel 4:Aircraft
start	int	No	Match results from the database, starting from the offset value (Default Value:0)
limit	int	No	Match results from the database, taking up to this many matches each search (Default Value:20 Max Value:50)
referenceNumber	String	No	Reference Number *(ScanId, unique identifier that created by Sanction Scanner on every scan)
outReferenceNumber	String	No	Out Reference Number is a unique identifier that you assign to this scan to track it and enables you to set Risks and Comments for Screening.
birthYear	String	No	Birth Year (Ex:1970)
minMatchRate	int	No	Minimum Match Rate (Default Value:80 Range:50-100; If the minimum match rate is set to 100, an "Exact Match" status occurs. In this case, the name of the record to be searched and the name you entered will result in a one-to-one match. )
maxMatchRate	int	No	Maximum Match Rate (Default Value:100 Range:50-100)
isDeepSearch	boolean	No	If you send it as true, the search will take place in the most detailed way. However, the search time will be longer. (Default Value:false)
countryCodes	String	No	If you fill this parameter according to COUNTRY CODES ALPHA-2 rule with commas, only records containing the countries you sent will be brought. You can access the country codes by clicking the link below; https://www.iban.com/country-codes
searchProfileKey	String	No	If you fill this parameter, it will be scanned according to the search profile you sent. You can access the Search Profile Key by going to the Search Profile page on the panel.
assigneeUserGuid	String	No	If you fill this parameter, the scan will be automatically assigned to the relevant user. You must use the "Get My Organization Users" method to obtain users' Guids.

*Reference Number field will be generated by our system. You have to send this field as empty for first searching, after we will return you can use it for pagination.

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
TotalRecordCount	int	Total count of unique records matching the search result
ReturnRecordCount	int	Count of unique records that match within the limit in the search result
TotalProfileCount	int	Total count of matching profiles in search result
Start	int	Match results from the database, starting from the offset value
Limit	int	Match results from the database, taking up to this many matches each search
ReferenceNumber	int	Reference Number *(ScanId, unique identifier that created by Sanction Scanner on every scan)
OutReferenceNumber	String	Out Reference Number is a unique identifier that you assign to this scan to track it and enables you to set Risks and Comments for Screening
NameSearchType	String	Search Type (Ex: Individual, Organization, Vessel etc.)
MinMatchRate	int	Minimum Match Rate parameter of scan
MaxMatchRate	int	Maximum Match Rate parameter of scan
BirthYear	int	Birth Year parameter of scan
IsSafeList	Booelan	If the result is true, the scanned value is in the safe list
IsZFS	Booelan	If the result is true, scan details will not be logged or saved
NationalyFilter	String	Country Code parameter of scan
MatchStatusId	int	Match Status Id of scan 0:Unknown 1:No Match 2:Potential Match 3:False Positive 4:True Positive 5:True Positive Approve 6:True Positive Reject
RiskLevelId	int	Risk Level Id of scan 0:Unknown 1:Low 2:Medium 3:High 4:Neutral 5:Increased 6:Unacceptable
AssignedUserGuidId	string	Assigned User Guid Id of scan *(You can find the details of the relevant user using the api described at Get My Organization Users.)
TagList	string array	Tag Guid Id List of scan *(You can find the details of the relevant tag using the api described at Get My Organization Tags.)
IsWhiteList	Booelan	If the result is true, the scanned value is in the whitelist
WhiteListMessage	String	Returns a message if IsWhiteList is true
Result	Result Class	Result Information. The following internal table describes the internal parameters.

Result Class Informations

Parameter Name	Data Type	Description
MatchRate	Double	The rate at which the result matches the scan term
IsMatchAka	Boolean	Is the match obtained from aka
FirstName	String	Name of scanned entity
MiddleName	String	Middle Name of scanned entity
LastName	String	Surname of scanned entity
FullName	String	Full Name of scanned entity
EntityType	String	Entity Type (Individual, Corporate, Vessel, Aircraft, Country)
Type	String	Type of list (Sanction, Wanted, Watchlist, PEP, SIP, Local, RCA)
BlacklistName	String	Blacklist Name (Us OFAC List, Interpol Wanted List Etc.)
RegisteredNumber	String	Registered Number for entities
ProgramKey	String	Program Key
ProgramName	String	The crime scope that caused the questioned person to be listed
Origin	String	Origin Information
SanctionSet	String	Sanction Set Information
Nationality	String	Nationality of scanned entity
Title	String	Title of scanned entity
HonoricPrefix	String	Honoric Prefix of scanned entity
HonoricSuffix	String	Honoric Suffix of scanned entity
ContactDetails	String	Contact Details of scanned entity
Email	String	Email of scanned entity
ListedOn	String	List entry date of scanned entity
OtherInformation	String	Other Information about scanned entity
MatchedListId	Integer	The list information that the query matches is given below the document.
Position	String	Position of scanned entity
LastUpdateDate	String	Last Update Date to record
CountryCode	String	Country Code
Country	String	Country information
Address	String	Address information
PassportDetails	String	Scanned entity’s Passport Details
Language	String	Language information
BirthDate	String	Scanned entity’s Birth Date
DeathDate	String	Scanned entity’s Death Date
CitizenDetail	String	Scanned entity’s Citizen Details
AddressDetail	String	Scanned entity’s Address Details
Function	String	Scanned entity’s Function information
Gender	String	Scanned entity’s Gender information
Remark	String	Remark information
FirstSeen	String	First Seen
LastSeen	String	Last Seen information
Summary	String	Summary information
FatherName	String	Father Name information
Committees	String	Committees information
Basis	String	Basis information
RecordUniqueNumber	String	Record Unique Number information
Designation	String	Designation information
SubmittedBy	String	Submitted By information
Justification	String	Justification information
DataSource	String	DataSource information
ListingInformation	String	Listing information
VesselCallSign	String	Vessel Call Sign
VesselType	String	Vessel Type
VesselFlag	String	Vessel Flag
VesselTonnage	String	Vessel Tonnage
VesselGrossRegisteredTonnage	String	Vessel Gross Registered Tonnage
VesselOwner	String	Vessel Owner
BlacklistFlagCode	String	Blacklist Flag Code
ProfileKey	String	If the names on different lists have the same person, entity or organization as a result of the search, they will have the same "ProfileKey" value.
PepClass	String	Pep Class Detail
PepClassId	Integer	1 (PEP Class 1): People with titles such as Heads of Government, Heads of State, Kings, Cabinet Members, Ministers, Members of Parliament, Deputies, Military Force Commanders, Supreme Court Presidents, Heads Of Law Enforcement Force, Party Presidents and Court Presidents are included in this class. 2 (PEP Class 2): People with titles such as High Ranking Soldiers, Governors, Religious and Spiritual Leaders, Ambassadors, Consuls, Members of High Court Delegations, and Under Secretaries are included in this class. 3 (PEP Class 3): People with titles such as Mayors and Managers of Public Institutions or Public Affiliated Organizations or Deputy Head of Mission are included in this class. 4 (PEP Class 4): People who have a relative close association with people who are in the category of politically exposed persons are included in this class. 6 (Special Interest Persons (SIP)): Special Interest Persons are individuals that present a heightened level of risk due to their suspected or confirmed involvement in criminal activity.
ssid	String	Unique Id of this data
OtherNames	OtherNames Class	OtherNames information. The following internal table describes the internal parameters.
Documents	Documents Class	Documents information. The following internal table describes the internal parameters.
BirthDetails	BirthDetails Class	BirthDetails information. The following internal table describes the internal parameters.
AddressDetails	AddressDetails Class	AddressDetails information. The following internal table describes the internal parameters.
Images	Images Class	Images Information. The following internal table describes the internal parameters.
Links	Links Class	Links information. The following internal table describes the internal parameters.
Modifications	Modifications Class	Modifications information. The following internal table describes the internal parameters.
MembershipData	MembershipData Class	MembershipData information. The following internal table describes the internal parameters.
MediaData	MediaData Class	MediaData information. The following internal table describes the internal parameters.

*Enhanced Profile is a profile that consists of more than one profile. Our powerful AI-Driven algorithms understand the same record in different sanction, pep or watchlists and it combines these records under an enhanced profile.

OtherNames Class Informations

Parameter Name	Data Type	Description
NameType	String	Name Type (AKA or Original Script etc.)
FullName	String	FullName of scanned entity
Language	String	Language of scanned entity Name
OtherInformation	String	Extra information
Quality	String	Quality of name

Documents Class Informations

Parameter Name	Data Type	Description
DocumentType	String	Document Type information
DocumentTypeInformation	String	Document Type extra information
DocumentNumber	String	Document Number
DocumentCountry	String	Country of Document
DocumentCity	String	City of Document
IssueDate	String	Issue Date of Document
ExpirationDate	String	Expiration Date of Document
OtherInformation	String	Extra Information

BirthDetails Class Informations

Parameter Name	Data Type	Description
BirthDate	String	Birth Date
BirthPlace	String	Birth Place
Birth Country	String	Birth Country
OtherInformation	String	Extra Information

AddressDetails Class Informations

Parameter Name	Data Type	Description
Number	String	Number
Street	String	Street
State	String	State
ZipCode	String	ZipCode
City	String	City
Country	String	Country
IsoCode	String	Country Iso Code
OtherInformation	String	Extra Information

Images Class Informations

Parameter Name	Data Type	Description
DataSource	String	Data Source
Link	String	Link of Image
OtherInformation	String	Extra Information

Links Class Informations

Parameter Name	Data Type	Description
DataSource	String	Data Source
Link	String	External Link
OtherInformation	String	Extra Information

Modifications Class Informations

Parameter Name	Data Type	Description
ProcessName	String	Process Name
Modification Type	String	Modification Type
EnactmentDate	String	Enactment Date
PublicationDate	String	Publication Date
EffectiveDate	String	Effective Date
OtherInformation	String	Extra Information

MembershipData Class Informations

Parameter Name	Data Type	Description
ConstituencyArea	String	Constituency Area Information
EventClassification	String	Event Classification Information
EventName	String	Event Name
EventStartDate	String	Event Start Date
EventEndDate	String	Event End Date
EventOrganizationName	String	Event Organization Name
PartyClassification	String	Party Classification Information
PartyShortName	String	Party Short Name
PartyName	String	Party Name
PartyImage	String	Party Image
PartyWebsite	String	Party Web site
PartySrgb	String	Party Srgb
OrganizationClassification	String	Organization Classification Information
OrganizationId	String	Organization Identity Number
OrganizationName	String	Organization Name
OrganizationImage	String	Organization Image
OrganizationWebsite	String	Organization Web site
OrganizationSrgb	String	Organization Srgb
Role	String	Role
Sources	String	Sources Informations

MediaData Class Informations

Parameter Name	Data Type	Description
Id	Integer	Id Of Media
Link	String	Link of Media
Title	String	Title Of Media

https://api.sanctionscanner.com/api/Search/SearchByName?name=Name

In the link above, a call must be made using the name of the person to be queried instead of the field that is in the “name” field.

The result of the call is a result and the status of the transaction is returned in response. In successful transactions , this status returns to 200, and in unsuccessful transactions it returns to 400.

Sample Service Response Codes

 
                                          
    
                                   
//Response
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": {
    "TotalRecordCount": 10,
    "ReturnRecordCount": 1,
    "TotalProfileCount": 1,
    "Start": 0,
    "Limit": 50,
    "ReferenceNumber": "D******",
    "OutReferenceNumber": "",
    "MatchStatus": "",
    "RiskLevel": "",
    "IsWhiteList": false,
    "WhiteListMessage": "",
    "MatchStatusId": 2,
    "RiskLevelId": 0,
    "AssignedUserGuidId": null,
    "TagList": [],
    "NameSearchType": "*******",
    "MinMatchRate": 50,
    "MaxMatchRate": 50,
    "BirthYear": 1999,
    "IsSafeList": false,
    "NationalyFilter": "tr,de,us",
    "IsZFS": false,
    "Result": [
        {
        "MatchRate": "****",
        "IsMatchAka": "****",
        "FirstName": "****",
        "MiddleName": "****",
        "LastName": "****",
        "FullName": "****",
        "Nationality": "****",
        "ListedOn": "****",
        "LastUpdateDate": "****",
        "ProgramKey": "****",
        "ProgramName": "****",
        "Position": "****",
        "Country": "****",
        "SanctionSet": "****",
        "Origin": "****",
        "Title": "****",
        "Gender": "****",
        "Function": "****",
        "Language": "****",
        "CitizenDetail": "****",
        "CountryCode": "****",
        "HonoricPrefix": "****",
        "HonoricSuffix": "****",
        "ContactDetails": "****",
        "Email": "****",
        "BirthDate": "****",
        "DeathDate": "****",
        "EntityType": "****",
        "Type": "****",
        "Remark": "****",
        "FirstSeen": "****",
        "LastSeen": "****",
        "Summary": "****",
        "FatherName": "****",
        "Committees": "****",
        "OtherInformation": "****",
        "Basis": "****",
        "BlackListTypeId": "****",
        "RecordUniqueNumber": "****",
        "Designation": "****",
        "SubmittedBy": "****",
        "Justification": "****",
        "DataSource": "****",
        "ListingInformation": "****",
        "BlacklistName": "****",
        "BlacklistFlagCode": "****",
        "VesselCallSign": "****",
        "VesselType": "****",
        "VesselFlag": "****",
        "VesselTonnage": "****",
        "VesselGrossRegisteredTonnage": "****",
        "VesselOwner": "****",
        "RegisteredNumber": "******",
        "ProfileKey": "******",
        "PepClass": "******",
        "ssid": "******",
        "PepClassId": "******",
        "OtherNames": [
        {
        "NameType": "****",
        "FullName": "****",
        "Language": "****",
        "OtherInformation": "****",
        "Quality": "****"
        }
              ],
    "Documents": [
        {
        "DocumentType": "****",
        "DocumentTypeInformation": "****",
        "DocumentNumber": "****",
        "DocumentCountry": "****",
        "DocumentCity": "****",
        "IssueDate": "****",
        "ExpirationDate": "****",
        "OtherInformation": "****"
        }
                ],
    "BirthDetails": [
        {
        "BirthDate": "****",
        "BirthPlace": "****",
        "BirthCountry": "****",
        "OtherInformation": "****"
        }
                   ],
    "AddressDetails": [
        {
        "Number": "****",
        "Street": "****",
        "State": "****",
        "ZipCode": "****",
        "City": "****",
        "Country": "****",
        "IsoCode": "****",
        "OtherInformation": "****"
        }
                      ],
    "Images": [
        {
        "DataSource": "****",
        "Link": "****",
        "OtherInformation": "****"
        }
              ],
    "Links": [
        {
        "DataSource": "****",
        "Link": "****",
        "OtherInformation": "****"
        }
             ],
    "Modifications": [
        {
        "ProcessName": "****",
        "ModificationType": "****",
        "EnactmentDate": "****",
        "PublicationDate": "****",
        "EffectiveDate": "****",
        "OtherInformation": "****"
        }
            ],
    "MemberShipData": [
        {
        "ConstituencyArea": "****",
        "EventClassification": "****",
        "EventName": "****",
        "EventStartDate": "****",
        "EventEndDate": "****",
        "EventOrganizationName": "****",
        "PartyClassification": "****",
        "PartyShortName": "****",
        "PartyName": "****",
        "PartyImage": "****",
        "PartyWebsite": "****",
        "PartySrgb": "****",
        "OrganizationClassification": "****",
        "OrganizationId": "****",
        "OrganizationName": "****",
        "OrganizationImage": "****",
        "OrganizationWebsite": "****",
        "OrganizationSrgb": "****",
        "Role": "****",
        "Sources": "****"
        }
                     ],
            "MediaData": [
        {
        "Id": "****",
        "Link": "****",
        "Title": "****"
        }
             ]
    }
        ]
    }
}

Sanction Scanner Search By Identity Number

Required input informations of SearchByIdentity Restful Service should be prepared in RESTful (JSON) format and sent the following address with GET method.
https://api.sanctionscanner.com/api/Search/SearchByIdentity?id=Id

This service is used to find out if the identity number (ID number for Individual, Register Number for Corporate, IMO Number for Vessel, Tail Number for Aircraft) of the person entered is on the national and international search list. The information required to perform the service call is the identity number of the person to be interrogated. The “GET” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information. The service call should be done as follows;

This service can be used to perform a search for real people using local identification numbers. Personal documents numbers can be used as local identification numbers.

⚠	This API call will be supported until 01/09/23. After this date, Instead of Search By Identity Number and Search By Passport Number Methods, a single API method will be used: Search By Document Number.

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
id	String	Yes	Identity Number of entity to scan (Number of characters entered must not be less than 5)
start	int	No	Match results from the database, starting from the offset value (Default Value:0)
limit	int	No	Match results from the database, taking up to this many matches each search (Default Value:20 Max Value:50)
referenceNumber	String	No	Reference Number *(ScanId, unique identifier that created by Sanction Scanner on every scan)
outReferenceNumber	String	No	Out Reference Number is a unique identifier that you assign to this scan to track it and enables you to set Risks and Comments for Screening
countryCodes	String	No	If you send this parameter as "COUNTRY CODES ALPHA-2" with commas, only records containing the countries you sent will be brought. You can access the country codes by clicking the link below; https://www.iban.com/country-codes
searchType	int	No	Only one of the following values can be sent (Default Value: 1); 0:Any 1:Individual 2:Corporate 3:Vessel 4:Aircraft
searchProfileKey	String	No	If you fill this parameter, it will be scanned according to the search profile you sent. You can access the Search Profile Key by going to the Search Profile page on the panel.
assigneeUserGuid	String	No	If you fill this parameter, the scan will be automatically assigned to the relevant user. You must use the "Get My Organization Users" method to obtain users' Guids.

*Reference Number field will be generated by our system. You have to send this field as empty for first searching, after we will return you can use it for pagination.

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
TotalRecordCount	int	Total count of unique records matching the search result
ReturnRecordCount	int	Count of unique records that match within the limit in the search result
TotalProfileCount	int	Total count of matching profiles in search result
Start	int	Match results from the database, starting from the offset value
Limit	int	Match results from the database, taking up to this many matches each search
ReferenceNumber	int	Reference Number *(ScanId, unique identifier that created by Sanction Scanner on every scan)
OutReferenceNumber	String	Out Reference Number is a unique identifier that you assign to this scan to track it and enables you to set Risks and Comments for Screening
NameSearchType	String	Search Type (Ex: Individual, Organization, Vessel etc.)
MinMatchRate	int	Minimum Match Rate parameter of scan
MaxMatchRate	int	Maximum Match Rate parameter of scan
BirthYear	int	Birth Year parameter of scan
IsSafeList	Booelan	If the result is true, the scanned value is in the safe list
IsZFS	Booelan	If the result is true, scan details will not be logged or saved
NationalyFilter	String	Country Code parameter of scan
MatchStatusId	int	Match Status Id of scan 0:Unknown 1:No Match 2:Potential Match 3:False Positive 4:True Positive 5:True Positive Approve 6:True Positive Reject
RiskLevelId	int	Risk Level Id of scan 0:Unknown 1:Low 2:Medium 3:High 4:Neutral 5:Increased 6:Unacceptable
AssignedUserGuidId	string	Assigned User Guid Id of scan *(You can find the details of the relevant user using the api described at Get My Organization Users.)
TagList	string array	Tag Guid Id List of scan *(You can find the details of the relevant tag using the api described at Get My Organization Tags.)
IsWhiteList	Booelan	If the result is true, the scanned value is in the whitelist
WhiteListMessage	String	Returns a message if IsWhiteList is true
Result	Result Class	Result Information. The following internal table describes the internal parameters.

Result Class Informations

Parameter Name	Data Type	Description
MatchRate	Double	The rate at which the result matches the scan term
IsMatchAka	Boolean	Is the match obtained from aka
FirstName	String	Name of scanned entity
MiddleName	String	Middle Name of scanned entity
LastName	String	Surname of scanned entity
FullName	String	Full Name of scanned entity
EntityType	String	Entity Type (Individual, Corporate, Vessel, Aircraft, Country)
Type	String	Type of list (Sanction, Wanted, Watchlist, PEP, SIP, Local, RCA)
BlacklistName	String	Blacklist Name (Us OFAC List, Interpol Wanted List Etc.)
RegisteredNumber	String	Registered Number for entities
ProgramKey	String	Program Key
ProgramName	String	The crime scope that caused the questioned person to be listed
Origin	String	Origin Information
SanctionSet	String	Sanction Set Information
Nationality	String	Nationality of scanned entity
Title	String	Title of scanned entity
HonoricPrefix	String	Honoric Prefix of scanned entity
HonoricSuffix	String	Honoric Suffix of scanned entity
ContactDetails	String	Contact Details of scanned entity
Email	String	Email of scanned entity
ListedOn	String	List entry date of scanned entity
OtherInformation	String	Other Information about scanned entity
MatchedListId	Integer	The list information that the query matches is given below the document.
Position	String	Position of scanned entity
LastUpdateDate	String	Last Update Date to record
CountryCode	String	Country Code
Country	String	Country information
Address	String	Address information
PassportDetails	String	Scanned entity’s Passport Details
Language	String	Language information
BirthDate	String	Scanned entity’s Birth Date
DeathDate	String	Scanned entity’s Death Date
CitizenDetail	String	Scanned entity’s Citizen Details
AddressDetail	String	Scanned entity’s Address Details
Function	String	Scanned entity’s Function information
Gender	String	Scanned entity’s Gender information
Remark	String	Remark information
FirstSeen	String	First Seen
LastSeen	String	Last Seen information
Summary	String	Summary information
FatherName	String	Father Name information
Committees	String	Committees information
Basis	String	Basis information
RecordUniqueNumber	String	Record Unique Number information
Designation	String	Designation information
SubmittedBy	String	Submitted By information
Justification	String	Justification information
DataSource	String	DataSource information
ListingInformation	String	Listing information
VesselCallSign	String	Vessel Call Sign
VesselType	String	Vessel Type
VesselFlag	String	Vessel Flag
VesselTonnage	String	Vessel Tonnage
VesselGrossRegisteredTonnage	String	Vessel Gross Registered Tonnage
VesselOwner	String	Vessel Owner
BlacklistFlagCode	String	Blacklist Flag Code
ProfileKey	String	If the names on different lists have the same person ,entity or organization as a result of the search, they will have the same "ProfileKey" value.
PepClass	String	Pep Class Detail
PepClassId	Integer	1 (PEP Class 1): People with titles such as Heads of Government, Heads of State, Kings, Cabinet Members, Ministers, Members of Parliament, Deputies, Military Force Commanders, Supreme Court Presidents, Heads Of Law Enforcement Force, Party Presidents and Court Presidents are included in this class. 2 (PEP Class 2): People with titles such as High Ranking Soldiers, Governors, Religious and Spiritual Leaders, Ambassadors, Consuls, Members of High Court Delegations, and Under Secretaries are included in this class. 3 (PEP Class 3): People with titles such as Mayors and Managers of Public Institutions or Public Affiliated Organizations or Deputy Head of Mission are included in this class. 4 (PEP Class 4): People who have a relative close association with people who are in the category of politically exposed persons are included in this class. 6 (Special Interest Persons (SIP)): Special Interest Persons are individuals that present a heightened level of risk due to their suspected or confirmed involvement in criminal activity.
ssid	String	Unique Id of this data
OtherNames	OtherNames Class	OtherNames information. The following internal table describes the internal parameters.
Documents	Documents Class	Documents information. The following internal table describes the internal parameters.
BirthDetails	BirthDetails Class	BirthDetails information. The following internal table describes the internal parameters.
AddressDetails	AddressDetails Class	AddressDetails information. The following internal table describes the internal parameters.
Images	Images Class	Images Information. The following internal table describes the internal parameters.
Links	Links Class	Links information. The following internal table describes the internal parameters.
Modifications	Modifications Class	Modifications information. The following internal table describes the internal parameters.
MembershipData	MembershipData Class	MembershipData information. The following internal table describes the internal parameters.
MediaData	MediaData Class	MediaData information. The following internal table describes the internal parameters.

OtherNames Class Informations

Parameter Name	Data Type	Description
NameType	String	Name Type (AKA or Original Script etc.)
FullName	String	FullName of scanned entity
Language	String	Language of scanned entity Name
OtherInformation	String	Extra information
Quality	String	Quality of name

Documents Class Informations

Parameter Name	Data Type	Description
DocumentType	String	Document Type information
DocumentTypeInformation	String	Document Type extra information
DocumentNumber	String	Document Number
DocumentCountry	String	Country of Document
DocumentCity	String	City of Document
IssueDate	String	Issue Date of Document
ExpirationDate	String	Expiration Date of Document
OtherInformation	String	Extra Information

BirthDetails Class Informations

Parameter Name	Data Type	Description
BirthDate	String	Birth Date
BirthPlace	String	Birth Place
Birth Country	String	Birth Country
OtherInformation	String	Extra Information

AddressDetails Class Informations

Parameter Name	Data Type	Description
Number	String	Number
Street	String	Street
State	String	State
ZipCode	String	ZipCode
City	String	City
Country	String	Country
IsoCode	String	Country Iso Code
OtherInformation	String	Extra Information

Images Class Informations

Parameter Name	Data Type	Description
DataSource	String	Data Source
Link	String	Link of Image
OtherInformation	String	Extra Information

Links Class Informations

Parameter Name	Data Type	Description
DataSource	String	Data Source
Link	String	External Link
OtherInformation	String	Extra Information

Modifications Class Informations

Parameter Name	Data Type	Description
ProcessName	String	Process Name
Modification Type	String	Modification Type
EnactmentDate	String	Enactment Date
PublicationDate	String	Publication Date
EffectiveDate	String	Effective Date
OtherInformation	String	Extra Information

MembershipData Class Informations

Parameter Name	Data Type	Description
ConstituencyArea	String	Constituency Area Information
EventClassification	String	Event Classification Information
EventName	String	Event Name
EventStartDate	String	Event Start Date
EventEndDate	String	Event End Date
EventOrganizationName	String	Event Organization Name
PartyClassification	String	Party Classification Information
PartyShortName	String	Party Short Name
PartyName	String	Party Name
PartyImage	String	Party Image
PartyWebsite	String	Party Web site
PartySrgb	String	Party Srgb
OrganizationClassification	String	Organization Classification Information
OrganizationId	String	Organization Identity Number
OrganizationName	String	Organization Name
OrganizationImage	String	Organization Image
OrganizationWebsite	String	Organization Web site
OrganizationSrgb	String	Organization Srgb
Role	String	Role
Sources	String	Sources Informations

MediaData Class Informations

Parameter Name	Data Type	Description
Id	Integer	Id Of Media
Link	String	Link of Media
Title	String	Title Of Media

https://api.sanctionscanner.com/api/Search/SearchByIdentity?id=Id

In the link above, a call must be made using the identity number of the person to be queried instead of the field that is in the “Id” field.

Sample Service Response Codes

 
                                          
    
                                   
//Response
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": {
    "TotalRecordCount": 10,
    "ReturnRecordCount": 1,
    "TotalProfileCount": 1,
    "Start": 0,
    "Limit": 50,
    "ReferenceNumber": "D******",
    "OutReferenceNumber": "",
    "MatchStatus": "",
    "RiskLevel": "",
    "IsWhiteList": false,
    "WhiteListMessage": "",
    "MatchStatusId": 2,
    "RiskLevelId": 0,
    "AssignedUserGuidId": null,
    "TagList": [],
    "NameSearchType": "*******",
    "MinMatchRate": 50,
    "MaxMatchRate": 50,
    "BirthYear": 1999,
    "IsSafeList": false,
    "NationalyFilter": "tr,de,us",
    "IsZFS": false,
    "Result": [
        {
        "MatchRate": "****",
        "IsMatchAka": "****",
        "FirstName": "****",
        "MiddleName": "****",
        "LastName": "****",
        "FullName": "****",
        "Nationality": "****",
        "ListedOn": "****",
        "LastUpdateDate": "****",
        "ProgramKey": "****",
        "ProgramName": "****",
        "Position": "****",
        "Country": "****",
        "SanctionSet": "****",
        "Origin": "****",
        "Title": "****",
        "Gender": "****",
        "Function": "****",
        "Language": "****",
        "CitizenDetail": "****",
        "CountryCode": "****",
        "HonoricPrefix": "****",
        "HonoricSuffix": "****",
        "ContactDetails": "****",
        "Email": "****",
        "BirthDate": "****",
        "DeathDate": "****",
        "EntityType": "****",
        "Type": "****",
        "Remark": "****",
        "FirstSeen": "****",
        "LastSeen": "****",
        "Summary": "****",
        "FatherName": "****",
        "Committees": "****",
        "OtherInformation": "****",
        "Basis": "****",
        "BlackListTypeId": "****",
        "RecordUniqueNumber": "****",
        "Designation": "****",
        "SubmittedBy": "****",
        "Justification": "****",
        "DataSource": "****",
        "ListingInformation": "****",
        "BlacklistName": "****",
        "BlacklistFlagCode": "****",
        "VesselCallSign": "****",
        "VesselType": "****",
        "VesselFlag": "****",
        "VesselTonnage": "****",
        "VesselGrossRegisteredTonnage": "****",
        "VesselOwner": "****",
        "RegisteredNumber": "******",
        "ProfileKey": "******",
        "PepClass": "******",
        "ssid": "******",
        "PepClassId": "******",
        "OtherNames": [
        {
        "NameType": "****",
        "FullName": "****",
        "Language": "****",
        "OtherInformation": "****",
        "Quality": "****"
        }
              ],
    "Documents": [
        {
        "DocumentType": "****",
        "DocumentTypeInformation": "****",
        "DocumentNumber": "****",
        "DocumentCountry": "****",
        "DocumentCity": "****",
        "IssueDate": "****",
        "ExpirationDate": "****",
        "OtherInformation": "****"
        }
                ],
    "BirthDetails": [
        {
        "BirthDate": "****",
        "BirthPlace": "****",
        "BirthCountry": "****",
        "OtherInformation": "****"
        }
                   ],
    "AddressDetails": [
        {
        "Number": "****",
        "Street": "****",
        "State": "****",
        "ZipCode": "****",
        "City": "****",
        "Country": "****",
        "IsoCode": "****",
        "OtherInformation": "****"
        }
                      ],
    "Images": [
        {
        "DataSource": "****",
        "Link": "****",
        "OtherInformation": "****"
        }
              ],
    "Links": [
        {
        "DataSource": "****",
        "Link": "****",
        "OtherInformation": "****"
        }
             ],
    "Modifications": [
        {
        "ProcessName": "****",
        "ModificationType": "****",
        "EnactmentDate": "****",
        "PublicationDate": "****",
        "EffectiveDate": "****",
        "OtherInformation": "****"
        }
            ],
    "MemberShipData": [
        {
        "ConstituencyArea": "****",
        "EventClassification": "****",
        "EventName": "****",
        "EventStartDate": "****",
        "EventEndDate": "****",
        "EventOrganizationName": "****",
        "PartyClassification": "****",
        "PartyShortName": "****",
        "PartyName": "****",
        "PartyImage": "****",
        "PartyWebsite": "****",
        "PartySrgb": "****",
        "OrganizationClassification": "****",
        "OrganizationId": "****",
        "OrganizationName": "****",
        "OrganizationImage": "****",
        "OrganizationWebsite": "****",
        "OrganizationSrgb": "****",
        "Role": "****",
        "Sources": "****"
        }
                     ],
            "MediaData": [
        {
        "Id": "****",
        "Link": "****",
        "Title": "****"
        }
             ]
    }
        ]
    }
}

Sanction Scanner Search By Passport Number

Required input informations of SearchByPassportNo Restful Service should be prepared in RESTful (JSON) format and sent the following address with GET method.
https://api.sanctionscanner.com/api/Search/SearchByPassportNo?passportNo=PassportNo

This service is used to find out if the passport number of the person entered is on the national and international search list. The information required to perform the service call is the passport number of the person to be interrogated. The “GET” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information. The service call should be done as follows;

This service can be used to perform a search for real people using passport numbers.

⚠	This API call will be supported until 01/09/23. After this date, Instead of Search By Identity Number and Search By Passport Number Methods, a single API method will be used: Search By Document Number.

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
passportNo	String	Yes	Passport Number of entity to scan (Number of characters entered must not be less than 5)
start	int	No	Match results from the database, starting from the offset value (Default Value:0)
limit	int	No	Match results from the database, taking up to this many matches each search (Default Value:20 Max Value:50)
referenceNumber	String	No	Reference Number *(ScanId, unique identifier that created by Sanction Scanner on every scan)
outReferenceNumber	String	No	Out Reference Number is a unique identifier that you assign to this scan to track it and enables you to set Risks and Comments for Screening
countryCodes	String	No	If you send this parameter as "COUNTRY CODES ALPHA-2" with commas, only records containing the countries you sent will be brought. You can access the country codes by clicking the link below; https://www.iban.com/country-codes
searchProfileKey	String	No	If you fill this parameter, it will be scanned according to the search profile you sent. You can access the Search Profile Key by going to the Search Profile page on the panel.
assigneeUserGuid	String	No	If you fill this parameter, the scan will be automatically assigned to the relevant user. You must use the "Get My Organization Users" method to obtain users' Guids.

*Reference Number field will be generated by our system. You have to send this field as empty for first searching, after we will return you can use it for pagination.

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
TotalRecordCount	int	Total count of unique records matching the search result
ReturnRecordCount	int	Count of unique records that match within the limit in the search result
TotalProfileCount	int	Total count of matching profiles in search result
Start	int	Match results from the database, starting from the offset value
Limit	int	Match results from the database, taking up to this many matches each search
ReferenceNumber	int	Reference Number *(ScanId, unique identifier that created by Sanction Scanner on every scan)
OutReferenceNumber	String	Out Reference Number is a unique identifier that you assign to this scan to track it and enables you to set Risks and Comments for Screening
NameSearchType	String	Search Type (Ex: Individual, Organization, Vessel etc.)
MinMatchRate	int	Minimum Match Rate parameter of scan
MaxMatchRate	int	Maximum Match Rate parameter of scan
BirthYear	int	Birth Year parameter of scan
IsSafeList	Booelan	If the result is true, the scanned value is in the safe list
IsZFS	Booelan	If the result is true, scan details will not be logged or saved
NationalyFilter	String	Country Code parameter of scan
MatchStatusId	int	Match Status Id of scan 0:Unknown 1:No Match 2:Potential Match 3:False Positive 4:True Positive 5:True Positive Approve 6:True Positive Reject
RiskLevelId	int	Risk Level Id of scan 0:Unknown 1:Low 2:Medium 3:High 4:Neutral 5:Increased 6:Unacceptable
AssignedUserGuidId	string	Assigned User Guid Id of scan *(You can find the details of the relevant user using the api described at Get My Organization Users.)
TagList	string array	Tag Guid Id List of scan *(You can find the details of the relevant tag using the api described at Get My Organization Tags.)
IsWhiteList	Booelan	If the result is true, the scanned value is in the whitelist
WhiteListMessage	String	Returns a message if IsWhiteList is true
Result	Result Class	Result Information. The following internal table describes the internal parameters.

Result Class Informations

Parameter Name	Data Type	Description
MatchRate	Double	The rate at which the result matches the scan term
IsMatchAka	Boolean	Is the match obtained from aka
FirstName	String	Name of scanned entity
MiddleName	String	Middle Name of scanned entity
LastName	String	Surname of scanned entity
FullName	String	Full Name of scanned entity
EntityType	String	Entity Type (Individual, Corporate, Vessel, Aircraft, Country)
Type	String	Type of list (Sanction, Wanted, Watchlist, PEP, SIP, Local, RCA)
BlacklistName	String	Blacklist Name (Us OFAC List, Interpol Wanted List Etc.)
RegisteredNumber	String	Registered Number for entities
ProgramKey	String	Program Key
ProgramName	String	The crime scope that caused the questioned person to be listed
Origin	String	Origin Information
SanctionSet	String	Sanction Set Information
Nationality	String	Nationality of scanned entity
Title	String	Title of scanned entity
HonoricPrefix	String	Honoric Prefix of scanned entity
HonoricSuffix	String	Honoric Suffix of scanned entity
ContactDetails	String	Contact Details of scanned entity
Email	String	Email of scanned entity
ListedOn	String	List entry date of scanned entity
OtherInformation	String	Other Information about scanned entity
MatchedListId	Integer	The list information that the query matches is given below the document.
Position	String	Position of scanned entity
LastUpdateDate	String	Last Update Date to record
CountryCode	String	Country Code
Country	String	Country information
Address	String	Address information
PassportDetails	String	Scanned entity’s Passport Details
Language	String	Language information
BirthDate	String	Scanned entity’s Birth Date
DeathDate	String	Scanned entity’s Death Date
CitizenDetail	String	Scanned entity’s Citizen Details
AddressDetail	String	Scanned entity’s Address Details
Function	String	Scanned entity’s Function information
Gender	String	Scanned entity’s Gender information
Remark	String	Remark information
FirstSeen	String	First Seen
LastSeen	String	Last Seen information
Summary	String	Summary information
FatherName	String	Father Name information
Committees	String	Committees information
Basis	String	Basis information
RecordUniqueNumber	String	Record Unique Number information
Designation	String	Designation information
SubmittedBy	String	Submitted By information
Justification	String	Justification information
DataSource	String	DataSource information
ListingInformation	String	Listing information
VesselCallSign	String	Vessel Call Sign
VesselType	String	Vessel Type
VesselFlag	String	Vessel Flag
VesselTonnage	String	Vessel Tonnage
VesselGrossRegisteredTonnage	String	Vessel Gross Registered Tonnage
VesselOwner	String	Vessel Owner
BlacklistFlagCode	String	Blacklist Flag Code
ProfileKey	String	If the names on different lists have the same person, entity or organization as a result of the search, they will have the same "ProfileKey" value.
PepClass	String	Pep Class Detail
PepClassId	Integer	1 (PEP Class 1): People with titles such as Heads of Government, Heads of State, Kings, Cabinet Members, Ministers, Members of Parliament, Deputies, Military Force Commanders, Supreme Court Presidents, Heads Of Law Enforcement Force, Party Presidents and Court Presidents are included in this class. 2 (PEP Class 2): People with titles such as High Ranking Soldiers, Governors, Religious and Spiritual Leaders, Ambassadors, Consuls, Members of High Court Delegations, and Under Secretaries are included in this class. 3 (PEP Class 3): People with titles such as Mayors and Managers of Public Institutions or Public Affiliated Organizations or Deputy Head of Mission are included in this class. 4 (PEP Class 4): People who have a relative close association with people who are in the category of politically exposed persons are included in this class. 6 (Special Interest Persons (SIP)): Special Interest Persons are individuals that present a heightened level of risk due to their suspected or confirmed involvement in criminal activity.
ssid	String	Unique Id of this data
OtherNames	OtherNames Class	OtherNames information. The following internal table describes the internal parameters.
Documents	Documents Class	Documents information. The following internal table describes the internal parameters.
BirthDetails	BirthDetails Class	BirthDetails information. The following internal table describes the internal parameters.
AddressDetails	AddressDetails Class	AddressDetails information. The following internal table describes the internal parameters.
Images	Images Class	Images Information. The following internal table describes the internal parameters.
Links	Links Class	Links information. The following internal table describes the internal parameters.
Modifications	Modifications Class	Modifications information. The following internal table describes the internal parameters.
MembershipData	MembershipData Class	MembershipData information. The following internal table describes the internal parameters.
MediaData	MediaData Class	MediaData information. The following internal table describes the internal parameters.

OtherNames Class Informations

Parameter Name	Data Type	Description
NameType	String	Name Type (AKA or Original Script etc.)
FullName	String	FullName of scanned entity
Language	String	Language of scanned entity Name
OtherInformation	String	Extra information
Quality	String	Quality of name

Documents Class Informations

Parameter Name	Data Type	Description
DocumentType	String	Document Type information
DocumentTypeInformation	String	Document Type extra information
DocumentNumber	String	Document Number
DocumentCountry	String	Country of Document
DocumentCity	String	City of Document
IssueDate	String	Issue Date of Document
ExpirationDate	String	Expiration Date of Document
OtherInformation	String	Extra Information

BirthDetails Class Informations

Parameter Name	Data Type	Description
BirthDate	String	Birth Date
BirthPlace	String	Birth Place
Birth Country	String	Birth Country
OtherInformation	String	Extra Information

AddressDetails Class Informations

Parameter Name	Data Type	Description
Number	String	Number
Street	String	Street
State	String	State
ZipCode	String	ZipCode
City	String	City
Country	String	Country
IsoCode	String	Country Iso Code
OtherInformation	String	Extra Information

Images Class Informations

Parameter Name	Data Type	Description
DataSource	String	Data Source
Link	String	Link of Image
OtherInformation	String	Extra Information

Links Class Informations

Parameter Name	Data Type	Description
DataSource	String	Data Source
Link	String	External Link
OtherInformation	String	Extra Information

Modifications Class Informations

Parameter Name	Data Type	Description
ProcessName	String	Process Name
Modification Type	String	Modification Type
EnactmentDate	String	Enactment Date
PublicationDate	String	Publication Date
EffectiveDate	String	Effective Date
OtherInformation	String	Extra Information

MembershipData Class Informations

Parameter Name	Data Type	Description
ConstituencyArea	String	Constituency Area Information
EventClassification	String	Event Classification Information
EventName	String	Event Name
EventStartDate	String	Event Start Date
EventEndDate	String	Event End Date
EventOrganizationName	String	Event Organization Name
PartyClassification	String	Party Classification Information
PartyShortName	String	Party Short Name
PartyName	String	Party Name
PartyImage	String	Party Image
PartyWebsite	String	Party Web site
PartySrgb	String	Party Srgb
OrganizationClassification	String	Organization Classification Information
OrganizationId	String	Organization Identity Number
OrganizationName	String	Organization Name
OrganizationImage	String	Organization Image
OrganizationWebsite	String	Organization Web site
OrganizationSrgb	String	Organization Srgb
Role	String	Role
Sources	String	Sources Informations

MediaData Class Informations

Parameter Name	Data Type	Description
Id	Integer	Id Of Media
Link	String	Link of Media
Title	String	Title Of Media

https://api.sanctionscanner.com/api/Search/SearchByPassportNo?passportNo=PassportNo

In the link above, a call must be made using the passport number of the person to be queried instead of the field that is in the “PassportNo” field.

Sample Service Response Codes

 
                                          
    
                                   
//Response
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": {
    "TotalRecordCount": 10,
    "ReturnRecordCount": 1,
    "TotalProfileCount": 1,
    "Start": 0,
    "Limit": 50,
    "ReferenceNumber": "D******",
    "OutReferenceNumber": "",
    "MatchStatus": "",
    "RiskLevel": "",
    "IsWhiteList": false,
    "WhiteListMessage": "",
    "MatchStatusId": 2,
    "RiskLevelId": 0,
    "AssignedUserGuidId": null,
    "TagList": [],
    "NameSearchType": "*******",
    "MinMatchRate": 50,
    "MaxMatchRate": 50,
    "BirthYear": 1999,
    "IsSafeList": false,
    "NationalyFilter": "tr,de,us",
    "IsZFS": false,
    "Result": [
        {
        "MatchRate": "****",
        "IsMatchAka": "****",
        "FirstName": "****",
        "MiddleName": "****",
        "LastName": "****",
        "FullName": "****",
        "Nationality": "****",
        "ListedOn": "****",
        "LastUpdateDate": "****",
        "ProgramKey": "****",
        "ProgramName": "****",
        "Position": "****",
        "Country": "****",
        "SanctionSet": "****",
        "Origin": "****",
        "Title": "****",
        "Gender": "****",
        "Function": "****",
        "Language": "****",
        "CitizenDetail": "****",
        "CountryCode": "****",
        "HonoricPrefix": "****",
        "HonoricSuffix": "****",
        "ContactDetails": "****",
        "Email": "****",
        "BirthDate": "****",
        "DeathDate": "****",
        "EntityType": "****",
        "Type": "****",
        "Remark": "****",
        "FirstSeen": "****",
        "LastSeen": "****",
        "Summary": "****",
        "FatherName": "****",
        "Committees": "****",
        "OtherInformation": "****",
        "Basis": "****",
        "BlackListTypeId": "****",
        "RecordUniqueNumber": "****",
        "Designation": "****",
        "SubmittedBy": "****",
        "Justification": "****",
        "DataSource": "****",
        "ListingInformation": "****",
        "BlacklistName": "****",
        "BlacklistFlagCode": "****",
        "VesselCallSign": "****",
        "VesselType": "****",
        "VesselFlag": "****",
        "VesselTonnage": "****",
        "VesselGrossRegisteredTonnage": "****",
        "VesselOwner": "****",
        "RegisteredNumber": "******",
        "ProfileKey": "******",
        "PepClass": "******",
        "ssid": "******",
        "PepClassId": "******",
        "OtherNames": [
        {
        "NameType": "****",
        "FullName": "****",
        "Language": "****",
        "OtherInformation": "****",
        "Quality": "****"
        }
              ],
    "Documents": [
        {
        "DocumentType": "****",
        "DocumentTypeInformation": "****",
        "DocumentNumber": "****",
        "DocumentCountry": "****",
        "DocumentCity": "****",
        "IssueDate": "****",
        "ExpirationDate": "****",
        "OtherInformation": "****"
        }
                ],
    "BirthDetails": [
        {
        "BirthDate": "****",
        "BirthPlace": "****",
        "BirthCountry": "****",
        "OtherInformation": "****"
        }
                   ],
    "AddressDetails": [
        {
        "Number": "****",
        "Street": "****",
        "State": "****",
        "ZipCode": "****",
        "City": "****",
        "Country": "****",
        "IsoCode": "****",
        "OtherInformation": "****"
        }
                      ],
    "Images": [
        {
        "DataSource": "****",
        "Link": "****",
        "OtherInformation": "****"
        }
              ],
    "Links": [
        {
        "DataSource": "****",
        "Link": "****",
        "OtherInformation": "****"
        }
             ],
    "Modifications": [
        {
        "ProcessName": "****",
        "ModificationType": "****",
        "EnactmentDate": "****",
        "PublicationDate": "****",
        "EffectiveDate": "****",
        "OtherInformation": "****"
        }
            ],
    "MemberShipData": [
        {
        "ConstituencyArea": "****",
        "EventClassification": "****",
        "EventName": "****",
        "EventStartDate": "****",
        "EventEndDate": "****",
        "EventOrganizationName": "****",
        "PartyClassification": "****",
        "PartyShortName": "****",
        "PartyName": "****",
        "PartyImage": "****",
        "PartyWebsite": "****",
        "PartySrgb": "****",
        "OrganizationClassification": "****",
        "OrganizationId": "****",
        "OrganizationName": "****",
        "OrganizationImage": "****",
        "OrganizationWebsite": "****",
        "OrganizationSrgb": "****",
        "Role": "****",
        "Sources": "****"
        }
                     ],
            "MediaData": [
        {
        "Id": "****",
        "Link": "****",
        "Title": "****"
        }
             ]
    }
        ]
    }
}

Sanction Scanner Search By Document Number

Required input informations of SearchByDocumentNumber Restful Service should be prepared in RESTful (JSON) format and sent the following address with GET method.
https://api.sanctionscanner.com/api/Search/SearchByDocumentNumber?documentNumber=documentNumber

This service is used to find out if the identity number (ID number for Individual, Register Number for Corporate, IMO Number for Vessel, Tail Number for Aircraft) or passport number of the person or entity entered is on the national and international search list. The information required to perform the service call is the identity number or passport number of the person or entity to be interrogated. The “GET” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information. The service call should be done as follows;

This service can be used to perform a search for person or entity using local identification numbers and passport numbers.

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
documentNumber	String	Yes	Identity Number Or Passport Number of entity to scan (Number of characters entered must not be less than 5)
searchType	int	No	Only one of the following values can be sent (Default Value: 1); 1:By Identity Number 2:By Passport Number
entityType	int	No	It should be sent when scanning with Identity Number. Only one of the following values can be sent (Default Value: 1); 0:Any 1:Individual 2:Corporate 3:Vessel 4:Aircraft
start	int	No	Match results from the database, starting from the offset value (Default Value:0)
limit	int	No	Match results from the database, taking up to this many matches each search (Default Value:20 Max Value:50)
referenceNumber	String	No	Reference Number *(ScanId, unique identifier that created by Sanction Scanner on every scan)
outReferenceNumber	String	No	Out Reference Number is a unique identifier that you assign to this scan to track it and enables you to set Risks and Comments for Screening
countryCodes	String	No	If you send this parameter as "COUNTRY CODES ALPHA-2" with commas, only records containing the countries you sent will be brought. You can access the country codes by clicking the link below; https://www.iban.com/country-codes
searchProfileKey	String	No	If you fill this parameter, it will be scanned according to the search profile you sent. You can access the Search Profile Key by going to the Search Profile page on the panel.
assigneeUserGuid	String	No	If you fill this parameter, the scan will be automatically assigned to the relevant user. You must use the "Get My Organization Users" method to obtain users' Guids.

*Reference Number field will be generated by our system. You have to send this field as empty for first searching, after we will return you can use it for pagination.

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
TotalRecordCount	int	Total count of unique records matching the search result
ReturnRecordCount	int	Count of unique records that match within the limit in the search result
TotalProfileCount	int	Total count of matching profiles in search result
Start	int	Match results from the database, starting from the offset value
Limit	int	Match results from the database, taking up to this many matches each search
ReferenceNumber	int	Reference Number *(ScanId, unique identifier that created by Sanction Scanner on every scan)
OutReferenceNumber	String	Out Reference Number is a unique identifier that you assign to this scan to track it and enables you to set Risks and Comments for Screening
NameSearchType	String	Search Type (Ex: Individual, Organization, Vessel etc.)
MinMatchRate	int	Minimum Match Rate parameter of scan
MaxMatchRate	int	Maximum Match Rate parameter of scan
BirthYear	int	Birth Year parameter of scan
IsSafeList	Booelan	If the result is true, the scanned value is in the safe list
IsZFS	Booelan	If the result is true, scan details will not be logged or saved
NationalyFilter	String	Country Code parameter of scan
MatchStatusId	int	Match Status Id of scan 0:Unknown 1:No Match 2:Potential Match 3:False Positive 4:True Positive 5:True Positive Approve 6:True Positive Reject
RiskLevelId	int	Risk Level Id of scan 0:Unknown 1:Low 2:Medium 3:High 4:Neutral 5:Increased 6:Unacceptable
AssignedUserGuidId	string	Assigned User Guid Id of scan *(You can find the details of the relevant user using the api described at Get My Organization Users.)
TagList	string array	Tag Guid Id List of scan *(You can find the details of the relevant tag using the api described at Get My Organization Tags.)
IsWhiteList	Booelan	If the result is true, the scanned value is in the whitelist
WhiteListMessage	String	Returns a message if IsWhiteList is true
Result	Result Class	Result Information. The following internal table describes the internal parameters.

Result Class Informations

Parameter Name	Data Type	Description
MatchRate	Double	The rate at which the result matches the scan term
IsMatchAka	Boolean	Is the match obtained from aka
FirstName	String	Name of scanned entity
MiddleName	String	Middle Name of scanned entity
LastName	String	Surname of scanned entity
FullName	String	Full Name of scanned entity
EntityType	String	Entity Type (Individual, Corporate, Vessel, Aircraft, Country)
Type	String	Type of list (Sanction, Wanted, Watchlist, PEP, SIP, Local, RCA)
BlacklistName	String	Blacklist Name (Us OFAC List, Interpol Wanted List Etc.)
RegisteredNumber	String	Registered Number for entities
ProgramKey	String	Program Key
ProgramName	String	The crime scope that caused the questioned person to be listed
Origin	String	Origin Information
SanctionSet	String	Sanction Set Information
Nationality	String	Nationality of scanned entity
Title	String	Title of scanned entity
HonoricPrefix	String	Honoric Prefix of scanned entity
HonoricSuffix	String	Honoric Suffix of scanned entity
ContactDetails	String	Contact Details of scanned entity
Email	String	Email of scanned entity
ListedOn	String	List entry date of scanned entity
OtherInformation	String	Other Information about scanned entity
MatchedListId	Integer	The list information that the query matches is given below the document.
Position	String	Position of scanned entity
LastUpdateDate	String	Last Update Date to record
CountryCode	String	Country Code
Country	String	Country information
Address	String	Address information
PassportDetails	String	Scanned entity’s Passport Details
Language	String	Language information
BirthDate	String	Scanned entity’s Birth Date
DeathDate	String	Scanned entity’s Death Date
CitizenDetail	String	Scanned entity’s Citizen Details
AddressDetail	String	Scanned entity’s Address Details
Function	String	Scanned entity’s Function information
Gender	String	Scanned entity’s Gender information
Remark	String	Remark information
FirstSeen	String	First Seen
LastSeen	String	Last Seen information
Summary	String	Summary information
FatherName	String	Father Name information
Committees	String	Committees information
Basis	String	Basis information
RecordUniqueNumber	String	Record Unique Number information
Designation	String	Designation information
SubmittedBy	String	Submitted By information
Justification	String	Justification information
DataSource	String	DataSource information
ListingInformation	String	Listing information
VesselCallSign	String	Vessel Call Sign
VesselType	String	Vessel Type
VesselFlag	String	Vessel Flag
VesselTonnage	String	Vessel Tonnage
VesselGrossRegisteredTonnage	String	Vessel Gross Registered Tonnage
VesselOwner	String	Vessel Owner
BlacklistFlagCode	String	Blacklist Flag Code
ProfileKey	String	If the names on different lists have the same person ,entity or organization as a result of the search, they will have the same "ProfileKey" value.
PepClass	String	Pep Class Detail
PepClassId	Integer	1 (PEP Class 1): People with titles such as Heads of Government, Heads of State, Kings, Cabinet Members, Ministers, Members of Parliament, Deputies, Military Force Commanders, Supreme Court Presidents, Heads Of Law Enforcement Force, Party Presidents and Court Presidents are included in this class. 2 (PEP Class 2): People with titles such as High Ranking Soldiers, Governors, Religious and Spiritual Leaders, Ambassadors, Consuls, Members of High Court Delegations, and Under Secretaries are included in this class. 3 (PEP Class 3): People with titles such as Mayors and Managers of Public Institutions or Public Affiliated Organizations or Deputy Head of Mission are included in this class. 4 (PEP Class 4): People who have a relative close association with people who are in the category of politically exposed persons are included in this class. 6 (Special Interest Persons (SIP)): Special Interest Persons are individuals that present a heightened level of risk due to their suspected or confirmed involvement in criminal activity.
ssid	String	Unique Id of this data
OtherNames	OtherNames Class	OtherNames information. The following internal table describes the internal parameters.
Documents	Documents Class	Documents information. The following internal table describes the internal parameters.
BirthDetails	BirthDetails Class	BirthDetails information. The following internal table describes the internal parameters.
AddressDetails	AddressDetails Class	AddressDetails information. The following internal table describes the internal parameters.
Images	Images Class	Images Information. The following internal table describes the internal parameters.
Links	Links Class	Links information. The following internal table describes the internal parameters.
Modifications	Modifications Class	Modifications information. The following internal table describes the internal parameters.
MembershipData	MembershipData Class	MembershipData information. The following internal table describes the internal parameters.
MediaData	MediaData Class	MediaData information. The following internal table describes the internal parameters.

OtherNames Class Informations

Parameter Name	Data Type	Description
NameType	String	Name Type (AKA or Original Script etc.)
FullName	String	FullName of scanned entity
Language	String	Language of scanned entity Name
OtherInformation	String	Extra information
Quality	String	Quality of name

Documents Class Informations

Parameter Name	Data Type	Description
DocumentType	String	Document Type information
DocumentTypeInformation	String	Document Type extra information
DocumentNumber	String	Document Number
DocumentCountry	String	Country of Document
DocumentCity	String	City of Document
IssueDate	String	Issue Date of Document
ExpirationDate	String	Expiration Date of Document
OtherInformation	String	Extra Information

BirthDetails Class Informations

Parameter Name	Data Type	Description
BirthDate	String	Birth Date
BirthPlace	String	Birth Place
Birth Country	String	Birth Country
OtherInformation	String	Extra Information

AddressDetails Class Informations

Parameter Name	Data Type	Description
Number	String	Number
Street	String	Street
State	String	State
ZipCode	String	ZipCode
City	String	City
Country	String	Country
IsoCode	String	Country Iso Code
OtherInformation	String	Extra Information

Images Class Informations

Parameter Name	Data Type	Description
DataSource	String	Data Source
Link	String	Link of Image
OtherInformation	String	Extra Information

Links Class Informations

Parameter Name	Data Type	Description
DataSource	String	Data Source
Link	String	External Link
OtherInformation	String	Extra Information

Modifications Class Informations

Parameter Name	Data Type	Description
ProcessName	String	Process Name
Modification Type	String	Modification Type
EnactmentDate	String	Enactment Date
PublicationDate	String	Publication Date
EffectiveDate	String	Effective Date
OtherInformation	String	Extra Information

MembershipData Class Informations

Parameter Name	Data Type	Description
ConstituencyArea	String	Constituency Area Information
EventClassification	String	Event Classification Information
EventName	String	Event Name
EventStartDate	String	Event Start Date
EventEndDate	String	Event End Date
EventOrganizationName	String	Event Organization Name
PartyClassification	String	Party Classification Information
PartyShortName	String	Party Short Name
PartyName	String	Party Name
PartyImage	String	Party Image
PartyWebsite	String	Party Web site
PartySrgb	String	Party Srgb
OrganizationClassification	String	Organization Classification Information
OrganizationId	String	Organization Identity Number
OrganizationName	String	Organization Name
OrganizationImage	String	Organization Image
OrganizationWebsite	String	Organization Web site
OrganizationSrgb	String	Organization Srgb
Role	String	Role
Sources	String	Sources Informations

MediaData Class Informations

Parameter Name	Data Type	Description
Id	Integer	Id Of Media
Link	String	Link of Media
Title	String	Title Of Media

https://api.sanctionscanner.com/api/Search/SearchByIdentity?id=Id

In the link above, a call must be made using the identity number of the person to be queried instead of the field that is in the “Id” field.

Sample Service Response Codes

 
                                          
    
                                   
//Response
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": {
    "TotalRecordCount": 10,
    "ReturnRecordCount": 1,
    "TotalProfileCount": 1,
    "Start": 0,
    "Limit": 50,
    "ReferenceNumber": "D******",
    "OutReferenceNumber": "",
    "MatchStatus": "",
    "RiskLevel": "",
    "IsWhiteList": false,
    "WhiteListMessage": "",
    "MatchStatusId": 2,
    "RiskLevelId": 0,
    "AssignedUserGuidId": null,
    "TagList": [],
    "NameSearchType": "*******",
    "MinMatchRate": 50,
    "MaxMatchRate": 50,
    "BirthYear": 1999,
    "IsSafeList": false,
    "NationalyFilter": "tr,de,us",
    "IsZFS": false,
    "Result": [
        {
        "MatchRate": "****",
        "IsMatchAka": "****",
        "FirstName": "****",
        "MiddleName": "****",
        "LastName": "****",
        "FullName": "****",
        "Nationality": "****",
        "ListedOn": "****",
        "LastUpdateDate": "****",
        "ProgramKey": "****",
        "ProgramName": "****",
        "Position": "****",
        "Country": "****",
        "SanctionSet": "****",
        "Origin": "****",
        "Title": "****",
        "Gender": "****",
        "Function": "****",
        "Language": "****",
        "CitizenDetail": "****",
        "CountryCode": "****",
        "HonoricPrefix": "****",
        "HonoricSuffix": "****",
        "ContactDetails": "****",
        "Email": "****",
        "BirthDate": "****",
        "DeathDate": "****",
        "EntityType": "****",
        "Type": "****",
        "Remark": "****",
        "FirstSeen": "****",
        "LastSeen": "****",
        "Summary": "****",
        "FatherName": "****",
        "Committees": "****",
        "OtherInformation": "****",
        "Basis": "****",
        "BlackListTypeId": "****",
        "RecordUniqueNumber": "****",
        "Designation": "****",
        "SubmittedBy": "****",
        "Justification": "****",
        "DataSource": "****",
        "ListingInformation": "****",
        "BlacklistName": "****",
        "BlacklistFlagCode": "****",
        "VesselCallSign": "****",
        "VesselType": "****",
        "VesselFlag": "****",
        "VesselTonnage": "****",
        "VesselGrossRegisteredTonnage": "****",
        "VesselOwner": "****",
        "RegisteredNumber": "******",
        "ProfileKey": "******",
        "PepClass": "******",
        "ssid": "******",
        "PepClassId": "******",
        "OtherNames": [
        {
        "NameType": "****",
        "FullName": "****",
        "Language": "****",
        "OtherInformation": "****",
        "Quality": "****"
        }
              ],
    "Documents": [
        {
        "DocumentType": "****",
        "DocumentTypeInformation": "****",
        "DocumentNumber": "****",
        "DocumentCountry": "****",
        "DocumentCity": "****",
        "IssueDate": "****",
        "ExpirationDate": "****",
        "OtherInformation": "****"
        }
                ],
    "BirthDetails": [
        {
        "BirthDate": "****",
        "BirthPlace": "****",
        "BirthCountry": "****",
        "OtherInformation": "****"
        }
                   ],
    "AddressDetails": [
        {
        "Number": "****",
        "Street": "****",
        "State": "****",
        "ZipCode": "****",
        "City": "****",
        "Country": "****",
        "IsoCode": "****",
        "OtherInformation": "****"
        }
                      ],
    "Images": [
        {
        "DataSource": "****",
        "Link": "****",
        "OtherInformation": "****"
        }
              ],
    "Links": [
        {
        "DataSource": "****",
        "Link": "****",
        "OtherInformation": "****"
        }
             ],
    "Modifications": [
        {
        "ProcessName": "****",
        "ModificationType": "****",
        "EnactmentDate": "****",
        "PublicationDate": "****",
        "EffectiveDate": "****",
        "OtherInformation": "****"
        }
            ],
    "MemberShipData": [
        {
        "ConstituencyArea": "****",
        "EventClassification": "****",
        "EventName": "****",
        "EventStartDate": "****",
        "EventEndDate": "****",
        "EventOrganizationName": "****",
        "PartyClassification": "****",
        "PartyShortName": "****",
        "PartyName": "****",
        "PartyImage": "****",
        "PartyWebsite": "****",
        "PartySrgb": "****",
        "OrganizationClassification": "****",
        "OrganizationId": "****",
        "OrganizationName": "****",
        "OrganizationImage": "****",
        "OrganizationWebsite": "****",
        "OrganizationSrgb": "****",
        "Role": "****",
        "Sources": "****"
        }
                     ],
            "MediaData": [
        {
        "Id": "****",
        "Link": "****",
        "Title": "****"
        }
             ]
    }
        ]
    }
}

Multiple Search

Required input informations of Multiple Search Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.
https://api.sanctionscanner.com/api/Search/MultipleSearch

This service allows you to make bulk searches.The “POST” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information. The service call should be done as follows;

This service allows you to make multiple searches same time. You can perform multiple searches same time via API using this service. You can make up to five searches at a time.

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
SearchType	Integer	Yes	One of the following values must be sent; 1:By Name 2:By Local Identity Number 3:Passport Number
EntityType	Integer	Yes	One of the following values must be sent. Required only if search type by name; 0:Any 1:Individual 2:Corporate 3:Vessel 4:Aircraft
start	int	No	Match results from the database, starting from the offset value (Default Value:0)
limit	int	No	Match results from the database, taking up to this many matches each search (Default Value:20 Max Value:50)
isDeepSearch	Boolean	No	If you send it as true, the search will take place in the most detailed way. However, the search time will be longer. (Default Value:false)
Searches	Searches Class Array	Yes	Searches Class Information. The following internal table describes the internal parameters.

Searches Class Informations

Parameter Name	Data Type	Requirement	Description
SearchTerm	String	Yes	Search term of entity to scan (Name, Local Id Number or Passport Number)
BirthYear	String	No	Birth Year *(Ex:1970) Avaliable only if search type by name.**
OutReferenceNumber	String	No	Out Reference Number is a unique identifier that you assign to this scan to track it and enables you to set Risks and Comments for Screening.
MinMatchRate	Integer	No	One of the following values must be sent. Required only if search type by name; Minimum Match Rate (Default Value: 80)
MaxMatchRate	Integer	No	Maximum Match Rate (Default Value: 100)
CountryCodes	String	No	If you send this parameter as "COUNTRY CODES ALPHA-2" with commas, only records containing the countries you sent will be brought. You can access the country codes by clicking the link below; https://www.iban.com/country-codes

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
Result	Result Class List	Result Information. The following internal table describes the internal parameters.

Result Class Informations

Parameter Name	Data Type	Description
TotalRecordCount	int	Total count of unique records matching the search result
ReturnRecordCount	int	Count of unique records that match within the limit in the search result
TotalProfileCount	int	Total count of matching profiles in search result
Start	int	Match results from the database, starting from the offset value
Limit	int	Match results from the database, taking up to this many matches each search
ReferenceNumber	int	Reference Number *(ScanId, unique identifier that created by Sanction Scanner on every scan)
OutReferenceNumber	String	Out Reference Number is a unique identifier that you assign to this scan to track it and enables you to set Risks and Comments for Screening
NameSearchType	String	Search Type (Ex: Individual, Organization, Vessel etc.)
MinMatchRate	int	Minimum Match Rate parameter of scan
MaxMatchRate	int	Maximum Match Rate parameter of scan
BirthYear	int	Birth Year parameter of scan
IsSafeList	Booelan	If the result is true, the scanned value is in the safe list
IsZFS	Booelan	If the result is true, scan details will not be logged or saved
NationalyFilter	String	Country Code parameter of scan
MatchStatusId	int	Match Status Id of scan 0:Unknown 1:No Match 2:Potential Match 3:False Positive 4:True Positive 5:True Positive Approve 6:True Positive Reject
RiskLevelId	int	Risk Level Id of scan 0:Unknown 1:Low 2:Medium 3:High 4:Neutral 5:Increased 6:Unacceptable
AssignedUserGuidId	string	Assigned User Guid Id of scan *(You can find the details of the relevant user using the api described at Get My Organization Users.)
TagList	string array	Tag Guid Id List of scan *(You can find the details of the relevant tag using the api described at Get My Organization Tags.)
IsWhiteList	Booelan	If the result is true, the scanned value is in the whitelist
WhiteListMessage	String	Returns a message if IsWhiteList is true
Result	InnerResult Class List	InnerResult Information. The following internal table describes the internal parameters.

InnerResult Class Informations

Parameter Name	Data Type	Description
MatchRate	Double	The rate at which the result matches the scan term
IsMatchAka	Boolean	Is the match obtained from aka
FirstName	String	Name of scanned entity
MiddleName	String	Middle Name of scanned entity
LastName	String	Surname of scanned entity
FullName	String	Full Name of scanned entity
EntityType	String	Entity Type (Individual, Corporate, Vessel, Aircraft, Country)
Type	String	Type of list (Sanction, Wanted, Watchlist, PEP, SIP, Local, RCA)
BlacklistName	String	Blacklist Name (Us OFAC List, Interpol Wanted List Etc.)
RegisteredNumber	String	Registered Number for entities
ProgramKey	String	Program Key
ProgramName	String	The crime scope that caused the questioned person to be listed
Origin	String	Origin Information
SanctionSet	String	Sanction Set Information
Nationality	String	Nationality of scanned entity
Title	String	Title of scanned entity
HonoricPrefix	String	Honoric Prefix of scanned entity
HonoricSuffix	String	Honoric Suffix of scanned entity
ContactDetails	String	Contact Details of scanned entity
Email	String	Email of scanned entity
ListedOn	String	List entry date of scanned entity
OtherInformation	String	Other Information about scanned entity
MatchedListId	Integer	The list information that the query matches is given below the document.
Position	String	Position of scanned entity
LastUpdateDate	String	Last Update Date to record
CountryCode	String	Country Code
Country	String	Country information
Address	String	Address information
PassportDetails	String	Scanned entity’s Passport Details
Language	String	Language information
BirthDate	String	Scanned entity’s Birth Date
DeathDate	String	Scanned entity’s Death Date
CitizenDetail	String	Scanned entity’s Citizen Details
AddressDetail	String	Scanned entity’s Address Details
Function	String	Scanned entity’s Function information
Gender	String	Scanned entity’s Gender information
Remark	String	Remark information
FirstSeen	String	First Seen
LastSeen	String	Last Seen information
Summary	String	Summary information
FatherName	String	Father Name information
Committees	String	Committees information
Basis	String	Basis information
RecordUniqueNumber	String	Record Unique Number information
Designation	String	Designation information
SubmittedBy	String	Submitted By information
Justification	String	Justification information
DataSource	String	DataSource information
ListingInformation	String	Listing information
VesselCallSign	String	Vessel Call Sign
VesselType	String	Vessel Type
VesselFlag	String	Vessel Flag
VesselTonnage	String	Vessel Tonnage
VesselGrossRegisteredTonnage	String	Vessel Gross Registered Tonnage
VesselOwner	String	Vessel Owner
BlacklistFlagCode	String	Blacklist Flag Code
ProfileKey	String	If the names on different lists have the same person, entity or organization as a result of the search, they will have the same "ProfileKey" value.
PepClass	String	Pep Class Detail
PepClassId	Integer	1 (PEP Class 1): People with titles such as Heads of Government, Heads of State, Kings, Cabinet Members, Ministers, Members of Parliament, Deputies, Military Force Commanders, Supreme Court Presidents, Heads Of Law Enforcement Force, Party Presidents and Court Presidents are included in this class. 2 (PEP Class 2): People with titles such as High Ranking Soldiers, Governors, Religious and Spiritual Leaders, Ambassadors, Consuls, Members of High Court Delegations, and Under Secretaries are included in this class. 3 (PEP Class 3): People with titles such as Mayors and Managers of Public Institutions or Public Affiliated Organizations or Deputy Head of Mission are included in this class. 4 (PEP Class 4): People who have a relative close association with people who are in the category of politically exposed persons are included in this class. 6 (Special Interest Persons (SIP)): Special Interest Persons are individuals that present a heightened level of risk due to their suspected or confirmed involvement in criminal activity.
ssid	String	Unique Id of this data
OtherNames	OtherNames Class	OtherNames information. The following internal table describes the internal parameters.
Documents	Documents Class	Documents information. The following internal table describes the internal parameters.
BirthDetails	BirthDetails Class	BirthDetails information. The following internal table describes the internal parameters.
AddressDetails	AddressDetails Class	AddressDetails information. The following internal table describes the internal parameters.
Images	Images Class	Images Information. The following internal table describes the internal parameters.
Links	Links Class	Links information. The following internal table describes the internal parameters.
Modifications	Modifications Class	Modifications information. The following internal table describes the internal parameters.
MembershipData	MembershipData Class	MembershipData information. The following internal table describes the internal parameters.
MediaData	MediaData Class	MediaData information. The following internal table describes the internal parameters.

OtherNames Class Informations

Parameter Name	Data Type	Description
NameType	String	Name Type (AKA or Original Script etc.)
FullName	String	FullName of scanned entity
Language	String	Language of scanned entity Name
OtherInformation	String	Extra information
Quality	String	Quality of name

Documents Class Informations

Parameter Name	Data Type	Description
DocumentType	String	Document Type information
DocumentTypeInformation	String	Document Type extra information
DocumentNumber	String	Document Number
DocumentCountry	String	Country of Document
DocumentCity	String	City of Document
IssueDate	String	Issue Date of Document
ExpirationDate	String	Expiration Date of Document
OtherInformation	String	Extra Information

BirthDetails Class Informations

Parameter Name	Data Type	Description
BirthDate	String	Birth Date
BirthPlace	String	Birth Place
Birth Country	String	Birth Country
OtherInformation	String	Extra Information

AddressDetails Class Informations

Parameter Name	Data Type	Description
Number	String	Number
Street	String	Street
State	String	State
ZipCode	String	ZipCode
City	String	City
Country	String	Country
IsoCode	String	Country Iso Code
OtherInformation	String	Extra Information

Images Class Informations

Parameter Name	Data Type	Description
DataSource	String	Data Source
Link	String	Link of Image
OtherInformation	String	Extra Information

Links Class Informations

Parameter Name	Data Type	Description
DataSource	String	Data Source
Link	String	External Link
OtherInformation	String	Extra Information

Modifications Class Informations

Parameter Name	Data Type	Description
ProcessName	String	Process Name
Modification Type	String	Modification Type
EnactmentDate	String	Enactment Date
PublicationDate	String	Publication Date
EffectiveDate	String	Effective Date
OtherInformation	String	Extra Information

MembershipData Class Informations

Parameter Name	Data Type	Description
ConstituencyArea	String	Constituency Area Information
EventClassification	String	Event Classification Information
EventName	String	Event Name
EventStartDate	String	Event Start Date
EventEndDate	String	Event End Date
EventOrganizationName	String	Event Organization Name
PartyClassification	String	Party Classification Information
PartyShortName	String	Party Short Name
PartyName	String	Party Name
PartyImage	String	Party Image
PartyWebsite	String	Party Web site
PartySrgb	String	Party Srgb
OrganizationClassification	String	Organization Classification Information
OrganizationId	String	Organization Identity Number
OrganizationName	String	Organization Name
OrganizationImage	String	Organization Image
OrganizationWebsite	String	Organization Web site
OrganizationSrgb	String	Organization Srgb
Role	String	Role
Sources	String	Sources Informations

MediaData Class Informations

Parameter Name	Data Type	Description
Id	Integer	Id Of Media
Link	String	Link of Media
Title	String	Title Of Media

https://api.sanctionscanner.com/api/Search/MultipleSearch

In the link above, a call must be made using MultipleSearch.

Sample Service Response Codes

 
                                          
    
                                   
//Response

{
  "HttpStatusCode": 100,
  "IsSuccess": true,
  "ErrorCode": "string",
  "ErrorMessage": "string",
  "ExtraInfo": "string",
  "Result": [
    {
      "TotalRecordCount": 0,
      "ReturnRecordCount": 0,
      "Start": 0,
      "Limit": 0,
      "ReferenceNumber": "string",
      "NameSearchType": "string",
      "OutReferenceNumber": "string",
      "IsWhiteList": true,
      "WhiteListMessage": "string",
      "MinMatchRate": 0,
      "MaxMatchRate": 0,
      "BirthYear": "string",
      "IsSafeList": true,
      "NationalyFilter": "string",
      "IsZFS": true,
      "TotalProfileCount": 0,
      "Result": [
        {
          "MatchRate": 0,
          "IsMatchAka": true,
          "FirstName": "string",
          "MiddleName": "string",
          "LastName": "string",
          "FullName": "string",
          "Nationality": "string",
          "ListedOn": "string",
          "LastUpdateDate": "string",
          "ProgramKey": "string",
          "ProgramName": "string",
          "Position": "string",
          "Country": "string",
          "SanctionSet": "string",
          "Origin": "string",
          "Title": "string",
          "Gender": "string",
          "Function": "string",
          "Language": "string",
          "CitizenDetail": "string",
          "CountryCode": "string",
          "HonoricPrefix": "string",
          "HonoricSuffix": "string",
          "ContactDetails": "string",
          "Email": "string",
          "BirthDate": "string",
          "DeathDate": "string",
          "EntityType": "string",
          "Type": "string",
          "Remark": "string",
          "FirstSeen": "string",
          "LastSeen": "string",
          "Summary": "string",
          "FatherName": "string",
          "Committees": "string",
          "OtherInformation": "string",
          "Basis": "string",
          "BlackListTypeId": "string",
          "RecordUniqueNumber": "string",
          "Designation": "string",
          "SubmittedBy": "string",
          "Justification": "string",
          "DataSource": "string",
          "ListingInformation": "string",
          "BlacklistName": "string",
          "BlacklistFlagCode": "string",
          "VesselCallSign": "string",
          "VesselType": "string",
          "VesselFlag": "string",
          "VesselTonnage": "string",
          "VesselGrossRegisteredTonnage": "string",
          "VesselOwner": "string",
          "RegisteredNumber": "string",
          "ProfileKey": "string",
          "PepClass": "string",
          "ssid": "string",
          "PepClassId": 0,
          "OtherNames": [
            {
              "NameType": "string",
              "FullName": "string",
              "Language": "string",
              "OtherInformation": "string",
              "Quality": "string"
            }
          ],
          "Documents": [
            {
              "DocumentType": "string",
              "DocumentTypeInformation": "string",
              "DocumentNumber": "string",
              "DocumentCountry": "string",
              "DocumentCity": "string",
              "IssueDate": "string",
              "ExpirationDate": "string",
              "OtherInformation": "string"
            }
          ],
          "BirthDetails": [
            {
              "BirthDate": "string",
              "BirthPlace": "string",
              "BirthCountry": "string",
              "OtherInformation": "string"
            }
          ],
          "AddressDetails": [
            {
              "Number": "string",
              "Street": "string",
              "State": "string",
              "ZipCode": "string",
              "City": "string",
              "Country": "string",
              "IsoCode": "string",
              "OtherInformation": "string"
            }
          ],
          "Images": [
            {
              "DataSource": "string",
              "Link": "string",
              "OtherInformation": "string"
            }
          ],
          "Links": [
            {
              "DataSource": "string",
              "Link": "string",
              "OtherInformation": "string"
            }
          ],
          "Modifications": [
            {
              "ProcessName": "string",
              "ModificationType": "string",
              "EnactmentDate": "string",
              "PublicationDate": "string",
              "EffectiveDate": "string",
              "OtherInformation": "string"
            }
          ],
          "MemberShipData": [
            {
              "ConstituencyArea": "string",
              "EventClassification": "string",
              "EventName": "string",
              "EventStartDate": "string",
              "EventEndDate": "string",
              "EventOrganizationName": "string",
              "PartyClassification": "string",
              "PartyShortName": "string",
              "PartyName": "string",
              "PartyImage": "string",
              "PartyWebsite": "string",
              "PartySrgb": "string",
              "OrganizationClassification": "string",
              "OrganizationId": "string",
              "OrganizationName": "string",
              "OrganizationImage": "string",
              "OrganizationWebsite": "string",
              "OrganizationSrgb": "string",
              "Role": "string",
              "Sources": "string"
            }
          ],
          "MediaData": [
            {
              "Id": 0,
              "Link": "string",
              "Title": "string"
            }
          ]
        }
      ],
      "MatchStatusId": 0,
      "RiskLevelId": 0,
      "AssignedUserGuidId": "string",
      "TagList": [
        0
      ]
    }
  ]
}

Batch Search

Required input informations of BatchSearch Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.
https://api.sanctionscanner.com/api/Search/BatchSearch

This service allows you to make batch search. You can perform batch search via api using this service.

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
SearchType	Integer	Yes	One of the following values must be sent; 1:By Name 2:By Local Identity Number 3:Passport Number
EntityType	Integer	Yes	One of the following values must be sent. Required only if search type by name; 0:Any 1:Individual 2:Corporate 3:Vessel 4:Aircraft
MinMatchRate	Integer	No	One of the following values must be sent. Required only if search type by name; Minimum Match Rate (Default Value: 80)
MaxMatchRate	Integer	No	Maximum Match Rate (Default Value: 100)
isDeepSearch	Boolean	No	If you send it as true, the search will take place in the most detailed way. However, the search time will be longer. (Default Value:false)
CountryCodes	String	No	If you send this parameter as "COUNTRY CODES ALPHA-2" with commas, only records containing the countries you sent will be brought. You can access the country codes by clicking the link below; *If the "CountryCodes" value in the Searches sub-class is filled, this value will be invalid for the relevant search. https://www.iban.com/country-codes
Searches	Searches Class Array	Yes	Searches Class Information. The following internal table describes the internal parameters.

Searches Class Informations

Parameter Name	Data Type	Requirement	Description
SearchTerm	String	Yes	Search term of entity to scan (Name, Local Id Number or Passport Number)
OutReferenceNumber	String	No	Out Reference Number is a unique identifier that you assign to this scan to track it and enables you to set Risks and Comments for Screening.
BirthYear	String	No	Birth Year *(Ex:1970) Avaliable only if search type by name.**
CountryCodes	String	No	If you send this parameter as "COUNTRY CODES ALPHA-2" with commas, only records containing the countries you sent will be brought. You can access the country codes by clicking the link below; *If this parameter is filled out, the "CountryCodes" value in the main class will not affect this row. https://www.iban.com/country-codes

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
Result	Result Class	Result Information. The following internal table describes the internal parameters.

Result Class Informations

Parameter Name	Data Type	Description
BatchId	String	Batch Search Id. You can use this data to get Batch Search results.
Message	String	Result Message

https://api.sanctionscanner.com/api/Search/BatchSearch

In the link above, a call must be made using BatchSearch.

Sample Service Response Codes

 



//Response
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": {
        "BatchId": "BS0000000001",
        "Message": "You will be notified by email when the process is complete."
    }
}

Batch Search By File

Required input informations of BatchSearchByFile Restful Service should be prepared in RESTful (JSON) format and sent the following address with POST method.
https://api.sanctionscanner.com/api/Search/BatchSearchByFile

This service allows you to make batch searches. You can perform batch search using web screens via api using this service. You can use this service by downloading the batch search template from the address below.
Download Template

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
SearchType	Integer	Yes	One of the following values must be sent; 1:By Name 2:By Local Identity Number 3:Passport Number
EntityType	Integer	Yes	One of the following values must be sent. Required only if search type by name; 1:Individual 2:Corporate 3:Vessel 4:Aircraft
MinMatchRate	Integer	No	One of the following values must be sent. Required only if search type by name; Minimum Match Rate (Default Value: 80)
MaxMatchRate	Integer	No	Maximum Match Rate (Default Value: 100)
isDeepSearch	Boolean	No	If you send it as true, the search will take place in the most detailed way. However, the search time will be longer. (Default Value:false)
file	File	Yes	Only the template downloaded here should be used.

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
Result	Result Class	Result Information. The following internal table describes the internal parameters.

Result Class Informations

Parameter Name	Data Type	Description
BatchId	String	Batch Search Id. You can use this data to get Batch Search results.
Message	String	Result Message

https://api.sanctionscanner.com/api/Search/BatchSearchByFile

In the link above, a call must be made using BatchSearchByFile.

Sample Service Response Codes

 



//Response
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": {
        "BatchId": "BS0000000001",
        "Message": "You will be notified by email when the process is complete."
    }
}

MRZ Validate

Required input informations of MRZValidate Restful Service should be prepared in RESTful (JSON) format and sent the following address with GET method.
https://api.sanctionscanner.com/api/Search/MRZValidate

This service is used to generate a MRZ. The “GET” method should be used when making a service call. In addition, the “username” and “password” information required for the service should be sent via “header” as “Authorization” information. The service call should be done as follows;

Verification Procedure

Please compare the computed results below with the lines of the Machine Readable Zone on the document at hand. In particular pay attention to check the control digits (coloured orange) in this form for better readability only. Examples;

Passport Number

Check digit for passport numbers are the 10th, 20th, 28th, 43th, 44th numbers on the 2nd line.

Id Card Number (Three Line)

Check digit for Id Card Number (Three Line) are the 15th number on the 1st line, and 7th, 15th, 30th numbers on the 2nd line.

Id Card Number (Two Line)

Check digit for Id Card Number (Two Line) are the 10th, 20th, 28th, 36th numbers on the 2nd line.

MRZ Matches Document

If the machine readable zone does not match, the document at hand may be a forgery and enhanced due diligence should be performed.

Token Informations

Parameter Name	Data Type	Requirement	Description
username	String	Yes	Api Username Info
password	String	Yes	Api Password Info

Input Informations

Parameter Name	Data Type	Requirement	Description
DocumentType	Int	Yes	Only one of the following values can be sent 1:Passport Number 2:Id Card Number (Three Line) 3:Id Card Number (Two Line)
NationalityIsoCode	String	Yes	Nationality Iso Code (Three Letter) You can access the COUNTRY CODES ALPHA-3 by clicking the link below; https://www.iban.com/country-codes
DocumentNumber	String	Yes	Document Number
Surname	String	Yes	Surname
GivenName	String	Yes	Given Name
DateOfBirth	DateTime	Yes	Date Of Birth
Gender	String	Yes	Only one of the following values can be sent M:Male F:Female
IdentificationNumber	String	No	Identification Number
IssueStateIsoCode	String	Yes	Issued State Iso Code (Three Letter)
DateOfExpiration	DateTime	Yes	Date Of Expiration

Output Informations

Parameter Name	Data Type	Description
HttpStatusCode	Int	Transaction Result Code 200: Success 400: Unsuccessful
IsSuccess	Boolean	Transaction Result True: Success False: Unsuccessful
ErrorCode	String	Error Code
ErrorMessage	String	Error Message
ExtraInfo	String	Extra Information
Result	String	Result Message

https://api.sanctionscanner.com/api/Search/MRZValidate

Sample Service Response Codes

 
                                          

//Request GET /api/Search/MRZValidate

//Response
{
"HttpStatusCode": 200,
"IsSuccess": true,
"ErrorCode": null,
"ErrorMessage": null,
"ExtraInfo": null,
"Result": "P<ARGLOPEZ<<LUCIANO<<<<<<<<<<<<<<<<<<<<<<<<<\r\nA26F187340ARG9002236F2406237132469887<<<<<00" 
}