Denied Party Screening (DPS) SOAP API v4
The DPS API supports real-time/dynamic screening, custom denied parties management and dials to fine tune your screening.
Download WSDL
Table of Contents

Methods | Complex Types | Simple Types

Methods: DPS API v4

Methods
Name  Description 
AddDynamicScreeningListEntry   
ClearMatch   
DelistDynamicScreeningListEntry   
GetAliases   
GetCodeDetails   
GetCountryDetails   
GetDynamicScreeningListEntry   
GetEntry   
GetLogs   
GetUserDetails   
GroupFactory   
IsCountryEmbargoed   
LastUpdate   
LicenseRequired   
SearchDpl   
Up   
UpdateDynamicScreeningListEntry   

Method: AddDynamicScreeningListEntry

Parameters
Name  Type  Direction  Description 
credentials  Credentials  Input   
duplicateHandlingType  DuplicateHandlingType  Input   
Name  string  Input   
Street1  string  Input   
Street2  string  Input   
City  string  Input   
Region  string  Input   
ISO2LetterCountryCode  string  Input   
UserDefinedCode  string  Input   
Notes  string  Input   
clientSuppliedId  int  Input   
Returns

A AddDynamicScreeningListEntryResult element.

Method: ClearMatch

Parameters
Name  Type  Direction  Description 
credentials  Credentials  Input   
idnum  int  Input   
partyName  string  Input   
signature  string  Input   
Returns

A ClearMatchResult element.

Method: DelistDynamicScreeningListEntry

Parameters
Name  Type  Direction  Description 
credentials  Credentials  Input   
id  int  Input   
idIsCustomers  boolean  Input   
Returns

A DelistDynamicScreeningListEntryResult element.

Method: GetAliases

Parameters
Name  Type  Direction  Description 
credentials  Credentials  Input   
IDNUM  int  Input   
Returns

A GetAliasesResult element having the structure defined by the following table.

Name  Type  Description 
Entry  Entry   

Method: GetCodeDetails

Parameters
Name  Type  Direction  Description 
credentials  Credentials  Input   
listCode  string  Input   
Returns

A GetCodeDetailsResult element having the structure defined by the following table.

Name  Type  Description 
Code1  string   
Codename  string   
Country  string   
InsertDate  dateTime   
IsDplcode  boolean   
IsListed  boolean   
IsPremium  boolean   
IssuingAuthority  string   
IssuingAuthorityCode  string   
LastUpdate  dateTime   
ReferenceUrl  string   

Method: GetCountryDetails

Parameters
Name  Type  Direction  Description 
credentials  Credentials  Input   
countryCode  string  Input   
Returns

A GetCountryDetailsResult element having the structure defined by the following table.

Name  Type  Description 
Cntryname  string   
Country1  string   
Isoip  string   

Method: GetDynamicScreeningListEntry

Parameters
Name  Type  Direction  Description 
credentials  Credentials  Input   
id  int  Input   
idIsCustomers  boolean  Input   
Returns

A GetDynamicScreeningListEntryResult element having the structure defined by the following table.

Name  Type  Description 
BeigeList  BeigeList   
BeigeListEntityId  int   
BeigeListId  int   
City  string   
ClientId  int   
Code  string   
Country  string   
CreatedByCustomerNumber  int   
DelistDate  dateTime   
EntryDate  dateTime   
LastUpdate  dateTime   
Name  string   
Notes  string   
Region  string   
Street1  string   
Street2  string   
Wordcount  int   

Method: GetEntry

Parameters
Name  Type  Direction  Description 
credentials  Credentials  Input   
idnum  int  Input   
source  ListSource  Input   
Returns

A GetEntryResult element having the structure defined by the following table.

Name  Type  Description 
City  string   
Code  string   
Country  string   
DelistDate  dateTime   
EndDate  dateTime   
FederalRegisterNotices  ArrayOfFederalRegisterNotice   
IDNUM  int   
LastUpdate  dateTime   
Name  string   
Notes  string   
Source  ListSource   
StartDate  dateTime   
State  string   
Street  string   
Url  string   
WeakAlias  boolean   

Method: GetLogs

Parameters
Name  Type  Direction  Description 
credentials  Credentials  Input   
FromDateTime  dateTime  Input   
ToDateTime  dateTime  Input   
Returns

A GetLogsResult element having the structure defined by the following table.

Name  Type  Description 
Log  Log   

Method: GetUserDetails

Parameters
Name  Type  Direction  Description 
credentials  Credentials  Input   
Returns

A GetUserDetailsResult element having the structure defined by the following table.

