Fircosoft

17 May 2019

Automated Screening
Manager Web Service v2
Programmer’s Guide
Version 3.7 / May 2019

accuity.com
© 2019 ACCUITY, INC.
All Rights Reserved.
No part of this manual may be reproduced, transmitted, transcribed, stored in a retrieval system, or
translated into any language (natural or computer), in any form or by any means without the prior written
permission of Accuity, Inc.

No part of this manual may be divulged to unlicensed parties without the written consent of Accuity, Inc.

Information in this manual is subject to change without notice and does not represent a commitment on
the part of Accuity. In addition, Accuity may make improvements or changes to this manual and Firco
Compliance Link at any time.

By reading or using this manual, you indicate your acceptance of the foregoing.

Automated Screening Manager Web Service

Programmer’s Guide
Accuity Proprietary and Confidential
Page 2 of 15
Table of Contents
OVERVIEW ................................................................................................................................................... 4
GETTING STARTED .................................................................................................................................... 5
REQUEST AND RESPONSE ....................................................................................................................... 8
Request Elements: .................................................................................................................................... 8
Results Elements:...................................................................................................................................... 9
ERROR RESPONSE .................................................................................................................................. 12
LIST VERSIONS ......................................................................................................................................... 13
Request Elements ................................................................................................................................... 13
Result Elements ...................................................................................................................................... 13
WS-SECURITY ........................................................................................................................................... 15
Request Sample ...................................................................................................................................... 15

Automated Screening Manager Web Service

Programmer’s Guide
Accuity Proprietary and Confidential
Page 3 of 15
OVERVIEW
The Automated Screening Manager Web Service Version 2.0 provides customers with the ability to
integrate screening securely into their applications using standard Web Service calls. The Automated
Screening Manager Web Service v2 is a Java web application that requires a servlet engine or J2EE
application server. The Web Service can be accessed by applications written for any platform and in any
language that supports Web Services.

Note: Version 2.0 of the Automated Screening Manager Web Service includes WS-security. Version 1.0 (non WS-
security version) will no longer be supported after April 30 th, 2019. If you would like access to the version 1.0
installation and programmers guides, please contact [email protected].

Figure 1: System Overview

Automated Screening Manager Web Service

Programmer’s Guide
Accuity Proprietary and Confidential
Page 4 of 15
GETTING STARTED
There are many tools on the market utilized to interact and use the web services. Soap UI is an open
source tool that can be used to test and understand the Automated Screening Manager Web Service.
This section will detail how to install the web service into SOAP UI.

Note: Soup UI is not included with the distribution package. Users can download this tool from the following link:
https://www.soapui.org/downloads/soapui.html

Once the Soap UI is installed on the machine, follow the steps below:

1. Open the application ASM Screening and download service WSDL file.
2. Open a new SOAP project, add the “project name” then “WSDL” and click “OK”.

Figure 1: Soap UI Client Window

Note: It is important to know the WSDL URL of web service. For example: If your Web Service is running on a
server named “Yourserver” on port “xyz”, then the WSDL URL is:
http://Yourserver:xyz/ASMWS/services/v2/ImportScreeningService?wsdl

3. Once the WSDL import has finished, copy the below request sample (section three includes a full
sample request) in the request section auto generated by SoapUI.

Automated Screening Manager Web Service

Programmer’s Guide
Accuity Proprietary and Confidential
Page 5 of 15
 Figure 2: Soap UI Service Screen

4. In the Soap UI Request, populate all required fields highlighted in Figure 3. All request
 ServiceID: This is a Web service Access ID created by an Admin in Compliance Link
system
 ServiceIDPassword: This is the password for Service Access ID used in the request
Note: These credentials need to be set up in the Compliance Link User Interface. Please see
section six below.
 ProfileID: Web Service Profile ID
 RequestID: Customer transaction ID
 ScreeningExpirationDate: Optional – Screening Expiration Date in MM/DD/YYYY format
 FieldName: Field name of the input record field
 FieldValue: Data value of the field
Add any number of fields to the <Field> tag in the request as required by dataset
definition.
 EndpointURL: The yellow highlighted field is the Web Service URL below

5. Hit the Green Arrow to submit the request. Below is a successful response.

