WebHooks

SOURCE IP ADDRESSES

POST REQUEST FORMAT
Parameter Name Data Type
Event String
Data Data Class. The Data Class varies for events. You can find detailed explanations in the tables below.

Event: match_status_updated

Token Informations
Parameter Name Data Type Description
Search_ScanId String

ScanId of the affected call

Search_ReferenceNumber String

Reference number of the affected call

Search_MatchStatus String

Match status of the affected call

Search_RiskLevel String

Risk level of the affected call

Search_Tags Array

Tags of the affected call

Sample Response Codes

 

//Response
{
    "Event": "match_status_updated",
    "Data": {
        "Search_ScanId": "******",
        "Search_ReferenceNumber": "******",
        "Search_MatchStatus": "******",
        "Search_RiskLevel": "******",
        "Search_Tags": "******",
    }
}
                    

Event: risk_level_updated

Token Informations
Parameter Name Data Type Description
Search_ScanId String

ScanId of the affected call

Search_ReferenceNumber String

Reference number of the affected call

Search_MatchStatus String

Match status of the affected call

Search_RiskLevel String

Risk level of the affected call

Search_Tags Array

Tags of the affected call

Sample Response Codes

 

//Response
{
    "Event": "risk_level_updated",
    "Data": {
        "Search_ScanId": "******",
        "Search_ReferenceNumber": "******",
        "Search_MatchStatus": "******",
        "Search_RiskLevel": "******",
        "Search_Tags": "******",
    }
}
                    

Event: ongoing_monitoring_updated

Token Informations
Parameter Name Data Type Description
Search_ScanId String

ScanId of the affected call

Search_ReferenceNumber String

Reference number of the affected call

Search_MatchStatus String

Match status of the affected call

Search_RiskLevel String

Risk level of the affected call

Search_Tags Array

Tags of the affected call

MonitoringChanged Integer

Monitoring Changed Data Count

MonitoringResponse MonitoringResponse Class. You can find detailed explanations in the tables below.

Monitoring Data Details

Monitoring Response
Parameter Name Data Type Description
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 Array

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,Corporate,Vessel,Aircraft

EntityType String

Entity Type (Individual,Corporate,Vessel,Aircraft)

Type String

Type Of List (Sanction,PEP)

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

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.

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

Sample Response Codes

 

//Response
{
    "Event": "ongoing_monitoring_updated",
    "Data": {
        "Search_ScanId": "******",
        "Search_ReferenceNumber": "******",
        "Search_MatchStatus": "******",
        "Search_RiskLevel": "******",
        "Search_Tags": "******",
        "MonitoringChanged": "******",
        "MonitoringResponse": {
     "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": "******",
         "ProfileKey": "******",
         "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": "****"
         }
                      ]
     }
         ]
     }
}
    }
}