Name  Type  Description 
_x003C_Access_x003E_k__BackingField  short   
_x003C_CBS_x003E_k__BackingField  boolean   
_x003C_ChildCount_x003E_k__BackingField  int   
_x003C_CreateDate_x003E_k__BackingField  dateTime   
_x003C_DeactivateDate_x003E_k__BackingField  dateTime   
_x003C_Description_x003E_k__BackingField  string   
_x003C_Downloads_x003E_k__BackingField  boolean   
_x003C_ECCN_x003E_k__BackingField  boolean   
_x003C_Email_x003E_k__BackingField  string   
_x003C_Id_x003E_k__BackingField  int   
_x003C_KeepLog_x003E_k__BackingField  boolean   
_x003C_LastName_x003E_k__BackingField  string   
_x003C_NewSubAccountMask_x003E_k__BackingField  string   
_x003C_RestName_x003E_k__BackingField  string   
_x003C_Shared_x003E_k__BackingField  boolean   
_x003C_Username_x003E_k__BackingField  string   
_x003C_WebServiceAccess_x003E_k__BackingField  boolean   

Method: GroupFactory

Parameters
Name  Type  Direction  Description 
credentials  Credentials  Input   
filterType  GroupFilterType  Input   
argument  string  Input   
Returns

A GroupFactoryResult element having the structure defined by the following table.

Name  Type  Description 
Connect  ConnectType   
Matches  ArrayOfMatch   

Method: IsCountryEmbargoed

Parameters
Name  Type  Direction  Description 
credentials  Credentials  Input   
iso2Letter  string  Input   
Returns

A IsCountryEmbargoedResult element.

Method: LastUpdate

Parameters
Name  Type  Direction  Description 
credentials  Credentials  Input   
Returns

A LastUpdateResult element.

Method: LicenseRequired

Parameters
Name  Type  Direction  Description 
credentials  Credentials  Input   
eccnCode  string  Input   
iso2Country  string  Input   
Returns

A LicenseRequiredResult element having the structure defined by the following table.

Name  Type  Description 
details  string   
required  boolean   

Method: SearchDpl

Parameters
Name  Type  Direction  Description 
credentials  Credentials  Input   
request  Search  Input   
Returns

A SearchDplResult element having the structure defined by the following table.

Name  Type  Description 
Hits  ArrayOfEntry   
MaxHitsSurpassed  boolean   
SearchRequest  Search   

Method: Up

Parameters
Name  Type  Direction  Description 
credentials  Credentials  Input   
Returns

A UpResult element.

Method: UpdateDynamicScreeningListEntry

Parameters
Name  Type  Direction  Description 
credentials  Credentials  Input   
id  int  Input   
idIsCustomers  boolean  Input   
Name  string  Input   
Street1  string  Input   
Street2  string  Input   
City  string  Input   
Region  string  Input   
ISO2LetterCountryCode  string  Input   
UserDefinedCode  string  Input   
Notes  string  Input   
Returns

A UpdateDynamicScreeningListEntryResult element.

Complex Types: DPS API v4

Complex Types
Name  Description 
BeigeListEntity   
Code   
Country   
Credentials   
Entry   
FederalRegisterNotice   
Group   
Log   
Match   
Report   
Search   
User   

Complex Type: BeigeListEntity

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
BeigeList  BeigeList  0..1   
BeigeListEntityId  int  0..1   
BeigeListId  int  0..1   
City  string  0..1   
ClientId  int  0..1   
Code  string  0..1   
Country  string  0..1   
CreatedByCustomerNumber  int  0..1   
DelistDate  dateTime  0..1   
EntryDate  dateTime  0..1   
LastUpdate  dateTime  0..1   
Name  string  0..1   
Notes  string  0..1   
Region  string  0..1   
Street1  string  0..1   
Street2  string  0..1   
Wordcount  int  0..1   

Complex Type: Code

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Code1  string  0..1   
Codename  string  0..1   
Country  string  0..1   
InsertDate  dateTime  0..1   
IsDplcode  boolean  0..1   
IsListed  boolean  0..1   
IsPremium  boolean  0..1   
IssuingAuthority  string  0..1   
IssuingAuthorityCode  string  0..1   
LastUpdate  dateTime  0..1   
ReferenceUrl  string  0..1   

Complex Type: Country

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Cntryname  string  0..1   
Country1  string  0..1   
Isoip  string  0..1   

Complex Type: Credentials

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Username  string  1..1   
Password  string  1..1   

