Skip to main content

Legal

Recommended products

Questions? We are here to help
Contact us

Tax & Accounting

Trade & Supply

Risk & Fraud

News & Media

Books

Developers

Denied Party Screening (DPS)

Consuming The Web Service Response

Response Element Details

Response Element Details
Description
<Search_Request>
The received XML request will be returned as an element in the response. This element could be logged for verification that the correct data was sent. For security purposes, the password element is removed.
Search Elements
The following search result elements fall under the <search_status> element. These are related to the overall search request.
Search request
Description
<Result_GUID>
This generated unique identifier (GUID) is specific to the screening that was just performed. This GUID can be used to streamline your review process. Ask us how!
<Company_ID>
There are several scenarios where this field could show up. See below: 1. If the search did not contain <Company_ID> as a request parameter and no company was found with the same data, this field will be blank. 2. If the search contains a match with company data that is stored within ONESOURCE Denied Party Screening, this field will populate with the <Company_ID> of the company found. 3. If the search contains <Company_ID> as a request parameter but no matching information was found in ONESOURCE Denied Party Screening, this field will populate with “NOT FOUND”.
<DTS_Search_Date>
The exact time and date that the screening was performed. This will match the date and time stored within the “DPS Management” screen.
<dts_status>
The status (overridden, blocked, etc.) of the company after the screening that was just performed.
<DTS_Match>
  • This field will display whether or not any hits or manual blocks were found in the search. For more information about Manual Block, refer to the ONESOURCE Denied Party Screening User Guide.
  • Y
    : The search received hits or was manually blocked by a user.
  • N
    : No hits were found on this search.
<DTS_Last_ Validated_Date>
  • If the search came back with no hits, then the DTS_Search_Date will populate.
  • If the search returned with a hit, then “1/1/1900” will populate
<Num_Hits>
This is the total number of hits found in the search. Every hit that was found will have a <result> element containing the details of the hit.
Result Elements
The following result elements fall under the <Result> element. Each of these elements are details to a specific denied entity. There will be a result element with each of these data elements for each hit specified in <Num_Hits>.
Search result
Description
<Entity_ID>
The ONESOURCE identifier for the denied entity.
<Full_Name>
The full name of the denied entity.
<Score>
The score shows how closely each screened field matched the denied party on the list. The inner text of this element will represent the overall score. Please refer to the Denied Party Screening help manual for information about customized scoring.
  • If the score is at 100%, the output will be the integer value “1”. If the score is anything below 100% match, it will be outputted as decimals.
    Note
    : When an entry is linked to denied entities listed in a denial list the score column will present numeric values as decimals with two decimal places, decomposed into two parts.
  • Sanctions will be explicitly labeled.
  • Sanction type of results shown first, followed by denied entities.
<Address>
  • The street address of the denied entity.
  • Blank
    : This information was not provided on the denied party list.
  • ANY_ADDRESS
    : The hit was the result of an embargo or sanction.
<City>
  • The city address of the denied entity.
  • Blank
    : This information was not provided on the denied party list.
  • ANY_CITY
    : The hit was the result of an embargo or sanction.
<State>
  • The state or province address of the denied entity.
  • Blank
    : This information was not provided on the denied party list.
  • ANY_CITY
    : The hit was the result of an embargo or sanction.
<Postal_Code>
The postal code address of the denied entity. If this information was not provided on a list, the field will be blank.
<Country>
The country address of the denied entity. If this information was not provided on a list, the field will be blank.
<List_Name>
The name of the denied party list the denied entity was found on.
<List_Website>
A URL hyperlink to the denied party list.
<Reg_Exp_Date>
The date the entity will no longer be classified as a denied party.
<Eff_Date>
The date this entity was added or updated on the denied party list.

Search Response Examples