Automated Screening Manager Web Service

Programmer’s Guide
Accuity Proprietary and Confidential
Page 6 of 15
 Figure 3: Service request XML Form

The response XML document provides information about the screened information, including information
about the Case ID, Case Status, Import Status, Screening Status, and the match details.

Automated Screening Manager Web Service

Programmer’s Guide
Accuity Proprietary and Confidential
Page 7 of 15
REQUEST AND RESPONSE
The importScreening is a document-centric web service where both the request and response are XML
documents.

Request Elements:
Element – Attribute Data Type Description

This is a Web Service Access ID created by an Admin in

Username Alpha-Numeric
Compliance Link system

Password Alpha-Numeric This is password for Service Access ID used in the request

Request - DatasetGUID Character Unique Dataset Web Service Profile ID

Request – Id Character Customer Transaction ID

Optional – Screening Expiration Date in MM/DD/YYY

Request-ScreeningExpirationDate Character
format

Optional – ASM Logged in user (Used in ASMLookup

UserID Character
Only)

Field – Name Character Field Name

Field Character Data Value of the field

Request Sample:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:asm="http://asm.webservice.autoscreeningmgr.accuity.com/">
<soapenv:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-
1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken-1" xmlns:wsu="http://docs.oasis-
open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:Username>test</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-
profile-1.0#PasswordText">password</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>

<soapenv:Body>
<asm:importScreening>
<requestXML><![CDATA[
<Request DatasetGUID="dccd041f-e0a6-40a8-ad87-dffbb2d6df94" Id="1005"
ScreeningExpirationDate="02/10/2020">
<Field Name="ID">031620151307</Field>
<Field Name="Name">Matthew WinGrove</Field>
<Field Name="Address">2402 W Main Street</Field>
<Field Name="City">Nashville</Field>
<Field Name="State">TN</Field>
<Field Name="Country">US</Field>
</Request>
]]>
</requestXML>
</asm:importScreening>
</soapenv:Body>
</soapenv:Envelope>

Automated Screening Manager Web Service

Programmer’s Guide
Accuity Proprietary and Confidential
Page 8 of 15
Requests must be in the valid XML format specified above. The Automated Screening Manager Web
Service screens only fields that you have selected in the Screening Instructions of that particular dataset
you are trying to invoke.

Results Elements:
Element – Attribute Data Type Description

Results – CaseID Character Case ID of customer input record

Results – CaseStatus Character Case status of customer input record

Results – DatasetGUID Character Dataset Web Service Profile ID

Results – Id Character Customer Transaction id

Results – ImportStatus Character Import Status can be Add/Update/NoChange

IsHit can be Y/N. “Y” indicates that the screened record has matches
Results – IsHit Character
with an “open” or “closed” status

Results – ScreeningStatus Character Screening status can be Success/Error

Results – TotalCWL Character Total number of CWL matches that customer input record matched

Total number of Global WatchList matches that customer input

Results – TotalGWL Character
record matched

Total number of PEPEDD matches that customer input record

Results – Total PEPEDD Character
matched
Results – TotalPrivate Character Total number of Private matches that customer input record matched

Match – MatchStatus Character Status of the match

Match – MatchType Character Type of the match (GWL/CWL/PEPEDD/PWL)

RiskScore of the match. Displays N.A of user screened without

Match – RiskScore Character
scorecard

RuleMatched can be Y/N. “Y” indicated that this match was passed
Match – RuleMatched Character
by a rule
Match – RuleID Character If match is passed by rule then RuleID of the match passed by rule

Entity – Id Character Entity ID

Entity-ENTITY_TEXT_TYPE Character Text Type of Entity. It can be UPID/CWL/GWL format

Entity – Source Character Entity source

Entity – Version Character Entity version information

Entity Character Entity information in Entity XML format

Automated Screening Manager Web Service

Programmer’s Guide
Accuity Proprietary and Confidential
Page 9 of 15
The following is an example of a response:

<Results CaseID="1078" CaseStatus="GWL-Open" DatasetGUID="dccd041f-e0a6-40a8-ad87-