Complex Type: Entry

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
City  string  0..1   
Code  string  0..1   
Country  string  0..1   
DelistDate  dateTime  0..1   
EndDate  dateTime  0..1   
FederalRegisterNotices  ArrayOfFederalRegisterNotice  0..1   
IDNUM  int  0..1   
LastUpdate  dateTime  0..1   
Name  string  0..1   
Notes  string  0..1   
Source  ListSource  0..1   
StartDate  dateTime  0..1   
State  string  0..1   
Street  string  0..1   
Url  string  0..1   
WeakAlias  boolean  0..1   

Complex Type: FederalRegisterNotice

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Date  dateTime  1..1   
Page  int  1..1   
Volume  int  1..1   

Complex Type: Group

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Connect  ConnectType  1..1   
Matches  ArrayOfMatch  0..1   

Complex Type: Log

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
DateTime  dateTime  0..1   
Entry  int  0..1   
Hits  int  0..1   
Reference  string  0..1   
Search  string  0..1   
Username  string  0..1   

Complex Type: Match

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Direction  MatchDirection  1..1   
Field  FieldType  1..1   
Keyword  string  1..1   
Level  int  1..1   
Scope  MatchScope  1..1   
Type  MatchType  1..1   

Complex Type: Report

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
Hits  ArrayOfEntry  0..1   
MaxHitsSurpassed  boolean  0..1   
SearchRequest  Search  0..1   

Complex Type: Search

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
AlwaysIncludeUnknownCountry  boolean  1..1   
Connect  ConnectType  1..1   
ExcludeCommonWords  boolean  1..1   
ExcludeWeakAliases  boolean  0..1   
Groups  ArrayOfGroup  1..1   
IncludeDelistedParties  boolean  0..1   
MaxReturnHits  int  0..1   
Reference  string  0..1   
Skip  int  0..1   
Take  int  0..1   
UnknownCountryBehavior  UnknownCountryBehaviorType  0..1   

Complex Type: User

Derived By

Restricting anyType

Content Model

Contains elements as defined in the following table.

Component  Type  Occurs  Description 
    1..1   
_x003C_Access_x003E_k__BackingField  short  1..1   
_x003C_CBS_x003E_k__BackingField  boolean  1..1   
_x003C_ChildCount_x003E_k__BackingField  int  1..1   
_x003C_CreateDate_x003E_k__BackingField  dateTime  1..1   
_x003C_DeactivateDate_x003E_k__BackingField  dateTime  1..1   
_x003C_Description_x003E_k__BackingField  string  1..1   
_x003C_Downloads_x003E_k__BackingField  boolean  1..1   
_x003C_ECCN_x003E_k__BackingField  boolean  1..1   
_x003C_Email_x003E_k__BackingField  string  1..1   
_x003C_Id_x003E_k__BackingField  int  1..1   
_x003C_KeepLog_x003E_k__BackingField  boolean  1..1   
_x003C_LastName_x003E_k__BackingField  string  1..1   
_x003C_NewSubAccountMask_x003E_k__BackingField  string  1..1   
_x003C_RestName_x003E_k__BackingField  string  1..1   
_x003C_Shared_x003E_k__BackingField  boolean  1..1   
_x003C_Username_x003E_k__BackingField  string  1..1   
_x003C_WebServiceAccess_x003E_k__BackingField  boolean  1..1   

Simple Types: DPS API v4

Simple Types
Name  Description 
ConnectType   
DuplicateHandlingType   
FieldType   
GroupFilterType   
ListSource   
MatchDirection   
MatchScope   
MatchType   
UnknownCountryBehaviorType   

Simple Type: ConnectType

Derived By

Restricting string

Enumeration
Value  Description 
and   
or   

Simple Type: DuplicateHandlingType

Derived By

Restricting string

Enumeration
Value  Description 
Error   
Update   
Allow   

Simple Type: FieldType

Derived By

Restricting string

Enumeration
Value  Description 
Name   
Street   
City   
State   
Country   
Code   
Notes   
IDNUM   

Simple Type: GroupFilterType

Derived By

Restricting string

Enumeration
Value  Description 
RestrictToCodesBySourceCountry   

Simple Type: ListSource

Derived By

Restricting string

Enumeration
Value  Description 
DeniedPartyList   
PremiumList   

Simple Type: MatchDirection

Derived By

Restricting string

Enumeration
Value  Description 
Into   
From   
Both   

Simple Type: MatchScope

Derived By

Restricting string

Enumeration
Value  Description 
Phrase   
Word   

Simple Type: MatchType

Derived By

Restricting string

Enumeration
Value  Description 
Is   
Contains   
IsSimilarTo   

Simple Type: UnknownCountryBehaviorType

Derived By

Restricting string

Enumeration
Value  Description 
Ignore   
ReplaceWithXX   
ThrowError