Complete Specifications

Follow

Note: We recommend that you use the latest version of our DPS web services for any new development or when you perform updates to an integration using an older version of our web services. Please review our web services listing to read up on our latest version.

Web Service Overview

Intended Uses

MKDenial has designed this interface into the MKDenial DPL to empower our end users with the ability to screen in real time. Your backend systems can call these routines directly, provided you code on a system that can use web services. Some examples of web service enabled platforms include: .NET (ASP.NET), Java (J2EE, JSP, WebSphere), WebMethodsMacromedia ColdFusion MXDelphiSAPBaaNi2JD EdwardsPeopleSoft, and Oracle.

Technical Details

Use of the MKDenial DPL Web Service requires an account for the website, which must be used to login before calling any methods. There are three methods for logging in:

  1. LoginNoSoapCredentials which requires a Username and Password can be called first, as long as you are using cookies the web service will remember who you are via a session. A boolean response will be returned indicating if the login is successful or not.
  2. Login requires a soap:Header with the Username and Password passed along with the request. A boolean response will be returned indicating if the login is successful or not.
  3. And you may just skip both of the above if you are using the soap:Header method, and pass the Username and Password with each request. You will not receive any indication that you have or have not sucessfully logged in, but in many cases you will receive a null response when the login has failed. One place to be careful with this method is the IsMatch methods. Since they return a boolean, they are unable to return null. This means that if your login fails they will always response false.


After authenticating there are a number of methods that you can call for reporting and other purposes.

When used the SearchTypes indicate what logic to use for a match. The default SearchType is TwoWordMatch.

OneWordMatch
One word is common to your entity and a party on the MK Denied Parties List (MKDPL)
TwoWordMatch
Two words are common between your entity and a party on the MKDPL; or if either has only 1 word, it matches.
ThreeWordMatch
Three words are common between your entity and a party on the MKDPL; or if either has only 2 words, both match; or if either has only 1 word, it matches.
AllWordsMatch
All words in your entity match exactly a word in a party on the MKDPL, or vice versa.
AllWordsSimilar
All words in your entity match a word in a party on the MKDPL, or vice versa. Metaphone is used to determine what words that don't match exactly do sound similar.
Contains
Your entity is a substring of a party on the MKDPL. Not very reliable, provided for backwards compatibility.
StartsWith
Your entity is a substring at the begining of a party on the MKDPL. Not very reliable, provided for backwards compatibility.
EndsWith
Your entity is a substring at the end of a party on the MKDPL. Not very reliable, provided for backwards compatibility.
Is
Your entity is an exact match to a party on the MKDPL. Not very reliable, provided for backwards compatibility.
IsSimilarTo
Your entity is somewhat similar to a party on the MKDPL. Extremely unreliable, provided for backwards compatibility.

MKDenial recommends use of Storm or WebService Studio v2.0 for testing web services and getting a good feel for how our interface works.

Please select the version of our v1.0 offering that you have integrated with:

If you haven't implemented either yet, please consider using our new version 3.0 web service.

Have more questions? Submit a request

Comments

Powered by Zendesk