dffbb2d6df94" Id="1018" ImportStatus="NoChange" IsHit="Y" ScreeningStatus="Success"
TotalCWL="0" TotalGWL="3" TotalPEPEDD="71" TotalPrivate="0">
-<Match MatchStatus="Open" MatchType="GWL" RiskScore="N.A." RuleID="" RuleMatched="N">
<Entity ENTITY_TEXT_TYPE="UPID" Id="12068" Source="UST" Version="20130402103408">
ENTITY-XML
</Entity>
</Match>
-<Match MatchStatus="Open" MatchType="GWL" RiskScore="N.A." RuleID="" RuleMatched="N">
<Entity ENTITY_TEXT_TYPE="UPID" Id="2688" Source="TFP" Version="20080415130036">
ENTITY-XML
</Entity>
</Match>
</Results>

To highlight the structure of the XML response, we have replaced the entity XML string with the value
ENTITY-XML above. The actual entity XML fragment for this response is shown below.

<entity id="12068" version="20130402103408">

<name>MATTHEWS, GLENROY VINGROVE</name>
<listId>0</listId> <listCode>OF</listCode>
<entityType>03</entityType>
<createdDate>06/02/2000</createdDate> <lastUpdateDate>03/29/2013</lastUpdateDate>
<source>UST</source>
<OriginalSource>OFAC</OriginalSource>
<dobs>
<dob D="26" M="07" Y="1958">07/26/1958</dob>
</dobs>
<pobs>
<pob>ST. KITTS AND NEVIS</pob>
</pobs>
<aliases>
<alias category="STRONG" type="Alias">MATHEW, GLENROY</alias>
<alias category="STRONG" type="Alias">MATTHEW, GLENROY WINGROVE</alias>
<alias category="STRONG" type="Alias">MATTHEWS, GLEN ROY</alias>
</aliases>
<ids>
<id otherInfo="ST. KITTS AND NEVIS" type="Passport">047815</id>
</ids>
<programs>
<program type="07">SDNTK</program>
</programs>
<sdfs>
<sdf name="OriginalID">6711</sdf>
</sdfs>
<addresses>
<address>
<address1>FRIGATE BAY</address1>
<country>KN</country>
<countryName>SAINT KITTS AND NEVIS</countryName>
</address>
</addresses>
<otherIds>
<childId>12065</childId>
<childId>12066</childId>
<childId>12067</childId>
</otherIds>
</entity>

Automated Screening Manager Web Service

Programmer’s Guide
Accuity Proprietary and Confidential
Page 10 of 15
If the Dataset Screening instructions are configured to use Rule Packs, then results can be somewhat
different. In the example below, the Rule Pack contains the rule that passes the matches when “Entity
Name” contains “MATTHEWS, GLENROY VINGROVE”. This rule causes the related matched to be
passed, and the differences are shown in blue bold.

Response Sample:
<Results CaseID="1078" CaseStatus="GWL-Open" DatasetGUID="dccd041f-e0a6-40a8-ad87-
dffbb2d6df94" Id="1025" ImportStatus="NoChange" IsHit="Y" ScreeningStatus="Success"
TotalCWL="0" TotalGWL="3" TotalPEPEDD="71" TotalPrivate="0">
- <Match MatchStatus="Passed by Rules" MatchType="GWL" RiskScore="N.A." RuleID="1013"
RuleMatched="Y">
<Entity ENTITY_TEXT_TYPE="UPID" Id="12068" Source="UST" Version="20130402103408">
ENTITY-XML
</Entity>
</Match>
-<Match MatchStatus="Open" MatchType="GWL" RiskScore="N.A." RuleID="" RuleMatched="N">
<Entity ENTITY_TEXT_TYPE="UPID" Id="2688" Source="TFP" Version="20080415130036">
ENTITY-XML
</Entity>
</Match>

</Results>

Automated Screening Manager Web Service

Programmer’s Guide
Accuity Proprietary and Confidential
Page 11 of 15
ERROR RESPONSE
In cases when an error condition is detected, the returned response will be an error document. The
format of the error document is shown below, where error_code will be the error code.

<Results success="false">error_code
</Results>

Below are the error codes and the associated error description for each error code.

Error Code Error Desscription

100 Error occurred while processing the request

