Sanction Scanner Get Report By Scan Id

This service performs fetching the results of a previous search with scanId. 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. The service call should be done as follows;

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
scanId String Yes

scan Id
Output Informations
Parameter Name Data Type Description
HttpStatusCode Int

Transaction Result Code

200: Success

400: Unsuccess
IsSuccess Boolean

Transaction Result

True: Success

False: Unsuccess
ErrorCode String

Error Code
ErrorMessage String

Error Message
ExtraInfo String

Extra Information
TotalRecordCount int

Total Record Count
ReturnRecordCount int

Return Record Count
Start int

Start Value
Limit int

Limit Value
ReferenceNumber int

Reference Number
OutReferenceNumber int

Out Reference Number
IsWhiteList Booelan

Searched Value Is In White List
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
FirstName String

Name Of Queried Person
MiddleName String

Middle Name Of Queried Person
LastName String

Surname Name Of Queried Person
FullName String

Full Name Of Queried Person
EntityType String

Entity Type
Type String

Type Of List
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 Queried Person
Title String

Title Of Queried Person
HonoricPrefix String

Honoric Prefix Of Queried Person
Honoric Suffix String

Honoric Prefix Of Queried Person
ContactDetails String

Contact Details
Email String

Email
ListedOn String

List entry date
OtherInformation String

Other Information About Queried Person
MatchedListId Integer

The list information that the query matches is given below the document.
Position String

Position Of Queried Person
LastUpdateDate String

Last Update Date To Record
CountryCode String

Country Code
Country String

Country Information
Address String

Address Information
PassportDetails String

Queried Person’s Passport Details
Language String

Language Information
BirthDate String

Queried Person’s Birth Date
DeathDate String

Queried Person’s Death Date
CitizenDetail String

Queried Person’s Citizen Details
AddressDetail String

Queried Person’s Address Details
Function String

Queried Person’s Function Information
Gender String

Queried Person’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
BlacklistName String

Blacklist Name
BlacklistFlagCode String

Blacklist Flag Code
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.
OtherNames Class Informations
Parameter Name Data Type Description
NameType String

Name Type Information
FullName String

FullName Of Queried Person
Language String

Language Of Queried Person Name
OtherInformation String

Extra Informations
Quality String

Quality
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

Document Country
DocumentCity String

Document City
IssueDate String

Issue Date
ExpirationDate String

Expiration Date
OtherInformation String

Extra Informations
BirthDetails Class Informations
Parameter Name Data Type Description
BirthDate String

Birth Date
BirthPlace String

Birth Place
Birth Country String

Birth Country
OtherInformation String

Extra Informations
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

IsoCode
OtherInformation String

Extra Informations
Images Class Informations
Parameter Name Data Type Description
DataSource String

Data Source
Link String

Link
OtherInformation String

Extra Informations
Links Class Informations
Parameter Name Data Type Description
DataSource String

Data Source
Link String

Link
OtherInformation String

Extra Informations
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 Informations
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
https://api.sanctionscanner.com/api/BlackList/GetReportByScanId?scanId=SCANID

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 Request Codes 

 
                                          
                                              

                                              //Response
                                              
{
    "HttpStatusCode": 200,
    "IsSuccess": true,
    "ErrorCode": null,
    "ErrorMessage": null,
    "ExtraInfo": null,
    "Result": {
    "TotalRecordCount": 10,
    "ReturnRecordCount": 1,
    "Start": 0,
    "Limit": 50,
    "ReferenceNumber": "D******",
    "OutReferenceNumber": "",
    "IsWhiteList": false,
    "WhiteListMessage": "",
    "Result": [
        {
        "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": "****",
        "RegisteredNumber": "******",
        "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": "****"
        }
                     ]
    }
        ]
    }
}