Skip to main content

Legal

Tax & Accounting

Trade & Supply

Risk & Fraud

News & Media

Books

Developers

Denied Party Screening (DPS)

Creating the Web Service Request

File Format

The file you submit to ONESOURCE must be in XML. This Web Services Guide contains a template that can be used for successfully creating those files.
SOAP 1.1
Below is a sample SOAP 1.1 request.
POST /DTSwebservice/dtswebservice.asmx HTTP/1.1
Host: dts.integrationpoint.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://integrationpoint.com/DPSIntegratedSearch"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
 <soap:Body>
   <DPSIntegratedSearch xmlns="http://integrationpoint.com/">
     <company>string</company>
     <username>string</username>
     <password>string</password>
     <loggedInUser>string</loggedInUser>
     <companyId>string</companyId>
     <SearchType>string</SearchType>
     <settingsDescription>string</settingsDescription>
     <name>string</name>
     <address>string</address>
     <city>string</city>
     <countryCode>string</countryCode>
     <countryStateCode>string</countryStateCode>
     <postalCode>string</postalCode>
     <dtsSearchFlag>string</dtsSearchFlag>
     <dtsLastValidatedDate>string</dtsLastValidatedDate>
     <dtsOverride>string</dtsOverride>
     <dtsOverrideDate>string</dtsOverrideDate>
     <SearchRefNum>string</SearchRefNum>
     <CompanySync>string</CompanySync>
     <EntityType>string</EntityType>
   </DPSIntegratedSearch>
 </soap:Body>
</soap:Envelope>
SOAP 1.2
Below is a sample SOAP 1.2 request.
POST /DTSwebservice/dtswebservice.asmx HTTP/1.1
Host: dts.integrationpoint.net
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
 <soap12:Body>
   <DPSIntegratedSearch xmlns="http://integrationpoint.com/">
     <company>string</company>
     <username>string</username>
     <password>string</password>
     <loggedInUser>string</loggedInUser>
     <companyId>string</companyId>
     <SearchType>string</SearchType>
     <settingsDescription>string</settingsDescription>
     <name>string</name>
     <address>string</address>
     <city>string</city>
     <countryCode>string</countryCode>
     <countryStateCode>string</countryStateCode>
     <postalCode>string</postalCode>
     <dtsSearchFlag>string</dtsSearchFlag>
     <dtsLastValidatedDate>string</dtsLastValidatedDate>
     <dtsOverride>string</dtsOverride>
     <dtsOverrideDate>string</dtsOverrideDate>
     <SearchRefNum>string</SearchRefNum>
     <CompanySync>string</CompanySync>
     <EntityType>string</EntityType>
   </DPSIntegratedSearch>
 </soap12:Body>
</soap12:Envelope>

Request Parameter Details

The table below contains more detailed explanations for the data types you must complete in order to perform a successful Web Services Search.
Company, Username and Password fields are mandatory.
Data type
Description
Company
The company name for login. This information is supplied by ONESOURCE.
Username
The user name for login. This information is supplied by ONESOURCE.
Password
The password for login. This information is encrypted and supplied by ONESOURCE.
LoggedInUser
This field represents the user who performed the DPS Search and appears as the username on the
DPS Management
 screen. This field is optional and can be left blank. If this field is left blank, the username specified above will be stored in the
DPS Management
 search result.
CompanyID
Specifies the company ID of the company to be screened. This company should already exist and all data fields provided must match the data stored in company partners. If all data matches, the search will be stored linked to the company in company partners. If the data does not match, the screening will still be performed, but will not be linked with a company ID. This field can be used in conjunction with the
CompanySync
 parameter below for adding a new company to company partners. If this field is specified and CompanySync is provided, the service will store the request as a company within the ONESOURCE software.
SearchType
The Search Type field can be left blank to default to Company records in company partners. This element also accepts Address and Contact as options. The identifiers for an Address or Contact will be different than the identifier for a company.
SettingsDescription
If your client has been set up to screen with multiple search settings, this parameter allows you to choose which setting(s) to use. This field is optional and can be left blank. If this field is left blank, screenings will use the default settings from
DPS Settings
.

Data Elements

The following data elements make up the data being screened. All of these fields are optional, but an error message will appear if no data is provided to screen against.
Data Element
Description
Mandatory (Y|N)
Name
The name of the party being searched.
Y
Address
The address of the party being searched.
Y
City
The city of the party being searched.
Y
CountryCode
The two-digit ISO country code of the party being searched.
Y
CountryStateCode
The two-digit code or name of the state/province of the party being searched.
Y
PostalCode
The postal code of the party being searched.
Y
DTSSearchFlag
This search option is depreciated. There is no need to send any information in this field.
N
DTSLastValidatedDate
  • This date can be used to filter the search results received, if you have reviewed hits on a given date. Specifying a date in this field will only return entities that have been added or updated since this date. This field will be used if the “DTSOverride” parameter is set to “N”.
  • Valid Arguments: Actual Date and Time Stamp (MM/DD/YYYY hh:mm:ss AMPM)
N
DTSOverride
  • This option specifies a search as overridden. This can prevent repeated searches from returning hits that have already been reviewed. Setting this field to “Y” will only return hits that have been added or updated since the last time the screening was reviewed. The review date is provided in the DTSOverrideDate field.
  • Y
    : Yes. Use the specified DTSOverrideDate. This is the default value.
  • N
    : No. Do not use the specified DTSOverrideDate. DTSLastValidatedDate will be used if provided
Y
DTSOverrideDate
  • The most recent date and time stamp that the party name was overridden. Specifying a date in this field will only return entities that have been added or updated since the Override Date. This date will be used if the DTSOverride field is set to “Y”. This field can be left blank.
  • Valid Arguments: Actual Date and Time Stamp (MM/DD/YYYY hh:mm:ss AMPM)
Y
SearchRefNum
The “Search Reference Number” is an additional, supplementary identifier that can be entered along with any search at the user’s discretion. This identifier is not unique to any one search. The same Search Reference Number can be entered with multiple searches for various uses.
Y
CompanySync
This option ("Y"|"N") indicates whether the searched company is to be stored. It requires passing company name and Company ID.
N
EntityType
This option specifies the entity type associated to search criteria. Setting this field to Person or Organization will score hits with matching entity type more accurately, if any. Setting this field to blank will be considered as not specified.
N

This article applies to:

  • PRODUCT: ONESOURCE Global Trade
  • Sub-Product: Denied Party Screening

Related Content