101 Request was not in expected format

102 Request was rejected due to unknown IP Address

103 Profile associated with DatasetGUID not found

104 Profile associated with inactive Dataset

105 Profile associated with DatasetGUID is not configured correctly

106 Profile associated with inactive Account

107 Profile associated with invalid Dataset

108 [List Name] is not valid

109 Error getting filters for Profile associated with DatasetGUID

110 Invalid field names

111 Error not all fields present

112 Unique ID cannot be empty

113 The Unique ID cannot be longer than 120 characters

114 Field Name cannot be longer than 50 characters

Automated Screening Manager Web Service

Programmer’s Guide
Accuity Proprietary and Confidential
Page 12 of 15
LIST VERSIONS
In addition to the importScreening method, customers can use getListVersions method to get
information about the lists which are loaded in the Automated Screening Manager Web Service. The call
retrieves Watch Lists names and their data versions associated with a Dataset Screening Instruction
profiles. This method can also be used as a ping mechanism or periodic Watch List data version checks.

Request Elements
Element – Attribute Data Type Description

This is Web Service Access ID created by an Admin in Compliance

Username Alpha-Numeric
Link system
Password Alpha-Numeric This is the password for Service Access ID used in the request
Request – DatasetGUID Character Dataset Web service Profile ID
Request – ID Character Customer transaction ID

Request XML messages should look like the following example:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:asm="http://asm.webservice.autoscreeningmgr.accuity.com/">
<soapenv:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-secext-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken-1" xmlns:wsu="http://docs.oasis-
open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:Username>test</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
username-token-profile-1.0#PasswordText">password</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>

<soapenv:Body>
<asm:getListVersions>
<requestXML><![CDATA[
<Request DatasetGUID="dccd041f-e0a6-40a8-ad87-dffbb2d6df94" Id="1005">
</Request>]]>
</requestXML>
</asm:getListVersions>
</soapenv:Body>
</soapenv:Envelope>

Result Elements
Element – Attribute Data Type Description

List – Id Character Watch List ID

List – Version Character Watch List Version

List Character Watch List Name

Automated Screening Manager Web Service

Programmer’s Guide
Accuity Proprietary and Confidential
Page 13 of 15
The following is the sample Response XML in response to the above sample request.

<Results DatasetGUID="dccd041f-e0a6-40a8-ad87-dffbb2d6df94">
<ListVersions>
<List Id="1020" Version="20140701122718">PEP List powered by WorldCompliance</List>
<List Id="0" Version="20150301151628">Accuity's OFAC List</List>
<List Id="1072" Version="20150225201017">Accuity OFAC Enhancements</List>
<List Id="1021" Version="20140808135246">US PEP List powered by WorldCompliance</List>
</ListVersions>
</Results>

Automated Screening Manager Web Service

Programmer’s Guide
Accuity Proprietary and Confidential
Page 14 of 15
WS-SECURITY
An Access ID and Password will need to be created on the Compliance Link Institution Summary Page
(Web Service Access Credentials) to use the ASM Web Service. The values (highlighted below) are
added to every ASM Web Service request to authenticate the message.

Request Sample
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:asm="http://asm.webservice.autoscreeningmgr.accuity.com/">
<soapenv:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-secext-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken-1" xmlns:wsu="http://docs.oasis-
open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:Username>test</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
username-token-profile-1.0#PasswordText">password</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>

<soapenv:Body>
<asm:importScreening>
<requestXML><![CDATA[
<Request DatasetGUID="dccd041f-e0a6-40a8-ad87-dffbb2d6df94" Id="1005">
<Field Name="ID">031620151307</Field>
<Field Name="Name">Matthew WinGrove</Field>
<Field Name="Address">2402 W Main Street</Field>
<Field Name="City">Nashville</Field>
<Field Name="State">TN</Field>
<Field Name="Country">US</Field>
</Request>
]]>
</requestXML>
</asm:importScreening>
</soapenv:Body>
</soapenv:Envelope>

Please see the Compliance Link Admin guide on Web Service Access Credential set up.

</Request>

Automated Screening Manager Web Service

Programmer’s Guide
Accuity Proprietary and Confidential
Page 15 of 15