Search Response with Hits
You can see below an example of a search response that returned 3 hits.
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
  <DPSIntegratedSearchResponse xmlns="http://integrationpoint.com/">
     <DPSIntegratedSearchResult>
        <dts_search_results xmlns="">
           <search_request><![CDATA[<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:int="http://integrationpoint.com/">
<soap:Header/>
<soap:Body>
  <int:DPSIntegratedSearch>
     <int:company>company name</int:company>
     <int:username>username</int:username>
     <int:password>password</int:password>
     <int:loggedInUser>User ID</int:loggedInUser>
     <int:companyId>123456</int:companyId>
     <int:SearchType></int:SearchType>
     <int:settingsDescription>DEFAULT</int:settingsDescription>
     <int:name>Ronald Taylor</int:name>
     <int:address></int:address>
     <int:city>Carson</int:city>
     <int:countryCode>US</int:countryCode>
     <int:countryStateCode>CA</int:countryStateCode>
     <int:postalCode></int:postalCode>
     <int:dtsSearchFlag>Y</int:dtsSearchFlag>
     <int:dtsLastValidatedDate></int:dtsLastValidatedDate>
     <int:dtsOverride></int:dtsOverride>
     <int:dtsOverrideDate></int:dtsOverrideDate>
     <int:SearchRefNum></int:SearchRefNum>
     <int:CompanySync>Y</int:CompanySync>
  </int:DPSIntegratedSearch>
</soap:Body>
</soap:Envelope>]]></search_request>
           <entry>
              <search_status>
                 <result_guid>095550b0-c7a9-4c3d-a7c5-9e3843991648</result_guid>
                 <company_id>123456</company_id>
                 <dts_search_date>2/15/2024 4:54:02 PM</dts_search_date>
                 <dts_status>Blocked</dts_status>
                 <dts_match>Y</dts_match>
                 <dts_last_validated_date>1/1/1900</dts_last_validated_date>
                 <dts_override>N</dts_override>
                 <dts_override_date>1/1/1900</dts_override_date>
                 <num_hits>3</num_hits>
              </search_status>
              <summary_results>
                 <result>
                    <entity_id>137436029</entity_id>
                    <full_name>US_test sanction</full_name>
                    <score name_word="0" name_field="0" address_score="0" city_score="0" state_score="0" postal_score="0" country_score="0" score_code="0">Sanction</score>
                    <address/>
                    <city/>
                    <state>California</state>
                    <postal_code/>
                    <country>UNITED STATES OF AMERICA</country>
                    <list_name>122620 LIST</list_name>
                    <list_website/>
                    <reg_exp_date>1/1/1900</reg_exp_date>
                    <eff_date>2/7/2023 6:59:28 PM</eff_date>
                 </result>
                 <result>
                    <entity_id>137536941</entity_id>
                    <full_name>RONALD TAYLOR JR.</full_name>
                    <score name_word="0" name_field="0.9066776" address_score="0.49774194" city_score="0" state_score="0" postal_score="0" country_score="0" score_code="0">0.9066776</score>
                    <address/>
                    <city>ASHLAND</city>
                    <state>Kentucky</state>
                    <postal_code>41105</postal_code>
                    <country>UNITED STATES OF AMERICA</country>
                    <list_name>System for Award Management</list_name>
                    <list_website>https://www.sam.gov/SAM/</list_website>
                    <reg_exp_date>1/1/1900</reg_exp_date>
                    <eff_date>3/17/2023 2:14:42 PM</eff_date>
                 </result>
                 <result>
                    <entity_id>135921923</entity_id>
                    <full_name>RONALD CHARLES TAYLOR</full_name>
                    <score name_word="0" name_field="0.9048006" address_score="0.8229032" city_score="0" state_score="0" postal_score="0" country_score="0" score_code="0">0.9048006</score>
                    <address/>
                    <city>CARSON</city>
                    <state>California</state>
                    <postal_code>90746</postal_code>
                    <country>UNITED STATES OF AMERICA</country>
                    <list_name>System for Award Management</list_name>
                    <list_website>https://www.sam.gov/SAM/</list_website>
                    <reg_exp_date>1/1/1900</reg_exp_date>
                    <eff_date>3/15/2022 2:23:33 PM</eff_date>
                 </result>
              </summary_results>
           </entry>
        </dts_search_results>
     </DPSIntegratedSearchResult>
  </DPSIntegratedSearchResponse>
</soap:Body>
</soap:Envelope>

This article applies to:

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

Related Content