d&b direct 2.0 compliance check service · arb arbitration arn arraign art arrest asc...
Post on 02-Nov-2019
1 Views
Preview:
TRANSCRIPT
D&B DirectAPI Documentation for
Compliance Check Service
Version 2.0 (API) / 1.0 (Service)
D&B Direct is a trademark or registered trademark of Dun and Bradstreet, Incorporated. Other trademarks
used herein are the trademarks or registered trademarks of their respective owners.
This document is a work of authorship that belongs to Dun and Bradstreet, Incorporated and is protected
by United States and foreign copyright laws and international copyright treaties. The use of the software
and this Documentation is governed by the Dun and Bradstreet Incorporated software license agreement.
©2014 Dun & Bradstreet, Incorporated. All rights reserved
ContentsThese pages provide business overviews; explaining requirements and the business elements that will bedelivered. For suggested uses of the API components, please refer to the Solutions menu option on thedeveloper.dnb.com home page.
Title / Overview Link
Compliance √ Screening
These pages provide the technical specifications that a developer will need to obtain information usingD&B Direct.
Service Operation / SOAP Resource / REST
Authentication Process All All
Compliance Check Service RegisterSubject POST compliancecheck/subjects
ListComplianceSubjects GET compliancecheck/subjects
GetSubjectComplianceData GET compliancecheck/subjects/{subjectID}
GetComplianceAlerts GET compliancecheck/subjects/alerts/
UpdateSubjectRegistration PUT compliancecheck/subjects/{subjectID}
Service History
Version Date Interface(s) Change(s)
D&B Direct API Documentation Service History
©Dun & Bradstreet, Inc. 2014 3
About this DocumentationThe D&B Direct 2.0 API Reference materials are organized into product, feature, service and operation pages.Throughout the documentation, certain items are marked as eligible for custom products and/or for inclusionin the monitoring process.
Key Concepts
Business Elements vs. Data Fields
The D&B Direct API has been designed to efficiently deliver information, and as a result, multiple businesselements are often delivered in the same data field (with separate attributes signaling the specific contents ofa data field).
The documentation highlights the business elements (i.e. business-oriented labels) on product pages; and thedata fields (i.e. technical, variable-like names used within the delivery packages) on operation pages -- withthe business elements linked to the corresponding data field for each available implementation.
Data Layers
The D&B Direct API delivers information in data layers, some of which have multiple levels. For the purpose ofthis documentation, the term Product is used to represent a given level for a data layer.
For example, "Detailed Company Profile" is the Data Layer, while "Detailed Company Profile - Enhanced" willbe referred to as a Product.
Custom Products
D&B Direct offers a customization service that allows for up to eight pre-configured products to be deliveredthrough the API web service. Throughout the documentation, business elements and data fields which areeligible for inclusion in a custom product are designated with a [C] marker.
Service Versions
It is important to note that D&B Direct 2.x implements version control at the service level, in addition to theAPI level. For example, the current version of the Assessment Product Service is Version 2.0 (API) / 3.0 (Service).
D&B Direct services will be updated (major and minor version changes) without a API version change.Following the example given, it will be possible for the Assessment Product Service to change to Version 2.0
D&B Direct API Documentation About this Documentation
©Dun & Bradstreet, Inc. 2014 4
(API) / 3.1 (Service) or Version 2.0 (API) / 4.0 (Service) based on the significance of the changes made to theservice.
Product Pages
These are non-technical pages that describe the information (i.e. business elements) returned by the data-oriented operations. In addition, the requirements and options for requesting data are mentioned.
Feature Pages
These are also non-technical pages, but explain the use of operations that provide a function (e.g. search) andoften return the items (i.e. D-U-N-S Number) required to request data products.
Service Pages
These are technical pages that explain what operations a given API web service provides, the correct versionand endpoints, WSDL location (for SOAP), and how to download samples and data dictionaries specific to theservice. While services are not applicable for REST implementations, the documentation is organized aroundthem for consistency.
Operation Pages
These are also technical pages, but describe (for each available implementation method) the individualfunctions provided by a service, listing the input field names and requirements, and the output with datafields (including data type, size, description and possible values).
Release Histories
Whenever an operation is enhanced (or a minor correction is made), a notation will be added to a section onthe bottom of the affected SOAP/REST operation page. If the change is significant and results in a versionchange, the release history will maintain a link to the documentation for the previous version(s).
Getting Started
While the API Reference documentation provides extensive details on each operation and data layer, for moresummarized explanations of common tasks/uses refer to the collection of How To Guides.
D&B Direct API Documentation Product Pages
©Dun & Bradstreet, Inc. 2014 5
Compliance √ ScreeningD&B Compliance Check is a powerful solution providing organizations advanced screening and monitoring ofcustomers and suppliers to ensure global regulatory compliance with a growing range of Global AntiCorruption regulations, including the Foreign Corrupt Practices Act and U.K. Bribery Act, among others.
Leveraging multiple databases, including global watch lists, regulatory authority actions, law enforcementsources, and global news sources, updated daily, businesses have the most comprehensive and broad-reachingcompliance solution to address all compliance program needs.
Terminology
An Entity is any organization (or company principal) that will be subjected to the D&B Compliance screeningprocess.
A Politically Exposed Person (PEP) is someone who has been entrusted with a prominent public function, or anindividual (including family and associates) closely related to such a person.
An IRC is a company that has been matched to a list of names and associations of organizations andindividuals with publicly known connections to the Iranian energy, transportation, and military sectors.
The WLT includes the foundational collection of watch lists, including PEP and IRC.
The Global Regulatory Information Database (GRID) is a 17 million-plus records database, updated daily onknown or suspected corrupt private and public sector figures, fraudsters, illicit financiers, money launderers,organized crime groups, terrorist organizations, politically exposed persons and dozens of other risk relevantcategories of persons and organizations.
Regulatory Data Corporation (RDC) is a D&B partner specializing in regulatory compliance solutions.
Compliance Screening Options
In addition to the data supplied by the customer, D&B information can be appended prior to initiating thescreen process. Options are available to incrementally append company name, trade styles and CEO names;principal names and shareholders; and direct line entities between the requested company and the ultimateparent (also referred to as upward linkage).
Customers may choose to broaden the scope of the screening process from a basic WLT/PEP/IRC screening, toone based on the complete list of available sources (including adverse media). Customers may also elect tohave skilled analysts conduct review of the screening results to eliminate false positives before returning anoutcome.
D&B Direct API Documentation Compliance √ Screening
©Dun & Bradstreet, Inc. 2014 6
For ongoing alerts and updates, customers may elect for the Compliance Monitoring service.
Single Entity Submission
A company (or individual) name, primary entity address (street, city, state, postal code and country) and theappropriate product code must be provided for a Compliance √ registration. Customers are encouraged to alsoprovide any known DBA (Doing Business As) or alternate business names and principals of the business toensure an accurate and complete screening. A unique tracking number is provided upon a successfulregistration.
Note: Please contact a D&B sales representative to obtain the product code(s) entitled for a specificCustomer contract.
For screening requests that do not include an analyst review, results can be retrieved within an hour ofsubmission. Analyst reviews are typically completed within 2 to 3 business days. In either case, the retrievaloperation may be polled for a completion status of the request.
Monitoring alerts can be retrieved (PULL) on an ongoing basis. An alert delivery (PUSH) option is not currentlyavailable.
Compliance Check Results
The following table is an alphabetical list of the unique items available for each entity registered with theCompliance Check service. The actual information provided is dependent on the "module(s)" specified on therequest. Available options include "APPEND_DATA" (includes customer submitted data and D&B appendedinformation) and "ALERTS."
Criteria options are available to filter the Compliance alerts for a specific date range.
Business Elements - APPEND_DATA
Name Description XML* JSON*
Address 1 - HQCompany
SOAP REST
Address 1 - ParentCompany
SOAP REST
Address 2 - HQCompany
SOAP REST
Address 2 - ParentCompany
SOAP REST
Area of Concern Text Describes finding of search for each of the Risk Categories. SOAP REST
D&B Direct API Documentation Single Entity Submission
©Dun & Bradstreet, Inc. 2014 7
Name Description XML* JSON*
City - HQ Company SOAP REST
City - ParentCompany
SOAP REST
City -DomesticUltimate & GlobalUltimate
SOAP REST
Company Name -Domestic Ultimate &Global Ultimate
Name by which the Linked Company is primarily identified. SOAP REST
Company Name -Parent Company
Entity name SOAP REST
Compliance SystemRegistration ID
Unique identifier assigned to the entity record that was successfully uploaded tothe compliance system.
SOAP REST
Country Code The two-letter country code, defined by the International Organization forStandardization (ISO) ISO 3166-1 scheme identifying the country which thebusiness uses for mailing purposes.
SOAP REST
Country Name -Domestic Ultimate &Global Ultimate
SOAP REST
Country Name - HQCompany
ISO 2 Character Code of the Country where the Linked Company is located. SOAP REST
Country Name -Parent Company
ISO 2 Character Code of the Country where the Linked Company is located. SOAP REST
Customer ProvidedCountry Code
ISO 2 Character Code of the Country where the Eneity is located. SOAP REST
Customer ProvidedDivision ID
The identifier for the Customer Division that this record will be loaded to. SOAP REST
Customer ProvidedDivision Name
The name of the Customer Division that this record will be loaded to. For Wal-Martthe Division is Retail Market.
SOAP REST
Customer ProvidedD-U-N-S Number
The D&B D-U-N-S of the entity as provided by the customer in the input. SOAP REST
Customer ProvidedEntity ID
Internal identifier provided by the customer to uniquely identify an entity. SOAP REST
Customer ProvidedEntity Name
Identifies the name of the entity as provided by the customer in the input. SOAP REST
Customer ProvidedEntity Tax ID
Identifies the Taxation ID for Corporation or Individual. The Taxation ID is anumerical designation that is assigned to a business Entity operating within agiven locality. The main purpose of tax IDs is to quickly identify the Entity forpurposes of as
SOAP REST
Customer ProvidedEntity Tax ID Type
Identifies the Type of the Tax ID. For ex - US FEIN, UK CRO Number, ES VAT etc SOAP REST
Customer ProvidedEntity Type
Identifies whether the Entity is a Company or Individual SOAP REST
D&B Direct API Documentation Business Elements - APPEND_DATA
©Dun & Bradstreet, Inc. 2014 8
Name Description XML* JSON*
Customer ProvidedPostal Code
Identifies the Postal Code where the Entity is located. SOAP REST
Customer ProvidedPrincipal CountryCode
The two digit ISO Country Code of the Principal as provided by the customer in theinput.
SOAP REST
Customer ProvidedPrincipal Name
Identifies the Principal associated with the entity by name as provided by thecustomer in the input.
SOAP REST
Customer ProvidedPrincipal Title
The Title of the Principal as provided by the customer in the input. SOAP REST
Customer ProvidedProject ID
An internal project identifier provided by the customer to which the entity has tobe loaded. If not provided, defaulted to Project 00000.
SOAP REST
Customer ProvidedShareholder CountryCode
Identifies the two digit ISO Country Code of the Shareholder as provided by theCustomer in the input.
SOAP REST
Customer ProvidedShareholder Name
Identifies the Shareholders for the entity by name as provided by the customer inthe input.
SOAP REST
Customer ProvidedShareholderPercentage
The percentage held by the shareholder(s) as provided by the customer in theinput.
SOAP REST
Customer ProvidedStreet Address 1
Address Line 1 Text of the Entity Address SOAP REST
Customer ProvidedStreet Address 2
Address Line 2 Text of the Entity Address SOAP REST
Customer ProvidedSub Division ID
SOAP REST
Customer ProvidedSub Division Name
SOAP REST
Customer ProvidedTelephone
Primary Telephone Number of the Entity. SOAP REST
Customer ProvidedTerritory Name
Identifies the State / Province where the Entity is located. SOAP REST
Customer ProvidedTotal Spend
Total Spend of the Customer for the Entity. SOAP REST
Customer ProvidedTotal Spend
ISO 4217 country code to determine currency type for 'Total Spend' element SOAP REST
Customer ProvidedTown Name
Identifies the City Name where the Entity is located. SOAP REST
Customer ProvidedWorkflow Queue ID
The identifier for the actual queue within the Division this entity must be pushedto. By default the record will be loaded in the first available queue for that decision.
SOAP REST
Customer ProvidedWorkflow QueueName
The name of the actual queue within the Division this entity must be pushed to.By default the record will be loaded in the first available queue for that decision.
SOAP REST
D&B Direct API Documentation Business Elements - APPEND_DATA
©Dun & Bradstreet, Inc. 2014 9
Name Description XML* JSON*
D-U-N-S Number The D-U-N-S Number is D&B's identification number, which provides uniqueidentification of this organization, in accordance with the Data UniversalNumbering System (D-U-N-S). This DUNS Number represents the business entity.
SOAP REST
DUNS Number -Domestic Ultimate &Global Ultimate
Randomly generated nine-digit number assigned by D&B to the Linked Company. SOAP REST
DUNS Number - HQCompany
SOAP REST
DUNS Number -Parent Company
DUNS Number of the Family Tree Member SOAP REST
Family Tree MemberLevel
Indicates Subject, Parent / HQ, Parent 2, Parent 3…Domestic Ultimate, GlobalUltimate
SOAP REST
Organization Name -HQ Company
SOAP REST
Postal Code An identifier used by the local country Postal Authority to identify where thebusiness is located.
SOAP REST
Primary BusinessName
Text recording of a single name by which the organization is primarily known oridentified. In many cases this may be the same as the Registered name and assuch will not need to be quoted. For businesses which do not need to register, andas such do not
SOAP REST
Primary StreetAddress
Text recording the address number, or post office box number and street namewhere the business is located.
SOAP REST
Primary StreetAddress Line 2
Line 2 of the text recording the address number, or post office box number andstreet name where the business is located.
SOAP REST
Principal CountryCode
Identifies the ISO Country Code of the Principal. SOAP REST
Principal countryCode - HQ Company
Identifies the ISO Country Code of the Principal. SOAP REST
Principal CountryName - GlobalUltimate andDomentic Ultimate
SOAP REST
Principal CountryName - ParentCompany
Identifies the ISO Country Code of the Principal. SOAP REST
Principal Job Title -Parent Company
SOAP REST
Principal Name Full name of the principal associated with the company. SOAP REST
Principal Name -Domestic Ultimate &Global Ultimate
Principal Name SOAP REST
Principal Name - HQCompany
SOAP REST
D&B Direct API Documentation Business Elements - APPEND_DATA
©Dun & Bradstreet, Inc. 2014 10
Name Description XML* JSON*
Principal name -Parent Compnay
SOAP REST
Principal Title Identifies the Title of the Principal. SOAP REST
Principal Title -Domestic Ultimate &Global Ultimate
Principal Title SOAP REST
Principal Title - HQCompany
SOAP REST
Related PartyAssociation Type
Indicates tye of related party, i.e., affiliate, sub-contractor, etc. SOAP REST
Related Party Name Name of related parties, if any, for the supplier. SOAP REST
Risk Category Name The name of the risk category. SOAP REST
State - DomesticUltimate & GlobalUltimate
SOAP REST
State - HQ Company SOAP REST
State - ParentCompany
SOAP REST
Territory Name Text recording the name of the locally governed area which forms part of acentrally governed nation to identify where the business is located.
SOAP REST
Town Name Text recording the name of a city, town, township, village, borough, etc. where thebusiness is located.
SOAP REST
Trade Style Name Text recording the name which an organization trades under for commercialpurposes although its registered legal name used for contracts and other formalsituations may be another name.
SOAP REST
Zip - HQ Company SOAP REST
Zip code -DomesticUltimate & GlobalUltimate
SOAP REST
Zip -Patent Company SOAP REST
Business Elements - ALERTS
Name Description XML* JSON*
Alert Date Date on which the alert became effective SOAP REST
Alert ID Unique identifier assigned by RDC for the alert SOAP REST
Alias Name Alias or also known by name of the matched entitity. SOAP REST
Alias Name -Tradestyle Name
Alias name of the entity. SOAP REST
Attribute Description SOAP REST
D&B Direct API Documentation Business Elements - ALERTS
©Dun & Bradstreet, Inc. 2014 11
Name Description XML* JSON*
Birth Country Name SOAP REST
Birth Postal Code SOAP REST
Birth Territory Name SOAP REST
Birth Town Name SOAP REST
Compliance SystemRegistration ID
Unique identifier assigned to the entity record that was successfully uploaded tothe compliance system.
SOAP REST
Country Name The country where the business is located. SOAP REST
Date of Birth SOAP REST
Entity ID Unique Identifier generated by RDC for the Alert Entity. This will be used as areference identifier to get more details on the Alert Entity.
SOAP REST
Entity Name Name of the matched entitity. SOAP REST
Entity Reference URL URL to the RDC Entity Viewer which will contain additional information and allowviewing of media articles.
SOAP REST
Entity Type Indicates if the Entity is a Individual or Organization SOAP REST
Event Category Code A three digit code describing the type of event. Examples are Counterfeiting,Murder, Espionage, Money Laundering, Terrorist Related, etc.
SOAP REST
Event Date Date that event or action took place or went into effect. SOAP REST
Event Description A small description about the event or crime. SOAP REST
Event Sub CategoryCode
A three digit code describing the event outcome. Examples are Allege, Arrest,Indictment, etc.
SOAP REST
Former PrimaryName
Former primary name of the entity. SOAP REST
New Attribute Value New value of the attribute SOAP REST
Note A note provided about the entity by the RDC Analyst. SOAP REST
Postal Code SOAP REST
Publication Name of the publication. SOAP REST
Publication Date Date Published SOAP REST
Publisher SOAP REST
Source Description Description of the source. SOAP REST
Source Name Name of the source SOAP REST
Source URL A URL back to the Source where the record was found SOAP REST
Street Address SOAP REST
Street Address 2 SOAP REST
Territory Name SOAP REST
Town Name SOAP REST
*The links in this column provide developer information for the data field characteristics of the respective business
element in the XML (SOAP) or JSON (REST) response.
D&B Direct API Documentation Business Elements - ALERTS
©Dun & Bradstreet, Inc. 2014 12
The preceding list is not presented in the order, nor manner, in which the information is packaged anddelivered via the D&B Direct API.
Access to this information is provided on a metered basis; and requires a pre-established D&B subscribercontract for the specific Compliance service options that your organization intends to utilize. Note: thiscontract is separate from the standard D&B Direct API contract.
Entity Attributes
CODE DESCRIPTION
URL Entity Url
POS Position Held
IMG Image Url
PHD Physical Description
HCL Hair Color
ECL Eye Color
HGT Height
CPX Complexion
WGT Weight
SEX Sex
BLD Build
RAC Race
SMK Scars or Marks
LNG Language
NAT Nationality
OCU Occupation
DED Deceased
DDT Deceased Date
PTY PEP Type
RMK Remark
This table is subject to change; new attribute values are added periodically.
Event Categories
CODE DESCRIPTION
ARS Arson
AST Assault, Battery
BUR Burglary
D&B Direct API Documentation Entity Attributes
©Dun & Bradstreet, Inc. 2014 13
CODE DESCRIPTION
BUS Business Crimes (Antitrust, Bankruptcy, Price Fixing)
ABU Abuse (Domestic, Elder, Child)
CYB Computer Related, Cyber Crime
CFT Counterfeiting, Forgery
DTF Trafficking or Distribution of Drugs
DPS Possession of Drugs or Drug Paraphernalia
DUI DUI, DWI
FUG Escape, Fugitive
SPY Espionage, Spying, Treason
PRJ False Filings, False Statements, Perjury, Obstruction of Justice
BRB Bribery, Graft, Kickbacks, Political Corruption
IMP Identity Theft, Impersonation
GAM Illegal Gambling
IGN Possession or Sale of Guns, Weapons and Explosives
IPR Illegal Prostitution, Promoting Illegal Prostitution
KID Kidnapping, Abduction, Held Against Will
LNS Loan Sharking, Usury, Predatory Lending
ORG Organized Crime, Criminal Association, Racketeering
MLA Money Laundering
MUR Murder, Manslaughter (Committed, Planned or Attempted)
OBS Obscenity Related, Child Pornography
MIS Misconduct
TRF People Trafficking, Organ Trafficking
PEP Person Political
PSP Possession of Stolen Property
PLT Public Intoxication, Lewdness, Trespassing
ROB Robbery (Stealing by Threat, Use of Force)
FRD Fraud, Scams, Swindles
SEC SEC Violations (Insider Trading, Securities Fraud)
SEX Sex Offenses (Rape, Sodomy, Sexual Abuse, Pedophilia)
TAX Tax Related Offenses
TER Terrorist Related
TFT Theft (Larceny, Misappropriation, Embezzlement, Extortion)
WLT Watch List
HUM Human rights, Genocide, War crimes
DEN Denied Entity
D&B Direct API Documentation Event Categories
©Dun & Bradstreet, Inc. 2014 14
CODE DESCRIPTION
REG Regulatory Action
CON Conspiracy (No specific crime named)
FOR Forfeiture
MSB Money Services Business
RES Real Estate Actions
MOR Mortgage Related
NSC Non Specific Crime
BKY Bankruptcy
REO Restructuring, Reorganization, Divestiture Risk
PER Performance Risk
CND Financial Condition Risk
DEF Default Risk
BIL Questionable Billing Practices
ENV Environmental Crimes (Poaching, Illegal Logging, Animal Cruelty
SMG Smuggling (Does not include Drugs, Money, People or Guns)
CPR Copyright Infringement (Intellectual Property, Electronic Piracy)
IRC Iran Connect
HCD Health Care Disciplines
This table is subject to change; new code values are added periodically.
Event Sub-Categories
CODE DESCRIPTION
ACC Accuse
ACQ Acquit, Not Guilty
ACT Disciplinary, Regulatory Action
ADT Audit
ALL Allege
APL Appeal
ARB Arbitration
ARN Arraign
ART Arrest
ASC Associated with, Seen with
CEN Censure
CHG Charged
CMP Complaint Filed
D&B Direct API Documentation Event Sub-Categories
©Dun & Bradstreet, Inc. 2014 15
CODE DESCRIPTION
CNF Confession
CSP Conspire
CVT Convict, Conviction
DEP Deported
DMS Dismissed
EXP Expelled
FIL Fine - Less than $10,000
FIM Fine - More than $10,000
GOV Government Official
IND Indict, Indictment
LIN Lien
PLE Plea
PRB Probe
RVK Revoked Registration
SAN Sanction
SET Settlement or Suit
SEZ Seizure
SJT Served Jail Time
SPD Suspended
SPT Suspected
TRL Trial
WTD Wanted
This table is subject to change; new code values are added periodically.
Technical Specification
For details on how to obtain the Compliance Check results, please refer to the Compliance Check Servicedocumentation.
D&B Direct API Documentation Technical Specification
©Dun & Bradstreet, Inc. 2014 16
Compliance Check ServiceVersion 2.0 (API) / 1.0 (Service)
D&B Compliance Check operations help customers effectively protect company assets and brand frompotential corruption and/or non-compliance of regulatory requirements. This solution allows organizations toidentify banned or suspect entities (suppliers, partners, customers, etc.) and individuals, strengthen fraudprotection, ensure regulatory compliance and manage supply and distribution risk.
Note: While the Compliance √ Screening features are accessed through the D&B Direct service, separatecredentials are required for each data environment and will be provided by a D&B sales representative.
Functions
This D&B Direct service includes the following functionality. The respective SOAP and/or REST pages providetechnical details including input parameters, responses and sample requests.
Function / Overview Link Operation / SOAP Resource / REST
Single Entity Submission RegisterSubject() POST compliancecheck/subjects
GetSubjectComplianceData() GET compliancecheck/subjects/{subjectID}
GetComplianceAlerts() GET compliancecheck/subjects/alerts/
ListComplianceSubjects() GET compliancecheck/subjects
UpdateSubjectRegistration() PUT compliancecheck/subjects/{subjectID}
The Register Subject function allows entities (organizations and/or individuals) to be submitted forCompliance Check screening. Validated requests will move through the D&B D-U-N-S Number matching anddata append services (based on the service level selected) and then be submitted for screening. An optionexists for ongoing monitoring of screening alerts related to the entity.
The Get Subject Compliance Data function is used to retrieve the results of the Compliance Check process for aspecific entity. A tracking number is provided by the Register Subject function that allows for direct access tothe results (when they are available).
The Get Compliance Alerts function is used to retrieve lists of alerts across multiple registered subjects using adate range.
The List Compliance Subjects function provides a list of Subject IDs for entities submitted using the RegisterSubject function.
D&B Direct API Documentation Compliance Check Service
©Dun & Bradstreet, Inc. 2014 17
The Update Subject Registration function allows certain data elements on an existing subject to be modified.Currently, this is limited to the monitoring status.
Interfaces & Endpoints
D&B Direct implements version control at the web service level, in addition to the API level. This D&B Direct2.0 {version} of the Compliance Check Service is 1.0, and the table below explains the access points for boththe SOAP and REST interfaces.
SOAP
Endpoint https://maxcvservices.dnb.com/ComplianceCheckService/V{version}
WSDL* http://developer.dnb.com/docs/2.0/compliance/1.0/ComplianceCheckService.zip
*There may be operations defined in the WSDL that are not available to D&B Direct customers at this time.
REST
RegisterSubject POST https://maxcvservices.dnb.com/V{version}/compliancecheck/subjects/
GetSubjectComplianceData GET https://maxcvservices.dnb.com/V{version}/compliancecheck/subjects/{subjectID}
GetComplianceAlerts GET https://maxcvservices.dnb.com/V{version}/compliancecheck/subjects/alerts?SubjectID={subjectID}
ListComplianceSubjects GET https://maxcvservices.dnb.com/V{version}/compliancecheck/subjects/
UpdateSubjectRegistration PUT https://maxcvservices.dnb.com/V{version}/compliancecheck/subjects/{subjectID}
D&B Direct API calls must be made using Secured Socket Layers (SSL) as noted in the preceding table(s).
D&B Direct API Documentation Interfaces & Endpoints
©Dun & Bradstreet, Inc. 2014 18
RegisterSubject (REST)This operation -- part of the Compliance Check Service -- is a component of the Compliance √ Screeningsolution.
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Note: While the Compliance √ Screening features are accessed through the D&B Direct service, separatecredentials are required for each data environment and will be provided by a D&B sales representative.
Endpoint
POST https://maxcvservices.dnb.com/V{version}/compliancecheck/subjects/
Request Parameters
The following parameters are accepted by this operation.
Exception: The subjects (and corresponding data and alerts) registered by this operation will be accessible toALL user credentials associated with the customer contract.
If an application requires filtering by user credentials, a possible solution would be to place a unique value inthe CustomerReferenceText field when registering subjects, and then supply the same value to theListComplianceSubjects operation.
Restriction: The sequence of Request Parameters submitted to POST/PUT operations currently MUST followthe order presented in this section. This applies to REST calls only.
Restriction: For POST/PUT requests, the ‘Accept’ header item should be set to ‘application/json’ or be leftempty. If the value submitted is ‘*/*’, the service will return an error. This applies to REST calls only.
Restriction: An XML namespace statement MUST be included as the first statement within the primaryAggregate of the request. Please refer to the Sample Request for an example. This applies to REST calls only.
Name Characteristics
RegisterSubjectRequest Aggregate
RegisterSubjectRequest@ServiceVersionNumber
Attribute
D&B Direct API Documentation RegisterSubject (REST)
©Dun & Bradstreet, Inc. 2014 19
Name Characteristics
RegisterSubjectRequest { TransactionDetail
Aggregate, Optional
Records information necessary to process this request.
RegisterSubjectRequest { TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely identify this request.
RegisterSubjectRequest { TransactionDetail { TransactionTimestamp
DateTimestamp, Optional
The date and time when this request was created. When the request is from
an intermediary, such as a workflow manager or service bus, this is the date
and time when the message was sent to the D&B function, i.e., the date and
time when the xml document was created by the requesting intermediary.
RegisterSubjectRequest { TransactionDetail { SubmittingOfficeID
string up to 64 chars., Optional
A number that identifies the system or the software application from where
this request originated. / A number used to uniquely identfy the D&B business
segment or delivery channel from where this request originated.
End: RegisterSubjectRequest }TransactionDetail
/Aggregate
RegisterSubjectRequest { RegisterSubjectRequestDetail
Aggregate, Required
Records data relating to requests for supplier registeration. This may include
such details as the product required, the subject about which the product
should be produced, the content of the product.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail
Aggregate, Required
Records data that allows the supplier to specify identifying information about
the subject being inquired, e.g., the DUNS Number, SupplierName etc.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { ProjectID
string up to 64 chars., Optional
An internal project identifciation provided by customer to uniquely identify the
record
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { SubjectName
_, Required
The name of the individual or organization from which the subject purchases
goods or services.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 20
Name Characteristics
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { DUNSNumber
string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Optional
The D-U-N-S Number is D&B's identification number, which provides unique
identification of this organization, in accordance with the Data Universal
Numbering System (D-U-N-S).
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { ApplicationSubjectID
ApplicationSubjectIDType up to 20 chars., Optional
A number uniquely identifying the inquired subject within the application.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Principal
Aggregate, Optional(Up to 6x)
Records the information of each principal that are actively associated with the
subject organization.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Principal { NamePrefixText
string up to 512 chars., Optional
Text defining the correct form of address for this individual. E.g., Dr, Professor,
Lord etc.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Principal { PrincipalName
_, Optional
Records the different names for the Principal.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Principal { PrincipalName@NameIdentificationNumber
Attribute
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Principal { JobTitle
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the recording of the
name used by the organization to describe this person's job, e.g., Leader Global
Communication, Manager National Technical Support Center.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Principal { JobTitle { JobTitleText
string up to 3000 chars., Optional
Text that denotes a position held by the principal or manager.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Principal { JobTitle { JobTitleText@WritingScriptISOAlpha4Code
Attribute
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Principal { JobTitle { JobTitleText @LanguageCode
Attribute
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 21
Name Characteristics
End: RegisterSubjectRequest }RegisterSubjectRequestDetail }InquiryDetail } Principal } JobTitle
/Aggregate
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Principal { CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1 scheme published by
International Organization for Standardization (ISO)identifying the country of
the inquired subject.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Principal { DataProviderName
string up to 256 chars., Optional
Name identifying the source from which this data was originally obtained by
DnB.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Principal { DataProviderName @DNBCodeValue
Attribute
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Principal { DataProviderName@DNBCodeTableNumber
Attribute
End: RegisterSubjectRequest }RegisterSubjectRequestDetail }InquiryDetail } Principal
/Aggregate
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Shareholder
Aggregate, Optional(Up to 6x)
Records the information of individual or organization that legally owns a share
of stock in a public or private organization.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Shareholder { NamePrefixText
string up to 512 chars., Optional
Text defining the correct form of address for this individual. E.g., Dr, Professor,
Lord etc.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Shareholder { ShareholderName
_, Optional
The name of the individual or organization that legally who owns a share of
stock in a public or private organization.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Shareholder { ShareholderName@NameIdentificationNumber
Attribute
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 22
Name Characteristics
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Shareholder { ShareholdingPercentage
decimal up to 5 digits. Maximum of 2 decimal places., Optional
Records the percentage of share owned by the individual or organization.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Shareholder { CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1 scheme published by
International Organization for Standardization (ISO)identifying the country of
the inquired subject.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Shareholder { DataProviderName
string up to 256 chars., Optional
Name identifying the source from which this data was originally obtained by
DnB.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Shareholder { DataProviderName @DNBCodeValue
Attribute
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { Shareholder { DataProviderName@DNBCodeTableNumber
Attribute
End: RegisterSubjectRequest }RegisterSubjectRequestDetail }InquiryDetail } Shareholder
/Aggregate
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { PrimaryAddress
Aggregate, Required
An entry loop to allow the recording of a single primary or physical address of
the subject in multiple languages and/or writing scripts. For an organization
this is the principal address at which the organization is located. For an
individual, this is the home address.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { PrimaryAddress@LanguageCode
Attribute
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { PrimaryAddress@WritingScriptCode
Attribute
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 23
Name Characteristics
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { PrimaryAddress { StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the recording of several
lines where each address line contains one or more named address elements.
Examples of named address elements are Street Name, Street Number,
Building Name, Estate Name. They are called “lines” because an addres can be
divided into multiple lines. When there are multiple lines the sequence of the
lines must be preserved.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { PrimaryAddress { StreetAddressLine { LineText
string up to 240 chars., Required
Text that records the street address components as it would be presented on
an address label. This includes, but is not limited to, details such as street
name, street number, building name, estate name.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { PrimaryAddress { StreetAddressLine { DisplaySequence
int up to 3 digits., Optional
A number which may be used to define the order in which this street address
line should be presented relative to other street address lines where the lower
the number the earlier the data is presented.
End: RegisterSubjectRequest }RegisterSubjectRequestDetail }InquiryDetail } PrimaryAddress }StreetAddressLine
/Aggregate
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { PrimaryAddress { PrimaryTownName
string up to 64 chars., Optional
The name of the town or city recognized by the Postal Authority for delivering
mail.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { PrimaryAddress { PostalCode
string, Optional
An identifier used by the local country Postal Authority to identify a particular
geographic location. For example, in Belgium, Postal Code 9000 identifies the
town of GHENT.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { PrimaryAddress { CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1 scheme published by
International Organization for Standardization (ISO), identifying the country for
this address.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 24
Name Characteristics
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { PrimaryAddress { TerritoryName
string up to 128 chars., Optional
The name of the locally governed area which forms part of a centrally governed
nation as received by D&B. Clarification Note: As a guiding principle this is a
geographic area which could theoretically exist as a separate nation. In the U.S.
this would be a State. In the UK this would be one of the Home Nations.
End: RegisterSubjectRequest }RegisterSubjectRequestDetail }InquiryDetail } PrimaryAddress
/Aggregate
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { SalesRevenueAmount
decimal, Optional
The monetary value of income received from customers from the sale of the
business' goods and/or services. This means it is the gross sales minus any
returns, rebates/discounts, allowances for damages or shortages, shipping
expenses passed on to the customer, and amounts due where there is not a
reasonable expectation of collection.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { SalesRevenueAmount@UnitOfSize
Attribute
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { SalesRevenueAmount@CurrencyISOAlpha3Code
Attribute
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { SalesRevenueAmount@ReliabilityText
Attribute
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { SubjectIdentificationNumberDetail
Aggregate, Optional (Infinite)
Records the address details where the Organization Identification Number is
registered.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { SubjectIdentificationNumberDetail@DNBCodeValue
Attribute
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { SubjectIdentificationNumberDetail@DNBCodeTableNumber
Attribute
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 25
Name Characteristics
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { SubjectIdentificationNumberDetail@TypeText
Attribute
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { SubjectIdentificationNumberDetail { SubjectIdentificationNumber
string at least 1 chars. up to 40 chars., Required
A number assigned by an external body or by D&B which either uniquely
identifies or helps to identify the subject.
End: RegisterSubjectRequest }RegisterSubjectRequestDetail }InquiryDetail }SubjectIdentificationNumberDetail
/Aggregate
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { EntityTypeText
EntityTypeEnumeration, Optional
Text describes whether the entity is Person or Organization.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { TelephoneNumber
Aggregate, Optional
Records information about the different modes of Telecommunication
addresses used by a subject for external contact purposes.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { TelephoneNumber { TelecommunicationNumber
string at least 1 chars. up to 50 chars., Required
A sequence of digits used by the subject for voice communication in a public
switched telephone network. This sequence of digits includes the area code or
city code. Note: This number does not include the International Dialing Code
and Domestic Dialing Code.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryDetail { TelephoneNumber { InternationalDialingCode
string up to 7 chars., Optional
The country calling code assigned by the International Telecommunication
Union (ITU) required to connect to this Telecommunication Number of the
subject country when dialing from outside the subject country; e.g., '1 ' for the
US, '44' for the UK, '91' for India.
End: RegisterSubjectRequest }RegisterSubjectRequestDetail }InquiryDetail } TelephoneNumber
/Aggregate
End: RegisterSubjectRequest }RegisterSubjectRequestDetail }InquiryDetail
/Aggregate
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 26
Name Characteristics
RegisterSubjectRequest { RegisterSubjectRequestDetail { RegisterSubjectSpecification
Aggregate, Required
Records data that allows the customer to specify the details of the requested
product. This may include details such as the identifier of the product, the
language in which the product needs to be rendered, the format in which the
product needs to be rendered.
RegisterSubjectRequest { RegisterSubjectRequestDetail { RegisterSubjectSpecification { DNBProductID
string up to 64 chars., Required
RegisterSubjectRequest { RegisterSubjectRequestDetail { RegisterSubjectSpecification { LanguagePreferenceCode
integer up to 7 digits., Optional
A D&B code value that defines the language in which the customer wants this
product to be rendered.
RegisterSubjectRequest { RegisterSubjectRequestDetail { RegisterSubjectSpecification { CharacterSetPreferenceCode
integer up to 7 digits., Optional
A D&B code value denoting the set of graphic symbols (e.g., alphabet letter,
pictograph) in which the product is to be rendered, e.g., Unicode.
RegisterSubjectRequest { RegisterSubjectRequestDetail { RegisterSubjectSpecification { DUNSInvestigationRequiredIndicator
boolean, Optional
When true (set to 1) it indicates if Automatic DUNS investigation is required or
not if returned unmatched. Note: This element need not be generated for the
FALSE condition.
RegisterSubjectRequest { RegisterSubjectRequestDetail { RegisterSubjectSpecification { OptOutOnDataUnavailableIndicator
boolean, Optional
When true (set to 1) it denotes that the Supplier Registration process should be
aborted when D&B is unable to append data on the supplier; e.g., D&B was not
able to match a DUNS, D&B data is out of date. Note: This element need not be
generated for the FALSE condition.
RegisterSubjectRequest { RegisterSubjectRequestDetail { RegisterSubjectSpecification { MatchSpecification
Aggregate, Optional
RegisterSubjectRequest { RegisterSubjectRequestDetail { RegisterSubjectSpecification { MatchSpecification { ConfidenceLowerLevelThresholdValue
int up to 2 digits., Optional
A numeric value from 1 (low) up to 10 (high) indicating the required level of
certainty at which a possible Candidate should be included in the result set.
End: RegisterSubjectRequest }RegisterSubjectRequestDetail }RegisterSubjectSpecification }MatchSpecification
/Aggregate
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 27
Name Characteristics
End: RegisterSubjectRequest }RegisterSubjectRequestDetail }RegisterSubjectSpecification
/Aggregate
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryReferenceDetail
Aggregate, Optional
Records data that allows the customer to specify information to be linked to
the request in order to support subsequent order reconciliation.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryReferenceDetail { CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to be linked to the
product in order to support subsequent order reconciliation.
RegisterSubjectRequest { RegisterSubjectRequestDetail { InquiryReferenceDetail { CustomerBillingEndorsementText
string at least 1 chars. up to 240 chars., Optional
Text that is filled in by customer and commonly contains requesting individual
or department name, or customer's own account/reference number and/or
name for the case on which the product was provided.This text is a reference
used during the billing process.
End: RegisterSubjectRequest }RegisterSubjectRequestDetail }InquiryReferenceDetail
/Aggregate
End: RegisterSubjectRequest }RegisterSubjectRequestDetail
/Aggregate
End: RegisterSubjectRequest /Aggregate
Sample Request
POST https://maxcvservices.dnb.com/V1.0/compliancecheck/subjects HTTP/1.1Accept-Encoding: gzip,deflateContent-Type: application/jsonAuthorization: <MyToken>
{"com$RegisterSubjectRequest": {"@xmlns$com": "http://services.dnb.com/ComplianceCheckServiceV2.0","@ServiceVersionNumber": "?","TransactionDetail": {
"ApplicationTransactionID": "0412199","TransactionTimestamp": "2013-04-12T10:03:27.397-04:00","SubmittingOfficeID": "334"
},"RegisterSubjectRequestDetail": {
"InquiryDetail": {
D&B Direct API Documentation Sample Request
©Dun & Bradstreet, Inc. 2014 28
"SubjectName": "CTS","DUNSNumber": "804735132","ApplicationSubjectID": "AppID_001","Principal": {
"NamePrefixText": "Mr.","PrincipalName": {
"@NameIdentificationNumber": "1","$": "Kevin J Hunt"
},"JobTitle": {"JobTitleText": {
"$": "Sec-treas"}},"CountryISOAlpha2Code": "US"
},"Shareholder": {
"NamePrefixText": "Mike","ShareholderName": {
"$": "Mike"},"ShareholdingPercentage": "5","CountryISOAlpha2Code": "CA"
},"PrimaryAddress": {
"StreetAddressLine": {"LineText": "492 KOLLER STREET"
},"PrimaryTownName": "San Francisco","PostalCode": "94110","CountryISOAlpha2Code": "US","TerritoryName": "CA"
},"EntityTypeText": "Organization"
},"RegisterSubjectSpecification": {
"DNBProductID": "LVL2_FULGRD","DUNSInvestigationRequiredIndicator": "false","OptOutOnDataUnavailableIndicator": "true","MatchSpecification": {"ConfidenceLowerLevelThresholdValue": "8
"}},"InquiryReferenceDetail": {"CustomerReferenceText": "Registratio
n-Gorman","CustomerBillingEndorsementText": "Registration-Gorman"}}
D&B Direct API Documentation Sample Request
©Dun & Bradstreet, Inc. 2014 29
}}
Testing / Sandbox
This operation is currently unavailable in the D&B Direct sandbox (test) environment.
Data Field Response
The following is a list of the possible data fields returned by this operation in the JSON response.
Name Characteristics
RegisterSubjectResponse Aggregate
RegisterSubjectResponse@ServiceVersionNumber
Attribute
RegisterSubjectResponse { TransactionDetail
Aggregate, Required
Records information necessary to process a particular request. Examples of a request
is the ordering of a product.
RegisterSubjectResponse { TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely identify this request.
RegisterSubjectResponse { TransactionDetail { ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely identify this transaction.
RegisterSubjectResponse { TransactionDetail { TransactionTimestamp
DateTimestamp, Required
The date and time when this request was submitted or the date and time when the
requesting intermediary, such as a workflow manager or service bus, sent the
message to the D&B function, i.e., the date and time when the xml document was
created by the requesting intermediary.
End: RegisterSubjectResponse} TransactionDetail
/Aggregate
RegisterSubjectResponse { TransactionResult
Aggregate, Required
An aggregate that can repeat multiple times to record the different outcomes of the
transaction.
RegisterSubjectResponse { TransactionResult { SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g., Information, Warning, Error, Fatal.
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2014 30
Name Characteristics
RegisterSubjectResponse { TransactionResult { ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the outcome of the transaction.
RegisterSubjectResponse { TransactionResult { ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
RegisterSubjectResponse { TransactionResult { ResultMessage
Aggregate, Optional (Infinite)
An aggregate that can repeat multiple times to record textual data that expands on
the ResultID and ResultText to provide additional information to the user regarding the
status of the transaction. If the status implies that there is a problem this may also
provide guidance to the user on how to address it.
RegisterSubjectResponse { TransactionResult { ResultMessage { ResultMessageID
string up to 30 chars., Optional
An alphanumeric string that uniquely identifies the additional information regarding
the outcome of the transaction.
RegisterSubjectResponse { TransactionResult { ResultMessage { ResultDescription
string up to 512 chars., Required
Text that describes the additional information regarding the outcome of the
transaction.
RegisterSubjectResponse { TransactionResult { ResultMessage { NonSpecificDataProviderText
string up to 30 chars., Optional
Text that describes, in general terms, the source from which the Result Message data
was originally obtained by D&B; e.g. Credit Bureau.
End: RegisterSubjectResponse} TransactionResult }ResultMessage
/Aggregate
End: RegisterSubjectResponse} TransactionResult
/Aggregate
RegisterSubjectResponse { RegisterSubjectResponseDetail
Aggregate, Optional
RegisterSubjectResponse { RegisterSubjectResponseDetail{ ComplianceSubject
Aggregate, Required
RegisterSubjectResponse { RegisterSubjectResponseDetail{ ComplianceSubject { SubjectID
SubjectIDType up to 25 chars., Required
A number uniquely identifying the registered subject
End: RegisterSubjectResponse}RegisterSubjectResponseDetail} ComplianceSubject
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 31
Name Characteristics
End: RegisterSubjectResponse}RegisterSubjectResponseDetail
/Aggregate
End: RegisterSubjectResponse /Aggregate
Lists of possible values (when present) are subject to change. Additional values not presented in this documentation may be delivered
in the response and should be anticipated in any implementation.
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM002, CM004 and SC001-SC009.
Operation-specific supplemental response code explanations:
CM002 The format of this request is invalid.
CM004 Internal D&B system error.
Note: Some service levels will invoke additional processes upon successful completion of a RegisterSubjectoperation call. In the event that an additional process fails, an error response will be delivered. Refer to theGetSubjectComplianceData operation for details.
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Compliance Check Service
Samples http://developer.dnb.com/docs/2.0/compliance/1.0/DnB-Compliance.zip
Related Topics
ListComplianceSubjects (REST), GetComplianceSubjectData (REST), On-Demand Entity Identification, DetailedCompany Profile - Enhanced, Linkage Product Service - Enhanced, Data Products by Category.
D&B Direct API Documentation Response Codes
©Dun & Bradstreet, Inc. 2014 32
RegisterSubject (SOAP)This operation -- part of the Compliance Check Service -- is a component of the Compliance √ Screeningsolution.
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Note: While the Compliance √ Screening features are accessed through the D&B Direct service, separatecredentials are required for each data environment and will be provided by a D&B sales representative.
Endpoint
https://maxcvservices.dnb.com/ComplianceCheckService/V{version}
Request Parameters
The following parameters are accepted by this operation.
Exception: The subjects (and corresponding data and alerts) registered by this operation will be accessible toALL user credentials associated with the customer contract.
If an application requires filtering by user credentials, a possible solution would be to place a unique value inthe CustomerReferenceText field when registering subjects, and then supply the same value to theListComplianceSubjects operation.
Name Characteristics
RegisterSubjectRequest Aggregate
RegisterSubjectRequest@ServiceVersionNumber
Attribute
RegisterSubjectRequest.TransactionDetail
Aggregate, Optional
Records information necessary to process this request.
RegisterSubjectRequest.TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely identify this request.
D&B Direct API Documentation RegisterSubject (SOAP)
©Dun & Bradstreet, Inc. 2014 33
Name Characteristics
RegisterSubjectRequest.TransactionDetail.TransactionTimestamp
DateTimestamp, Optional
The date and time when this request was created. When the request is from
an intermediary, such as a workflow manager or service bus, this is the date
and time when the message was sent to the D&B function, i.e., the date and
time when the xml document was created by the requesting intermediary.
RegisterSubjectRequest.TransactionDetail. SubmittingOfficeID
string up to 64 chars., Optional
A number that identifies the system or the software application from where
this request originated. / A number used to uniquely identfy the D&B business
segment or delivery channel from where this request originated.
End: RegisterSubjectRequest.TransactionDetail
/Aggregate
RegisterSubjectRequest.RegisterSubjectRequestDetail
Aggregate, Required
Records data relating to requests for supplier registeration. This may include
such details as the product required, the subject about which the product
should be produced, the content of the product.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail
Aggregate, Required
Records data that allows the supplier to specify identifying information about
the subject being inquired, e.g., the DUNS Number, SupplierName etc.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. ProjectID
string up to 64 chars., Optional
An internal project identifciation provided by customer to uniquely identify the
record
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. SubjectName
_, Required
The name of the individual or organization from which the subject purchases
goods or services.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. DUNSNumber
string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Optional
The D-U-N-S Number is D&B's identification number, which provides unique
identification of this organization, in accordance with the Data Universal
Numbering System (D-U-N-S).
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. ApplicationSubjectID
ApplicationSubjectIDType up to 20 chars., Optional
A number uniquely identifying the inquired subject within the application.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 34
Name Characteristics
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Principal
Aggregate, Optional(Up to 6x)
Records the information of each principal that are actively associated with the
subject organization.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Principal.NamePrefixText
string up to 512 chars., Optional
Text defining the correct form of address for this individual. E.g., Dr, Professor,
Lord etc.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Principal. PrincipalName
_, Optional
Records the different names for the Principal.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Principal. PrincipalName@NameIdentificationNumber
Attribute
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Principal. JobTitle
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the recording of the
name used by the organization to describe this person's job, e.g., Leader Global
Communication, Manager National Technical Support Center.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Principal. JobTitle.JobTitleText
string up to 3000 chars., Optional
Text that denotes a position held by the principal or manager.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Principal. JobTitle.JobTitleText@WritingScriptISOAlpha4Code
Attribute
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Principal. JobTitle.JobTitleText @LanguageCode
Attribute
End: RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Principal. JobTitle
/Aggregate
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Principal.CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1 scheme published by
International Organization for Standardization (ISO)identifying the country of
the inquired subject.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 35
Name Characteristics
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Principal.DataProviderName
string up to 256 chars., Optional
Name identifying the source from which this data was originally obtained by
DnB.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Principal.DataProviderName @DNBCodeValue
Attribute
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Principal.DataProviderName@DNBCodeTableNumber
Attribute
End: RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Principal
/Aggregate
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Shareholder
Aggregate, Optional(Up to 6x)
Records the information of individual or organization that legally owns a share
of stock in a public or private organization.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Shareholder.NamePrefixText
string up to 512 chars., Optional
Text defining the correct form of address for this individual. E.g., Dr, Professor,
Lord etc.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Shareholder.ShareholderName
_, Optional
The name of the individual or organization that legally who owns a share of
stock in a public or private organization.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Shareholder.ShareholderName@NameIdentificationNumber
Attribute
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Shareholder.ShareholdingPercentage
decimal up to 5 digits. Maximum of 2 decimal places., Optional
Records the percentage of share owned by the individual or organization.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Shareholder.CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1 scheme published by
International Organization for Standardization (ISO)identifying the country of
the inquired subject.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 36
Name Characteristics
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Shareholder.DataProviderName
string up to 256 chars., Optional
Name identifying the source from which this data was originally obtained by
DnB.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Shareholder.DataProviderName @DNBCodeValue
Attribute
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Shareholder.DataProviderName@DNBCodeTableNumber
Attribute
End: RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. Shareholder
/Aggregate
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. PrimaryAddress
Aggregate, Required
An entry loop to allow the recording of a single primary or physical address of
the subject in multiple languages and/or writing scripts. For an organization
this is the principal address at which the organization is located. For an
individual, this is the home address.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. PrimaryAddress@LanguageCode
Attribute
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. PrimaryAddress@WritingScriptCode
Attribute
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. PrimaryAddress.StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the recording of several
lines where each address line contains one or more named address elements.
Examples of named address elements are Street Name, Street Number,
Building Name, Estate Name. They are called “lines” because an addres can be
divided into multiple lines. When there are multiple lines the sequence of the
lines must be preserved.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 37
Name Characteristics
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. PrimaryAddress.StreetAddressLine. LineText
string up to 240 chars., Required
Text that records the street address components as it would be presented on
an address label. This includes, but is not limited to, details such as street
name, street number, building name, estate name.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. PrimaryAddress.StreetAddressLine. DisplaySequence
int up to 3 digits., Optional
A number which may be used to define the order in which this street address
line should be presented relative to other street address lines where the lower
the number the earlier the data is presented.
End: RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. PrimaryAddress.StreetAddressLine
/Aggregate
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. PrimaryAddress.PrimaryTownName
string up to 64 chars., Optional
The name of the town or city recognized by the Postal Authority for delivering
mail.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. PrimaryAddress.PostalCode
string, Optional
An identifier used by the local country Postal Authority to identify a particular
geographic location. For example, in Belgium, Postal Code 9000 identifies the
town of GHENT.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. PrimaryAddress.CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1 scheme published by
International Organization for Standardization (ISO), identifying the country for
this address.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. PrimaryAddress.TerritoryName
string up to 128 chars., Optional
The name of the locally governed area which forms part of a centrally governed
nation as received by D&B. Clarification Note: As a guiding principle this is a
geographic area which could theoretically exist as a separate nation. In the U.S.
this would be a State. In the UK this would be one of the Home Nations.
End: RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. PrimaryAddress
/Aggregate
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 38
Name Characteristics
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. SalesRevenueAmount
decimal, Optional
The monetary value of income received from customers from the sale of the
business' goods and/or services. This means it is the gross sales minus any
returns, rebates/discounts, allowances for damages or shortages, shipping
expenses passed on to the customer, and amounts due where there is not a
reasonable expectation of collection.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. SalesRevenueAmount@UnitOfSize
Attribute
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. SalesRevenueAmount@CurrencyISOAlpha3Code
Attribute
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. SalesRevenueAmount@ReliabilityText
Attribute
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail.SubjectIdentificationNumberDetail
Aggregate, Optional (Infinite)
Records the address details where the Organization Identification Number is
registered.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail.SubjectIdentificationNumberDetail@DNBCodeValue
Attribute
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail.SubjectIdentificationNumberDetail@DNBCodeTableNumber
Attribute
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail.SubjectIdentificationNumberDetail@TypeText
Attribute
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail.SubjectIdentificationNumberDetail.SubjectIdentificationNumber
string at least 1 chars. up to 40 chars., Required
A number assigned by an external body or by D&B which either uniquely
identifies or helps to identify the subject.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 39
Name Characteristics
End: RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail.SubjectIdentificationNumberDetail
/Aggregate
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. EntityTypeText
EntityTypeEnumeration, Optional
Text describes whether the entity is Person or Organization.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. TelephoneNumber
Aggregate, Optional
Records information about the different modes of Telecommunication
addresses used by a subject for external contact purposes.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. TelephoneNumber.TelecommunicationNumber
string at least 1 chars. up to 50 chars., Required
A sequence of digits used by the subject for voice communication in a public
switched telephone network. This sequence of digits includes the area code or
city code. Note: This number does not include the International Dialing Code
and Domestic Dialing Code.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. TelephoneNumber.InternationalDialingCode
string up to 7 chars., Optional
The country calling code assigned by the International Telecommunication
Union (ITU) required to connect to this Telecommunication Number of the
subject country when dialing from outside the subject country; e.g., '1 ' for the
US, '44' for the UK, '91' for India.
End: RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail. TelephoneNumber
/Aggregate
End: RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryDetail
/Aggregate
RegisterSubjectRequest.RegisterSubjectRequestDetail.RegisterSubjectSpecification
Aggregate, Required
Records data that allows the customer to specify the details of the requested
product. This may include details such as the identifier of the product, the
language in which the product needs to be rendered, the format in which the
product needs to be rendered.
RegisterSubjectRequest.RegisterSubjectRequestDetail.RegisterSubjectSpecification.DNBProductID
string up to 64 chars., Required
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 40
Name Characteristics
RegisterSubjectRequest.RegisterSubjectRequestDetail.RegisterSubjectSpecification.LanguagePreferenceCode
integer up to 7 digits., Optional
A D&B code value that defines the language in which the customer wants this
product to be rendered.
RegisterSubjectRequest.RegisterSubjectRequestDetail.RegisterSubjectSpecification.CharacterSetPreferenceCode
integer up to 7 digits., Optional
A D&B code value denoting the set of graphic symbols (e.g., alphabet letter,
pictograph) in which the product is to be rendered, e.g., Unicode.
RegisterSubjectRequest.RegisterSubjectRequestDetail.RegisterSubjectSpecification.DUNSInvestigationRequiredIndicator
boolean, Optional
When true (set to 1) it indicates if Automatic DUNS investigation is required or
not if returned unmatched. Note: This element need not be generated for the
FALSE condition.
RegisterSubjectRequest.RegisterSubjectRequestDetail.RegisterSubjectSpecification.OptOutOnDataUnavailableIndicator
boolean, Optional
When true (set to 1) it denotes that the Supplier Registration process should be
aborted when D&B is unable to append data on the supplier; e.g., D&B was not
able to match a DUNS, D&B data is out of date. Note: This element need not be
generated for the FALSE condition.
RegisterSubjectRequest.RegisterSubjectRequestDetail.RegisterSubjectSpecification.MatchSpecification
Aggregate, Optional
RegisterSubjectRequest.RegisterSubjectRequestDetail.RegisterSubjectSpecification.MatchSpecification.ConfidenceLowerLevelThresholdValue
int up to 2 digits., Optional
A numeric value from 1 (low) up to 10 (high) indicating the required level of
certainty at which a possible Candidate should be included in the result set.
End: RegisterSubjectRequest.RegisterSubjectRequestDetail.RegisterSubjectSpecification.MatchSpecification
/Aggregate
End: RegisterSubjectRequest.RegisterSubjectRequestDetail.RegisterSubjectSpecification
/Aggregate
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryReferenceDetail
Aggregate, Optional
Records data that allows the customer to specify information to be linked to
the request in order to support subsequent order reconciliation.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 41
Name Characteristics
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryReferenceDetail.CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to be linked to the
product in order to support subsequent order reconciliation.
RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryReferenceDetail.CustomerBillingEndorsementText
string at least 1 chars. up to 240 chars., Optional
Text that is filled in by customer and commonly contains requesting individual
or department name, or customer's own account/reference number and/or
name for the case on which the product was provided.This text is a reference
used during the billing process.
End: RegisterSubjectRequest.RegisterSubjectRequestDetail.InquiryReferenceDetail
/Aggregate
End: RegisterSubjectRequest.RegisterSubjectRequestDetail
/Aggregate
End: RegisterSubjectRequest /Aggregate
Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:com="http://services.dnb.com/ComplianceCheckServiceV2.0">
<soapenv:Header><wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://do
cs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken-2"><wsse:Username>MyUsername</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>
<com:RegisterSubjectRequest ServiceVersionNumber="?"><TransactionDetail>
<ApplicationTransactionID>GoodYear</ApplicationTransactionID>
<TransactionTimestamp>2013-04-12T10:03:27.397-04:00</TransactionTimestamp>
D&B Direct API Documentation Sample Request
©Dun & Bradstreet, Inc. 2014 42
<SubmittingOfficeID>333</SubmittingOfficeID></TransactionDetail><RegisterSubjectRequestDetail>
<InquiryDetail><SubjectName>Standard Chartered</SubjectName><ApplicationSubjectID>10001</ApplicationSubjectID><PrimaryAddress LanguageCode="3" WritingScriptCode="
4"><StreetAddressLine>
<LineText>6601 NE 78 Court Ste 815</LineText><DisplaySequence>1</DisplaySequence>
</StreetAddressLine><PrimaryTownName>Portland</PrimaryTownName><PostalCode>10504</PostalCode><CountryISOAlpha2Code>US</CountryISOAlpha2Code><TerritoryName>FL</TerritoryName>
</PrimaryAddress><EntityTypeText>Organization</EntityTypeText>
</InquiryDetail><RegisterSubjectSpecification>
<DNBProductID>LVL1_BSGRD</DNBProductID><DUNSInvestigationRequiredIndicator>true</DUNSInvestig
ationRequiredIndicator><MatchSpecification>
<ConfidenceLowerLevelThresholdValue>9</ConfidenceLowerLevelThresholdValue>
</MatchSpecification></RegisterSubjectSpecification><InquiryReferenceDetail>
<CustomerReferenceText>TC9</CustomerReferenceText><CustomerBillingEndorsementText>TC9</CustomerBillingEn
dorsementText></InquiryReferenceDetail>
</RegisterSubjectRequestDetail></com:RegisterSubjectRequest>
</soapenv:Body></soapenv:Envelope>
Testing / Sandbox
This operation is currently unavailable in the D&B Direct sandbox (test) environment.
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2014 43
Data Field Response
The following is a list of the possible data fields returned by this operation in the XML response.
Name Characteristics
RegisterSubjectResponse Aggregate
RegisterSubjectResponse@ServiceVersionNumber
Attribute
RegisterSubjectResponse.TransactionDetail
Aggregate, Required
Records information necessary to process a particular request. Examples of a request
is the ordering of a product.
RegisterSubjectResponse.TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely identify this request.
RegisterSubjectResponse.TransactionDetail.ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely identify this transaction.
RegisterSubjectResponse.TransactionDetail.TransactionTimestamp
DateTimestamp, Required
The date and time when this request was submitted or the date and time when the
requesting intermediary, such as a workflow manager or service bus, sent the
message to the D&B function, i.e., the date and time when the xml document was
created by the requesting intermediary.
End: RegisterSubjectResponse.TransactionDetail
/Aggregate
RegisterSubjectResponse.TransactionResult
Aggregate, Required
An aggregate that can repeat multiple times to record the different outcomes of the
transaction.
RegisterSubjectResponse.TransactionResult. SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g., Information, Warning, Error,
Fatal.
RegisterSubjectResponse.TransactionResult. ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the outcome of the transaction.
RegisterSubjectResponse.TransactionResult. ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 44
Name Characteristics
RegisterSubjectResponse.TransactionResult.ResultMessage
Aggregate, Optional (Infinite)
An aggregate that can repeat multiple times to record textual data that expands on
the ResultID and ResultText to provide additional information to the user regarding
the status of the transaction. If the status implies that there is a problem this may
also provide guidance to the user on how to address it.
RegisterSubjectResponse.TransactionResult.ResultMessage.ResultMessageID
string up to 30 chars., Optional
An alphanumeric string that uniquely identifies the additional information regarding
the outcome of the transaction.
RegisterSubjectResponse.TransactionResult.ResultMessage.ResultDescription
string up to 512 chars., Required
Text that describes the additional information regarding the outcome of the
transaction.
RegisterSubjectResponse.TransactionResult.ResultMessage.NonSpecificDataProviderText
string up to 30 chars., Optional
Text that describes, in general terms, the source from which the Result Message data
was originally obtained by D&B; e.g. Credit Bureau.
End: RegisterSubjectResponse.TransactionResult.ResultMessage
/Aggregate
End: RegisterSubjectResponse.TransactionResult
/Aggregate
RegisterSubjectResponse.RegisterSubjectResponseDetail
Aggregate, Optional
RegisterSubjectResponse.RegisterSubjectResponseDetail.ComplianceSubject
Aggregate, Required
RegisterSubjectResponse.RegisterSubjectResponseDetail.ComplianceSubject. SubjectID
SubjectIDType up to 25 chars., Required
A number uniquely identifying the registered subject
End: RegisterSubjectResponse.RegisterSubjectResponseDetail.ComplianceSubject
/Aggregate
End: RegisterSubjectResponse.RegisterSubjectResponseDetail
/Aggregate
End: RegisterSubjectResponse /Aggregate
Lists of possible values (when present) are subject to change. Additional values not presented in this documentation may be delivered
in the response and should be anticipated in any implementation.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 45
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM002, CM004 and SC001-SC009.
Operation-specific supplemental response code explanations:
CM002 The format of this request is invalid.
CM004 Internal D&B system error.
Note: Some service levels will invoke additional processes upon successful completion of a RegisterSubjectoperation call. In the event that an additional process fails, an error response will be delivered. Refer to theGetSubjectComplianceData operation for details.
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Compliance Check Service
Samples http://developer.dnb.com/docs/2.0/compliance/1.0/DnB-Compliance.zip
Related Topics
ListComplianceSubjects (SOAP), GetComplianceSubjectData (SOAP), GetComplianceAlerts (SOAP), On-DemandEntity Identification, Detailed Company Profile - Enhanced, Linkage Product Service - Enhanced, Data Productsby Category.
D&B Direct API Documentation Response Codes
©Dun & Bradstreet, Inc. 2014 46
UpdateSubjectRegistation (REST)This operation -- part of the Compliance Check Service -- is a component of the Compliance √ Screeningsolution.
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Note: While the Compliance √ Screening features are accessed through the D&B Direct service, separatecredentials are required for each data environment and will be provided by a D&B sales representative.
Endpoint
PUT https://maxcvservices.dnb.com/V{version}/compliancecheck/subjects/{subjectID}
Request Parameters
The following parameters are accepted by this operation.
Name Characteristics
{subjectID} SubjectIDType up to 25 chars., Required
A number uniquely identifying the
inquired subject within the D&B
Worldwide Network.
Restriction: The sequence of Request Parameters submitted to POST/PUT operations currently MUST followthe order presented in this section. This applies to REST calls only.
Restriction: For POST/PUT requests, the ‘Accept’ header item should be set to ‘application/json’ or be leftempty. If the value submitted is ‘*/*’, the service will return an error. This applies to REST calls only.
Restriction: An XML namespace statement MUST be included as the first statement within the primaryAggregate of the request. Please refer to the Sample Request for an example. This applies to REST calls only.
Restriction: In addition to the previous restriction, the statement listing the primary Aggregate MUST beprefixed with the corresponding namespace. Please refer to the Sample Request for an example.
D&B Direct API Documentation UpdateSubjectRegistation (REST)
©Dun & Bradstreet, Inc. 2014 47
Name Characteristics
UpdateSubjectRegistrationRequest Aggregate
UpdateSubjectRegistrationRequest@ServiceVersionNumber
Attribute
UpdateSubjectRegistrationRequest { TransactionDetail
Aggregate, Optional
Records information necessary to process this request.
UpdateSubjectRegistrationRequest { TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely identify this
request.
UpdateSubjectRegistrationRequest { TransactionDetail { TransactionTimestamp
DateTimestamp, Optional
The date and time when this request was created. When the request is
from an intermediary, such as a workflow manager or service bus, this is the
date and time when the message was sent to the D&B function, i.e., the
date and time when the xml document was created by the requesting
intermediary.
UpdateSubjectRegistrationRequest { TransactionDetail { SubmittingOfficeID
string up to 64 chars., Optional
A number that identifies the system or the software application from where
this request originated. / A number used to uniquely identfy the D&B
business segment or delivery channel from where this request originated.
End: UpdateSubjectRegistrationRequest} TransactionDetail
/Aggregate
UpdateSubjectRegistrationRequest { UpdateSubjectRegistrationRequestDetail
Aggregate, Required
UpdateSubjectRegistrationRequest { UpdateSubjectRegistrationRequestDetail{ RegistrationStatusText
RegistrationStatusEnum, Optional
Records the status of the registration
Possible values: Active; Cancelled
End: UpdateSubjectRegistrationRequest}UpdateSubjectRegistrationRequestDetail
/Aggregate
End: UpdateSubjectRegistrationRequest /Aggregate
Sample Request
PUT https://maxcvservices.dnb.com/V1.0/compliancecheck/subjects/1025653 HTTP/1.1Authorization: MyToken
D&B Direct API Documentation Sample Request
©Dun & Bradstreet, Inc. 2014 48
{"com$UpdateSubjectRegistrationRequest": {"@xmlns$com": "http://services.dnb.com/ComplianceCheckServiceV2.0","TransactionDetail": {
"ApplicationTransactionID": "Year","TransactionTimestamp": "2013-04-12T10:03:27.397-04:00","SubmittingOfficeID": "333"
},"UpdateSubjectRegistrationRequestDetail":{}}
}
Testing / Sandbox
This operation is currently unavailable in the D&B Direct sandbox (test) environment.
Data Field Response
The following is a list of the possible data fields returned by this operation in the JSON response.
Name Characteristics
UpdateSubjectRegistrationResponse Aggregate
UpdateSubjectRegistrationResponse@ServiceVersionNumber
Attribute
UpdateSubjectRegistrationResponse{ TransactionDetail
Aggregate, Required
Records information necessary to process a particular request. Examples of a
request is the ordering of a product.
UpdateSubjectRegistrationResponse{ TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely identify this request.
UpdateSubjectRegistrationResponse{ TransactionDetail { ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely identify this transaction.
UpdateSubjectRegistrationResponse{ TransactionDetail { TransactionTimestamp
DateTimestamp, Required
The date and time when this request was submitted or the date and time when
the requesting intermediary, such as a workflow manager or service bus, sent
the message to the D&B function, i.e., the date and time when the xml
document was created by the requesting intermediary.
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2014 49
Name Characteristics
End:UpdateSubjectRegistrationResponse} TransactionDetail
/Aggregate
UpdateSubjectRegistrationResponse{ TransactionResult
Aggregate, Required
An aggregate that can repeat multiple times to record the different outcomes of
the transaction.
UpdateSubjectRegistrationResponse{ TransactionResult { SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g., Information, Warning, Error,
Fatal.
UpdateSubjectRegistrationResponse{ TransactionResult { ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the outcome of the transaction.
UpdateSubjectRegistrationResponse{ TransactionResult { ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
UpdateSubjectRegistrationResponse{ TransactionResult { ResultMessage
Aggregate, Optional (Infinite)
An aggregate that can repeat multiple times to record textual data that expands
on the ResultID and ResultText to provide additional information to the user
regarding the status of the transaction. If the status implies that there is a
problem this may also provide guidance to the user on how to address it.
UpdateSubjectRegistrationResponse{ TransactionResult { ResultMessage{ ResultMessageID
string up to 30 chars., Optional
An alphanumeric string that uniquely identifies the additional information
regarding the outcome of the transaction.
UpdateSubjectRegistrationResponse{ TransactionResult { ResultMessage{ ResultDescription
string up to 512 chars., Required
Text that describes the additional information regarding the outcome of the
transaction.
UpdateSubjectRegistrationResponse{ TransactionResult { ResultMessage{ NonSpecificDataProviderText
string up to 30 chars., Optional
Text that describes, in general terms, the source from which the Result Message
data was originally obtained by D&B; e.g. Credit Bureau.
End:UpdateSubjectRegistrationResponse} TransactionResult } ResultMessage
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 50
Name Characteristics
End:UpdateSubjectRegistrationResponse} TransactionResult
/Aggregate
End:UpdateSubjectRegistrationResponse
/Aggregate
Lists of possible values (when present) are subject to change. Additional values not presented in this documentation may be delivered
in the response and should be anticipated in any implementation.
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM002, CM004, CM018 and SC001-SC009.
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Compliance Check Service
Samples http://developer.dnb.com/docs/2.0/compliance/1.0/DnB-Compliance.zip
Related Topics
D&B Direct API Documentation Response Codes
©Dun & Bradstreet, Inc. 2014 51
UpdateSubjectRegistration (SOAP)This operation -- part of the Compliance Check Service -- is a component of the Compliance √ Screeningsolution.
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Note: While the Compliance √ Screening features are accessed through the D&B Direct service, separatecredentials are required for each data environment and will be provided by a D&B sales representative.
Endpoint
https://maxcvservices.dnb.com/ComplianceCheckService/V{version}
Request Parameters
The following parameters are accepted by this operation.
Name Characteristics
UpdateSubjectRegistrationRequest Aggregate
UpdateSubjectRegistrationRequest@ServiceVersionNumber
Attribute
UpdateSubjectRegistrationRequest.TransactionDetail
Aggregate, Optional
Records information necessary to process this request.
UpdateSubjectRegistrationRequest.TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely identify this
request.
UpdateSubjectRegistrationRequest.TransactionDetail.TransactionTimestamp
DateTimestamp, Optional
The date and time when this request was created. When the request is
from an intermediary, such as a workflow manager or service bus, this is
the date and time when the message was sent to the D&B function, i.e.,
the date and time when the xml document was created by the requesting
intermediary.
D&B Direct API Documentation UpdateSubjectRegistration (SOAP)
©Dun & Bradstreet, Inc. 2014 52
Name Characteristics
UpdateSubjectRegistrationRequest.TransactionDetail. SubmittingOfficeID
string up to 64 chars., Optional
A number that identifies the system or the software application from
where this request originated. / A number used to uniquely identfy the D&B
business segment or delivery channel from where this request originated.
End: UpdateSubjectRegistrationRequest.TransactionDetail
/Aggregate
UpdateSubjectRegistrationRequest.UpdateSubjectRegistrationRequestDetail
Aggregate, Required
UpdateSubjectRegistrationRequest.UpdateSubjectRegistrationRequestDetail.SubjectID
SubjectIDType up to 25 chars., Required
A number uniquely identifying the inquired subject within the D&B
Worldwide Network.
UpdateSubjectRegistrationRequest.UpdateSubjectRegistrationRequestDetail.RegistrationStatusText
RegistrationStatusEnum, Optional
Records the status of the registration
Possible values: Active; Cancelled
End: UpdateSubjectRegistrationRequest.UpdateSubjectRegistrationRequestDetail
/Aggregate
End: UpdateSubjectRegistrationRequest /Aggregate
Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:com="http://services.dnb.com/ComplianceCheckServiceV2.0">
<soapenv:Header><wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://do
cs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken-2"><wsse:Username>MyUsername</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>
D&B Direct API Documentation Sample Request
©Dun & Bradstreet, Inc. 2014 53
<com:UpdateSubjectRegistrationRequest ServiceVersionNumber="1.0">
<UpdateSubjectRegistrationRequestDetail><SubjectID>100000</SubjectID>
</UpdateSubjectRegistrationRequestDetail></com:UpdateSubjectRegistrationRequest>
</soapenv:Body></soapenv:Envelope>
Testing / Sandbox
This operation is currently unavailable in the D&B Direct sandbox (test) environment.
Data Field Response
The following is a list of the possible data fields returned by this operation in the XML response.
Name Characteristics
UpdateSubjectRegistrationResponse Aggregate
UpdateSubjectRegistrationResponse@ServiceVersionNumber
Attribute
UpdateSubjectRegistrationResponse.TransactionDetail
Aggregate, Required
Records information necessary to process a particular request. Examples of a
request is the ordering of a product.
UpdateSubjectRegistrationResponse.TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely identify this request.
UpdateSubjectRegistrationResponse.TransactionDetail.ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely identify this transaction.
UpdateSubjectRegistrationResponse.TransactionDetail.TransactionTimestamp
DateTimestamp, Required
The date and time when this request was submitted or the date and time when
the requesting intermediary, such as a workflow manager or service bus, sent
the message to the D&B function, i.e., the date and time when the xml
document was created by the requesting intermediary.
End:UpdateSubjectRegistrationResponse.TransactionDetail
/Aggregate
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2014 54
Name Characteristics
UpdateSubjectRegistrationResponse.TransactionResult
Aggregate, Required
An aggregate that can repeat multiple times to record the different outcomes of
the transaction.
UpdateSubjectRegistrationResponse.TransactionResult. SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g., Information, Warning, Error,
Fatal.
UpdateSubjectRegistrationResponse.TransactionResult. ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the outcome of the transaction.
UpdateSubjectRegistrationResponse.TransactionResult. ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
UpdateSubjectRegistrationResponse.TransactionResult. ResultMessage
Aggregate, Optional (Infinite)
An aggregate that can repeat multiple times to record textual data that expands
on the ResultID and ResultText to provide additional information to the user
regarding the status of the transaction. If the status implies that there is a
problem this may also provide guidance to the user on how to address it.
UpdateSubjectRegistrationResponse.TransactionResult. ResultMessage.ResultMessageID
string up to 30 chars., Optional
An alphanumeric string that uniquely identifies the additional information
regarding the outcome of the transaction.
UpdateSubjectRegistrationResponse.TransactionResult. ResultMessage.ResultDescription
string up to 512 chars., Required
Text that describes the additional information regarding the outcome of the
transaction.
UpdateSubjectRegistrationResponse.TransactionResult. ResultMessage.NonSpecificDataProviderText
string up to 30 chars., Optional
Text that describes, in general terms, the source from which the Result Message
data was originally obtained by D&B; e.g. Credit Bureau.
End:UpdateSubjectRegistrationResponse.TransactionResult. ResultMessage
/Aggregate
End:UpdateSubjectRegistrationResponse.TransactionResult
/Aggregate
End:UpdateSubjectRegistrationResponse
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 55
Lists of possible values (when present) are subject to change. Additional values not presented in this documentation may be delivered
in the response and should be anticipated in any implementation.
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM002, CM004, CM018 and SC001-SC009.
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Compliance Check Service
Samples http://developer.dnb.com/docs/2.0/compliance/1.0/DnB-Compliance.zip
Related Topics
D&B Direct API Documentation Response Codes
©Dun & Bradstreet, Inc. 2014 56
ListComplianceSubjects (REST)This operation -- part of the Compliance Check Service -- is a component of the Compliance √ Screeningsolution.
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Note: While the Compliance √ Screening features are accessed through the D&B Direct service, separatecredentials are required for each data environment and will be provided by a D&B sales representative.
Endpoint
GET https://maxcvservices.dnb.com/V{version}/compliancecheck/subjects/
Request Parameters
The following parameters are accepted by this operation.
Exception: The list returned by this operation will include all subjects registered by user credentials associatedwith the customer contract.
If an application requires filtering by user credentials, a possible solution would be to place a unique value inthe CustomerReferenceText field when registering subjects, and then supply the same value to this operation.
Exception: The pagination sequence for this operation starts at zero (rather than one). Also, responsescurrently deliver one less than the per page value specified on the request.
Name Characteristics
SubjectID Element
SubjectName string up to 256 chars., Optional
DUNSNumber string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Optional
The D-U-N-S Number is D&B's identification number,
which provides unique identification of this
organization, in accordance with the Data Universal
Numbering System (D-U-N-S).
D&B Direct API Documentation ListComplianceSubjects (REST)
©Dun & Bradstreet, Inc. 2014 57
Name Characteristics
SortDirectionText SortDirectionEnum, Optional
Text that indicates the direction of sorting, e.g.,
Ascending,Descending.
CandidateMaximumQuantity int up to 6 digits., Optional
The maximum number of candidates expected in the
Search Response.
CandidatePerPageMaximumQuantity int Less than or equal to 1000., Optional
The maximum number of results to be included in a
page.
CandidateDisplayStartSequenceNumber int, Optional
The Display Sequence number of the first record in the
page.
CustomerReferenceText string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to
be linked to the product in order to support subsequent
order reconciliation.
Sample Request
GET http://services-ext.dnb.com/V1.0/compliancecheck/subjects?SortDirectionText=Ascending&CandidateDisplayStartSequenceNumber=1&CandidatePerPageMaximumQuantity=10Authorization: <My Token>
Testing / Sandbox
This operation is currently unavailable in the D&B Direct sandbox (test) environment.
Data Field Response
The following is a list of the possible data fields returned by this operation in the JSON response.
D&B Direct API Documentation Sample Request
©Dun & Bradstreet, Inc. 2014 58
Name Characteristics
ListComplianceSubjectsResponse Aggregate
ListComplianceSubjectsResponse { TransactionDetail Aggregate, Required
Records information necessary to process a particular
request. Examples of a request is the ordering of a product.
ListComplianceSubjectsResponse { TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
ListComplianceSubjectsResponse { TransactionDetail { ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely identify
this transaction.
ListComplianceSubjectsResponse { TransactionDetail { TransactionTimestamp
DateTimestamp, Required
The date and time when this request was submitted or the
date and time when the requesting intermediary, such as a
workflow manager or service bus, sent the message to the
D&B function, i.e., the date and time when the xml
document was created by the requesting intermediary.
END: ListComplianceSubjectsResponse }TransactionDetail
/Aggregate
ListComplianceSubjectsResponse { TransactionResult Aggregate, Required
An aggregate that can repeat multiple times to record the
different outcomes of the transaction.
ListComplianceSubjectsResponse { TransactionResult { SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g.,
Information, Warning, Error, Fatal.
ListComplianceSubjectsResponse { TransactionResult { ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the outcome
of the transaction.
ListComplianceSubjectsResponse { TransactionResult { ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 59
Name Characteristics
ListComplianceSubjectsResponse { TransactionResult { ResultMessage
Aggregate, Optional (Infinite)
An aggregate that can repeat multiple times to record
textual data that expands on the ResultID and ResultText to
provide additional information to the user regarding the
status of the transaction. If the status implies that there is a
problem this may also provide guidance to the user on how to
address it.
ListComplianceSubjectsResponse { TransactionResult { ResultMessage { ResultMessageID
string up to 30 chars., Optional
An alphanumeric string that uniquely identifies the
additional information regarding the outcome of the
transaction.
ListComplianceSubjectsResponse { TransactionResult { ResultMessage { ResultDescription
string up to 512 chars., Required
Text that describes the additional information regarding the
outcome of the transaction.
ListComplianceSubjectsResponse { TransactionResult { ResultMessage { NonSpecificDataProviderText
string up to 30 chars., Optional
Text that describes, in general terms, the source from which
the Result Message data was originally obtained by D&B; e.g.
Credit Bureau.
END: ListComplianceSubjectsResponse }TransactionResult } ResultMessage
/Aggregate
END: ListComplianceSubjectsResponse }TransactionResult
/Aggregate
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail
Aggregate, Optional
Records the details returned based on the request for a list of
suppliers within a customer created entity.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { CandidateMatchedQuantity
int up to 6 digits., Required
The number of candidates matched for the search criteria.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { CandidateReturnedQuantity
int up to 6 digits., Required
The number of candidates returned for the search criteria.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryDetail
Aggregate, Required
Records data that allows the customer to specify identifying
information about the supplier registration workflow domain
being inquired, e.g., the division, queue.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 60
Name Characteristics
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryDetail { ComplianceDivisionID
long, Optional
An alphanumeric value that uniquely identifies the customer
created category.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryDetail { ComplianceDivisionName
string up to 256 chars., Optional
Name of the customer created category.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryDetail { ComplianceDivisionName@WritingScriptISOAlpha4Code
Attribute
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryDetail { ComplianceDivisionName@LanguageCode
Attribute
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryDetail { ComplianceQueueID
long, Optional
An alphanumeric value that uniquely identifies the customer
created queue where the supplier record eixists.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryDetail { ComplianceQueueName
string up to 256 chars., Optional
Name of the customer created queue where the supplier
record exists.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryDetail { ComplianceQueueName@WritingScriptISOAlpha4Code
Attribute
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryDetail { ComplianceQueueName@LanguageCode
Attribute
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryDetail { SubjectName
string up to 256 chars., Optional
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryDetail { DUNSNumber
string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Optional
The D-U-N-S Number is D&B's identification number, which
provides unique identification of this organization, in
accordance with the Data Universal Numbering System (D-U-
N-S).
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryDetail { AssignedToUserName
UserNameType up to 50 chars., Optional
Name of the user who needs to take relevant action on this
supplier record.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 61
Name Characteristics
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryDetail { StartDate
date, Optional
The date when the supplier record was loaded into this
queue.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryDetail { SortBasisText
ListComplianceSubjectsSortBasisEnum, Optional
Text that records the fields by which the response list is
ordered.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryDetail { SortDirectionText
SortDirectionEnum, Optional
Text that indicates the direction of sorting, e.g.,
Ascending,Descending.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryDetail { CandidateMaximumQuantity
int up to 6 digits., Optional
The maximum number of candidates expected in the Search
Response.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryDetail { CandidatePerPageMaximumQuantity
int Less than or equal to 1000., Optional
The maximum number of results to be included in a page.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryDetail { CandidateDisplayStartSequenceNumber
int, Optional
The Display Sequence number of the first record in the page.
END: ListComplianceSubjectsResponse }ListComplianceSubjectsResponseDetail } InquiryDetail
/Aggregate
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData
Aggregate, Required (Infinite)
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceDivisionQueueDetail
Aggregate, Required
Records the customer created caregories under which the
customer's suppliers are classified. For example, the division
for Walmart is Retailmarket.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceDivisionQueueDetail { ComplianceDivisionID
long, Optional
An alphanumeric value that uniquely identifies the customer
created category.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceDivisionQueueDetail { ComplianceDivisionName
string up to 256 chars., Optional
Name of the customer created category.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 62
Name Characteristics
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceDivisionQueueDetail { ComplianceDivisionName@WritingScriptISOAlpha4Code
Attribute
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceDivisionQueueDetail { ComplianceDivisionName@LanguageCode
Attribute
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceDivisionQueueDetail { ComplianceQueueID
long, Optional
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceDivisionQueueDetail { ComplianceQueueName
string up to 256 chars., Optional
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceDivisionQueueDetail { ComplianceQueueName@WritingScriptISOAlpha4Code
Attribute
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceDivisionQueueDetail { ComplianceQueueName@LanguageCode
Attribute
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceDivisionQueueDetail { SubDivisionDetail
Aggregate, Optional (Infinite)
Records the customer created sub caregories under which
the customer's suppliers are classified. For example, the
division for Walmart is Retailmarket.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceDivisionQueueDetail { SubDivisionDetail { SubDivisionID
long, Optional
An alphanumeric value that uniquely identifies the customer
created sub category.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceDivisionQueueDetail { SubDivisionDetail { SubDivisionName
string up to 256 chars., Optional
Name of the customer created sub category.
END: ListComplianceSubjectsResponse }ListComplianceSubjectsResponseDetail }ComplianceData } ComplianceDivisionQueueDetail }SubDivisionDetail
/Aggregate
END: ListComplianceSubjectsResponse }ListComplianceSubjectsResponseDetail }ComplianceData } ComplianceDivisionQueueDetail
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 63
Name Characteristics
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject
Aggregate, Required
An entry loop which can repeat multiple times to allow the
recording of the details of the supplier within a specific
supplier registration workflow domain.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { SubjectID
SubjectIDType up to 25 chars., Required
A number uniquely identifying the inquired subject within
the D&B Worldwide Network.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { CustomerProvidedSubjectData
Aggregate, Optional (Infinite)
Records data that allows the supplier to specify identifying
information about the subject being inquired, e.g., the DUNS
Number, SupplierName etc.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { CustomerProvidedSubjectData { ProjectID
string up to 64 chars., Required
An internal project identifciation provided by customer to
uniquely identify the record
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { CustomerProvidedSubjectData { SubjectName
_, Required
The name of the individual or organization from which the
subject purchases goods or services.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { CustomerProvidedSubjectData { SubjectName@LanguageCode
Attribute
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { CustomerProvidedSubjectData { SubjectName@WritingScriptISOAlpha4Code
Attribute
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { CustomerProvidedSubjectData { SubjectName@NameIdentificationNumber
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 64
Name Characteristics
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { CustomerProvidedSubjectData { DUNSNumber
string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Optional
The D-U-N-S Number is D&B's identification number, which
provides unique identification of this organization, in
accordance with the Data Universal Numbering System (D-U-
N-S).
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { CustomerProvidedSubjectData { ApplicationSubjectID
ApplicationSubjectIDType up to 20 chars., Optional
A number uniquely identifying the inquired subject within
the application.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { CustomerProvidedSubjectData { SubjectTypeText
string up to 256 chars., Optional
The customer specific category assigned to the supplier.
END: ListComplianceSubjectsResponse }ListComplianceSubjectsResponseDetail }ComplianceData } ComplianceSubject }CustomerProvidedSubjectData
/Aggregate
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { Organization
Aggregate, Optional
Records data about an organization, a legal or commercial
entity established to provide products and/or services in the
marketplace or to the community.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { Organization { SubjectHeader
Aggregate, Required
Records high level information about the subject such as the
primary language of the subject and the primary currency in
which this subject trades. When the subject is an
organizantion, this may also include details such as DUNS
Number.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { Organization { SubjectHeader { DUNSNumber
string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Required
The D-U-N-S Number is D&B's identification number, which
provides unique identification of this organization, in
accordance with the Data Universal Numbering System (D-U-
N-S).
END: ListComplianceSubjectsResponse }ListComplianceSubjectsResponseDetail }ComplianceData } ComplianceSubject } Organization }SubjectHeader
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 65
Name Characteristics
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { Organization { OrganizationName
Aggregate, Optional
Records the different names of the organization by which it
is known as well as names of other organizations that have a
similar name to this organization.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { Organization { OrganizationName { OrganizationPrimaryName
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of a single name by which the organization is
primarily known / identified in different languages and/or
writing scripts.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { Organization { OrganizationName { OrganizationPrimaryName@RegisteredNameIndicator
Attribute
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { Organization { OrganizationName { OrganizationPrimaryName { OrganizationName
OrganizationNameType up to 256 chars., Required
Text recording a name of this organization in the specified
language and/or writing script.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { Organization { OrganizationName { OrganizationPrimaryName { OrganizationName@LanguageCode
Attribute
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { Organization { OrganizationName { OrganizationPrimaryName { OrganizationName@WritingScriptISOAlpha4Code
Attribute
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { Organization { OrganizationName { OrganizationPrimaryName { OrganizationName@NameIdentificationNumber
Attribute
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { Organization { OrganizationName { OrganizationPrimaryName { DisplaySequence
int up to 3 digits., Optional
A numeric value used to identify the relative importance of
this Organization Name compared to the other Organization
Names for this organization that are of the same type (e.g.,
Trading Style). The lower the importance level number, the
more important (preferred) is an Organization Name.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 66
Name Characteristics
END: ListComplianceSubjectsResponse }ListComplianceSubjectsResponseDetail }ComplianceData } ComplianceSubject } Organization }OrganizationName } OrganizationPrimaryName
/Aggregate
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { Organization { OrganizationName { TradeStyleName
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of a single name by which the organization is
primarily known / identified in different languages and/or
writing scripts.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { Organization { OrganizationName { TradeStyleName@RegisteredNameIndicator
Attribute
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { Organization { OrganizationName { TradeStyleName { OrganizationName
OrganizationNameType up to 256 chars., Required
Text recording a name of this organization in the specified
language and/or writing script.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { Organization { OrganizationName { TradeStyleName { OrganizationName@LanguageCode
Attribute
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { Organization { OrganizationName { TradeStyleName { OrganizationName@WritingScriptISOAlpha4Code
Attribute
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { Organization { OrganizationName { TradeStyleName { OrganizationName@NameIdentificationNumber
Attribute
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { Organization { OrganizationName { TradeStyleName { DisplaySequence
int up to 3 digits., Optional
A numeric value used to identify the relative importance of
this Organization Name compared to the other Organization
Names for this organization that are of the same type (e.g.,
Trading Style). The lower the importance level number, the
more important (preferred) is an Organization Name.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 67
Name Characteristics
END: ListComplianceSubjectsResponse }ListComplianceSubjectsResponseDetail }ComplianceData } ComplianceSubject } Organization }OrganizationName } TradeStyleName
/Aggregate
END: ListComplianceSubjectsResponse }ListComplianceSubjectsResponseDetail }ComplianceData } ComplianceSubject } Organization }OrganizationName
/Aggregate
END: ListComplianceSubjectsResponse }ListComplianceSubjectsResponseDetail }ComplianceData } ComplianceSubject } Organization
/Aggregate
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { SubjectTypeText
string up to 256 chars., Optional
The customer specific category assigned to the supplier.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { ThirdPartyAssessment
Aggregate, Required (Infinite)
An entry loop which can repeat multiple times to allow the
recording of the appraisals/opinions assigned to this Subject
by an entity other than the D&B Worldwide Network (WWN).
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { ThirdPartyAssessment { AssessmentTypeValue
string up to 128 chars., Optional
An alphanumeric value as assigned by the third party to
define the kind of appraisal/opinion that was assigned to this
subject by the third party, e.g., Moody's Long Term Obligation
Rating, FICO score, Vantage Score.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { ThirdPartyAssessment { AssessmentValue
string, Optional
Text that records appraisal/opinion that was assigned to this
Subject by a third party.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { ThirdPartyAssessment { AssessmentCommentaryText
string up to 3000 chars., Optional (Infinite)
Free form text which records the primary reasons for the
assessment value.
END: ListComplianceSubjectsResponse }ListComplianceSubjectsResponseDetail }ComplianceData } ComplianceSubject }ThirdPartyAssessment
/Aggregate
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { AuditSnapshotDetail
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of the chronological sequence of movement of the
supplier record through the queues.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 68
Name Characteristics
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { AuditSnapshotDetail { StartDate
date, Required
The date when the supplier record was loaded into this
queue.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { AuditSnapshotDetail { StatusDescription
SupplierStatusEnum, Required
Text describing the current state of the record.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { AuditSnapshotDetail { StatusReasonText
string up to 256 chars., Optional
The reason why the supplier record has this status.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { AuditSnapshotDetail { AssignedToUserName
UserNameType up to 50 chars., Optional
Name of the user who needs to take relevant action on this
supplier record.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { AuditSnapshotDetail { InitiatedUserName
string up to 256 chars., Optional
Name of the user responsible for managing this supplier
record through the screening process.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { AuditSnapshotDetail { InitiatedUserEmailAddress
Aggregate, Optional
Email Address of the user responsible for managing this
supplier record through the screening process.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { AuditSnapshotDetail { InitiatedUserEmailAddress { TelecommunicationAddress
string, Optional
END: ListComplianceSubjectsResponse }ListComplianceSubjectsResponseDetail }ComplianceData } ComplianceSubject }AuditSnapshotDetail } InitiatedUserEmailAddress
/Aggregate
END: ListComplianceSubjectsResponse }ListComplianceSubjectsResponseDetail }ComplianceData } ComplianceSubject }AuditSnapshotDetail
/Aggregate
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { ConsolidatedAssessmentReportAvailabilityIndicator
boolean, Optional
When true (set to 1) it denotes that the Consolidated
Assessment Report for the supplier is available. When false
(set to 0) it denotes that the Consolidated Assessment Report
for the supplier is not available.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 69
Name Characteristics
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { DocumentID
DocumentIDType, Optional
A number uniquely identifying the document within the
application.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { ObjectTypeCode
integer up to 7 digits., Optional
To show the type of the report for example CAR, Media
Articles
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { ComplianceAlertsAvailabilityIndicator
boolean, Optional
Indicates whether Compliance alerts are available for the
subject.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { TrainingCompletionDate
Element
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { TrainingStatusText
Element
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { ComplianceData { ComplianceSubject { TrainingCommentsText
Element
END: ListComplianceSubjectsResponse }ListComplianceSubjectsResponseDetail }ComplianceData } ComplianceSubject
/Aggregate
END: ListComplianceSubjectsResponse }ListComplianceSubjectsResponseDetail }ComplianceData
/Aggregate
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryReferenceDetail
Aggregate, Optional
Records data that allows the customer to specify information
to be linked to the request in order to support subsequent
order reconciliation.
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryReferenceDetail { CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to be
linked to the product in order to support subsequent order
reconciliation.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 70
Name Characteristics
ListComplianceSubjectsResponse { ListComplianceSubjectsResponseDetail { InquiryReferenceDetail { CustomerBillingEndorsementText
string at least 1 chars. up to 240 chars., Optional
Text that is filled in by customer and commonly contains
requesting individual or department name, or customer's
own account/reference number and/or name for the case
on which the product was provided.This text is a reference
used during the billing process.
END: ListComplianceSubjectsResponse }ListComplianceSubjectsResponseDetail }InquiryReferenceDetail
/Aggregate
END: ListComplianceSubjectsResponse }ListComplianceSubjectsResponseDetail
/Aggregate
END: ListComplianceSubjectsResponse /Aggregate
Lists of possible values (when present) are subject to change. Additional values not presented in this documentation may be delivered
in the response and should be anticipated in any implementation.
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: ??? and SC001-SC009.
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Compliance Check Service
Samples http://developer.dnb.com/docs/2.0/compliance/1.0/DnB-Compliance.zip
Related Topics
RegisterSubject (REST), GetComplianceSubjectData (REST).
D&B Direct API Documentation Response Codes
©Dun & Bradstreet, Inc. 2014 71
ListComplianceSubjects (SOAP)This operation -- part of the Compliance Check Service -- is a component of the Compliance √ Screeningsolution.
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Note: While the Compliance √ Screening features are accessed through the D&B Direct service, separatecredentials are required for each data environment and will be provided by a D&B sales representative.
Endpoint
https://maxcvservices.dnb.com/ComplianceCheckService/V{version}
Request Parameters
The following parameters are accepted by this operation.
Exception: The list returned by this operation will include all subjects registered by user credentials associatedwith the customer contract.
If an application requires filtering by user credentials, a possible solution would be to place a unique value inthe CustomerReferenceText field when registering subjects, and then supply the same value to this operation.
Exception: The pagination sequence for this operation starts at zero (rather than one). Also, responsescurrently deliver one less than the per page value specified on the request.
Name Characteristics
ListComplianceSubjectsRequest Aggregate
ListComplianceSubjectsRequest@ServiceVersionNumber Attribute
ListComplianceSubjectsRequest@xsi:schemaLocation Attribute
ListComplianceSubjectsRequest. TransactionDetail Aggregate, Optional
Records information necessary to process this request.
D&B Direct API Documentation ListComplianceSubjects (SOAP)
©Dun & Bradstreet, Inc. 2014 72
Name Characteristics
ListComplianceSubjectsRequest. TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
ListComplianceSubjectsRequest. TransactionDetail.TransactionTimestamp
DateTimestamp, Optional
The date and time when this request was created. When
the request is from an intermediary, such as a workflow
manager or service bus, this is the date and time when the
message was sent to the D&B function, i.e., the date and
time when the xml document was created by the
requesting intermediary.
ListComplianceSubjectsRequest. TransactionDetail.SubmittingOfficeID
string up to 64 chars., Optional
A number that identifies the system or the software
application from where this request originated. / A number
used to uniquely identfy the D&B business segment or
delivery channel from where this request originated.
END: ListComplianceSubjectsRequest. TransactionDetail /Aggregate
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail
Aggregate, Required
Records the details to request for a list of suppliers within a
customer created entity.
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria
Aggregate, Optional
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria. SubjectID
Element
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria. ApplicationSubjectID
ApplicationSubjectIDType up to 20 chars., Optional
A number uniquely identifying the inquired subject within
the application.
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria. ComplianceDivisionID
long, Optional
An alphanumeric value that uniquely identifies the
customer created category.
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria.ComplianceDivisionName
string up to 256 chars., Optional
Name of the customer created category.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 73
Name Characteristics
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria.ComplianceDivisionName@WritingScriptISOAlpha4Code
Attribute
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria.ComplianceDivisionName@LanguageCode
Attribute
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria. ComplianceQueueID
long, Optional
An alphanumeric value that uniquely identifies the
customer created queue where the supplier record eixists.
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria. ComplianceQueueName
string up to 256 chars., Optional
Name of the customer created queue where the supplier
record exists.
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria.ComplianceQueueName@WritingScriptISOAlpha4Code
Attribute
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria.ComplianceQueueName@LanguageCode
Attribute
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria. SubjectName
string up to 256 chars., Optional
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria. DUNSNumber
string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Optional
The D-U-N-S Number is D&B's identification number, which
provides unique identification of this organization, in
accordance with the Data Universal Numbering System (D-
U-N-S).
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria. AssignedToUserName
UserNameType up to 50 chars., Optional
Name of the user who needs to take relevant action on this
supplier record.
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria. StartDate
date, Optional
The date when the supplier record was loaded into this
queue.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 74
Name Characteristics
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria.ComplianceAlertsAvailabilityIndicator
boolean, Optional
Indicates whether Compliance alerts are available for the
subject.
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria. OrganizationName
string up to 256 chars., Optional
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria. KeywordText
string up to 256 chars., Optional
Keyword for searching. Value passed in this field will be
compared with D&B Organization Name and the Customer
Provided Subject Name.
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria. InitiatedUserName
string up to 256 chars., Optional
Name of the user who moved the Subject to the current
workflow Queue.
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria.InitiatedUserEmailAddress
Aggregate, Optional
Email ID of the user who moved the Subject to the current
workflow Queue.
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria.InitiatedUserEmailAddress. TelecommunicationAddress
string, Optional
END: ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria.InitiatedUserEmailAddress
/Aggregate
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria. StatusDescription
SupplierStatusEnum, Optional
Text describing the current state of the record.
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria. TrainingStatusText
Element
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria. TrainingCompletionDate
Element
END: ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsCriteria
/Aggregate
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 75
Name Characteristics
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsSpecification
Aggregate, Optional
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsSpecification. SortBasisText
ListComplianceSubjectsSortBasisEnum, Optional
Text that records the fields by which the response list is
ordered.
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsSpecification. SortDirectionText
SortDirectionEnum, Optional
Text that indicates the direction of sorting, e.g.,
Ascending,Descending.
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsSpecification.CandidateMaximumQuantity
int up to 6 digits., Optional
The maximum number of candidates expected in the
Search Response.
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsSpecification.CandidatePerPageMaximumQuantity
int Less than or equal to 1000., Optional
The maximum number of results to be included in a page.
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsSpecification.CandidateDisplayStartSequenceNumber
int, Optional
The Display Sequence number of the first record in the page.
END: ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.ListComplianceSubjectsSpecification
/Aggregate
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.InquiryReferenceDetail
Aggregate, Optional
Records data that allows the customer to specify
information to be linked to the request in order to support
subsequent order reconciliation.
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.InquiryReferenceDetail. CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to be
linked to the product in order to support subsequent order
reconciliation.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 76
Name Characteristics
ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.InquiryReferenceDetail.CustomerBillingEndorsementText
string at least 1 chars. up to 240 chars., Optional
Text that is filled in by customer and commonly contains
requesting individual or department name, or customer's
own account/reference number and/or name for the case
on which the product was provided.This text is a reference
used during the billing process.
END: ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail.InquiryReferenceDetail
/Aggregate
END: ListComplianceSubjectsRequest.ListComplianceSubjectsRequestDetail
/Aggregate
END: ListComplianceSubjectsRequest /Aggregate
Sample Request
Testing / Sandbox
This operation is currently unavailable in the D&B Direct sandbox (test) environment.
Data Field Response
The following is a list of the possible data fields returned by this operation in the XML response.
Name Characteristics
ListComplianceSubjectsResponse Aggregate
ListComplianceSubjectsResponse. TransactionDetail Aggregate, Required
Records information necessary to process a particular
request. Examples of a request is the ordering of a product.
ListComplianceSubjectsResponse. TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
D&B Direct API Documentation Sample Request
©Dun & Bradstreet, Inc. 2014 77
Name Characteristics
ListComplianceSubjectsResponse. TransactionDetail.ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely identify
this transaction.
ListComplianceSubjectsResponse. TransactionDetail.TransactionTimestamp
DateTimestamp, Required
The date and time when this request was submitted or the
date and time when the requesting intermediary, such as a
workflow manager or service bus, sent the message to the
D&B function, i.e., the date and time when the xml
document was created by the requesting intermediary.
END: ListComplianceSubjectsResponse.TransactionDetail
/Aggregate
ListComplianceSubjectsResponse. TransactionResult Aggregate, Required
An aggregate that can repeat multiple times to record the
different outcomes of the transaction.
ListComplianceSubjectsResponse. TransactionResult.SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g.,
Information, Warning, Error, Fatal.
ListComplianceSubjectsResponse. TransactionResult.ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the outcome
of the transaction.
ListComplianceSubjectsResponse. TransactionResult.ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
ListComplianceSubjectsResponse. TransactionResult.ResultMessage
Aggregate, Optional (Infinite)
An aggregate that can repeat multiple times to record
textual data that expands on the ResultID and ResultText to
provide additional information to the user regarding the
status of the transaction. If the status implies that there is a
problem this may also provide guidance to the user on how to
address it.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 78
Name Characteristics
ListComplianceSubjectsResponse. TransactionResult.ResultMessage. ResultMessageID
string up to 30 chars., Optional
An alphanumeric string that uniquely identifies the
additional information regarding the outcome of the
transaction.
ListComplianceSubjectsResponse. TransactionResult.ResultMessage. ResultDescription
string up to 512 chars., Required
Text that describes the additional information regarding the
outcome of the transaction.
ListComplianceSubjectsResponse. TransactionResult.ResultMessage. NonSpecificDataProviderText
string up to 30 chars., Optional
Text that describes, in general terms, the source from which
the Result Message data was originally obtained by D&B; e.g.
Credit Bureau.
END: ListComplianceSubjectsResponse.TransactionResult. ResultMessage
/Aggregate
END: ListComplianceSubjectsResponse.TransactionResult
/Aggregate
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail
Aggregate, Optional
Records the details returned based on the request for a list of
suppliers within a customer created entity.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.CandidateMatchedQuantity
int up to 6 digits., Required
The number of candidates matched for the search criteria.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.CandidateReturnedQuantity
int up to 6 digits., Required
The number of candidates returned for the search criteria.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail. InquiryDetail
Aggregate, Required
Records data that allows the customer to specify identifying
information about the supplier registration workflow domain
being inquired, e.g., the division, queue.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail. InquiryDetail.ComplianceDivisionID
long, Optional
An alphanumeric value that uniquely identifies the customer
created category.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail. InquiryDetail.ComplianceDivisionName
string up to 256 chars., Optional
Name of the customer created category.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 79
Name Characteristics
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail. InquiryDetail.ComplianceDivisionName@WritingScriptISOAlpha4Code
Attribute
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail. InquiryDetail.ComplianceDivisionName@LanguageCode
Attribute
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail. InquiryDetail.ComplianceQueueID
long, Optional
An alphanumeric value that uniquely identifies the customer
created queue where the supplier record eixists.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail. InquiryDetail.ComplianceQueueName
string up to 256 chars., Optional
Name of the customer created queue where the supplier
record exists.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail. InquiryDetail.ComplianceQueueName@WritingScriptISOAlpha4Code
Attribute
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail. InquiryDetail.ComplianceQueueName@LanguageCode
Attribute
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail. InquiryDetail.SubjectName
string up to 256 chars., Optional
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail. InquiryDetail.DUNSNumber
string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Optional
The D-U-N-S Number is D&B's identification number, which
provides unique identification of this organization, in
accordance with the Data Universal Numbering System (D-U-
N-S).
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail. InquiryDetail.AssignedToUserName
UserNameType up to 50 chars., Optional
Name of the user who needs to take relevant action on this
supplier record.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail. InquiryDetail.StartDate
date, Optional
The date when the supplier record was loaded into this
queue.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail. InquiryDetail.SortBasisText
ListComplianceSubjectsSortBasisEnum, Optional
Text that records the fields by which the response list is
ordered.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 80
Name Characteristics
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail. InquiryDetail.SortDirectionText
SortDirectionEnum, Optional
Text that indicates the direction of sorting, e.g.,
Ascending,Descending.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail. InquiryDetail.CandidateMaximumQuantity
int up to 6 digits., Optional
The maximum number of candidates expected in the Search
Response.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail. InquiryDetail.CandidatePerPageMaximumQuantity
int Less than or equal to 1000., Optional
The maximum number of results to be included in a page.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail. InquiryDetail.CandidateDisplayStartSequenceNumber
int, Optional
The Display Sequence number of the first record in the page.
END: ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail. InquiryDetail
/Aggregate
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData
Aggregate, Required (Infinite)
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceDivisionQueueDetail
Aggregate, Required
Records the customer created caregories under which the
customer's suppliers are classified. For example, the division
for Walmart is Retailmarket.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceDivisionQueueDetail.ComplianceDivisionID
long, Optional
An alphanumeric value that uniquely identifies the customer
created category.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceDivisionQueueDetail.ComplianceDivisionName
string up to 256 chars., Optional
Name of the customer created category.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceDivisionQueueDetail.ComplianceDivisionName@WritingScriptISOAlpha4Code
Attribute
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceDivisionQueueDetail.ComplianceDivisionName@LanguageCode
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 81
Name Characteristics
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceDivisionQueueDetail.ComplianceQueueID
long, Optional
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceDivisionQueueDetail.ComplianceQueueName
string up to 256 chars., Optional
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceDivisionQueueDetail.ComplianceQueueName@WritingScriptISOAlpha4Code
Attribute
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceDivisionQueueDetail.ComplianceQueueName@LanguageCode
Attribute
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceDivisionQueueDetail.SubDivisionDetail
Aggregate, Optional (Infinite)
Records the customer created sub caregories under which
the customer's suppliers are classified. For example, the
division for Walmart is Retailmarket.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceDivisionQueueDetail.SubDivisionDetail. SubDivisionID
long, Optional
An alphanumeric value that uniquely identifies the customer
created sub category.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceDivisionQueueDetail.SubDivisionDetail. SubDivisionName
string up to 256 chars., Optional
Name of the customer created sub category.
END: ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceDivisionQueueDetail.SubDivisionDetail
/Aggregate
END: ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceDivisionQueueDetail
/Aggregate
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject
Aggregate, Required
An entry loop which can repeat multiple times to allow the
recording of the details of the supplier within a specific
supplier registration workflow domain.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 82
Name Characteristics
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. SubjectID
SubjectIDType up to 25 chars., Required
A number uniquely identifying the inquired subject within
the D&B Worldwide Network.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.CustomerProvidedSubjectData
Aggregate, Optional (Infinite)
Records data that allows the supplier to specify identifying
information about the subject being inquired, e.g., the DUNS
Number, SupplierName etc.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.CustomerProvidedSubjectData. ProjectID
string up to 64 chars., Required
An internal project identifciation provided by customer to
uniquely identify the record
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.CustomerProvidedSubjectData. SubjectName
_, Required
The name of the individual or organization from which the
subject purchases goods or services.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.CustomerProvidedSubjectData.SubjectName@LanguageCode
Attribute
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.CustomerProvidedSubjectData.SubjectName@WritingScriptISOAlpha4Code
Attribute
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.CustomerProvidedSubjectData.SubjectName@NameIdentificationNumber
Attribute
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.CustomerProvidedSubjectData. DUNSNumber
string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Optional
The D-U-N-S Number is D&B's identification number, which
provides unique identification of this organization, in
accordance with the Data Universal Numbering System (D-U-
N-S).
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.CustomerProvidedSubjectData. ApplicationSubjectID
ApplicationSubjectIDType up to 20 chars., Optional
A number uniquely identifying the inquired subject within
the application.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 83
Name Characteristics
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.CustomerProvidedSubjectData. SubjectTypeText
string up to 256 chars., Optional
The customer specific category assigned to the supplier.
END: ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.CustomerProvidedSubjectData
/Aggregate
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization
Aggregate, Optional
Records data about an organization, a legal or commercial
entity established to provide products and/or services in the
marketplace or to the community.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.SubjectHeader
Aggregate, Required
Records high level information about the subject such as the
primary language of the subject and the primary currency in
which this subject trades. When the subject is an
organizantion, this may also include details such as DUNS
Number.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.SubjectHeader. DUNSNumber
string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Required
The D-U-N-S Number is D&B's identification number, which
provides unique identification of this organization, in
accordance with the Data Universal Numbering System (D-U-
N-S).
END: ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.SubjectHeader
/Aggregate
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.OrganizationName
Aggregate, Optional
Records the different names of the organization by which it
is known as well as names of other organizations that have a
similar name to this organization.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.OrganizationName. OrganizationPrimaryName
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of a single name by which the organization is
primarily known / identified in different languages and/or
writing scripts.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 84
Name Characteristics
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.OrganizationName.OrganizationPrimaryName@RegisteredNameIndicator
Attribute
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.OrganizationName. OrganizationPrimaryName.OrganizationName
OrganizationNameType up to 256 chars., Required
Text recording a name of this organization in the specified
language and/or writing script.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.OrganizationName. OrganizationPrimaryName.OrganizationName@LanguageCode
Attribute
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.OrganizationName. OrganizationPrimaryName.OrganizationName@WritingScriptISOAlpha4Code
Attribute
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.OrganizationName. OrganizationPrimaryName.OrganizationName@NameIdentificationNumber
Attribute
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.OrganizationName. OrganizationPrimaryName.DisplaySequence
int up to 3 digits., Optional
A numeric value used to identify the relative importance of
this Organization Name compared to the other Organization
Names for this organization that are of the same type (e.g.,
Trading Style). The lower the importance level number, the
more important (preferred) is an Organization Name.
END: ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.OrganizationName. OrganizationPrimaryName
/Aggregate
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.OrganizationName. TradeStyleName
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of a single name by which the organization is
primarily known / identified in different languages and/or
writing scripts.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 85
Name Characteristics
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.OrganizationName.TradeStyleName@RegisteredNameIndicator
Attribute
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.OrganizationName. TradeStyleName.OrganizationName
OrganizationNameType up to 256 chars., Required
Text recording a name of this organization in the specified
language and/or writing script.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.OrganizationName. TradeStyleName.OrganizationName@LanguageCode
Attribute
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.OrganizationName. TradeStyleName.OrganizationName@WritingScriptISOAlpha4Code
Attribute
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.OrganizationName. TradeStyleName.OrganizationName@NameIdentificationNumber
Attribute
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.OrganizationName. TradeStyleName. DisplaySequence
int up to 3 digits., Optional
A numeric value used to identify the relative importance of
this Organization Name compared to the other Organization
Names for this organization that are of the same type (e.g.,
Trading Style). The lower the importance level number, the
more important (preferred) is an Organization Name.
END: ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.OrganizationName. TradeStyleName
/Aggregate
END: ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization.OrganizationName
/Aggregate
END: ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. Organization
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 86
Name Characteristics
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. SubjectTypeText
string up to 256 chars., Optional
The customer specific category assigned to the supplier.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.ThirdPartyAssessment
Aggregate, Required (Infinite)
An entry loop which can repeat multiple times to allow the
recording of the appraisals/opinions assigned to this Subject
by an entity other than the D&B Worldwide Network (WWN).
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.ThirdPartyAssessment. AssessmentTypeValue
string up to 128 chars., Optional
An alphanumeric value as assigned by the third party to
define the kind of appraisal/opinion that was assigned to this
subject by the third party, e.g., Moody's Long Term Obligation
Rating, FICO score, Vantage Score.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.ThirdPartyAssessment. AssessmentValue
string, Optional
Text that records appraisal/opinion that was assigned to this
Subject by a third party.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.ThirdPartyAssessment. AssessmentCommentaryText
string up to 3000 chars., Optional (Infinite)
Free form text which records the primary reasons for the
assessment value.
END: ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.ThirdPartyAssessment
/Aggregate
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.AuditSnapshotDetail
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of the chronological sequence of movement of the
supplier record through the queues.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.AuditSnapshotDetail. StartDate
date, Required
The date when the supplier record was loaded into this
queue.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.AuditSnapshotDetail. StatusDescription
SupplierStatusEnum, Required
Text describing the current state of the record.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 87
Name Characteristics
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.AuditSnapshotDetail. StatusReasonText
string up to 256 chars., Optional
The reason why the supplier record has this status.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.AuditSnapshotDetail. AssignedToUserName
UserNameType up to 50 chars., Optional
Name of the user who needs to take relevant action on this
supplier record.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.AuditSnapshotDetail. InitiatedUserName
string up to 256 chars., Optional
Name of the user responsible for managing this supplier
record through the screening process.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.AuditSnapshotDetail. InitiatedUserEmailAddress
Aggregate, Optional
Email Address of the user responsible for managing this
supplier record through the screening process.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.AuditSnapshotDetail. InitiatedUserEmailAddress.TelecommunicationAddress
string, Optional
END: ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.AuditSnapshotDetail. InitiatedUserEmailAddress
/Aggregate
END: ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.AuditSnapshotDetail
/Aggregate
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.ConsolidatedAssessmentReportAvailabilityIndicator
boolean, Optional
When true (set to 1) it denotes that the Consolidated
Assessment Report for the supplier is available. When false
(set to 0) it denotes that the Consolidated Assessment Report
for the supplier is not available.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. DocumentID
DocumentIDType, Optional
A number uniquely identifying the document within the
application.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject. ObjectTypeCode
integer up to 7 digits., Optional
To show the type of the report for example CAR, Media
Articles
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 88
Name Characteristics
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.ComplianceAlertsAvailabilityIndicator
boolean, Optional
Indicates whether Compliance alerts are available for the
subject.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.TrainingCompletionDate
Element
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.TrainingStatusText
Element
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject.TrainingCommentsText
Element
END: ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData. ComplianceSubject
/Aggregate
END: ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.ComplianceData
/Aggregate
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.InquiryReferenceDetail
Aggregate, Optional
Records data that allows the customer to specify information
to be linked to the request in order to support subsequent
order reconciliation.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.InquiryReferenceDetail. CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to be
linked to the product in order to support subsequent order
reconciliation.
ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.InquiryReferenceDetail.CustomerBillingEndorsementText
string at least 1 chars. up to 240 chars., Optional
Text that is filled in by customer and commonly contains
requesting individual or department name, or customer's
own account/reference number and/or name for the case
on which the product was provided.This text is a reference
used during the billing process.
END: ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail.InquiryReferenceDetail
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 89
Name Characteristics
END: ListComplianceSubjectsResponse.ListComplianceSubjectsResponseDetail
/Aggregate
END: ListComplianceSubjectsResponse /Aggregate
Lists of possible values (when present) are subject to change. Additional values not presented in this documentation may be delivered
in the response and should be anticipated in any implementation.
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: ??? and SC001-SC009.
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Compliance Check Service
Samples http://developer.dnb.com/docs/2.0/compliance/1.0/DnB-Compliance.zip
Related Topics
RegisterSubject (SOAP), GetComplianceSubjectData (SOAP), GetComplianceAlerts (SOAP).
D&B Direct API Documentation Response Codes
©Dun & Bradstreet, Inc. 2014 90
GetSubjectComplianceData (REST)This operation -- part of the Compliance Check Service -- is a component of the Compliance √ Screeningsolution.
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Note: While the Compliance √ Screening features are accessed through the D&B Direct service, separatecredentials are required for each data environment and will be provided by a D&B sales representative.
Endpoint
GET https://maxcvservices.dnb.com/V{version}/compliancecheck/subjects/{subjectID}
Request Parameters
The following parameters are accepted by this operation.
Name Characteristics
ApplicationTransactionID string up to 64 chars., Optional
A number assigned by the calling
application to uniquely identify this
request.
TransactionTimestamp DateTimestamp, Optional
The date and time when this request
was created. When the request is from
an intermediary, such as a workflow
manager or service bus, this is the date
and time when the message was sent
to the D&B function, i.e., the date and
time when the xml document was
created by the requesting intermediary.
D&B Direct API Documentation GetSubjectComplianceData (REST)
©Dun & Bradstreet, Inc. 2014 91
Name Characteristics
SubmittingOfficeID string up to 64 chars., Optional
A number that identifies the system or
the software application from where
this request originated. / A number used
to uniquely identfy the D&B business
segment or delivery channel from
where this request originated.
{subjectID} SubjectIDType up to 25 chars., Required
A number uniquely identifying the
inquired subject within the D&B
Worldwide Network.
ComplianceDataModuleID-n string up to 64 chars., Required
Possible values: APPEND_DATA; ALERTS
CustomerReferenceText string up to 240 chars., Optional
A freeform reference string provided by
the customer to be linked to the product
in order to support subsequent order
reconciliation.
Sample Request
GET https://maxcvservices.dnb.com/V1.0/compliancecheck/subjects/1012107?ComplianceDataModuleID=ALERTSAuthorization: <MyToken>
Testing / Sandbox
This operation is currently unavailable in the D&B Direct sandbox (test) environment.
Data Field Response
The following is a list of the possible data fields returned by this operation in the JSON response.
Name Characteristics
GetSubjectComplianceDataResponse Aggregate
GetSubjectComplianceDataResponse@ServiceVersionNumber Attribute
D&B Direct API Documentation Sample Request
©Dun & Bradstreet, Inc. 2014 92
Name Characteristics
GetSubjectComplianceDataResponse { TransactionDetail Aggregate, Required
Records information necessary to process a particular
request. Examples of a request is the ordering of a
product.
GetSubjectComplianceDataResponse { TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to
uniquely identify this request.
GetSubjectComplianceDataResponse { TransactionDetail { ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely
identify this transaction.
GetSubjectComplianceDataResponse { TransactionDetail { TransactionTimestamp
DateTimestamp, Required
The date and time when this request was submitted or
the date and time when the requesting intermediary,
such as a workflow manager or service bus, sent the
message to the D&B function, i.e., the date and time
when the xml document was created by the
requesting intermediary.
END: GetSubjectComplianceDataResponse } TransactionDetail /Aggregate
GetSubjectComplianceDataResponse { TransactionResult Aggregate, Required
An aggregate that can repeat multiple times to record
the different outcomes of the transaction.
GetSubjectComplianceDataResponse { TransactionResult { SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g.,
Information, Warning, Error, Fatal.
GetSubjectComplianceDataResponse { TransactionResult { ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the
outcome of the transaction.
GetSubjectComplianceDataResponse { TransactionResult { ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 93
Name Characteristics
GetSubjectComplianceDataResponse { TransactionResult { ResultMessage
Aggregate, Optional (Infinite)
An aggregate that can repeat multiple times to record
textual data that expands on the ResultID and
ResultText to provide additional information to the
user regarding the status of the transaction. If the
status implies that there is a problem this may also
provide guidance to the user on how to address it.
GetSubjectComplianceDataResponse { TransactionResult { ResultMessage { ResultDescription
string up to 512 chars., Required
Text that describes the additional information
regarding the outcome of the transaction.
END: GetSubjectComplianceDataResponse }TransactionResult } ResultMessage
/Aggregate
END: GetSubjectComplianceDataResponse }TransactionResult
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail
Aggregate, Optional
Records the data being returned to the customer as a
result of a product request.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { InquiryDetail
Aggregate, Required
Records data that allows the customer to specify
identifying information about the subject being
inquired, e.g., the DUNS Number, the address, the
telephone number.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { InquiryDetail { SubjectID
SubjectIDType up to 25 chars., Optional
A number uniquely identifying the inquired subject
within the D&B Worldwide Network.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { InquiryDetail { ApplicationSubjectID
ApplicationSubjectIDType up to 20 chars., Optional
A number uniquely identifying the inquired subject
within an application.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } InquiryDetail
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { SubProcessResult
Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { SubProcessResult{ SubProcessName
Element
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 94
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { SubProcessResult{ ResultID
Element
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { SubProcessResult{ ResultText
Element
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } SubProcessResult
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData
Aggregate, Required
Records data about the product ordered by the
customer and data about the organization on which
the customer has placed this order.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject
Aggregate, Optional
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectID
SubjectIDType up to 25 chars., Optional
A number uniquely identifying the inquired subject
within an application.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData
Aggregate, Optional (Infinite)
Records data that allows the supplier to specify
identifying information about the subject being
inquired, e.g., the DUNS Number, SupplierName etc.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { ProjectID
string up to 64 chars., Optional
An internal project identifciation provided by customer
to uniquely identify the record
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { SubjectName
_, Required
The name of the individual or organization from which
the subject purchases goods or services.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { SubjectName@LanguageCode
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { SubjectName@WritingScriptISOAlpha4Code
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 95
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { DUNSNumber
string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}.,Optional
The D-U-N-S Number is D&B's identification number,
which provides unique identification of this
organization, in accordance with the Data Universal
Numbering System (D-U-N-S).
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { ApplicationSubjectID
ApplicationSubjectIDType up to 20 chars., Optional
A number uniquely identifying the inquired subject
within the application.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { Principal
Aggregate, Optional(Up to 6x)
Records the information of each principal that are
actively associated with the subject organization.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { Principal { PrincipalName
_, Optional
Records the different names for the Principal.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { Principal { PrincipalName@LanguageCode
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { Principal { PrincipalName@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { Principal { JobTitle
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of the name used by the organization to
describe this person's job, e.g., Leader Global
Communication, Manager National Technical Support
Center.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { Principal { JobTitle { JobTitleText
string up to 3000 chars., Optional
Text that denotes a position held by the principal or
manager.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { Principal { JobTitle { JobTitleText@WritingScriptISOAlpha4Code
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 96
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { Principal { JobTitle { JobTitleText@LanguageCode
Attribute
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } CustomerProvidedSubjectData }Principal } JobTitle
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { Principal { CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO)identifying the country of the
inquired subject.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { Principal { DataProviderName@DNBCodeValue
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { Principal { DataProviderName@DNBCodeTableNumber
Attribute
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } CustomerProvidedSubjectData }Principal
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { Shareholder
Aggregate, Optional(Up to 6x)
Records the information of individual or organization
that legally owns a share of stock in a public or private
organization.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { Shareholder { ShareholderName
_, Optional
The name of the individual or organization that legally
who owns a share of stock in a public or private
organization.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { Shareholder { ShareholderName@LanguageCode
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 97
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { Shareholder { ShareholderName@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { Shareholder { ShareholderName@NameIdentificationNumber
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { Shareholder { ShareholdingPercentage
decimal up to 5 digits. Maximum of 2 decimalplaces., Optional
Records the percentage of share owned by the
individual or organization.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { Shareholder { CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO)identifying the country of the
inquired subject.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { Shareholder { DataProviderName@DNBCodeValue
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { Shareholder { DataProviderName@DNBCodeTableNumber
Attribute
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } CustomerProvidedSubjectData }Shareholder
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { DivisionDetail
Aggregate, Optional
Records the customer created caregories under which
the customers' suppliers are classified.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { DivisionDetail { ComplianceDivisionID
long, Optional
An alphanumeric value that uniquely identifies the
customer created category.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 98
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { DivisionDetail { ComplianceDivisionName
string up to 256 chars., Optional
Name of the customer created category.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { DivisionDetail { ComplianceDivisionName@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { DivisionDetail { ComplianceDivisionName@LanguageCode
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { DivisionDetail { ComplianceQueueID
long, Optional
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { DivisionDetail { ComplianceQueueName
string up to 256 chars., Optional
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { DivisionDetail { ComplianceQueueName@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { DivisionDetail { ComplianceQueueName@LanguageCode
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { DivisionDetail { SubDivisionDetail
Aggregate, Optional (Infinite)
Records the customer created sub caregories under
which the customer's suppliers are classified.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { DivisionDetail { SubDivisionDetail { SubDivisionID
long, Optional
An alphanumeric value that uniquely identifies the
customer created sub category.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { DivisionDetail { SubDivisionDetail { SubDivisionName
string up to 256 chars., Optional
Name of the customer created sub category.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 99
Name Characteristics
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } CustomerProvidedSubjectData }DivisionDetail } SubDivisionDetail
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } CustomerProvidedSubjectData }DivisionDetail
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { PrimaryAddress
Aggregate, Required
An entry loop to allow the recording of a single primary
or physical address of the subject in multiple languages
and/or writing scripts. For an organization this is the
principal address at which the organization is located.
For an individual, this is the home address.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { PrimaryAddress@LanguageCode
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { PrimaryAddress@WritingScriptCode
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { PrimaryAddress { StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of several lines where each address line
contains one or more named address elements.
Examples of named address elements are Street
Name, Street Number, Building Name, Estate Name.
They are called “lines” because an addres can be
divided into multiple lines. When there are multiple
lines the sequence of the lines must be preserved.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { PrimaryAddress { StreetAddressLine { LineText
string up to 240 chars., Required
Text that records the street address components as it
would be presented on an address label. This includes,
but is not limited to, details such as street name, street
number, building name, estate name.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 100
Name Characteristics
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } CustomerProvidedSubjectData }PrimaryAddress } StreetAddressLine
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { PrimaryAddress { PrimaryTownName
string up to 64 chars., Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { PrimaryAddress { PostalCode
string, Optional
An identifier used by the local country Postal Authority
to identify a particular geographic location. For
example, in Belgium, Postal Code 9000 identifies the
town of GHENT.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { PrimaryAddress { CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this
address.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { PrimaryAddress { TerritoryName
string up to 128 chars., Optional
The name of the locally governed area which forms
part of a centrally governed nation as received by D&B.
Clarification Note: As a guiding principle this is a
geographic area which could theoretically exist as a
separate nation. In the U.S. this would be a State. In
the UK this would be one of the Home Nations.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } CustomerProvidedSubjectData }PrimaryAddress
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { SalesRevenueAmount
decimal, Optional
The monetary value of income received from
customers from the sale of the business' goods and/or
services. This means it is the gross sales minus any
returns, rebates/discounts, allowances for damages or
shortages, shipping expenses passed on to the
customer, and amounts due where there is not a
reasonable expectation of collection.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 101
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { SalesRevenueAmount@UnitOfSize
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { SalesRevenueAmount@CurrencyISOAlpha3Code
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { SalesRevenueAmount@ReliabilityText
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { SubjectIdentificationNumberDetail
Aggregate, Optional (Infinite)
Records the address details where the Organization
Identification Number is registered.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { SubjectIdentificationNumberDetail@DNBCodeValue
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { SubjectIdentificationNumberDetail@DNBCodeTableNumber
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { SubjectIdentificationNumberDetail@TypeText
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { SubjectIdentificationNumberDetail { SubjectIdentificationNumber
string at least 1 chars. up to 40 chars., Required
A number assigned by an external body or by D&B
which either uniquely identifies or helps to identify the
subject.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } CustomerProvidedSubjectData }SubjectIdentificationNumberDetail
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { DataProviderName@DNBCodeValue
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 102
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { DataProviderName@DNBCodeTableNumber
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { RelatedPartyDetail
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to
record the details of the other Organizations or
Individuals (called Related Parties) that directly or
indirectly have an association with Supplier.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { RelatedPartyDetail { SubjectName
string up to 512 chars., Optional
Text that records the name of the different names for
the related parties for the Supplier
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { RelatedPartyDetail { SubjectName@LanguageCode
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { RelatedPartyDetail { SubjectName@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { RelatedPartyDetail { SubjectName@NameIdentificationNumber
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { RelatedPartyDetail { AssociationTypeText
string up to 512 chars., Optional
Text describes the type of the related party.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { RelatedPartyDetail { Assessment
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of the appraisal/opinion assigned to this
subject by an external entity.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 103
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { RelatedPartyDetail { Assessment { AssessmentTypeValue
string up to 128 chars., Optional
An alphanumeric value as assigned by the third party
to define the kind of appraisal/opinion that was
assigned to this subject by the third party, e.g., Moody's
Long Term Obligation Rating, FICO score, Vantage
Score.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { RelatedPartyDetail { Assessment { AssessmentValue
string, Optional
Text that records appraisal/opinion that was assigned
to this Subject by a third party.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { RelatedPartyDetail { Assessment { AssessmentCommentaryText
string up to 3000 chars., Optional (Infinite)
Free form text which records the primary reasons for
the assessment value.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } CustomerProvidedSubjectData }RelatedPartyDetail } Assessment
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } CustomerProvidedSubjectData }RelatedPartyDetail
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { EntityTypeText
EntityTypeEnumeration, Optional
Text describes whether the entity is Person or
Organization.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { TelephoneNumber
Aggregate, Optional
Records information about the different modes of
Telecommunication addresses used by a subject for
external contact purposes.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { CustomerProvidedSubjectData { TelephoneNumber { TelecommunicationNumber
string at least 1 chars. up to 50 chars., Required
A sequence of digits used by the subject for voice
communication in a public switched telephone
network. This sequence of digits includes the area code
or city code. Note: This number does not include the
International Dialing Code and Domestic Dialing Code.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 104
Name Characteristics
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } CustomerProvidedSubjectData }TelephoneNumber
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } CustomerProvidedSubjectData
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization
Aggregate, Optional
Records data about an organization, a legal or
commercial entity established to provide products
and/or services in the marketplace or to the
community.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { SubjectHeader
Aggregate, Required
Records high level information about the subject such
as the primary language of the subject and the primary
currency in which this subject trades. When the
subject is an organizantion, this may also include
details such as DUNS Number.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { SubjectHeader { DUNSNumber
string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}.,Required
The D-U-N-S Number is D&B's identification number,
which provides unique identification of this
organization, in accordance with the Data Universal
Numbering System (D-U-N-S).
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } SubjectHeader
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Location
Aggregate, Optional
Records the address details for a subject. An address is
the designation of a place where a subject can be
located or may be communicated with, e.g., primary
address, registered address, mailing address.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 105
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Location { PrimaryAddress
Aggregate, Optional
An entry loop to allow the recording of a single primary
or physical address of the subject in multiple languages
and/or writing scripts. For an organization this is the
principal address at which the organization is located.
For an individual, this is the home address.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Location { PrimaryAddress { StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of several lines where each address line
contains one or more named address elements.
Examples of named address elements are Street
Name, Street Number, Building Name, Estate Name.
They are called “lines” because an addres can be
divided into multiple lines. When there are multiple
lines the sequence of the lines must be preserved.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Location { PrimaryAddress { StreetAddressLine { LineText
string up to 240 chars., Required
Text that records the street address components as it
would be presented on an address label. This includes,
but is not limited to, details such as street name, street
number, building name, estate name.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Location }PrimaryAddress } StreetAddressLine
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Location { PrimaryAddress { PrimaryTownName
string, Optional
The name of the town or city recognized by the Postal
Authority for delivering mail
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Location { PrimaryAddress { TerritoryOfficialName
string, Optional
The legal name of the locally governed area which
forms part of a centrally governed nation. Clarification
Note: As a guiding principle this is a geographic area
which could theoretically exist as a separate nation. In
the U.S. this would be a State. In the UK this would be
one of the Home Nations.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 106
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Location { PrimaryAddress { PostalCode
string, Optional
An identifier used by the local country Postal Authority
to identify a particular geographic location. For
example, in Belgium, Postal Code 9000 identifies the
town of GHENT.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Location { PrimaryAddress { CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Required
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this
address.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Location }PrimaryAddress
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Location
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { OrganizationName
Aggregate, Optional
Records the different names of the organization by
which it is known as well as names of other
organizations that have a similar name to this
organization.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { OrganizationName { OrganizationPrimaryName
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of a single name by which the
organization is primarily known / identified in different
languages and/or writing scripts.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { OrganizationName { OrganizationPrimaryName { OrganizationName
OrganizationNameType up to 256 chars., Required
Text recording a name of this organization in the
specified language and/or writing script.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { OrganizationName { OrganizationPrimaryName { OrganizationName@NameIdentificationNumber
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 107
Name Characteristics
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } OrganizationName }OrganizationPrimaryName
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { OrganizationName { TradeStyleName
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of a single name by which the
organization is primarily known / identified in different
languages and/or writing scripts.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { OrganizationName { TradeStyleName { OrganizationName
OrganizationNameType up to 256 chars., Required
Text recording a name of this organization in the
specified language and/or writing script.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { OrganizationName { TradeStyleName { OrganizationName@NameIdentificationNumber
Attribute
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } OrganizationName }TradeStyleName
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } OrganizationName
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage
Aggregate, Optional
Records the relationship between the subject and the
next subject UP in the family tree. E.g. Its Parent, HQ,
Joint Parent or shareholder. Also records names,
addresses and registration numbers for the related
subject. This data topic may also be used to record the
details of the relationship between the subject and the
business founder; however if a simple textual
reference to the business founder is all that is required
then the 'Started By' element in 'Subject Details'
should be used
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization
Aggregate, Optional
Records information about the office that serves as the
administrative center of an enterprise.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 108
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { DUNSNumber
string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}.,Optional
The D-U-N-S Number is D&B's identification number,
which provides unique identification of this
organization, in accordance with the Data Universal
Numbering System (D-U-N-S).
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { OrganizationPrimaryName
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of a single name by which the
organization is primarily known / identified in different
languages and/or writing scripts.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { OrganizationPrimaryName { OrganizationName
OrganizationNameType up to 256 chars., Required
Text recording a name of this organization in the
specified language and/or writing script.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { OrganizationPrimaryName { OrganizationName@LanguageCode
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { OrganizationPrimaryName { OrganizationName@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { OrganizationPrimaryName { OrganizationName@NameIdentificationNumber
Attribute
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }HeadquartersOrganization } OrganizationPrimaryName
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 109
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { PrimaryAddress
Aggregate, Optional (Infinite)
An entry loop to allow the recording of a single primary
or physical address of the subject in multiple languages
and/or writing scripts. For an organization this is the
principal address at which the organization is located.
For an individual, this is the home address.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { PrimaryAddress@LanguageCode
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { PrimaryAddress@WritingScriptCode
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { PrimaryAddress { StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of several lines where each address line
contains one or more named address elements.
Examples of named address elements are Street
Name, Street Number, Building Name, Estate Name.
They are called “lines” because an addres can be
divided into multiple lines. When there are multiple
lines the sequence of the lines must be preserved.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { PrimaryAddress { StreetAddressLine { LineText
string up to 240 chars., Required
Text that records the street address components as it
would be presented on an address label. This includes,
but is not limited to, details such as street name, street
number, building name, estate name.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }HeadquartersOrganization } PrimaryAddress }StreetAddressLine
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { PrimaryAddress { PrimaryTownName
string up to 64 chars., Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 110
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { PrimaryAddress { PostalCode
string, Optional
An identifier used by the local country Postal Authority
to identify a particular geographic location. For
example, in Belgium, Postal Code 9000 identifies the
town of GHENT.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { PrimaryAddress { CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this
address.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { PrimaryAddress { TerritoryName
string up to 128 chars., Optional
The name of the locally governed area which forms
part of a centrally governed nation as received by D&B.
Clarification Note: As a guiding principle this is a
geographic area which could theoretically exist as a
separate nation. In the U.S. this would be a State. In
the UK this would be one of the Home Nations.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }HeadquartersOrganization } PrimaryAddress
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { Principal
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to
record the information of each principal that are
actively associated with the subject organization.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { Principal { PrincipalName
Aggregate, Optional
Records the different names for the Principal.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { Principal { PrincipalName@WritingScriptISOAlpha4Code
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 111
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { Principal { PrincipalName@LanguageCode
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { Principal { PrincipalName { FullName
string up to 256 chars., Optional
The entire name of the subject where the subject is
either an individual or an organization.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }HeadquartersOrganization } Principal } PrincipalName
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { Principal { JobTitle
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of the name used by the organization to
describe this person's job, e.g., Leader Global
Communication, Manager National Technical Support
Center.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { Principal { JobTitle { JobTitleText
string up to 3000 chars., Optional
Text that denotes a position held by the principal or
manager.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { Principal { JobTitle { JobTitleText@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { Principal { JobTitle { JobTitleText@LanguageCode
Attribute
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }HeadquartersOrganization } Principal } JobTitle
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { Principal { PrincipalLocation
Aggregate, Optional
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 112
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { HeadquartersOrganization { Principal { PrincipalLocation { PrimaryAddress { CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Required
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this
address.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }HeadquartersOrganization } Principal } PrincipalLocation }PrimaryAddress
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }HeadquartersOrganization } Principal } PrincipalLocation
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }HeadquartersOrganization } Principal
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }HeadquartersOrganization
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization
Aggregate, Optional (Infinite)
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { AssociationTypeText
string up to 256 chars., Optional
Text that denotes the type of family tree association
between the child and owner.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { AssociationTypeText@DNBCodeValue
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { AssociationTypeText@DNBCodeTableNumber
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 113
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { SubjectHeader
Aggregate, Optional
Records high level information about the subject such
as the primary language of the subject and the primary
currency in which this subject trades. When the
subject is an organizantion, this may also include
details such as DUNS Number.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { SubjectHeader { DUNSNumber
string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}.,Required
The D-U-N-S Number is D&B's identification number,
which provides unique identification of this
organization, in accordance with the Data Universal
Numbering System (D-U-N-S).
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }FamilyTreeMemberOrganization } SubjectHeader
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { Location
Aggregate, Optional
Records the address details for a subject. An address is
the designation of a place where a subject can be
located or may be communicated with, e.g., primary
address, registered address, mailing address.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { Location { PrimaryAddress
Aggregate, Optional
An entry loop to allow the recording of a single primary
or physical address of the subject in multiple languages
and/or writing scripts. For an organization this is the
principal address at which the organization is located.
For an individual, this is the home address.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { Location { PrimaryAddress { PrimaryTownName
string, Optional
The name of the town or city recognized by the Postal
Authority for delivering mail
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 114
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { Location { PrimaryAddress { TerritoryOfficialName
string, Optional
The legal name of the locally governed area which
forms part of a centrally governed nation. Clarification
Note: As a guiding principle this is a geographic area
which could theoretically exist as a separate nation. In
the U.S. this would be a State. In the UK this would be
one of the Home Nations.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { Location { PrimaryAddress { PostalCode
string, Optional
An identifier used by the local country Postal Authority
to identify a particular geographic location. For
example, in Belgium, Postal Code 9000 identifies the
town of GHENT.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { Location { PrimaryAddress { CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Required
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this
address.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }FamilyTreeMemberOrganization } Location } PrimaryAddress
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }FamilyTreeMemberOrganization } Location
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationPrimaryName
Aggregate, Optional
An entry loop which can repeat multiple times to allow
the recording of a single name by which the
organization is primarily known / identified in different
languages and/or writing scripts.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationPrimaryName@RegisteredNameIndicator
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 115
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationPrimaryName{ OrganizationName
OrganizationNameType up to 256 chars., Required
Text recording a name of this organization in the
specified language and/or writing script.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationPrimaryName{ OrganizationName@LanguageCode
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationPrimaryName{ OrganizationName@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { OrganizationPrimaryName{ OrganizationName@NameIdentificationNumber
Attribute
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }FamilyTreeMemberOrganization } OrganizationPrimaryName
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { Principal
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to
record the information of each principal that are
actively associated with the subject organization.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { Principal { PrincipalName
Aggregate, Optional
Records the different names for the Principal.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { Principal { PrincipalName@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { Principal { PrincipalName@LanguageCode
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 116
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { Principal { PrincipalName { FullName
string up to 256 chars., Optional
The entire name of the subject where the subject is
either an individual or an organization.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { Principal { PrincipalName { FullName@FormatText
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { Principal { PrincipalName { FullName@NameIdentificationNumber
Attribute
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }FamilyTreeMemberOrganization } Principal } PrincipalName
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { Principal { JobTitle
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of the name used by the organization to
describe this person's job, e.g., Leader Global
Communication, Manager National Technical Support
Center.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { Principal { JobTitle { JobTitleText
string up to 3000 chars., Optional
Text that denotes a position held by the principal or
manager.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { Principal { JobTitle { JobTitleText@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { Principal { JobTitle { JobTitleText@LanguageCode
Attribute
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }FamilyTreeMemberOrganization } Principal } JobTitle
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 117
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { Principal { PrincipalLocation
Aggregate, Optional
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeMemberOrganization { Principal { PrincipalLocation{ PrimaryAddress { CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Required
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this
address.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }FamilyTreeMemberOrganization } Principal } PrincipalLocation }PrimaryAddress
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }FamilyTreeMemberOrganization } Principal } PrincipalLocation
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }FamilyTreeMemberOrganization } Principal
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }FamilyTreeMemberOrganization
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization
Aggregate, Optional
Records information about the organization which
owns more than 50% of the subject and the
organization at the very top of the legal family.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO)identifying the country of the
inquired subject.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 118
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { DUNSNumber
string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}.,Optional
The D-U-N-S Number is D&B's identification number,
which provides unique identification of this
organization, in accordance with the Data Universal
Numbering System (D-U-N-S).
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { OrganizationPrimaryName
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of a single name by which the
organization is primarily known / identified in different
languages and/or writing scripts.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { OrganizationPrimaryName { OrganizationName
OrganizationNameType up to 256 chars., Required
Text recording a name of this organization in the
specified language and/or writing script.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { OrganizationPrimaryName { OrganizationName@LanguageCode
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { OrganizationPrimaryName { OrganizationName@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { OrganizationPrimaryName { OrganizationName@NameIdentificationNumber
Attribute
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }ParentOrganization } OrganizationPrimaryName
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 119
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { PrimaryAddress
Aggregate, Optional (Infinite)
An entry loop to allow the recording of a single primary
or physical address of the subject in multiple languages
and/or writing scripts. For an organization this is the
principal address at which the organization is located.
For an individual, this is the home address.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { PrimaryAddress@LanguageCode
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { PrimaryAddress@WritingScriptCode
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { PrimaryAddress { StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of several lines where each address line
contains one or more named address elements.
Examples of named address elements are Street
Name, Street Number, Building Name, Estate Name.
They are called “lines” because an addres can be
divided into multiple lines. When there are multiple
lines the sequence of the lines must be preserved.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { PrimaryAddress { StreetAddressLine { LineText
string up to 240 chars., Required
Text that records the street address components as it
would be presented on an address label. This includes,
but is not limited to, details such as street name, street
number, building name, estate name.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }ParentOrganization } PrimaryAddress } StreetAddressLine
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { PrimaryAddress { PrimaryTownName
string up to 64 chars., Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 120
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { PrimaryAddress { PostalCode
string, Optional
An identifier used by the local country Postal Authority
to identify a particular geographic location. For
example, in Belgium, Postal Code 9000 identifies the
town of GHENT.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { PrimaryAddress { CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this
address.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { PrimaryAddress { TerritoryName
string up to 128 chars., Optional
The name of the locally governed area which forms
part of a centrally governed nation as received by D&B.
Clarification Note: As a guiding principle this is a
geographic area which could theoretically exist as a
separate nation. In the U.S. this would be a State. In
the UK this would be one of the Home Nations.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }ParentOrganization } PrimaryAddress
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { Principal
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to
record the information of each principal that are
actively associated with the subject organization.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { Principal { PrincipalName
Aggregate, Optional
Records the different names for the Principal.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { Principal { PrincipalName@WritingScriptISOAlpha4Code
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 121
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { Principal { PrincipalName@LanguageCode
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { Principal { PrincipalName { FullName
string up to 256 chars., Optional
The entire name of the subject where the subject is
either an individual or an organization.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }ParentOrganization } Principal } PrincipalName
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { Principal { JobTitle
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of the name used by the organization to
describe this person's job, e.g., Leader Global
Communication, Manager National Technical Support
Center.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { Principal { JobTitle { JobTitleText
string up to 3000 chars., Optional
Text that denotes a position held by the principal or
manager.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { Principal { JobTitle { JobTitleText@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { Principal { JobTitle { JobTitleText@LanguageCode
Attribute
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }ParentOrganization } Principal } JobTitle
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { Principal { PrincipalLocation
Aggregate, Optional
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 122
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { Principal { PrincipalLocation { PrimaryAddress
Aggregate, Optional
An entry loop to allow the recording of a single primary
or physical address of the subject in multiple languages
and/or writing scripts. For an organization this is the
principal address at which the organization is located.
For an individual, this is the home address.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { ParentOrganization { Principal { PrincipalLocation { PrimaryAddress { CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Required
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this
address.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }ParentOrganization } Principal } PrincipalLocation }PrimaryAddress
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }ParentOrganization } Principal } PrincipalLocation
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }ParentOrganization } Principal
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage }ParentOrganization
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { Linkage { FamilyTreeHierarchyLevel
int up to 2 digits., Optional
A two-position code, in conjunction with the status
and subsidiary indicators that pinpoints the location of
an establishment within a corporate hierarchy.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization } Linkage
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 123
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { PrincipalsAndManagement
Aggregate, Optional
Records details of the Principals (e.g., President, Vice
President, Directors) and Managers responsible for the
business strategy, decision making and day to day
running of the subjects operations. This includes
names, addresses and identification numbers of the
principals. Whilst a principal will usually be an individual
in some countries it is legally acceptable for a
registered business entity to act as a principal in
another business. This excludes shareholders and
similar owners who are not responsible for the
management of the organization but includes
proprietors and partners who, whilst owners, are also
generally the principals running the business.Records
details of the Principals (e.g., President, Vice President,
Directors) and Managers responsible for the business
strategy, decision making and day to day running of the
subjects operations. This includes names, addresses
and identification numbers of the principals. Whilst a
principal will usually be an individual in some countries
it is legally acceptable for a registered business entity
to act as a principal in another business. This excludes
shareholders and similar owners who are not
responsible for the management of the organization
but includes proprietors and partners who, whilst
owners, are also generally the principals running the
business.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { PrincipalsAndManagement { CurrentPrincipal
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
recording of the information of each principal that are
actively associated with the subject organization.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { PrincipalsAndManagement { CurrentPrincipal { PrincipalName
Aggregate, Optional
Records the different names for the Principal.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { PrincipalsAndManagement { CurrentPrincipal { PrincipalName@WritingScriptISOAlpha4Code
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 124
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { PrincipalsAndManagement { CurrentPrincipal { PrincipalName@LanguageCode
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { PrincipalsAndManagement { CurrentPrincipal { PrincipalName{ FullName
string up to 256 chars., Optional
The entire name of the subject where the subject is
either an individual or an organization.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { PrincipalsAndManagement { CurrentPrincipal { PrincipalName{ FullName@FormatText
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { PrincipalsAndManagement { CurrentPrincipal { PrincipalName{ FullName@NameIdentificationNumber
Attribute
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization }PrincipalsAndManagement } CurrentPrincipal } PrincipalName
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { PrincipalsAndManagement { CurrentPrincipal { JobTitle
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of the name used by the organization to
describe this person's job, e.g., Leader Global
Communication, Manager National Technical Support
Center.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { PrincipalsAndManagement { CurrentPrincipal { JobTitle { JobTitleText
string up to 3000 chars., Optional
Text that denotes a position held by the principal or
manager.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { PrincipalsAndManagement { CurrentPrincipal { JobTitle { JobTitleText@WritingScriptISOAlpha4Code
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 125
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { PrincipalsAndManagement { CurrentPrincipal { JobTitle { JobTitleText@LanguageCode
Attribute
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization }PrincipalsAndManagement } CurrentPrincipal } JobTitle
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { PrincipalsAndManagement { CurrentPrincipal { PrincipalLocation
Aggregate, Optional
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { PrincipalsAndManagement { CurrentPrincipal { PrincipalLocation { PrimaryAddress
Aggregate, Optional
An entry loop to allow the recording of a single primary
or physical address of the subject in multiple languages
and/or writing scripts. For an organization this is the
principal address at which the organization is located.
For an individual, this is the home address.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { Organization { PrincipalsAndManagement { CurrentPrincipal { PrincipalLocation { PrimaryAddress { CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Required
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this
address.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization }PrincipalsAndManagement } CurrentPrincipal }PrincipalLocation
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization }PrincipalsAndManagement } CurrentPrincipal
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization }PrincipalsAndManagement
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } Organization
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 126
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of the changes to the details of the
supplier registered for monitoring.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { InquiryDetail
Aggregate, Optional
Inquiry Detail for the Alert
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { InquiryDetail { SubjectName
_, Required
The name of the individual or organization from which
the subject purchases goods or services.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { InquiryDetail { SubjectName@NameIdentificationNumber
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { InquiryDetail { Location
Aggregate, Optional
Records the components of a location for which the
business activity profile information is requested.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { InquiryDetail { Location { StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of several lines where each address line
contains one or more named address elements.
Examples of named address elements are Street
Name, Street Number, Building Name, Estate Name.
They are called “lines” because an addres can be
divided into multiple lines. When there are multiple
lines the sequence of the lines must be preserved.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { InquiryDetail { Location { StreetAddressLine { LineText
string up to 240 chars., Required
Text that records the street address components as it
would be presented on an address label. This includes,
but is not limited to, details such as street name, street
number, building name, estate name.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 127
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { InquiryDetail { Location { StreetAddressLine { DisplaySequence
int up to 3 digits., Optional
A number which may be used to define the order in
which this street address line should be presented
relative to other street address lines where the lower
the number the earlier the data is presented.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } SubjectAlertDetail } InquiryDetail }Location } StreetAddressLine
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { InquiryDetail { Location { PrimaryTownName
string up to 64 chars., Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { InquiryDetail { Location { PostalCode
string, Optional
An identifier used by the local country Postal Authority
to identify a particular geographic location. For
example, in Belgium, Postal Code 9000 identifies the
town of GHENT.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { InquiryDetail { Location { CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this
address.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } SubjectAlertDetail } InquiryDetail }Location
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } SubjectAlertDetail } InquiryDetail
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { RenderingApplicationID
string up to 100 chars., Optional
An alphanumeric value assigned to uniquely identify
the application delivering the report view of the alert
entity.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 128
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { AlertID
string up to 64 chars., Optional
An alphanumeric value that uniquely identifies the
Alert.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { AlertEntityID
string up to 32 chars., Optional
An alphanumeric value that uniquely identifies the
Vendor.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { AlertDate
date, Optional
Date when the alert was created.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { AlertNoteText
string up to 1000 chars., Optional
Text that describes the alert note.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { EntityTypeText
EntityTypeEnumeration, Optional
Text describes whether the entity is Person or
Organization.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { EntityReferenceWebPageURL
string up to 512 chars., Optional
Text identifying the internet URL that provides
additional information like media articles for the Entity.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { EntityMatchDetail
Aggregate, Optional
Records the details of the score indicating the degree
of the match to the inquiry name.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { EntityMatchDetail { EntityMatchScore
int up to 3 digits., Optional
A numeric value ranging from 1 to 100 which denotes
the degree of match of this entity against the inquired
subject name. A value of 1 denotes lowest degree of
match, value of 100 denotes highest degree of match.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } SubjectAlertDetail } EntityMatchDetail
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { ReferenceDetail
Aggregate, Optional (Infinite)
Records the source details of the data which was
originally obtained by D&B.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 129
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { ReferenceDetail { SourceName
string up to 400 chars., Optional
Text recording the name of the source from which the
alert data was originally obtained.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { ReferenceDetail { SourceDescription
string up to 500 chars., Optional
Text that describes the source.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { ReferenceDetail { PublicationName
string up to 500 chars., Optional
Name of the publication.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { ReferenceDetail { PublicationDate
date, Optional
The date of publication.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { ReferenceDetail { WebPageURL
string up to 500 chars., Optional
Records the internet link of the publication content.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { ReferenceDetail { PublisherName
string up to 512 chars., Optional
Name of the company or person that publishes
products.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { ReferenceDetail { SourceListName
string up to 256 chars., Optional
Text recording the name of the list from which the
alert data was originally obtained; e.g., UK sanctions
list, OFAC list.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { ReferenceDetail { SourceTypeText
string up to 256 chars., Optional
Text denoting the category of the source; e.g., internet,
publication, media.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { ReferenceDetail { ContentText
string up to 5000 chars., Optional
Text that records the body of the news item.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } SubjectAlertDetail } ReferenceDetail
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 130
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { EventDetail
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of the details of the events in which the
supplier is involved.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { EventDetail { EventTypeText
string up to 3 chars., Optional
Text that describes the category of the event.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { EventDetail { EventSubTypeText
string up to 3 chars., Optional
Text that describes the sub category of the event.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { EventDetail { EventText
string up to 2000 chars., Optional (Infinite)
Free form text recording additional details about the
event.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { EventDetail { EventDate
date, Optional
The date when the event occured.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { EventDetail { EventDate@DatePrecisionText
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { EventDetail { EventDate@DatePrecisionDNBCodeValue
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { EventDetail { EventDate@DatePrecisionDNBCodeTableNumber
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { EventDetail { EndDate
DateTimestamp, Optional
Date when the event action was no longer in affect.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } SubjectAlertDetail } EventDetail
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Name
Aggregate, Optional
Records the names used to identify this supplier.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 131
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Name { PrimaryName
string, Required
Name of the subject by which it is primarily known /
identified.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Name { KnownByName
string up to 500 chars., Optional (Infinite)
Any other name by which the subject is known which
cannot be categorised by one of the other name types
either because the name category is not covered by an
existing type of because the precise name type cannot
be identified.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Name { FormerPrimaryName
string up to 500 chars., Optional (Infinite)
Name of the subject was primarily known / identified
previously.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Name { TradeStyleName
string up to 500 chars., Optional (Infinite)
Name of the subject trades under for commercial
purposes, although its registered, legal name, used for
contracts and other formal situations, may be another.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } SubjectAlertDetail } Name
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address
Aggregate, Optional
Records the location details of the supplier.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { BirthAddress
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of the birth location details of the
supplier.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 132
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { BirthAddress { StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of several lines where each address line
contains one or more named address elements.
Examples of named address elements are Street
Name, Street Number, Building Name, Estate Name.
They are called “lines” because an addres can be
divided into multiple lines. When there are multiple
lines the sequence of the lines must be preserved.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { BirthAddress { StreetAddressLine { LineText
string up to 240 chars., Required
Text that records the street address components as it
would be presented on an address label. This includes,
but is not limited to, details such as street name, street
number, building name, estate name.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { BirthAddress { StreetAddressLine { DisplaySequence
int up to 3 digits., Optional
A number which may be used to define the order in
which this street address line should be presented
relative to other street address lines where the lower
the number the earlier the data is presented.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } SubjectAlertDetail } Address }BirthAddress } StreetAddressLine
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { BirthAddress { PrimaryTownName
string, Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { BirthAddress { TerritoryName
string, Optional
The name of the locally governed area which forms
part of a centrally governed nation as received by D&B.
Clarification Note: As a guiding principle this is a
geographic area which could theoretically exist as a
separate nation. In the U.S. this would be a State. In
the UK this would be one of the Home Nations.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 133
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { BirthAddress { PostalCode
string, Optional
An identifier used by the local country Postal Authority
to identify a particular geographic location. For
example, in Belgium, Postal Code 9000 identifies the
town of GHENT.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { BirthAddress { CountryName
string, Optional
The name of the country of this address.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } SubjectAlertDetail } Address }BirthAddress
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { PrimaryAddress
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of the present location details of the
supplier.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { PrimaryAddress { StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of several lines where each address line
contains one or more named address elements.
Examples of named address elements are Street
Name, Street Number, Building Name, Estate Name.
They are called “lines” because an addres can be
divided into multiple lines. When there are multiple
lines the sequence of the lines must be preserved.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { PrimaryAddress { StreetAddressLine { LineText
string up to 240 chars., Required
Text that records the street address components as it
would be presented on an address label. This includes,
but is not limited to, details such as street name, street
number, building name, estate name.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { PrimaryAddress { StreetAddressLine { DisplaySequence
int up to 3 digits., Optional
A number which may be used to define the order in
which this street address line should be presented
relative to other street address lines where the lower
the number the earlier the data is presented.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 134
Name Characteristics
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } SubjectAlertDetail } Address }PrimaryAddress } StreetAddressLine
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { PrimaryAddress { PrimaryTownName
string, Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { PrimaryAddress { TerritoryName
string, Optional
The name of the locally governed area which forms
part of a centrally governed nation as received by D&B.
Clarification Note: As a guiding principle this is a
geographic area which could theoretically exist as a
separate nation. In the U.S. this would be a State. In
the UK this would be one of the Home Nations.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { PrimaryAddress { PostalCode
string, Optional
An identifier used by the local country Postal Authority
to identify a particular geographic location. For
example, in Belgium, Postal Code 9000 identifies the
town of GHENT.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { PrimaryAddress { CountryName
string, Optional
The name of the country of this address.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } SubjectAlertDetail } Address }PrimaryAddress
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { NonspecificAddress
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of supplier address, which cannot be
classified into distinct sections.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 135
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { NonspecificAddress { StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of several lines where each address line
contains one or more named address elements.
Examples of named address elements are Street
Name, Street Number, Building Name, Estate Name.
They are called “lines” because an addres can be
divided into multiple lines. When there are multiple
lines the sequence of the lines must be preserved.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { NonspecificAddress { StreetAddressLine { LineText
string up to 240 chars., Required
Text that records the street address components as it
would be presented on an address label. This includes,
but is not limited to, details such as street name, street
number, building name, estate name.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { NonspecificAddress { StreetAddressLine { DisplaySequence
int up to 3 digits., Optional
A number which may be used to define the order in
which this street address line should be presented
relative to other street address lines where the lower
the number the earlier the data is presented.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } SubjectAlertDetail } Address }NonspecificAddress } StreetAddressLine
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { NonspecificAddress { PrimaryTownName
string, Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { NonspecificAddress { TerritoryName
string, Optional
The name of the locally governed area which forms
part of a centrally governed nation as received by D&B.
Clarification Note: As a guiding principle this is a
geographic area which could theoretically exist as a
separate nation. In the U.S. this would be a State. In
the UK this would be one of the Home Nations.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 136
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { NonspecificAddress { PostalCode
string, Optional
An identifier used by the local country Postal Authority
to identify a particular geographic location. For
example, in Belgium, Postal Code 9000 identifies the
town of GHENT.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { NonspecificAddress { CountryName
string, Required
The name of the country of this address.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { Address { NonspecificAddress { AddressTypeText
string up to 32 chars., Optional
Text identifying the type of address being supplied.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } SubjectAlertDetail } Address }NonspecificAddress
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } SubjectAlertDetail } Address
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { PersonalDetail
Aggregate, Optional
Records the personal information about the individual.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { PersonalDetail { BirthDate
date, Optional (Infinite)
The date when the individula was born.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { PersonalDetail { BirthDate@DatePrecisionText
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { PersonalDetail { BirthDate@DatePrecisionDNBCodeValue
Attribute
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { PersonalDetail { BirthDate@DatePrecisionDNBCodeTableNumber
Attribute
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } SubjectAlertDetail } PersonalDetail
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 137
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { NonspecificParameterDetail
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of supplier information, which cannot be
classified into distinct sections, as key value pairs.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { NonspecificParameterDetail { ParameterDescription
string up to 256 chars., Optional
Text that identifies the data in ParameterValue.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { NonspecificParameterDetail { ParameterValue
string up to 512 chars., Optional
Text that records a fact being communicated in the
decisioning process and identified by the
ParameterDescription.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } SubjectAlertDetail }NonspecificParameterDetail
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { ComplianceData{ ComplianceSubject { SubjectAlertDetail { DisplaySequence
int, Optional
A number which may be used to define the order in
which this text entry should be presented relative to
other occurrences of text entries where the lower the
number the earlier the data is presented.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject } SubjectAlertDetail
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData} ComplianceSubject
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail } ComplianceData
/Aggregate
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { InquiryReferenceDetail
Aggregate, Optional
Records data that allows the customer to specify
information to be linked to the request in order to
support subsequent order reconciliation.
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { InquiryReferenceDetail { CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer
to be linked to the product in order to support
subsequent order reconciliation.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 138
Name Characteristics
GetSubjectComplianceDataResponse { GetSubjectComplianceDataResponseDetail { InquiryReferenceDetail { CustomerBillingEndorsementText
string at least 1 chars. up to 240 chars., Optional
Text that is filled in by customer and commonly
contains requesting individual or department name, or
customer's own account/reference number and/or
name for the case on which the product was
provided.This text is a reference used during the billing
process.
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail }InquiryReferenceDetail
/Aggregate
END: GetSubjectComplianceDataResponse }GetSubjectComplianceDataResponseDetail
/Aggregate
END: GetSubjectComplianceDataResponse /Aggregate
Lists of possible values (when present) are subject to change. Additional values not presented in this documentation may be delivered
in the response and should be anticipated in any implementation.
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
During the period after a successful registration and the availability of results, this operation will return aCM000 response code and the ResultText will equal "RESPONSE IS STILL PROCESSING."
{"GetSubjectComplianceDataResponse": {
"TransactionDetail": {"ApplicationTransactionID": "063054273","ServiceTransactionID": "SVC_TRAN_001","TransactionTimestamp": "2013-12-13T06:31:00.119-05:00"
},"TransactionResult": {
"ResultID": "CM000","ResultText": "RESPONSE IS STILL PROCESSING","SeverityText": "Information"
}}
}
D&B Direct API Documentation Response Codes
©Dun & Bradstreet, Inc. 2014 139
This operation may return the following response codes: CM001, CM002, CM003, CM004, CM007, CM013,CM018 and SC001-SC009.
Operation-specific supplemental response code explanations:
CM001 The given request is invalid.
CM002 The format of this request is invalid.
CM003 Missing Information in the request.
CM004 Internal D&B system error. Please try again or contact your local Customer Service Center.
CM007 Your request cannot be fulfilled for the given criteria.
CM013 Invalid Subject ID provided in the request. Please refer to Online Documentation.
CM018 No candidates resulted for the given input criteria.
Sub-Process Results
Some service levels will invoke additional processes upon successful completion of a RegisterSubject operationcall. In the event that an additional process fails, an error response will be delivered in the SubProcessResultsection. Here are the possible values:
<SubProcessName> <ResultID> <ResultText>
Match CMP001 No Match for the given input criteria. Supplier Registration process aborted sinceD&B is unable to append data on the supplier.
Match CMP002 No Match for the given input criteria.
Match CMP003 Internal D&B system error. Supplier Registration process aborted since D&B isunable to append data on the supplier.
Match CMP004 Internal D&B system error.
RefreshCheck CMP005 TODO
RefreshCheck CMP006 DUNS Deleted
RefreshCheck CMP007 TODO
RefreshCheck CMP008 Invalid Duns number provided in the request.
RefreshCheck CMP009 TODO
RefreshCheck CMP004 Internal D&B system error.
DataAppend CMP011 D&B Data is out of Date. Supplier Registration process aborted since D&B isunable to append data on the supplier.
DataAppend CMP012 D&B Data is out of Date.
DataAppend CMP003 Internal D&B system error. Supplier Registration process aborted since D&B isunable to append data on the supplier.
DataAppend CMP004 Internal D&B system error.
D&B Direct API Documentation Sub-Process Results
©Dun & Bradstreet, Inc. 2014 140
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Compliance Check Service
Samples http://developer.dnb.com/docs/2.0/compliance/1.0/DnB-Compliance.zip
Related Topics
RegisterSubject (REST), ListComplianceSubjects (REST), GetComplianceAlerts (SOAP), Entity Attributes, EventCategories and Sub-Categories, Data Products by Category.
D&B Direct API Documentation Samples (Download)
©Dun & Bradstreet, Inc. 2014 141
GetSubjectComplianceData (SOAP)This operation -- part of the Compliance Check Service -- is a component of the Compliance √ Screeningsolution.
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Note: While the Compliance √ Screening features are accessed through the D&B Direct service, separatecredentials are required for each data environment and will be provided by a D&B sales representative.
Endpoint
https://maxcvservices.dnb.com/ComplianceCheckService/V{version}
Request Parameters
The following parameters are accepted by this operation.
Name Characteristics
GetSubjectComplianceDataRequest Aggregate
GetSubjectComplianceDataRequest@ServiceVersionNumber
Attribute
GetSubjectComplianceDataRequest.TransactionDetail
Aggregate, Optional
Records information necessary to process this request.
GetSubjectComplianceDataRequest.TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely identify this
request.
GetSubjectComplianceDataRequest.TransactionDetail. TransactionTimestamp
DateTimestamp, Optional
The date and time when this request was created. When the request is
from an intermediary, such as a workflow manager or service bus, this is
the date and time when the message was sent to the D&B function, i.e.,
the date and time when the xml document was created by the requesting
intermediary.
D&B Direct API Documentation GetSubjectComplianceData (SOAP)
©Dun & Bradstreet, Inc. 2014 142
Name Characteristics
GetSubjectComplianceDataRequest.TransactionDetail. SubmittingOfficeID
string up to 64 chars., Optional
A number that identifies the system or the software application from
where this request originated. / A number used to uniquely identfy the
D&B business segment or delivery channel from where this request
originated.
End: GetSubjectComplianceDataRequest.TransactionDetail
/Aggregate
GetSubjectComplianceDataRequest.GetSubjectComplianceDataRequestDetail
Aggregate, Required
Records data relating to requests for a product. This may include such
details as the product required, the subject about which the product should
be produced, the content of the product.
GetSubjectComplianceDataRequest.GetSubjectComplianceDataRequestDetail.InquiryDetail
Aggregate, Required
Records data that allows the customer to specify identifying information
about the subject being inquired, e.g., the DUNS Number, the address, the
telephone number.
GetSubjectComplianceDataRequest.GetSubjectComplianceDataRequestDetail.InquiryDetail. SubjectID
SubjectIDType up to 25 chars., Optional
A number uniquely identifying the inquired subject within the D&B
Worldwide Network.
End: GetSubjectComplianceDataRequest.GetSubjectComplianceDataRequestDetail.InquiryDetail
/Aggregate
GetSubjectComplianceDataRequest.GetSubjectComplianceDataRequestDetail.ComplianceDataSpecification
Aggregate, Required
Records data that allows the customer to specify the details of the
requested product. This may include details such as the identifier of the
product, the language in which the product needs to be rendered, the
format in which the product needs to be rendered.
GetSubjectComplianceDataRequest.GetSubjectComplianceDataRequestDetail.ComplianceDataSpecification.ComplianceDataModuleID
string up to 64 chars., Optional (Infinite)
Possible values: APPEND_DATA; ALERTS
End: GetSubjectComplianceDataRequest.GetSubjectComplianceDataRequestDetail.ComplianceDataSpecification
/Aggregate
GetSubjectComplianceDataRequest.GetSubjectComplianceDataRequestDetail.InquiryReferenceDetail
Aggregate, Optional
Records data that allows the customer to specify information to be linked
to the request in order to support subsequent order reconciliation.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 143
Name Characteristics
GetSubjectComplianceDataRequest.GetSubjectComplianceDataRequestDetail.InquiryReferenceDetail.CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to be linked to the
product in order to support subsequent order reconciliation.
End: GetSubjectComplianceDataRequest.GetSubjectComplianceDataRequestDetail.InquiryReferenceDetail
/Aggregate
End: GetSubjectComplianceDataRequest.GetSubjectComplianceDataRequestDetail
/Aggregate
End: GetSubjectComplianceDataRequest /Aggregate
Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:com="http://services.dnb.com/ComplianceCheckServiceV2.0">
<soapenv:Header><wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://do
cs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken-2"><wsse:Username>MyUsername</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>
<com:GetSubjectComplianceDataRequest><GetSubjectComplianceDataRequestDetail>
<InquiryDetail><SubjectID>1018961</SubjectID>
</InquiryDetail><ComplianceDataSpecification>
<ComplianceDataModuleID>ALERTS</ComplianceDataModuleID>
<LanguagePreferenceCode>39</LanguagePreferenceCode></ComplianceDataSpecification>
</GetSubjectComplianceDataRequestDetail></com:GetSubjectComplianceDataRequest>
D&B Direct API Documentation Sample Request
©Dun & Bradstreet, Inc. 2014 144
</soapenv:Body></soapenv:Envelope>
Testing / Sandbox
This operation is currently unavailable in the D&B Direct sandbox (test) environment.
Data Field Response
The following is a list of the possible data fields returned by this operation in the XML response.
Name Characteristics
GetSubjectComplianceDataResponse Aggregate
GetSubjectComplianceDataResponse@ServiceVersionNumber Attribute
GetSubjectComplianceDataResponse. TransactionDetail Aggregate, Required
Records information necessary to process a particular
request. Examples of a request is the ordering of a
product.
GetSubjectComplianceDataResponse. TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to
uniquely identify this request.
GetSubjectComplianceDataResponse. TransactionDetail.ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely
identify this transaction.
GetSubjectComplianceDataResponse. TransactionDetail.TransactionTimestamp
DateTimestamp, Required
The date and time when this request was submitted or
the date and time when the requesting intermediary,
such as a workflow manager or service bus, sent the
message to the D&B function, i.e., the date and time
when the xml document was created by the
requesting intermediary.
END: GetSubjectComplianceDataResponse. TransactionDetail /Aggregate
GetSubjectComplianceDataResponse. TransactionResult Aggregate, Required
An aggregate that can repeat multiple times to record
the different outcomes of the transaction.
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2014 145
Name Characteristics
GetSubjectComplianceDataResponse. TransactionResult.SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g.,
Information, Warning, Error, Fatal.
GetSubjectComplianceDataResponse. TransactionResult.ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the
outcome of the transaction.
GetSubjectComplianceDataResponse. TransactionResult.ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
GetSubjectComplianceDataResponse. TransactionResult.ResultMessage
Aggregate, Optional (Infinite)
An aggregate that can repeat multiple times to record
textual data that expands on the ResultID and
ResultText to provide additional information to the
user regarding the status of the transaction. If the
status implies that there is a problem this may also
provide guidance to the user on how to address it.
GetSubjectComplianceDataResponse. TransactionResult.ResultMessage. ResultDescription
string up to 512 chars., Required
Text that describes the additional information
regarding the outcome of the transaction.
END: GetSubjectComplianceDataResponse. TransactionResult.ResultMessage
/Aggregate
END: GetSubjectComplianceDataResponse. TransactionResult /Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail
Aggregate, Optional
Records the data being returned to the customer as a
result of a product request.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. InquiryDetail
Aggregate, Required
Records data that allows the customer to specify
identifying information about the subject being
inquired, e.g., the DUNS Number, the address, the
telephone number.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. InquiryDetail.SubjectID
SubjectIDType up to 25 chars., Optional
A number uniquely identifying the inquired subject
within the D&B Worldwide Network.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 146
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. InquiryDetail.ApplicationSubjectID
ApplicationSubjectIDType up to 20 chars., Optional
A number uniquely identifying the inquired subject
within an application.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. InquiryDetail
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. SubProcessResult
Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. SubProcessResult.SubProcessName
Element
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. SubProcessResult.ResultID
Element
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. SubProcessResult.ResultText
Element
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. SubProcessResult
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData
Aggregate, Required
Records data about the product ordered by the
customer and data about the organization on which
the customer has placed this order.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject
Aggregate, Optional
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectID
SubjectIDType up to 25 chars., Optional
A number uniquely identifying the inquired subject
within an application.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData
Aggregate, Optional (Infinite)
Records data that allows the supplier to specify
identifying information about the subject being
inquired, e.g., the DUNS Number, SupplierName etc.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData. ProjectID
string up to 64 chars., Optional
An internal project identifciation provided by customer
to uniquely identify the record
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 147
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.SubjectName
_, Required
The name of the individual or organization from which
the subject purchases goods or services.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.SubjectName@LanguageCode
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.SubjectName@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.DUNSNumber
string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}.,Optional
The D-U-N-S Number is D&B's identification number,
which provides unique identification of this
organization, in accordance with the Data Universal
Numbering System (D-U-N-S).
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.ApplicationSubjectID
ApplicationSubjectIDType up to 20 chars., Optional
A number uniquely identifying the inquired subject
within the application.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData. Principal
Aggregate, Optional(Up to 6x)
Records the information of each principal that are
actively associated with the subject organization.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData. Principal.PrincipalName
_, Optional
Records the different names for the Principal.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData. Principal.PrincipalName@LanguageCode
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData. Principal.PrincipalName@WritingScriptISOAlpha4Code
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 148
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData. Principal.JobTitle
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of the name used by the organization to
describe this person's job, e.g., Leader Global
Communication, Manager National Technical Support
Center.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData. Principal.JobTitle. JobTitleText
string up to 3000 chars., Optional
Text that denotes a position held by the principal or
manager.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData. Principal.JobTitle. JobTitleText@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData. Principal.JobTitle. JobTitleText@LanguageCode
Attribute
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData. Principal.JobTitle
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData. Principal.CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO)identifying the country of the
inquired subject.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData. Principal.DataProviderName@DNBCodeValue
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData. Principal.DataProviderName@DNBCodeTableNumber
Attribute
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData. Principal
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 149
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.Shareholder
Aggregate, Optional(Up to 6x)
Records the information of individual or organization
that legally owns a share of stock in a public or private
organization.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.Shareholder. ShareholderName
_, Optional
The name of the individual or organization that legally
who owns a share of stock in a public or private
organization.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.Shareholder. ShareholderName@LanguageCode
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.Shareholder. ShareholderName@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.Shareholder. ShareholderName@NameIdentificationNumber
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.Shareholder. ShareholdingPercentage
decimal up to 5 digits. Maximum of 2 decimalplaces., Optional
Records the percentage of share owned by the
individual or organization.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.Shareholder. CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO)identifying the country of the
inquired subject.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.Shareholder. DataProviderName@DNBCodeValue
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.Shareholder. DataProviderName@DNBCodeTableNumber
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 150
Name Characteristics
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.Shareholder
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.DivisionDetail
Aggregate, Optional
Records the customer created caregories under which
the customers' suppliers are classified. For example,
the division for Walmart is Retailmarket.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.DivisionDetail. ComplianceDivisionID
long, Optional
An alphanumeric value that uniquely identifies the
customer created category.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.DivisionDetail. ComplianceDivisionName
string up to 256 chars., Optional
Name of the customer created category.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.DivisionDetail.ComplianceDivisionName@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.DivisionDetail. ComplianceDivisionName@LanguageCode
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.DivisionDetail. ComplianceQueueID
long, Optional
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.DivisionDetail. ComplianceQueueName
string up to 256 chars., Optional
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.DivisionDetail.ComplianceQueueName@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.DivisionDetail. ComplianceQueueName@LanguageCode
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 151
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.DivisionDetail. SubDivisionDetail
Aggregate, Optional (Infinite)
Records the customer created sub caregories under
which the customer's suppliers are classified. For
example, the division for Walmart is Retailmarket.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.DivisionDetail. SubDivisionDetail. SubDivisionID
long, Optional
An alphanumeric value that uniquely identifies the
customer created sub category.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.DivisionDetail. SubDivisionDetail. SubDivisionName
string up to 256 chars., Optional
Name of the customer created sub category.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.DivisionDetail. SubDivisionDetail
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.DivisionDetail
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.PrimaryAddress
Aggregate, Required
An entry loop to allow the recording of a single primary
or physical address of the subject in multiple languages
and/or writing scripts. For an organization this is the
principal address at which the organization is located.
For an individual, this is the home address.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.PrimaryAddress@LanguageCode
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.PrimaryAddress@WritingScriptCode
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 152
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.PrimaryAddress. StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of several lines where each address line
contains one or more named address elements.
Examples of named address elements are Street
Name, Street Number, Building Name, Estate Name.
They are called “lines” because an addres can be
divided into multiple lines. When there are multiple
lines the sequence of the lines must be preserved.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.PrimaryAddress. StreetAddressLine. LineText
string up to 240 chars., Required
Text that records the street address components as it
would be presented on an address label. This includes,
but is not limited to, details such as street name, street
number, building name, estate name.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.PrimaryAddress. StreetAddressLine
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.PrimaryAddress. PrimaryTownName
string up to 64 chars., Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.PrimaryAddress. PostalCode
string, Optional
An identifier used by the local country Postal Authority
to identify a particular geographic location. For
example, in Belgium, Postal Code 9000 identifies the
town of GHENT.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.PrimaryAddress. CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this
address.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 153
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.PrimaryAddress. TerritoryName
string up to 128 chars., Optional
The name of the locally governed area which forms
part of a centrally governed nation as received by D&B.
Clarification Note: As a guiding principle this is a
geographic area which could theoretically exist as a
separate nation. In the U.S. this would be a State. In
the UK this would be one of the Home Nations.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.PrimaryAddress
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.SalesRevenueAmount
decimal, Optional
The monetary value of income received from
customers from the sale of the business' goods and/or
services. This means it is the gross sales minus any
returns, rebates/discounts, allowances for damages or
shortages, shipping expenses passed on to the
customer, and amounts due where there is not a
reasonable expectation of collection.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.SalesRevenueAmount@UnitOfSize
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.SalesRevenueAmount@CurrencyISOAlpha3Code
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.SalesRevenueAmount@ReliabilityText
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.SubjectIdentificationNumberDetail
Aggregate, Optional (Infinite)
Records the address details where the Organization
Identification Number is registered.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.SubjectIdentificationNumberDetail@DNBCodeValue
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 154
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.SubjectIdentificationNumberDetail@DNBCodeTableNumber
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.SubjectIdentificationNumberDetail@TypeText
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.SubjectIdentificationNumberDetail.SubjectIdentificationNumber
string at least 1 chars. up to 40 chars., Required
A number assigned by an external body or by D&B
which either uniquely identifies or helps to identify the
subject.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.SubjectIdentificationNumberDetail
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.DataProviderName@DNBCodeValue
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.DataProviderName@DNBCodeTableNumber
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.RelatedPartyDetail
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to
record the details of the other Organizations or
Individuals (called Related Parties) that directly or
indirectly have an association with Supplier.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.RelatedPartyDetail. SubjectName
string up to 512 chars., Optional
Text that records the name of the different names for
the related parties for the Supplier
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.RelatedPartyDetail. SubjectName@LanguageCode
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.RelatedPartyDetail.SubjectName@WritingScriptISOAlpha4Code
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 155
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.RelatedPartyDetail.SubjectName@NameIdentificationNumber
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.RelatedPartyDetail. AssociationTypeText
string up to 512 chars., Optional
Text describes the type of the related party.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.RelatedPartyDetail. Assessment
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of the appraisal/opinion assigned to this
subject by an external entity.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.RelatedPartyDetail. Assessment. AssessmentTypeValue
string up to 128 chars., Optional
An alphanumeric value as assigned by the third party
to define the kind of appraisal/opinion that was
assigned to this subject by the third party, e.g., Moody's
Long Term Obligation Rating, FICO score, Vantage
Score.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.RelatedPartyDetail. Assessment. AssessmentValue
string, Optional
Text that records appraisal/opinion that was assigned
to this Subject by a third party.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.RelatedPartyDetail. Assessment.AssessmentCommentaryText
string up to 3000 chars., Optional (Infinite)
Free form text which records the primary reasons for
the assessment value.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.RelatedPartyDetail. Assessment
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.RelatedPartyDetail
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.EntityTypeText
EntityTypeEnumeration, Optional
Text describes whether the entity is Person or
Organization.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 156
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.TelephoneNumber
Aggregate, Optional
Records information about the different modes of
Telecommunication addresses used by a subject for
external contact purposes.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.TelephoneNumber. TelecommunicationNumber
string at least 1 chars. up to 50 chars., Required
A sequence of digits used by the subject for voice
communication in a public switched telephone
network. This sequence of digits includes the area code
or city code. Note: This number does not include the
International Dialing Code and Domestic Dialing Code.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData.TelephoneNumber
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. CustomerProvidedSubjectData
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization
Aggregate, Optional
Records data about an organization, a legal or
commercial entity established to provide products
and/or services in the marketplace or to the
community.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. SubjectHeader
Aggregate, Required
Records high level information about the subject such
as the primary language of the subject and the primary
currency in which this subject trades. When the
subject is an organizantion, this may also include
details such as DUNS Number.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. SubjectHeader.DUNSNumber
string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}.,Required
The D-U-N-S Number is D&B's identification number,
which provides unique identification of this
organization, in accordance with the Data Universal
Numbering System (D-U-N-S).
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 157
Name Characteristics
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. SubjectHeader
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Location
Aggregate, Optional
Records the address details for a subject. An address is
the designation of a place where a subject can be
located or may be communicated with, e.g., primary
address, registered address, mailing address.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Location. PrimaryAddress
Aggregate, Optional
An entry loop to allow the recording of a single primary
or physical address of the subject in multiple languages
and/or writing scripts. For an organization this is the
principal address at which the organization is located.
For an individual, this is the home address.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Location. PrimaryAddress.StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of several lines where each address line
contains one or more named address elements.
Examples of named address elements are Street
Name, Street Number, Building Name, Estate Name.
They are called “lines” because an addres can be
divided into multiple lines. When there are multiple
lines the sequence of the lines must be preserved.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Location. PrimaryAddress.StreetAddressLine. LineText
string up to 240 chars., Required
Text that records the street address components as it
would be presented on an address label. This includes,
but is not limited to, details such as street name, street
number, building name, estate name.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Location. PrimaryAddress.StreetAddressLine
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Location. PrimaryAddress.PrimaryTownName
string, Optional
The name of the town or city recognized by the Postal
Authority for delivering mail
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 158
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Location. PrimaryAddress.TerritoryOfficialName
string, Optional
The legal name of the locally governed area which
forms part of a centrally governed nation. Clarification
Note: As a guiding principle this is a geographic area
which could theoretically exist as a separate nation. In
the U.S. this would be a State. In the UK this would be
one of the Home Nations.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Location. PrimaryAddress.PostalCode
string, Optional
An identifier used by the local country Postal Authority
to identify a particular geographic location. For
example, in Belgium, Postal Code 9000 identifies the
town of GHENT.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Location. PrimaryAddress.CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Required
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this
address.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Location. PrimaryAddress
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Location
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. OrganizationName
Aggregate, Optional
Records the different names of the organization by
which it is known as well as names of other
organizations that have a similar name to this
organization.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. OrganizationName.OrganizationPrimaryName
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of a single name by which the
organization is primarily known / identified in different
languages and/or writing scripts.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 159
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. OrganizationName.OrganizationPrimaryName. OrganizationName
OrganizationNameType up to 256 chars., Required
Text recording a name of this organization in the
specified language and/or writing script.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. OrganizationName.OrganizationPrimaryName.OrganizationName@NameIdentificationNumber
Attribute
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. OrganizationName.OrganizationPrimaryName
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. OrganizationName.TradeStyleName
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of a single name by which the
organization is primarily known / identified in different
languages and/or writing scripts.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. OrganizationName.TradeStyleName. OrganizationName
OrganizationNameType up to 256 chars., Required
Text recording a name of this organization in the
specified language and/or writing script.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. OrganizationName.TradeStyleName.OrganizationName@NameIdentificationNumber
Attribute
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. OrganizationName.TradeStyleName
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. OrganizationName
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 160
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage
Aggregate, Optional
Records the relationship between the subject and the
next subject UP in the family tree. E.g. Its Parent, HQ,
Joint Parent or shareholder. Also records names,
addresses and registration numbers for the related
subject. This data topic may also be used to record the
details of the relationship between the subject and the
business founder; however if a simple textual
reference to the business founder is all that is required
then the 'Started By' element in 'Subject Details'
should be used
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization
Aggregate, Optional
Records information about the office that serves as the
administrative center of an enterprise.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. DUNSNumber
string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}.,Optional
The D-U-N-S Number is D&B's identification number,
which provides unique identification of this
organization, in accordance with the Data Universal
Numbering System (D-U-N-S).
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. OrganizationPrimaryName
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of a single name by which the
organization is primarily known / identified in different
languages and/or writing scripts.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. OrganizationPrimaryName.OrganizationName
OrganizationNameType up to 256 chars., Required
Text recording a name of this organization in the
specified language and/or writing script.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. OrganizationPrimaryName.OrganizationName@LanguageCode
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 161
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. OrganizationPrimaryName.OrganizationName@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. OrganizationPrimaryName.OrganizationName@NameIdentificationNumber
Attribute
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. OrganizationPrimaryName
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. PrimaryAddress
Aggregate, Optional (Infinite)
An entry loop to allow the recording of a single primary
or physical address of the subject in multiple languages
and/or writing scripts. For an organization this is the
principal address at which the organization is located.
For an individual, this is the home address.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. PrimaryAddress@LanguageCode
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization.PrimaryAddress@WritingScriptCode
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. PrimaryAddress.StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of several lines where each address line
contains one or more named address elements.
Examples of named address elements are Street
Name, Street Number, Building Name, Estate Name.
They are called “lines” because an addres can be
divided into multiple lines. When there are multiple
lines the sequence of the lines must be preserved.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 162
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. PrimaryAddress.StreetAddressLine. LineText
string up to 240 chars., Required
Text that records the street address components as it
would be presented on an address label. This includes,
but is not limited to, details such as street name, street
number, building name, estate name.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. PrimaryAddress.StreetAddressLine
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. PrimaryAddress.PrimaryTownName
string up to 64 chars., Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. PrimaryAddress. PostalCode
string, Optional
An identifier used by the local country Postal Authority
to identify a particular geographic location. For
example, in Belgium, Postal Code 9000 identifies the
town of GHENT.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. PrimaryAddress.CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this
address.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. PrimaryAddress. TerritoryName
string up to 128 chars., Optional
The name of the locally governed area which forms
part of a centrally governed nation as received by D&B.
Clarification Note: As a guiding principle this is a
geographic area which could theoretically exist as a
separate nation. In the U.S. this would be a State. In
the UK this would be one of the Home Nations.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. PrimaryAddress
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 163
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. Principal
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to
record the information of each principal that are
actively associated with the subject organization.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. Principal. PrincipalName
Aggregate, Optional
Records the different names for the Principal.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. Principal.PrincipalName@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. Principal.PrincipalName@LanguageCode
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. Principal. PrincipalName. FullName
string up to 256 chars., Optional
The entire name of the subject where the subject is
either an individual or an organization.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. Principal. PrincipalName
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. Principal. JobTitle
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of the name used by the organization to
describe this person's job, e.g., Leader Global
Communication, Manager National Technical Support
Center.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. Principal. JobTitle. JobTitleText
string up to 3000 chars., Optional
Text that denotes a position held by the principal or
manager.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. Principal. JobTitle.JobTitleText@WritingScriptISOAlpha4Code
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 164
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. Principal. JobTitle.JobTitleText@LanguageCode
Attribute
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. Principal. JobTitle
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. Principal. PrincipalLocation
Aggregate, Optional
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. Principal. PrincipalLocation.PrimaryAddress. CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Required
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this
address.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. Principal. PrincipalLocation.PrimaryAddress
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. Principal. PrincipalLocation
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization. Principal
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.HeadquartersOrganization
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization
Aggregate, Optional (Infinite)
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. AssociationTypeText
string up to 256 chars., Optional
Text that denotes the type of family tree association
between the child and owner.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 165
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization.AssociationTypeText@DNBCodeValue
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization.AssociationTypeText@DNBCodeTableNumber
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. SubjectHeader
Aggregate, Optional
Records high level information about the subject such
as the primary language of the subject and the primary
currency in which this subject trades. When the
subject is an organizantion, this may also include
details such as DUNS Number.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. SubjectHeader.DUNSNumber
string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}.,Required
The D-U-N-S Number is D&B's identification number,
which provides unique identification of this
organization, in accordance with the Data Universal
Numbering System (D-U-N-S).
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. SubjectHeader
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Location
Aggregate, Optional
Records the address details for a subject. An address is
the designation of a place where a subject can be
located or may be communicated with, e.g., primary
address, registered address, mailing address.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Location. PrimaryAddress
Aggregate, Optional
An entry loop to allow the recording of a single primary
or physical address of the subject in multiple languages
and/or writing scripts. For an organization this is the
principal address at which the organization is located.
For an individual, this is the home address.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 166
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Location. PrimaryAddress.PrimaryTownName
string, Optional
The name of the town or city recognized by the Postal
Authority for delivering mail
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Location. PrimaryAddress.TerritoryOfficialName
string, Optional
The legal name of the locally governed area which
forms part of a centrally governed nation. Clarification
Note: As a guiding principle this is a geographic area
which could theoretically exist as a separate nation. In
the U.S. this would be a State. In the UK this would be
one of the Home Nations.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Location. PrimaryAddress.PostalCode
string, Optional
An identifier used by the local country Postal Authority
to identify a particular geographic location. For
example, in Belgium, Postal Code 9000 identifies the
town of GHENT.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Location. PrimaryAddress.CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Required
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this
address.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Location. PrimaryAddress
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Location
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. OrganizationPrimaryName
Aggregate, Optional
An entry loop which can repeat multiple times to allow
the recording of a single name by which the
organization is primarily known / identified in different
languages and/or writing scripts.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 167
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization.OrganizationPrimaryName@RegisteredNameIndicator
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. OrganizationPrimaryName.OrganizationName
OrganizationNameType up to 256 chars., Required
Text recording a name of this organization in the
specified language and/or writing script.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. OrganizationPrimaryName.OrganizationName@LanguageCode
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. OrganizationPrimaryName.OrganizationName@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. OrganizationPrimaryName.OrganizationName@NameIdentificationNumber
Attribute
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. OrganizationPrimaryName
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Principal
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to
record the information of each principal that are
actively associated with the subject organization.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Principal. PrincipalName
Aggregate, Optional
Records the different names for the Principal.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Principal.PrincipalName@WritingScriptISOAlpha4Code
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 168
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Principal.PrincipalName@LanguageCode
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Principal. PrincipalName.FullName
string up to 256 chars., Optional
The entire name of the subject where the subject is
either an individual or an organization.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Principal. PrincipalName.FullName@FormatText
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Principal. PrincipalName.FullName@NameIdentificationNumber
Attribute
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Principal. PrincipalName
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Principal. JobTitle
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of the name used by the organization to
describe this person's job, e.g., Leader Global
Communication, Manager National Technical Support
Center.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Principal. JobTitle.JobTitleText
string up to 3000 chars., Optional
Text that denotes a position held by the principal or
manager.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Principal. JobTitle.JobTitleText@WritingScriptISOAlpha4Code
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 169
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Principal. JobTitle.JobTitleText@LanguageCode
Attribute
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Principal. JobTitle
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Principal. PrincipalLocation
Aggregate, Optional
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Principal. PrincipalLocation.PrimaryAddress. CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Required
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this
address.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Principal. PrincipalLocation.PrimaryAddress
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Principal. PrincipalLocation
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization. Principal
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeMemberOrganization
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization
Aggregate, Optional
Records information about the organization which
owns more than 50% of the subject and the
organization at the very top of the legal family.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 170
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO)identifying the country of the
inquired subject.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. DUNSNumber
string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}.,Optional
The D-U-N-S Number is D&B's identification number,
which provides unique identification of this
organization, in accordance with the Data Universal
Numbering System (D-U-N-S).
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. OrganizationPrimaryName
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of a single name by which the
organization is primarily known / identified in different
languages and/or writing scripts.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. OrganizationPrimaryName.OrganizationName
OrganizationNameType up to 256 chars., Required
Text recording a name of this organization in the
specified language and/or writing script.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. OrganizationPrimaryName.OrganizationName@LanguageCode
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. OrganizationPrimaryName.OrganizationName@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. OrganizationPrimaryName.OrganizationName@NameIdentificationNumber
Attribute
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. OrganizationPrimaryName
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 171
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. PrimaryAddress
Aggregate, Optional (Infinite)
An entry loop to allow the recording of a single primary
or physical address of the subject in multiple languages
and/or writing scripts. For an organization this is the
principal address at which the organization is located.
For an individual, this is the home address.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. PrimaryAddress@LanguageCode
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. PrimaryAddress@WritingScriptCode
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. PrimaryAddress. StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of several lines where each address line
contains one or more named address elements.
Examples of named address elements are Street
Name, Street Number, Building Name, Estate Name.
They are called “lines” because an addres can be
divided into multiple lines. When there are multiple
lines the sequence of the lines must be preserved.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. PrimaryAddress. StreetAddressLine.LineText
string up to 240 chars., Required
Text that records the street address components as it
would be presented on an address label. This includes,
but is not limited to, details such as street name, street
number, building name, estate name.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. PrimaryAddress. StreetAddressLine
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. PrimaryAddress. PrimaryTownName
string up to 64 chars., Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 172
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. PrimaryAddress. PostalCode
string, Optional
An identifier used by the local country Postal Authority
to identify a particular geographic location. For
example, in Belgium, Postal Code 9000 identifies the
town of GHENT.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. PrimaryAddress. CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this
address.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. PrimaryAddress. TerritoryName
string up to 128 chars., Optional
The name of the locally governed area which forms
part of a centrally governed nation as received by D&B.
Clarification Note: As a guiding principle this is a
geographic area which could theoretically exist as a
separate nation. In the U.S. this would be a State. In
the UK this would be one of the Home Nations.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. PrimaryAddress
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. Principal
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to
record the information of each principal that are
actively associated with the subject organization.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. Principal. PrincipalName
Aggregate, Optional
Records the different names for the Principal.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. Principal.PrincipalName@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. Principal. PrincipalName@LanguageCode
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 173
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. Principal. PrincipalName. FullName
string up to 256 chars., Optional
The entire name of the subject where the subject is
either an individual or an organization.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. Principal. PrincipalName
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. Principal. JobTitle
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of the name used by the organization to
describe this person's job, e.g., Leader Global
Communication, Manager National Technical Support
Center.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. Principal. JobTitle. JobTitleText
string up to 3000 chars., Optional
Text that denotes a position held by the principal or
manager.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. Principal. JobTitle.JobTitleText@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. Principal. JobTitle.JobTitleText@LanguageCode
Attribute
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. Principal. JobTitle
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. Principal. PrincipalLocation
Aggregate, Optional
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 174
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. Principal. PrincipalLocation.PrimaryAddress
Aggregate, Optional
An entry loop to allow the recording of a single primary
or physical address of the subject in multiple languages
and/or writing scripts. For an organization this is the
principal address at which the organization is located.
For an individual, this is the home address.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. Principal. PrincipalLocation.PrimaryAddress. CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Required
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this
address.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. Principal. PrincipalLocation.PrimaryAddress
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. Principal. PrincipalLocation
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization. Principal
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.ParentOrganization
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage.FamilyTreeHierarchyLevel
int up to 2 digits., Optional
A two-position code, in conjunction with the status
and subsidiary indicators that pinpoints the location of
an establishment within a corporate hierarchy.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. Linkage
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 175
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. PrincipalsAndManagement
Aggregate, Optional
Records details of the Principals (e.g., President, Vice
President, Directors) and Managers responsible for the
business strategy, decision making and day to day
running of the subjects operations. This includes
names, addresses and identification numbers of the
principals. Whilst a principal will usually be an individual
in some countries it is legally acceptable for a
registered business entity to act as a principal in
another business. This excludes shareholders and
similar owners who are not responsible for the
management of the organization but includes
proprietors and partners who, whilst owners, are also
generally the principals running the business.Records
details of the Principals (e.g., President, Vice President,
Directors) and Managers responsible for the business
strategy, decision making and day to day running of the
subjects operations. This includes names, addresses
and identification numbers of the principals. Whilst a
principal will usually be an individual in some countries
it is legally acceptable for a registered business entity
to act as a principal in another business. This excludes
shareholders and similar owners who are not
responsible for the management of the organization
but includes proprietors and partners who, whilst
owners, are also generally the principals running the
business.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. PrincipalsAndManagement.CurrentPrincipal
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
recording of the information of each principal that are
actively associated with the subject organization.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. PrincipalsAndManagement.CurrentPrincipal. PrincipalName
Aggregate, Optional
Records the different names for the Principal.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. PrincipalsAndManagement.CurrentPrincipal.PrincipalName@WritingScriptISOAlpha4Code
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 176
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. PrincipalsAndManagement.CurrentPrincipal. PrincipalName@LanguageCode
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. PrincipalsAndManagement.CurrentPrincipal. PrincipalName. FullName
string up to 256 chars., Optional
The entire name of the subject where the subject is
either an individual or an organization.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. PrincipalsAndManagement.CurrentPrincipal. PrincipalName. FullName@FormatText
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. PrincipalsAndManagement.CurrentPrincipal. PrincipalName.FullName@NameIdentificationNumber
Attribute
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. PrincipalsAndManagement.CurrentPrincipal. PrincipalName
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. PrincipalsAndManagement.CurrentPrincipal. JobTitle
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of the name used by the organization to
describe this person's job, e.g., Leader Global
Communication, Manager National Technical Support
Center.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. PrincipalsAndManagement.CurrentPrincipal. JobTitle. JobTitleText
string up to 3000 chars., Optional
Text that denotes a position held by the principal or
manager.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. PrincipalsAndManagement.CurrentPrincipal. JobTitle.JobTitleText@WritingScriptISOAlpha4Code
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. PrincipalsAndManagement.CurrentPrincipal. JobTitle. JobTitleText@LanguageCode
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 177
Name Characteristics
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. PrincipalsAndManagement.CurrentPrincipal. JobTitle
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. PrincipalsAndManagement.CurrentPrincipal. PrincipalLocation
Aggregate, Optional
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. PrincipalsAndManagement.CurrentPrincipal. PrincipalLocation. PrimaryAddress
Aggregate, Optional
An entry loop to allow the recording of a single primary
or physical address of the subject in multiple languages
and/or writing scripts. For an organization this is the
principal address at which the organization is located.
For an individual, this is the home address.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. PrincipalsAndManagement.CurrentPrincipal. PrincipalLocation. PrimaryAddress.CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Required
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this
address.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. PrincipalsAndManagement.CurrentPrincipal. PrincipalLocation
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. PrincipalsAndManagement.CurrentPrincipal
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization. PrincipalsAndManagement
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. Organization
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of the changes to the details of the
supplier registered for monitoring.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 178
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. InquiryDetail
Aggregate, Optional
Inquiry Detail for the Alert
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. InquiryDetail.SubjectName
_, Required
The name of the individual or organization from which
the subject purchases goods or services.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. InquiryDetail.SubjectName@NameIdentificationNumber
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. InquiryDetail. Location
Aggregate, Optional
Records the components of a location for which the
business activity profile information is requested.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. InquiryDetail. Location.StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of several lines where each address line
contains one or more named address elements.
Examples of named address elements are Street
Name, Street Number, Building Name, Estate Name.
They are called “lines” because an addres can be
divided into multiple lines. When there are multiple
lines the sequence of the lines must be preserved.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. InquiryDetail. Location.StreetAddressLine. LineText
string up to 240 chars., Required
Text that records the street address components as it
would be presented on an address label. This includes,
but is not limited to, details such as street name, street
number, building name, estate name.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. InquiryDetail. Location.StreetAddressLine. DisplaySequence
int up to 3 digits., Optional
A number which may be used to define the order in
which this street address line should be presented
relative to other street address lines where the lower
the number the earlier the data is presented.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. InquiryDetail. Location.StreetAddressLine
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 179
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. InquiryDetail. Location.PrimaryTownName
string up to 64 chars., Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. InquiryDetail. Location.PostalCode
string, Optional
An identifier used by the local country Postal Authority
to identify a particular geographic location. For
example, in Belgium, Postal Code 9000 identifies the
town of GHENT.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. InquiryDetail. Location.CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this
address.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. InquiryDetail. Location
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. InquiryDetail
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail.RenderingApplicationID
string up to 100 chars., Optional
An alphanumeric value assigned to uniquely identify
the application delivering the report view of the alert
entity.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. AlertID
string up to 64 chars., Optional
An alphanumeric value that uniquely identifies the
Alert.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. AlertEntityID
string up to 32 chars., Optional
An alphanumeric value that uniquely identifies the
Vendor.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. AlertDate
date, Optional
Date when the alert was created.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 180
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. AlertNoteText
string up to 1000 chars., Optional
Text that describes the alert note.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. EntityTypeText
EntityTypeEnumeration, Optional
Text describes whether the entity is Person or
Organization.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail.EntityReferenceWebPageURL
string up to 512 chars., Optional
Text identifying the internet URL that provides
additional information like media articles for the Entity.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. EntityMatchDetail
Aggregate, Optional
Records the details of the score indicating the degree
of the match to the inquiry name.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. EntityMatchDetail.EntityMatchScore
int up to 3 digits., Optional
A numeric value ranging from 1 to 100 which denotes
the degree of match of this entity against the inquired
subject name. A value of 1 denotes lowest degree of
match, value of 100 denotes highest degree of match.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. EntityMatchDetail
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. ReferenceDetail
Aggregate, Optional (Infinite)
Records the source details of the data which was
originally obtained by D&B.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. ReferenceDetail.SourceName
string up to 400 chars., Optional
Text recording the name of the source from which the
alert data was originally obtained.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. ReferenceDetail.SourceDescription
string up to 500 chars., Optional
Text that describes the source.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. ReferenceDetail.PublicationName
string up to 500 chars., Optional
Name of the publication.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 181
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. ReferenceDetail.PublicationDate
date, Optional
The date of publication.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. ReferenceDetail.WebPageURL
string up to 500 chars., Optional
Records the internet link of the publication content.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. ReferenceDetail.PublisherName
string up to 512 chars., Optional
Name of the company or person that publishes
products.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. ReferenceDetail.SourceListName
string up to 256 chars., Optional
Text recording the name of the list from which the
alert data was originally obtained; e.g., UK sanctions
list, OFAC list.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. ReferenceDetail.SourceTypeText
string up to 256 chars., Optional
Text denoting the category of the source; e.g., internet,
publication, media.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. ReferenceDetail.ContentText
string up to 5000 chars., Optional
Text that records the body of the news item.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. ReferenceDetail
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. EventDetail
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of the details of the events in which the
supplier is involved.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. EventDetail.EventTypeText
string up to 3 chars., Optional
Text that describes the category of the event.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. EventDetail.EventSubTypeText
string up to 3 chars., Optional
Text that describes the sub category of the event.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 182
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. EventDetail. EventText
string up to 2000 chars., Optional (Infinite)
Free form text recording additional details about the
event.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. EventDetail.EventDate
date, Optional
The date when the event occured.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. EventDetail.EventDate@DatePrecisionText
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. EventDetail.EventDate@DatePrecisionDNBCodeValue
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. EventDetail.EventDate@DatePrecisionDNBCodeTableNumber
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. EventDetail. EndDate
DateTimestamp, Optional
Date when the event action was no longer in affect.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. EventDetail
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Name
Aggregate, Optional
Records the names used to identify this supplier.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Name. PrimaryName
string, Required
Name of the subject by which it is primarily known /
identified.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Name. KnownByName
string up to 500 chars., Optional (Infinite)
Any other name by which the subject is known which
cannot be categorised by one of the other name types
either because the name category is not covered by an
existing type of because the precise name type cannot
be identified.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 183
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Name.FormerPrimaryName
string up to 500 chars., Optional (Infinite)
Name of the subject was primarily known / identified
previously.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Name.TradeStyleName
string up to 500 chars., Optional (Infinite)
Name of the subject trades under for commercial
purposes, although its registered, legal name, used for
contracts and other formal situations, may be another.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Name
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address
Aggregate, Optional
Records the location details of the supplier.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address. BirthAddress
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of the birth location details of the
supplier.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address. BirthAddress.StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of several lines where each address line
contains one or more named address elements.
Examples of named address elements are Street
Name, Street Number, Building Name, Estate Name.
They are called “lines” because an addres can be
divided into multiple lines. When there are multiple
lines the sequence of the lines must be preserved.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address. BirthAddress.StreetAddressLine. LineText
string up to 240 chars., Required
Text that records the street address components as it
would be presented on an address label. This includes,
but is not limited to, details such as street name, street
number, building name, estate name.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 184
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address. BirthAddress.StreetAddressLine. DisplaySequence
int up to 3 digits., Optional
A number which may be used to define the order in
which this street address line should be presented
relative to other street address lines where the lower
the number the earlier the data is presented.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address. BirthAddress.StreetAddressLine
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address. BirthAddress.PrimaryTownName
string, Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address. BirthAddress.TerritoryName
string, Optional
The name of the locally governed area which forms
part of a centrally governed nation as received by D&B.
Clarification Note: As a guiding principle this is a
geographic area which could theoretically exist as a
separate nation. In the U.S. this would be a State. In
the UK this would be one of the Home Nations.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address. BirthAddress.PostalCode
string, Optional
An identifier used by the local country Postal Authority
to identify a particular geographic location. For
example, in Belgium, Postal Code 9000 identifies the
town of GHENT.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address. BirthAddress.CountryName
string, Optional
The name of the country of this address.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address. BirthAddress
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.PrimaryAddress
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of the present location details of the
supplier.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 185
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.PrimaryAddress. StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of several lines where each address line
contains one or more named address elements.
Examples of named address elements are Street
Name, Street Number, Building Name, Estate Name.
They are called “lines” because an addres can be
divided into multiple lines. When there are multiple
lines the sequence of the lines must be preserved.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.PrimaryAddress. StreetAddressLine. LineText
string up to 240 chars., Required
Text that records the street address components as it
would be presented on an address label. This includes,
but is not limited to, details such as street name, street
number, building name, estate name.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.PrimaryAddress. StreetAddressLine. DisplaySequence
int up to 3 digits., Optional
A number which may be used to define the order in
which this street address line should be presented
relative to other street address lines where the lower
the number the earlier the data is presented.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.PrimaryAddress. StreetAddressLine
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.PrimaryAddress. PrimaryTownName
string, Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.PrimaryAddress. TerritoryName
string, Optional
The name of the locally governed area which forms
part of a centrally governed nation as received by D&B.
Clarification Note: As a guiding principle this is a
geographic area which could theoretically exist as a
separate nation. In the U.S. this would be a State. In
the UK this would be one of the Home Nations.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 186
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.PrimaryAddress. PostalCode
string, Optional
An identifier used by the local country Postal Authority
to identify a particular geographic location. For
example, in Belgium, Postal Code 9000 identifies the
town of GHENT.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.PrimaryAddress. CountryName
string, Optional
The name of the country of this address.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.PrimaryAddress
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of supplier address, which cannot be
classified into distinct sections.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress. StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of several lines where each address line
contains one or more named address elements.
Examples of named address elements are Street
Name, Street Number, Building Name, Estate Name.
They are called “lines” because an addres can be
divided into multiple lines. When there are multiple
lines the sequence of the lines must be preserved.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress. StreetAddressLine. LineText
string up to 240 chars., Required
Text that records the street address components as it
would be presented on an address label. This includes,
but is not limited to, details such as street name, street
number, building name, estate name.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress. StreetAddressLine. DisplaySequence
int up to 3 digits., Optional
A number which may be used to define the order in
which this street address line should be presented
relative to other street address lines where the lower
the number the earlier the data is presented.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 187
Name Characteristics
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress. StreetAddressLine
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress. PrimaryTownName
string, Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress. TerritoryName
string, Optional
The name of the locally governed area which forms
part of a centrally governed nation as received by D&B.
Clarification Note: As a guiding principle this is a
geographic area which could theoretically exist as a
separate nation. In the U.S. this would be a State. In
the UK this would be one of the Home Nations.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress. PostalCode
string, Optional
An identifier used by the local country Postal Authority
to identify a particular geographic location. For
example, in Belgium, Postal Code 9000 identifies the
town of GHENT.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress. CountryName
string, Required
The name of the country of this address.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress. AddressTypeText
string up to 32 chars., Optional
Text identifying the type of address being supplied.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. Address
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. PersonalDetail
Aggregate, Optional
Records the personal information about the individual.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 188
Name Characteristics
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. PersonalDetail.BirthDate
date, Optional (Infinite)
The date when the individula was born.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. PersonalDetail.BirthDate@DatePrecisionText
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. PersonalDetail.BirthDate@DatePrecisionDNBCodeValue
Attribute
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. PersonalDetail.BirthDate@DatePrecisionDNBCodeTableNumber
Attribute
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. PersonalDetail
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail.NonspecificParameterDetail
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow
the recording of supplier information, which cannot be
classified into distinct sections, as key value pairs.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail.NonspecificParameterDetail. ParameterDescription
string up to 256 chars., Optional
Text that identifies the data in ParameterValue.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail.NonspecificParameterDetail. ParameterValue
string up to 512 chars., Optional
Text that records a fact being communicated in the
decisioning process and identified by the
ParameterDescription.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail.NonspecificParameterDetail
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail. DisplaySequence
int, Optional
A number which may be used to define the order in
which this text entry should be presented relative to
other occurrences of text entries where the lower the
number the earlier the data is presented.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 189
Name Characteristics
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject. SubjectAlertDetail
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData.ComplianceSubject
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail. ComplianceData
/Aggregate
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail.InquiryReferenceDetail
Aggregate, Optional
Records data that allows the customer to specify
information to be linked to the request in order to
support subsequent order reconciliation.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail.InquiryReferenceDetail. CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer
to be linked to the product in order to support
subsequent order reconciliation.
GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail.InquiryReferenceDetail. CustomerBillingEndorsementText
string at least 1 chars. up to 240 chars., Optional
Text that is filled in by customer and commonly
contains requesting individual or department name, or
customer's own account/reference number and/or
name for the case on which the product was
provided.This text is a reference used during the billing
process.
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail.InquiryReferenceDetail
/Aggregate
END: GetSubjectComplianceDataResponse.GetSubjectComplianceDataResponseDetail
/Aggregate
END: GetSubjectComplianceDataResponse /Aggregate
Lists of possible values (when present) are subject to change. Additional values not presented in this documentation may be delivered
in the response and should be anticipated in any implementation.
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
D&B Direct API Documentation Response Codes
©Dun & Bradstreet, Inc. 2014 190
During the period after a successful registration and the availability of results, this operation will return aCM000 response code and the ResultText will equal "RESPONSE IS STILL PROCESSING."
<GetSubjectComplianceDataResponse><TransactionDetail>
<ApplicationTransactionID>063054273</ApplicationTransactionID>
<ServiceTransactionID>12345</ServiceTransactionID><TransactionTimestamp>2013-12-13T06:31:00.119-05:00</Transac
tionTimestamp></TransactionDetail><TransactionResult>
<ResultID>CM000</ResultID><ResultMessage>
<e><ResultDescription>Retrieved Supplier Result successfu
lly</ResultDescription></e>
</ResultMessage><ResultText>RESPONSE IS STILL PROCESSING</ResultText><SeverityText>Information</SeverityText>
</TransactionResult></GetSubjectComplianceDataResponse>
This operation may return the following response codes: CM001, CM002, CM003, CM004, CM007, CM013,CM018 and SC001-SC009.
Operation-specific supplemental response code explanations:
CM001 The given request is invalid.
CM002 The format of this request is invalid.
CM003 Missing Information in the request.
CM004 Internal D&B system error. Please try again or contact your local Customer Service Center.
CM007 Your request cannot be fulfilled for the given criteria.
CM013 Invalid Subject ID provided in the request. Please refer to Online Documentation.
CM018 No candidates resulted for the given input criteria.
Sub-Process Results
Some service levels will invoke additional processes upon successful completion of a RegisterSubject operationcall. In the event that an additional process fails, an error response will be delivered in the SubProcessResultsection. Here are the possible values:
D&B Direct API Documentation Sub-Process Results
©Dun & Bradstreet, Inc. 2014 191
<SubProcessName> <ResultID> <ResultText>
Match CMP001 No Match for the given input criteria. Supplier Registration process aborted sinceD&B is unable to append data on the supplier.
Match CMP002 No Match for the given input criteria.
Match CMP003 Internal D&B system error. Supplier Registration process aborted since D&B isunable to append data on the supplier.
Match CMP004 Internal D&B system error.
RefreshCheck CMP005 TODO
RefreshCheck CMP006 DUNS Deleted
RefreshCheck CMP007 TODO
RefreshCheck CMP008 Invalid Duns number provided in the request.
RefreshCheck CMP009 TODO
RefreshCheck CMP004 Internal D&B system error.
DataAppend CMP011 D&B Data is out of Date. Supplier Registration process aborted since D&B isunable to append data on the supplier.
DataAppend CMP012 D&B Data is out of Date.
DataAppend CMP003 Internal D&B system error. Supplier Registration process aborted since D&B isunable to append data on the supplier.
DataAppend CMP004 Internal D&B system error.
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Compliance Check Service
Samples http://developer.dnb.com/docs/2.0/compliance/1.0/DnB-Compliance.zip
Related Topics
RegisterSubject (SOAP), ListComplianceSubjects (SOAP), GetComplianceAlerts (SOAP), ntity Attributes, EventCategories and Sub-Categories, Data Products by Category.
D&B Direct API Documentation Samples (Download)
©Dun & Bradstreet, Inc. 2014 192
GetComplianceAlerts (REST)This operation -- part of the Compliance Check Service -- is a component of the Compliance √ Screeningsolution.
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Note: While the Compliance √ Screening features are accessed through the D&B Direct service, separatecredentials are required for each data environment and will be provided by a D&B sales representative.
Endpoint
GET https://maxcvservices.dnb.com/V{version}/compliancecheck/subjects/alerts?SubjectID={subjectID}
Request Parameters
The following parameters are accepted by this operation.
Exception: The list returned by this operation will include all subjects registered by user credentials associatedwith the customer contract.
If an application requires filtering by user credentials, a possible solution would be to place a unique value inthe CustomerReferenceText field when registering subjects, and then supply the same value to this operation.
Exception: The pagination sequence for this operation starts at zero (rather than one). Also, responsescurrently deliver one less than the per page value specified on the request.
D&B Direct API Documentation GetComplianceAlerts (REST)
©Dun & Bradstreet, Inc. 2014 193
Name Characteristics
ApplicationTransactionID string up to 64 chars., Optional
A number assigned by the calling application to
uniquely identify this request.
TransactionTimestamp DateTimestamp, Optional
The date and time when this request was
created. When the request is from an
intermediary, such as a workflow manager or
service bus, this is the date and time when the
message was sent to the D&B function, i.e., the
date and time when the xml document was
created by the requesting intermediary.
SubmittingOfficeID string up to 64 chars., Optional
A number that identifies the system or the
software application from where this request
originated. / A number used to uniquely identfy
the D&B business segment or delivery channel
from where this request originated.
SubjectID SubjectIDType up to 25 chars., Optional
A number uniquely identifying the inquired
subject within the D&B Worldwide Network.
AlertFromTimestamp dateTime, Optional
The date & time from when the Alert should be
returned
AlertToTimestamp dateTime, Optional
The date & time till when the Alert should be
returned
SortBasisText ComplianceAlertsSortBasisTextEnum, Optional
Possible values: SubjectID; AlertDate
SortDirectionText SortDirectionEnum, Optional
Possible values: Ascending; Descending
CandidatePerPageMaximumQuantity int, Optional
CandidateDisplayStartSequenceNumber int, Optional
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 194
Name Characteristics
CustomerReferenceText string up to 240 chars., Optional
A freeform reference string provided by the
customer to be linked to the product in order to
support subsequent order reconciliation.
CustomerBillingEndorsementText string at least 1 chars. up to 240 chars., Optional
Text that is filled in by customer and commonly
contains requesting individual or department
name, or customer's own account/reference
number and/or name for the case on which the
product was provided.This text is a reference
used during the billing process.
Sample Request
Testing / Sandbox
This operation is currently unavailable in the D&B Direct sandbox (test) environment.
Data Field Response
The following is a list of the possible data fields returned by this operation in the JSON response.
Name Characteristics
GetComplianceAlertsResponse Aggregate
GetComplianceAlertsResponse@ServiceVersionNumber Attribute
GetComplianceAlertsResponse@xsi:schemaLocation Attribute
GetComplianceAlertsResponse { TransactionDetail Aggregate, Required
Records information necessary to process a particular
request. Examples of a request is the ordering of a product.
GetComplianceAlertsResponse { TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
D&B Direct API Documentation Sample Request
©Dun & Bradstreet, Inc. 2014 195
Name Characteristics
GetComplianceAlertsResponse { TransactionDetail { ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely identify
this transaction.
GetComplianceAlertsResponse { TransactionDetail { TransactionTimestamp
DateTimestamp, Required
The date and time when this request was submitted or the
date and time when the requesting intermediary, such as a
workflow manager or service bus, sent the message to the
D&B function, i.e., the date and time when the xml
document was created by the requesting intermediary.
END: GetComplianceAlertsResponse } TransactionDetail /Aggregate
GetComplianceAlertsResponse { TransactionResult Aggregate, Required
An aggregate that can repeat multiple times to record the
different outcomes of the transaction.
GetComplianceAlertsResponse { TransactionResult { SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g.,
Information, Warning, Error, Fatal.
GetComplianceAlertsResponse { TransactionResult { ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the outcome
of the transaction.
GetComplianceAlertsResponse { TransactionResult { ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
GetComplianceAlertsResponse { TransactionResult { ResultMessage
Aggregate, Optional (Infinite)
An aggregate that can repeat multiple times to record textual
data that expands on the ResultID and ResultText to provide
additional information to the user regarding the status of the
transaction. If the status implies that there is a problem this
may also provide guidance to the user on how to address it.
GetComplianceAlertsResponse { TransactionResult { ResultMessage { ResultMessageID
string up to 30 chars., Optional
An alphanumeric string that uniquely identifies the additional
information regarding the outcome of the transaction.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 196
Name Characteristics
GetComplianceAlertsResponse { TransactionResult { ResultMessage { ResultDescription
string up to 512 chars., Required
Text that describes the additional information regarding the
outcome of the transaction.
GetComplianceAlertsResponse { TransactionResult { ResultMessage { NonSpecificDataProviderText
string up to 30 chars., Optional
Text that describes, in general terms, the source from which
the Result Message data was originally obtained by D&B; e.g.
Credit Bureau.
END: GetComplianceAlertsResponse }TransactionResult } ResultMessage
/Aggregate
END: GetComplianceAlertsResponse }TransactionResult
/Aggregate
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail
Aggregate, Optional
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { CandidateMatchedQuantity
int, Required
The number of subjects identified as possible prospects in the
repository.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { CandidateReturnedQuantity
int, Optional
The number of subjects actually returned as possible
prospects in the repository based on the search criteria.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject
Aggregate, Optional (Infinite)
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectID
SubjectIDType up to 25 chars., Required
A number uniquely identifying the inquired subject within an
application.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail
Aggregate, Optional
An entry loop which can repeat multiple times to allow the
recording of the changes to the details of the supplier
registered for monitoring.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { InquiryDetail
Aggregate, Optional
Inquiry Detail for the Alert
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 197
Name Characteristics
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { InquiryDetail { SubjectName
_, Required
The name of the individual or organization from which the
subject purchases goods or services.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { InquiryDetail { SubjectName@NameIdentificationNumber
Attribute
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { InquiryDetail { Location
Aggregate, Optional
Records the components of a location for which the business
activity profile information is requested.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { InquiryDetail { Location { StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of several lines where each address line contains
one or more named address elements. Examples of named
address elements are Street Name, Street Number, Building
Name, Estate Name. They are called “lines” because an
addres can be divided into multiple lines. When there are
multiple lines the sequence of the lines must be preserved.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { InquiryDetail { Location { StreetAddressLine { LineText
string up to 240 chars., Required
Text that records the street address components as it would
be presented on an address label. This includes, but is not
limited to, details such as street name, street number,
building name, estate name.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { InquiryDetail { Location { StreetAddressLine { DisplaySequence
int up to 3 digits., Optional
A number which may be used to define the order in which
this street address line should be presented relative to other
street address lines where the lower the number the earlier
the data is presented.
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }ComplianceSubject } SubjectAlertDetail } InquiryDetail }Location } StreetAddressLine
/Aggregate
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { InquiryDetail { Location { PrimaryTownName
string up to 64 chars., Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 198
Name Characteristics
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { InquiryDetail { Location { PostalCode
string, Optional
An identifier used by the local country Postal Authority to
identify a particular geographic location. For example, in
Belgium, Postal Code 9000 identifies the town of GHENT.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { InquiryDetail { Location { CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this address.
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }ComplianceSubject } SubjectAlertDetail } InquiryDetail }Location
/Aggregate
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }ComplianceSubject } SubjectAlertDetail } InquiryDetail
/Aggregate
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { RenderingApplicationID
string up to 100 chars., Optional
An alphanumeric value assigned to uniquely identify the
application delivering the report view of the alert entity.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { AlertID
string up to 64 chars., Optional
An alphanumeric value that uniquely identifies the Alert.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { AlertEntityID
string up to 32 chars., Optional
An alphanumeric value that uniquely identifies the Vendor.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { AlertDate
date, Optional
Date when the alert was created.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { AlertNoteText
string up to 1000 chars., Optional
Text that describes the alert note.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { EntityTypeText
EntityTypeEnumeration, Optional
Text describes whether the entity is Person or Organization.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { EntityReferenceWebPageURL
string up to 512 chars., Optional
Text identifying the internet URL that provides additional
information like media articles for the Entity.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 199
Name Characteristics
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { EntityMatchDetail
Aggregate, Optional
Records the details of the score indicating the degree of the
match to the inquiry name.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { EntityMatchDetail { EntityMatchScore
int up to 3 digits., Optional
A numeric value ranging from 1 to 100 which denotes the
degree of match of this entity against the inquired subject
name. A value of 1 denotes lowest degree of match, value of
100 denotes highest degree of match.
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }ComplianceSubject } SubjectAlertDetail }EntityMatchDetail
/Aggregate
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { ReferenceDetail
Aggregate, Optional (Infinite)
Records the source details of the data which was originally
obtained by D&B.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { ReferenceDetail { SourceName
string up to 400 chars., Optional
Text recording the name of the source from which the alert
data was originally obtained.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { ReferenceDetail { SourceDescription
string up to 500 chars., Optional
Text that describes the source.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { ReferenceDetail { PublicationName
string up to 500 chars., Optional
Name of the publication.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { ReferenceDetail { PublicationDate
date, Optional
The date of publication.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { ReferenceDetail { WebPageURL
string up to 500 chars., Optional
Records the internet link of the publication content.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { ReferenceDetail { PublisherName
string up to 512 chars., Optional
Name of the company or person that publishes products.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 200
Name Characteristics
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { ReferenceDetail { SourceListName
string up to 256 chars., Optional
Text recording the name of the list from which the alert data
was originally obtained; e.g., UK sanctions list, OFAC list.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { ReferenceDetail { SourceTypeText
string up to 256 chars., Optional
Text denoting the category of the source; e.g., internet,
publication, media.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { ReferenceDetail { ContentText
string up to 5000 chars., Optional
Text that records the body of the news item.
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }ComplianceSubject } SubjectAlertDetail }ReferenceDetail
/Aggregate
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { EventDetail
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of the details of the events in which the supplier is
involved.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { EventDetail { EventTypeText
string up to 3 chars., Optional
Text that describes the category of the event.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { EventDetail { EventSubTypeText
string up to 3 chars., Optional
Text that describes the sub category of the event.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { EventDetail { EventText
string up to 2000 chars., Optional (Infinite)
Free form text recording additional details about the event.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { EventDetail { EventDate
date, Optional
The date when the event occured.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { EventDetail { EventDate@DatePrecisionText
Attribute
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 201
Name Characteristics
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { EventDetail { EventDate@DatePrecisionDNBCodeValue
Attribute
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { EventDetail { EventDate@DatePrecisionDNBCodeTableNumber
Attribute
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { EventDetail { EndDate
DateTimestamp, Optional
Date when the event action was no longer in affect.
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }ComplianceSubject } SubjectAlertDetail } EventDetail
/Aggregate
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Name
Aggregate, Optional
Records the names used to identify this supplier.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Name { PrimaryName
string, Required
Name of the subject by which it is primarily known /
identified.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Name { KnownByName
string up to 500 chars., Optional (Infinite)
Any other name by which the subject is known which cannot
be categorised by one of the other name types either because
the name category is not covered by an existing type of
because the precise name type cannot be identified.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Name { FormerPrimaryName
string up to 500 chars., Optional (Infinite)
Name of the subject was primarily known / identified
previously.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Name { TradeStyleName
string up to 500 chars., Optional (Infinite)
Name of the subject trades under for commercial purposes,
although its registered, legal name, used for contracts and
other formal situations, may be another.
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }ComplianceSubject } SubjectAlertDetail } Name
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 202
Name Characteristics
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address
Aggregate, Optional
Records the location details of the supplier.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { BirthAddress
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of the birth location details of the supplier.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { BirthAddress { StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of several lines where each address line contains
one or more named address elements. Examples of named
address elements are Street Name, Street Number, Building
Name, Estate Name. They are called “lines” because an
addres can be divided into multiple lines. When there are
multiple lines the sequence of the lines must be preserved.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { BirthAddress { StreetAddressLine { LineText
string up to 240 chars., Required
Text that records the street address components as it would
be presented on an address label. This includes, but is not
limited to, details such as street name, street number,
building name, estate name.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { BirthAddress { StreetAddressLine { DisplaySequence
int up to 3 digits., Optional
A number which may be used to define the order in which
this street address line should be presented relative to other
street address lines where the lower the number the earlier
the data is presented.
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }ComplianceSubject } SubjectAlertDetail } Address }BirthAddress } StreetAddressLine
/Aggregate
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { BirthAddress { PrimaryTownName
string, Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 203
Name Characteristics
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { BirthAddress { TerritoryName
string, Optional
The name of the locally governed area which forms part of a
centrally governed nation as received by D&B. Clarification
Note: As a guiding principle this is a geographic area which
could theoretically exist as a separate nation. In the U.S. this
would be a State. In the UK this would be one of the Home
Nations.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { BirthAddress { PostalCode
string, Optional
An identifier used by the local country Postal Authority to
identify a particular geographic location. For example, in
Belgium, Postal Code 9000 identifies the town of GHENT.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { BirthAddress { CountryName
string, Optional
The name of the country of this address.
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }ComplianceSubject } SubjectAlertDetail } Address }BirthAddress
/Aggregate
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { PrimaryAddress
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of the present location details of the supplier.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { PrimaryAddress { StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of several lines where each address line contains
one or more named address elements. Examples of named
address elements are Street Name, Street Number, Building
Name, Estate Name. They are called “lines” because an
addres can be divided into multiple lines. When there are
multiple lines the sequence of the lines must be preserved.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { PrimaryAddress { StreetAddressLine { LineText
string up to 240 chars., Required
Text that records the street address components as it would
be presented on an address label. This includes, but is not
limited to, details such as street name, street number,
building name, estate name.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 204
Name Characteristics
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { PrimaryAddress { StreetAddressLine { DisplaySequence
int up to 3 digits., Optional
A number which may be used to define the order in which
this street address line should be presented relative to other
street address lines where the lower the number the earlier
the data is presented.
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }ComplianceSubject } SubjectAlertDetail } Address }PrimaryAddress } StreetAddressLine
/Aggregate
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { PrimaryAddress { PrimaryTownName
string, Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { PrimaryAddress { TerritoryName
string, Optional
The name of the locally governed area which forms part of a
centrally governed nation as received by D&B. Clarification
Note: As a guiding principle this is a geographic area which
could theoretically exist as a separate nation. In the U.S. this
would be a State. In the UK this would be one of the Home
Nations.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { PrimaryAddress { PostalCode
string, Optional
An identifier used by the local country Postal Authority to
identify a particular geographic location. For example, in
Belgium, Postal Code 9000 identifies the town of GHENT.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { PrimaryAddress { CountryName
string, Optional
The name of the country of this address.
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }ComplianceSubject } SubjectAlertDetail } Address }PrimaryAddress
/Aggregate
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { NonspecificAddress
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of supplier address, which cannot be classified into
distinct sections.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 205
Name Characteristics
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { NonspecificAddress { StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of several lines where each address line contains
one or more named address elements. Examples of named
address elements are Street Name, Street Number, Building
Name, Estate Name. They are called “lines” because an
addres can be divided into multiple lines. When there are
multiple lines the sequence of the lines must be preserved.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { NonspecificAddress { StreetAddressLine { LineText
string up to 240 chars., Required
Text that records the street address components as it would
be presented on an address label. This includes, but is not
limited to, details such as street name, street number,
building name, estate name.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { NonspecificAddress { StreetAddressLine { DisplaySequence
int up to 3 digits., Optional
A number which may be used to define the order in which
this street address line should be presented relative to other
street address lines where the lower the number the earlier
the data is presented.
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }ComplianceSubject } SubjectAlertDetail } Address }NonspecificAddress } StreetAddressLine
/Aggregate
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { NonspecificAddress { PrimaryTownName
string, Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { NonspecificAddress { TerritoryName
string, Optional
The name of the locally governed area which forms part of a
centrally governed nation as received by D&B. Clarification
Note: As a guiding principle this is a geographic area which
could theoretically exist as a separate nation. In the U.S. this
would be a State. In the UK this would be one of the Home
Nations.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 206
Name Characteristics
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { NonspecificAddress { PostalCode
string, Optional
An identifier used by the local country Postal Authority to
identify a particular geographic location. For example, in
Belgium, Postal Code 9000 identifies the town of GHENT.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { NonspecificAddress { CountryName
string, Required
The name of the country of this address.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Address { NonspecificAddress { AddressTypeText
string up to 32 chars., Optional
Text identifying the type of address being supplied.
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }ComplianceSubject } SubjectAlertDetail } Address }NonspecificAddress
/Aggregate
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }ComplianceSubject } SubjectAlertDetail } Address
/Aggregate
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { PersonalDetail
Aggregate, Optional
Records the personal information about the individual.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { PersonalDetail{ BirthDate
date, Optional (Infinite)
The date when the individula was born.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { PersonalDetail{ BirthDate@DatePrecisionText
Attribute
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { PersonalDetail{ BirthDate@DatePrecisionDNBCodeValue
Attribute
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { PersonalDetail{ BirthDate@DatePrecisionDNBCodeTableNumber
Attribute
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }ComplianceSubject } SubjectAlertDetail } PersonalDetail
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 207
Name Characteristics
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Assessment
Aggregate, Optional
Records the appraisal/opinion assigned to this Subject by an
entity other than the D&B Worldwide Network (WWN).
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Assessment { SupplierRiskScore
Aggregate, Required
A numeric value ranging from 1 to 100 assigned to a supplier
using a scoring model used to predict the risk of doing
business with this supplier. Value 1 denotes lowest risk and
100 denotes highest risk.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Assessment { SupplierRiskScore { RawScore
string up to 16 chars., Required
A numeric value ranging from 1 to 100 assigned to a supplier
using a scoring model used to predict the risk of doing
business with this supplier. Value 1 denotes lowest risk and
100 denotes highest risk.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { Assessment { SupplierRiskScore { RiskPriorityValue
string up to 2 chars., Optional
A string denoting the level of risk priority .
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }ComplianceSubject } SubjectAlertDetail } Assessment }SupplierRiskScore
/Aggregate
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }ComplianceSubject } SubjectAlertDetail } Assessment
/Aggregate
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { NonspecificParameterDetail
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of supplier information, which cannot be classified
into distinct sections, as key value pairs.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { NonspecificParameterDetail { ParameterDescription
string up to 256 chars., Optional
Text that identifies the data in ParameterValue.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { NonspecificParameterDetail { ParameterValue
string up to 512 chars., Optional
Text that records a fact being communicated in the
decisioning process and identified by the
ParameterDescription.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 208
Name Characteristics
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }ComplianceSubject } SubjectAlertDetail }NonspecificParameterDetail
/Aggregate
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { ComplianceSubject { SubjectAlertDetail { DisplaySequence
int, Optional
A number which may be used to define the order in which
this text entry should be presented relative to other
occurrences of text entries where the lower the number the
earlier the data is presented.
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }ComplianceSubject } SubjectAlertDetail
/Aggregate
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }ComplianceSubject
/Aggregate
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { InquiryReferenceDetail
Aggregate, Optional
Records data that allows the customer to specify information
to be linked to this request in order to support subsequent
searches.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { InquiryReferenceDetail { CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to be
linked to the product in order to support subsequent order
reconciliation.
GetComplianceAlertsResponse { GetComplianceAlertsResponseDetail { InquiryReferenceDetail { CustomerBillingEndorsementText
string at least 1 chars. up to 240 chars., Optional
Text that is filled in by customer and commonly contains
requesting individual or department name, or customer's
own account/reference number and/or name for the case on
which the product was provided.This text is a reference used
during the billing process.
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail }InquiryReferenceDetail
/Aggregate
END: GetComplianceAlertsResponse }GetComplianceAlertsResponseDetail
/Aggregate
END: GetComplianceAlertsResponse /Aggregate
Lists of possible values (when present) are subject to change. Additional values not presented in this documentation may be delivered
in the response and should be anticipated in any implementation.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 209
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM002, CM004, CM018 and SC001-SC009.
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Compliance Check Service
Samples http://developer.dnb.com/docs/2.0/compliance/1.0/DnB-Compliance.zip
Related Topics
GetSubjectComplianceData (REST).
D&B Direct API Documentation Response Codes
©Dun & Bradstreet, Inc. 2014 210
GetComplianceAlerts (SOAP)This operation -- part of the Compliance Check Service -- is a component of the Compliance √ Screeningsolution.
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Note: While the Compliance √ Screening features are accessed through the D&B Direct service, separatecredentials are required for each data environment and will be provided by a D&B sales representative.
Endpoint
https://maxcvservices.dnb.com/ComplianceCheckService/V{version}
Request Parameters
The following parameters are accepted by this operation.
Exception: The list returned by this operation will include all subjects registered by user credentials associatedwith the customer contract.
If an application requires filtering by user credentials, a possible solution would be to place a unique value inthe CustomerReferenceText field when registering subjects, and then supply the same value to this operation.
Exception: The pagination sequence for this operation starts at zero (rather than one). Also, responsescurrently deliver one less than the per page value specified on the request.
Name Characteristics
GetComplianceAlertsRequest Aggregate
GetComplianceAlertsRequest@ServiceVersionNumber Attribute
GetComplianceAlertsRequest@xsi:schemaLocation Attribute
GetComplianceAlertsRequest. TransactionDetail Aggregate, Optional
Records information necessary to process this request.
D&B Direct API Documentation GetComplianceAlerts (SOAP)
©Dun & Bradstreet, Inc. 2014 211
Name Characteristics
GetComplianceAlertsRequest. TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
GetComplianceAlertsRequest. TransactionDetail.TransactionTimestamp
DateTimestamp, Optional
The date and time when this request was created. When the
request is from an intermediary, such as a workflow manager
or service bus, this is the date and time when the message
was sent to the D&B function, i.e., the date and time when the
xml document was created by the requesting intermediary.
GetComplianceAlertsRequest. TransactionDetail.SubmittingOfficeID
string up to 64 chars., Optional
A number that identifies the system or the software
application from where this request originated. / A number
used to uniquely identfy the D&B business segment or delivery
channel from where this request originated.
END: GetComplianceAlertsRequest. TransactionDetail /Aggregate
GetComplianceAlertsRequest.GetComplianceAlertsRequestDetail
Aggregate, Required
GetComplianceAlertsRequest.GetComplianceAlertsRequestDetail. InquiryDetail
Aggregate, Required
GetComplianceAlertsRequest.GetComplianceAlertsRequestDetail. InquiryDetail.SubjectID
SubjectIDType up to 25 chars., Optional
A number uniquely identifying the inquired subject within the
D&B Worldwide Network.
END: GetComplianceAlertsRequest.GetComplianceAlertsRequestDetail. InquiryDetail
/Aggregate
GetComplianceAlertsRequest.GetComplianceAlertsRequestDetail.ComplianceAlertsSpecification
Aggregate, Optional
GetComplianceAlertsRequest.GetComplianceAlertsRequestDetail.ComplianceAlertsSpecification. AlertFromTimestamp
dateTime, Optional
The date & time from when the Alert should be returned
GetComplianceAlertsRequest.GetComplianceAlertsRequestDetail.ComplianceAlertsSpecification. AlertToTimestamp
dateTime, Optional
The date & time till when the Alert should be returned
GetComplianceAlertsRequest.GetComplianceAlertsRequestDetail.ComplianceAlertsSpecification. SortBasisText
ComplianceAlertsSortBasisTextEnum, Optional
Possible values: SubjectID; AlertDate
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2014 212
Name Characteristics
GetComplianceAlertsRequest.GetComplianceAlertsRequestDetail.ComplianceAlertsSpecification. SortDirectionText
SortDirectionEnum, Optional
Possible values: Ascending; Descending
GetComplianceAlertsRequest.GetComplianceAlertsRequestDetail.ComplianceAlertsSpecification.CandidatePerPageMaximumQuantity
int, Optional
GetComplianceAlertsRequest.GetComplianceAlertsRequestDetail.ComplianceAlertsSpecification.CandidateDisplayStartSequenceNumber
int, Optional
END: GetComplianceAlertsRequest.GetComplianceAlertsRequestDetail.ComplianceAlertsSpecification
/Aggregate
GetComplianceAlertsRequest.GetComplianceAlertsRequestDetail.InquiryReferenceDetail
Aggregate, Optional
Records data that allows the customer to specify information
to be linked to this request in order to support subsequent
searches.
GetComplianceAlertsRequest.GetComplianceAlertsRequestDetail.InquiryReferenceDetail. CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to be
linked to the product in order to support subsequent order
reconciliation.
GetComplianceAlertsRequest.GetComplianceAlertsRequestDetail.InquiryReferenceDetail.CustomerBillingEndorsementText
string at least 1 chars. up to 240 chars., Optional
Text that is filled in by customer and commonly contains
requesting individual or department name, or customer's own
account/reference number and/or name for the case on
which the product was provided.This text is a reference used
during the billing process.
END: GetComplianceAlertsRequest.GetComplianceAlertsRequestDetail.InquiryReferenceDetail
/Aggregate
END: GetComplianceAlertsRequest.GetComplianceAlertsRequestDetail
/Aggregate
END: GetComplianceAlertsRequest /Aggregate
Sample Request
D&B Direct API Documentation Sample Request
©Dun & Bradstreet, Inc. 2014 213
Testing / Sandbox
This operation is currently unavailable in the D&B Direct sandbox (test) environment.
Data Field Response
The following is a list of the possible data fields returned by this operation in the XML response.
Name Characteristics
GetComplianceAlertsResponse Aggregate
GetComplianceAlertsResponse@ServiceVersionNumber Attribute
GetComplianceAlertsResponse@xsi:schemaLocation Attribute
GetComplianceAlertsResponse. TransactionDetail Aggregate, Required
Records information necessary to process a particular
request. Examples of a request is the ordering of a product.
GetComplianceAlertsResponse. TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
GetComplianceAlertsResponse. TransactionDetail.ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely identify
this transaction.
GetComplianceAlertsResponse. TransactionDetail.TransactionTimestamp
DateTimestamp, Required
The date and time when this request was submitted or the
date and time when the requesting intermediary, such as a
workflow manager or service bus, sent the message to the
D&B function, i.e., the date and time when the xml
document was created by the requesting intermediary.
END: GetComplianceAlertsResponse. TransactionDetail /Aggregate
GetComplianceAlertsResponse. TransactionResult Aggregate, Required
An aggregate that can repeat multiple times to record the
different outcomes of the transaction.
GetComplianceAlertsResponse. TransactionResult.SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g.,
Information, Warning, Error, Fatal.
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2014 214
Name Characteristics
GetComplianceAlertsResponse. TransactionResult.ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the outcome
of the transaction.
GetComplianceAlertsResponse. TransactionResult.ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
GetComplianceAlertsResponse. TransactionResult.ResultMessage
Aggregate, Optional (Infinite)
An aggregate that can repeat multiple times to record textual
data that expands on the ResultID and ResultText to provide
additional information to the user regarding the status of the
transaction. If the status implies that there is a problem this
may also provide guidance to the user on how to address it.
GetComplianceAlertsResponse. TransactionResult.ResultMessage. ResultMessageID
string up to 30 chars., Optional
An alphanumeric string that uniquely identifies the additional
information regarding the outcome of the transaction.
GetComplianceAlertsResponse. TransactionResult.ResultMessage. ResultDescription
string up to 512 chars., Required
Text that describes the additional information regarding the
outcome of the transaction.
GetComplianceAlertsResponse. TransactionResult.ResultMessage. NonSpecificDataProviderText
string up to 30 chars., Optional
Text that describes, in general terms, the source from which
the Result Message data was originally obtained by D&B; e.g.
Credit Bureau.
END: GetComplianceAlertsResponse. TransactionResult.ResultMessage
/Aggregate
END: GetComplianceAlertsResponse. TransactionResult /Aggregate
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail
Aggregate, Optional
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.CandidateMatchedQuantity
int, Required
The number of subjects identified as possible prospects in the
repository.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.CandidateReturnedQuantity
int, Optional
The number of subjects actually returned as possible
prospects in the repository based on the search criteria.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 215
Name Characteristics
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject
Aggregate, Optional (Infinite)
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectID
SubjectIDType up to 25 chars., Required
A number uniquely identifying the inquired subject within an
application.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail
Aggregate, Optional
An entry loop which can repeat multiple times to allow the
recording of the changes to the details of the supplier
registered for monitoring.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. InquiryDetail
Aggregate, Optional
Inquiry Detail for the Alert
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. InquiryDetail.SubjectName
_, Required
The name of the individual or organization from which the
subject purchases goods or services.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. InquiryDetail.SubjectName@NameIdentificationNumber
Attribute
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. InquiryDetail.Location
Aggregate, Optional
Records the components of a location for which the business
activity profile information is requested.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. InquiryDetail.Location. StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of several lines where each address line contains
one or more named address elements. Examples of named
address elements are Street Name, Street Number, Building
Name, Estate Name. They are called “lines” because an
addres can be divided into multiple lines. When there are
multiple lines the sequence of the lines must be preserved.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 216
Name Characteristics
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. InquiryDetail.Location. StreetAddressLine. LineText
string up to 240 chars., Required
Text that records the street address components as it would
be presented on an address label. This includes, but is not
limited to, details such as street name, street number,
building name, estate name.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. InquiryDetail.Location. StreetAddressLine. DisplaySequence
int up to 3 digits., Optional
A number which may be used to define the order in which
this street address line should be presented relative to other
street address lines where the lower the number the earlier
the data is presented.
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. InquiryDetail.Location. StreetAddressLine
/Aggregate
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. InquiryDetail.Location. PrimaryTownName
string up to 64 chars., Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. InquiryDetail.Location. PostalCode
string, Optional
An identifier used by the local country Postal Authority to
identify a particular geographic location. For example, in
Belgium, Postal Code 9000 identifies the town of GHENT.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. InquiryDetail.Location. CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO), identifying the country for this address.
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. InquiryDetail.Location
/Aggregate
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. InquiryDetail
/Aggregate
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail.RenderingApplicationID
string up to 100 chars., Optional
An alphanumeric value assigned to uniquely identify the
application delivering the report view of the alert entity.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 217
Name Characteristics
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. AlertID
string up to 64 chars., Optional
An alphanumeric value that uniquely identifies the Alert.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. AlertEntityID
string up to 32 chars., Optional
An alphanumeric value that uniquely identifies the Vendor.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. AlertDate
date, Optional
Date when the alert was created.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. AlertNoteText
string up to 1000 chars., Optional
Text that describes the alert note.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. EntityTypeText
EntityTypeEnumeration, Optional
Text describes whether the entity is Person or Organization.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail.EntityReferenceWebPageURL
string up to 512 chars., Optional
Text identifying the internet URL that provides additional
information like media articles for the Entity.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail.EntityMatchDetail
Aggregate, Optional
Records the details of the score indicating the degree of the
match to the inquiry name.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail.EntityMatchDetail. EntityMatchScore
int up to 3 digits., Optional
A numeric value ranging from 1 to 100 which denotes the
degree of match of this entity against the inquired subject
name. A value of 1 denotes lowest degree of match, value of
100 denotes highest degree of match.
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail.EntityMatchDetail
/Aggregate
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. ReferenceDetail
Aggregate, Optional (Infinite)
Records the source details of the data which was originally
obtained by D&B.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 218
Name Characteristics
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail.ReferenceDetail. SourceName
string up to 400 chars., Optional
Text recording the name of the source from which the alert
data was originally obtained.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail.ReferenceDetail. SourceDescription
string up to 500 chars., Optional
Text that describes the source.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail.ReferenceDetail. PublicationName
string up to 500 chars., Optional
Name of the publication.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail.ReferenceDetail. PublicationDate
date, Optional
The date of publication.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail.ReferenceDetail. WebPageURL
string up to 500 chars., Optional
Records the internet link of the publication content.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail.ReferenceDetail. PublisherName
string up to 512 chars., Optional
Name of the company or person that publishes products.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail.ReferenceDetail. SourceListName
string up to 256 chars., Optional
Text recording the name of the list from which the alert data
was originally obtained; e.g., UK sanctions list, OFAC list.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail.ReferenceDetail. SourceTypeText
string up to 256 chars., Optional
Text denoting the category of the source; e.g., internet,
publication, media.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail.ReferenceDetail. ContentText
string up to 5000 chars., Optional
Text that records the body of the news item.
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. ReferenceDetail
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 219
Name Characteristics
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. EventDetail
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of the details of the events in which the supplier is
involved.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. EventDetail.EventTypeText
string up to 3 chars., Optional
Text that describes the category of the event.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. EventDetail.EventSubTypeText
string up to 3 chars., Optional
Text that describes the sub category of the event.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. EventDetail.EventText
string up to 2000 chars., Optional (Infinite)
Free form text recording additional details about the event.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. EventDetail.EventDate
date, Optional
The date when the event occured.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. EventDetail.EventDate@DatePrecisionText
Attribute
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. EventDetail.EventDate@DatePrecisionDNBCodeValue
Attribute
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. EventDetail.EventDate@DatePrecisionDNBCodeTableNumber
Attribute
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. EventDetail.EndDate
DateTimestamp, Optional
Date when the event action was no longer in affect.
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. EventDetail
/Aggregate
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Name
Aggregate, Optional
Records the names used to identify this supplier.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 220
Name Characteristics
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Name.PrimaryName
string, Required
Name of the subject by which it is primarily known /
identified.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Name.KnownByName
string up to 500 chars., Optional (Infinite)
Any other name by which the subject is known which cannot
be categorised by one of the other name types either because
the name category is not covered by an existing type of
because the precise name type cannot be identified.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Name.FormerPrimaryName
string up to 500 chars., Optional (Infinite)
Name of the subject was primarily known / identified
previously.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Name.TradeStyleName
string up to 500 chars., Optional (Infinite)
Name of the subject trades under for commercial purposes,
although its registered, legal name, used for contracts and
other formal situations, may be another.
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Name
/Aggregate
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address
Aggregate, Optional
Records the location details of the supplier.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.BirthAddress
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of the birth location details of the supplier.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.BirthAddress. StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of several lines where each address line contains
one or more named address elements. Examples of named
address elements are Street Name, Street Number, Building
Name, Estate Name. They are called “lines” because an
addres can be divided into multiple lines. When there are
multiple lines the sequence of the lines must be preserved.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 221
Name Characteristics
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.BirthAddress. StreetAddressLine. LineText
string up to 240 chars., Required
Text that records the street address components as it would
be presented on an address label. This includes, but is not
limited to, details such as street name, street number,
building name, estate name.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.BirthAddress. StreetAddressLine. DisplaySequence
int up to 3 digits., Optional
A number which may be used to define the order in which
this street address line should be presented relative to other
street address lines where the lower the number the earlier
the data is presented.
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.BirthAddress. StreetAddressLine
/Aggregate
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.BirthAddress. PrimaryTownName
string, Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.BirthAddress. TerritoryName
string, Optional
The name of the locally governed area which forms part of a
centrally governed nation as received by D&B. Clarification
Note: As a guiding principle this is a geographic area which
could theoretically exist as a separate nation. In the U.S. this
would be a State. In the UK this would be one of the Home
Nations.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.BirthAddress. PostalCode
string, Optional
An identifier used by the local country Postal Authority to
identify a particular geographic location. For example, in
Belgium, Postal Code 9000 identifies the town of GHENT.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.BirthAddress. CountryName
string, Optional
The name of the country of this address.
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.BirthAddress
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 222
Name Characteristics
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.PrimaryAddress
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of the present location details of the supplier.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.PrimaryAddress. StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of several lines where each address line contains
one or more named address elements. Examples of named
address elements are Street Name, Street Number, Building
Name, Estate Name. They are called “lines” because an
addres can be divided into multiple lines. When there are
multiple lines the sequence of the lines must be preserved.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.PrimaryAddress. StreetAddressLine. LineText
string up to 240 chars., Required
Text that records the street address components as it would
be presented on an address label. This includes, but is not
limited to, details such as street name, street number,
building name, estate name.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.PrimaryAddress. StreetAddressLine. DisplaySequence
int up to 3 digits., Optional
A number which may be used to define the order in which
this street address line should be presented relative to other
street address lines where the lower the number the earlier
the data is presented.
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.PrimaryAddress. StreetAddressLine
/Aggregate
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.PrimaryAddress. PrimaryTownName
string, Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 223
Name Characteristics
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.PrimaryAddress. TerritoryName
string, Optional
The name of the locally governed area which forms part of a
centrally governed nation as received by D&B. Clarification
Note: As a guiding principle this is a geographic area which
could theoretically exist as a separate nation. In the U.S. this
would be a State. In the UK this would be one of the Home
Nations.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.PrimaryAddress. PostalCode
string, Optional
An identifier used by the local country Postal Authority to
identify a particular geographic location. For example, in
Belgium, Postal Code 9000 identifies the town of GHENT.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.PrimaryAddress. CountryName
string, Optional
The name of the country of this address.
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.PrimaryAddress
/Aggregate
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of supplier address, which cannot be classified into
distinct sections.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress. StreetAddressLine
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of several lines where each address line contains
one or more named address elements. Examples of named
address elements are Street Name, Street Number, Building
Name, Estate Name. They are called “lines” because an
addres can be divided into multiple lines. When there are
multiple lines the sequence of the lines must be preserved.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress. StreetAddressLine. LineText
string up to 240 chars., Required
Text that records the street address components as it would
be presented on an address label. This includes, but is not
limited to, details such as street name, street number,
building name, estate name.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 224
Name Characteristics
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress. StreetAddressLine.DisplaySequence
int up to 3 digits., Optional
A number which may be used to define the order in which
this street address line should be presented relative to other
street address lines where the lower the number the earlier
the data is presented.
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress. StreetAddressLine
/Aggregate
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress. PrimaryTownName
string, Optional
The name of the town or city recognized by the Postal
Authority for delivering mail.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress. TerritoryName
string, Optional
The name of the locally governed area which forms part of a
centrally governed nation as received by D&B. Clarification
Note: As a guiding principle this is a geographic area which
could theoretically exist as a separate nation. In the U.S. this
would be a State. In the UK this would be one of the Home
Nations.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress. PostalCode
string, Optional
An identifier used by the local country Postal Authority to
identify a particular geographic location. For example, in
Belgium, Postal Code 9000 identifies the town of GHENT.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress. CountryName
string, Required
The name of the country of this address.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress. AddressTypeText
string up to 32 chars., Optional
Text identifying the type of address being supplied.
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address.NonspecificAddress
/Aggregate
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Address
/Aggregate
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 225
Name Characteristics
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. PersonalDetail
Aggregate, Optional
Records the personal information about the individual.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. PersonalDetail.BirthDate
date, Optional (Infinite)
The date when the individula was born.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. PersonalDetail.BirthDate@DatePrecisionText
Attribute
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. PersonalDetail.BirthDate@DatePrecisionDNBCodeValue
Attribute
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. PersonalDetail.BirthDate@DatePrecisionDNBCodeTableNumber
Attribute
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. PersonalDetail
/Aggregate
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Assessment
Aggregate, Optional
Records the appraisal/opinion assigned to this Subject by an
entity other than the D&B Worldwide Network (WWN).
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Assessment.SupplierRiskScore
Aggregate, Required
A numeric value ranging from 1 to 100 assigned to a supplier
using a scoring model used to predict the risk of doing
business with this supplier. Value 1 denotes lowest risk and
100 denotes highest risk.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Assessment.SupplierRiskScore. RawScore
string up to 16 chars., Required
A numeric value ranging from 1 to 100 assigned to a supplier
using a scoring model used to predict the risk of doing
business with this supplier. Value 1 denotes lowest risk and
100 denotes highest risk.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Assessment.SupplierRiskScore. RiskPriorityValue
string up to 2 chars., Optional
A string denoting the level of risk priority .
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 226
Name Characteristics
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Assessment.SupplierRiskScore
/Aggregate
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail. Assessment
/Aggregate
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail.NonspecificParameterDetail
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of supplier information, which cannot be classified
into distinct sections, as key value pairs.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail.NonspecificParameterDetail. ParameterDescription
string up to 256 chars., Optional
Text that identifies the data in ParameterValue.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail.NonspecificParameterDetail. ParameterValue
string up to 512 chars., Optional
Text that records a fact being communicated in the
decisioning process and identified by the
ParameterDescription.
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail.NonspecificParameterDetail
/Aggregate
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail.DisplaySequence
int, Optional
A number which may be used to define the order in which
this text entry should be presented relative to other
occurrences of text entries where the lower the number the
earlier the data is presented.
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject. SubjectAlertDetail
/Aggregate
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.ComplianceSubject
/Aggregate
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.InquiryReferenceDetail
Aggregate, Optional
Records data that allows the customer to specify information
to be linked to this request in order to support subsequent
searches.
D&B Direct API Documentation Data Field Response
©Dun & Bradstreet, Inc. 2014 227
Name Characteristics
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.InquiryReferenceDetail. CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to be
linked to the product in order to support subsequent order
reconciliation.
GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.InquiryReferenceDetail.CustomerBillingEndorsementText
string at least 1 chars. up to 240 chars., Optional
Text that is filled in by customer and commonly contains
requesting individual or department name, or customer's
own account/reference number and/or name for the case on
which the product was provided.This text is a reference used
during the billing process.
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail.InquiryReferenceDetail
/Aggregate
END: GetComplianceAlertsResponse.GetComplianceAlertsResponseDetail
/Aggregate
END: GetComplianceAlertsResponse /Aggregate
Lists of possible values (when present) are subject to change. Additional values not presented in this documentation may be delivered
in the response and should be anticipated in any implementation.
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM002, CM004, CM018 and SC001-SC009.
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Compliance Check Service
Samples http://developer.dnb.com/docs/2.0/compliance/1.0/DnB-Compliance.zip
Related Topics
GetSubjectComplianceData (SOAP).
D&B Direct API Documentation Response Codes
©Dun & Bradstreet, Inc. 2014 228
Authentication Process
SOAP Authentication
Before D&B Direct API services can be invoked, the credentials must be activated. Instructions and a link foractivating username/password combinations will be included in an email sent upon completion of theregistration process. If you do not receive an email, or unable to locate it, please contact the D&B supportteam for assistance (and specify if this a production, trial or sandbox related issue).
The system will generate a unique username for accounts created after December 6, 2013. Prior to that date,the customer-supplied email address was used as the username. No change is required for existing credentials.
Most of the D&B Direct products and features require contractual entitlement prior to production (and trial)environment access. Please refer to the data layer entitlement page for more details.
All D&B Direct API services require that a valid username and password be provided in the SOAP header witheach call to an operation. The 2.0 services do not require that an API key be supplied.
If the credentials are valid and the associated account is entitled to access the product or feature, the requestwill be processed. If the authentication process fails, an error response code will be returned. The securityrelated response codes are prefixed with "SC."
Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:com="http://services.dnb.com/CompanyServiceV2.0">
<soapenv:Header><wsse:Security soapenv:mustUnderstand="0" xmlns:wsse="http://do
cs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken-11"><wsse:Username>MyUsername</wsse:Username><wsse:Password Type="http://docs.oasis-open.org/wss/2004/
01/oasis-200401-wss-username-token-profile-1.0#PasswordText">MyPassword</wsse:Password>
</wsse:UsernameToken></wsse:Security>
</soapenv:Header><soapenv:Body>
<!--Request Body as per the service schema-->
D&B Direct API Documentation Authentication Process
©Dun & Bradstreet, Inc. 2014 229
</soapenv:Body></soapenv:Envelope>
Response - Invalid Credentials
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body><com:MatchResponse ServiceVersionNumber="4.0" xmlns:com="http:/
/services.dnb.com/CompanyServiceV2.0"><TransactionDetail>
<ApplicationTransactionID>Id-b118ae275255a7cf0cfb742e</ApplicationTransactionID>
<ServiceTransactionID>Id-b118ae275255a7cf0cfb742e</ServiceTransactionID>
<TransactionTimestamp>2013-10-09T15:00:31</TransactionTimestamp>
</TransactionDetail><TransactionResult>
<SeverityText>Error</SeverityText><ResultID>SC001</ResultID><ResultText>Your user credentials are invalid. Please con
tact your D&B Representative or your local Customer Service Center.</ResultText>
</TransactionResult></com:MatchResponse>
</soapenv:Body></soapenv:Envelope>
REST Authentication
Before D&B Direct API services can be invoked, the credentials must be activated. Instructions and a link foractivating username/password combinations will be included in an email sent upon completion of theregistration process. If you do not receive an email, or unable to locate it, please contact the D&B supportteam for assistance (and specify if this a production, trial or sandbox related issue).
The system will generate a unique username for accounts created after December 6, 2013. Prior to that date,the customer-supplied email address was used as the username. No change is required for existing credentials.
Most of the D&B Direct products and features require contractual entitlement prior to production (and trial)environment access. Please refer to the data layer entitlement page for more details.
D&B Direct API Documentation Response - Invalid Credentials
©Dun & Bradstreet, Inc. 2014 230
Implementation of D&B Direct API services using REST methodology involves obtaining anAuthentication Token, that is then submitted with subsequent requests during a particular session (up to eighthours).
Secure access to D&B Direct services is managed through the use of an Authentication Token, which can beobtained by sending an HTTP POST request to Authentication Service URL, passing a valid username andpassword in the HTTP header. The 2.0 services do not require that an API key be supplied. If the usercredentials are valid, an Authentication Token (valid for eight hours) will be returned back in theAuthorization tag in the HTTP header of the response.
Once an Authentication Token is obtained, it should be embedded in the HTTP header of all subsequentrequests. If the Authentication Token is valid and the user is entitled to access the product or feature beingrequested, the service will be processed and requested information returned as a JSON object. If theAuthentication Token is invalid, an error code will be returned in the JSON response.
Note: The D&B Direct REST implementation uses the BadgerFish approach for JSON with some minorvariations.
Sample Request - Get New Token
POST https://maxcvservices.dnb.com/rest/Authenticationx-dnb-user: MyUsernamex-dnb-pwd: MyPassword
A {version} parameter is not required when initiating a request to the Authentication service.
Response - Success
HTTP/1.1 200 OKDate: Wed, 09 Oct 2013 18:47:22 GMTAuthorization: <MyToken>x-dnb-user: MyUsernamex-dnb-pwd: MyPassword
Response - Failed
HTTP/1.1 401 ERRORDate: Wed, 09 Oct 2013 18:51:11 GMTAuthorization: INVALID CREDENTIALSx-dnb-user: MyUsernamex-dnb-pwd: MyPassword
D&B Direct API Documentation Sample Request - Get New Token
©Dun & Bradstreet, Inc. 2014 231
Sample Request - Invoke Operation with Token
GET https://maxcvservices.dnb.com/V4.0/organizations?CountryISOAlpha2Code=US&SubjectName=GORMAN%20MANUFACTURING&match=true&MatchTypeText=Advanced&TerritoryName=CAAuthorization: <MyToken>
Response - Expired Authentication Token
HTTP/1.1 401 UNAUTHORIZEDDate: Thu, 10 Oct 2013 14:55:19 GMTAuthorization: <MyToken>Content-Type: application/jsonContent-Encoding: gzip
{"MatchResponse": {"TransactionDetail": {
"ApplicationTransactionID": "REST","ServiceTransactionID": "Id-c04bbdff5256bfd70a7b742e","TransactionTimestamp": "2013-10-10T10:55:19"
},"TransactionResult": {
"SeverityText": "Error","ResultID": "SC001","ResultText": "Your user credentials are invalid. Please contact
your D&B Representative or your local Customer Service Center."}
}}
D&B Direct API Documentation Sample Request - Invoke Operation with Token
©Dun & Bradstreet, Inc. 2014 232
Obtaining CredentialsAccess to the D&B Direct web services are secured by a username and password combination. D&B will issueyour organization a production username upon completion of the contract establishment process. Thisusername will be sent to the email address designated on the contract, along with instructions for setting upthe password. This process will also be followed for production trial requests.
D&B offers a non-billable environment (commonly referred to as the sandbox) for testing the D&B Direct webservices. Developers may establish, via a self-service interface, sandbox user id and password combinations.The production credentials assigned to your organization may NOT be used in the sandbox environment toauthenticate web services, and vice-versa.
Note: While the Compliance √ Screening features are accessed through the D&B Direct service, separatecredentials are required for each data environment and will be provided by a D&B sales representative.
Before D&B Direct API services can be invoked, the credentials must be activated. Instructions and a link foractivating username/password combinations will be included in an email sent upon completion of theregistration process. If you do not receive an email, or unable to locate it, please contact the D&B supportteam for assistance (and specify if this a production, trial or sandbox related issue).
The system will generate a unique username for accounts created after December 6, 2013. Prior to that date,the customer-supplied email address was used as the username. No change is required for existing credentials.
Most of the D&B Direct products and features require contractual entitlement prior to production (and trial)environment access. Please refer to the data layer entitlement page for more details.
D&B Direct API Documentation Obtaining Credentials
©Dun & Bradstreet, Inc. 2014 233
Data Layer EntitlementD&B Direct 2.0 services are provisioned to customers at the data layer, which, for some of the features, mightnot be intuitive. This page is intended to help developers clearly understand what services and operations theyare entitled to use.
Customers may access the "Review Contract Summary" function in the Online Usage Tracking online resourcefor a list of entitled data layers.
Components Requiring Entitlement
Data Layer: Compliance CheckService: Compliance Check ServiceOperations: RegisterSubject();Feature: Compliance √ Screening
Components Not Requiring Entitlement
These items are available to customers who have one or more entitled data layers.
Data Layer: Compliance Check Results*Service: Compliance Check ServiceOperations: GetSubjectComplianceData(); SearchComplianceAlerts()Feature: Compliance √ Screening
*Requires entitlement to the "Compliance Check" data layer.
D&B Direct API Documentation Data Layer Entitlement
©Dun & Bradstreet, Inc. 2014 234
Response CodesWhenever a D&B Direct web service request is unsuccessful, one of the following response codes will bereturned.
Code Description HTTPStatus*
CM000 Success 200
CM001 The given request is invalid. 400
CM002 The format of this request is invalid. 400
CM003 Missing information in the request. 400
CM004 Internal D&B system error. 500
CM005 D&B System temporarily unavailable. 503
CM006 D&B System busy. 503
CM007 Your request cannot be fulfilled for the given criteria. 404
CM008 No match found for the requested Duns number. 404
CM009 Reason Code required for Germany. 400
CM010 Partial Success. 200
CM011 Invalid Country Code provided in the request. 400
CM012 Invalid Duns number provided in the request. 400
CM013 Invalid Subject ID provided in the request. 400
CM014 Invalid Product Code provided in the request. 400
CM016 Invalid Territory provided in the request. 400
CM017 Duns number is missing in the request. 400
CM018 No candidates resulted for the given input criteria. 404
CM022 Only a Subset of request parameters were used for processing the request. 200
CM023 Duplicate record cannot be created. 400
CP001 No Match for the given input criteria. 404
CP002 No candidates resulted in the Extended Search. 404
CP003 No Match for given Telephone Number. 404
CP004 No Match for given Organization Identifier. 404
CP005 Insufficient Information to determine Fraud Score. 400
PD001 Requested product not available due to insufficient data. 404
PD002 Requested subject is promised later. Preliminary report returned. 200
PD003 Requested product not available - subject is on Stop Distribution. 404
PD004 Requested product not available due to subject information is too old. 404
D&B Direct API Documentation Response Codes
©Dun & Bradstreet, Inc. 2014 235
Code Description HTTPStatus*
PD005 Requested Product not available. 404
PD006 Subject is foreign branch, therefore trade-up to HQ is not available. 404
PD007 Family Tree does not exist for requested subject. 404
PD008 Success. Returned truncated family tree, as family tree member countexceeds maximum limit for requested subject.
200
PD009 Required scoring elements missing - a Commercial or Blended Small Businessreport is not available. You may proceed with a Principal only request.
200
PD010 Requested Product not available as address is undeliverable. 200
PD011 Requested Product not available as address is undeliverable. 404
PD012 Requested Product not available on Self request. 404
PD013 Requested Product is not available currently. Product will be delivered to thecustomer at a later point of time via offline delivery channels (Email/FAX/FTPetc).
404
PD014 Requested data is not available or partially available due to data integrityerrors.
404
PD015 Trade-up to HQ is not available. Therefore delivering the data for branchorganization.
200
PD016 Requested Product is not available since the requested DUNS is transferred toa new DUNS.
200
SC001 Your user credentials are invalid. 401
SC002 Your user credentials are not eligible for this request. 401
SC003 Your user credentials have expired. 401
SC004 Your Subscriber number has expired. 401
SC005 You have reached maximum limit permitted as per the contract. 401
SC006 Transaction not processed as the permitted concurrency limit was exceeded. 401
SC007 Subscriber validation failed. 401
SC008 Your account has been locked out due to repeated attempts to login with anincorrect User ID/Password.
401
SC009 Invalid Sign On Token in the request. 401
SC010 The User ID you provided doesn’t exist in the system. n/a
SC011 The User ID you provided already exist in the system n/a
SC012 Request not processed as user activation key is invalid or expired. n/a
BC001 Partial Success. One or more records in the input file were not processed. 200
BC002 Batch request is not processed since input file is not available in the specifiedlocation.
400
D&B Direct API Documentation Response Codes
©Dun & Bradstreet, Inc. 2014 236
Code Description HTTPStatus*
BC003 Batch request is not processed since the content of the input file is not in theexpected format.
400
BC004 Batch request is not processed since the count of the records specified in therequest do not match the exact count of records in the input file.
400
BC005 Intermediate Success 200
BC006 Batch request is not processed 400
BC007 Batch Execution in progress n/a
BC008 Batch Execution not yet started n/a
*This column displays the corresponding HTTP status code that will be returned for REST API calls.
D&B Direct API Documentation Response Codes
©Dun & Bradstreet, Inc. 2014 237
Sandbox AccessD&B Direct provides a test environment (referred to as the sandbox) that requires a separate set of credentials.Service requests made with sandbox credentials should be issued using the same endpoints (and in the case ofSOAP, using the same WSDL file).
When conducting testing in the production environment during a trial period, product requests will be limitedto the local market of the customer.
Some D&B Direct products and features may behave differently in the sandbox environment. Any limitationsor restrictions will be specified on the operation page for each interface.
Note: While the Compliance √ Screening features are accessed through a D&B Direct service, separatecredentials are required for each data environment and will be provided by a D&B sales representative.
Static Responses
Some operations currently return a static set of results, regardless of the request parameters, in the testenvironment.
Test Parameter Values
The following suggested parameters may be used for test environment (sandbox) requests to retrievesuccessful responses.
Feature Test Parameters
Register Subject n/a
Get Subject Compliance Data n/a
Get Compliance Alerts n/a
List Compliance Subjects n/a
Company Reports
Country Reports
D&B Direct API Documentation Sandbox Access
©Dun & Bradstreet, Inc. 2014 238
BadgerFish (REST)BadgerFish is a convention for translating an XML document into a JSON object. D&B Direct JSON responsesfollow this convention with a few minor variations. Exception: The responses supplied by the DataExchange Service follow the convention used by the respective business partner.
l Attributes will always be represented by prefixing with “@”. (see Example 2)l If an element is repeatable, that element will be always returned as an Array of objects in the JSON
response. (see Example 7)o If a repeatable element is not repeating in a specific JSON response, even then that element will
be returned as an Array having a single object. (see Example 9)l Element content will be represented with “$” if it has attributes (see Example 2)
o Consider a scenario where an element has an attribute as per the definition, however theattribute is not returned in a specific JSON response. Even then, the element content will berepresented as “$” in the JSON. (see Example 4)
l String values will be returned within double quotes. (see Example 14)l Numeric and Boolean values will not be returned within double quotes. (see Example 12 and Example
13)
Examples
# Scenario XML Instance JSON Instance
1 Element having noattribute
<DUNSNumber>804735132 </DUNSNumber> "DUNSNumber": "804735132"
2 Element havingAttribute
<FamilyTreeMemberRoleTextDNBCodeValue="12773">Parent</FamilyTreeMemberRoleText>
"FamilyTreeMemberRoleText": { "@DNBCodeValue": 12773, "$": "Parent" }
3 Aggregate havingattribute
<OrganizationIdentificationNumberDetailTypeText="Federal Taxpayer IdentificationNumber (US)" DNBCodeValue="6863"><OrganizationIdentificationNumber>12345</OrganizationIdentificationNumber></OrganizationIdentificationNumberDetail>
"OrganizationIdentificationNumberDetail":{ "@TypeText": "Federal TaxpayerIdentification Number (US)","@DNBCodeValue": 6863,"OrganizationIdentificationNumber":"12345" }
4 Element havingAttribute as perdefinition, howeverattribute is notreturned for aspecific JSONinstance
<OrganizationName>Gorman ManufacturingCompany, Inc. </OrganizationName>
"OrganizationName": { "$": "GormanManufacturing Company, Inc." }
D&B Direct API Documentation BadgerFish (REST)
©Dun & Bradstreet, Inc. 2014 239
# Scenario XML Instance JSON Instance
5 Aggregate havingAttribute as perdefinition, howeverattribute is notreturned for aspecific JSONinstance
<OrganizationIdentificationNumberDetail ><OrganizationIdentificationNumber>12345</OrganizationIdentificationNumber></OrganizationIdentificationNumberDetail>
"OrganizationIdentificationNumberDetail":{ "OrganizationIdentificationNumber":"12345" }
6 Non-RepeatingElement
<DUNSNumber>804735132 </DUNSNumber> "DUNSNumber": "804735132"
7 Repeating Element <SalesRevenueAmountCurrencyISOAlpha3Code="USD”>1000000</SalesRevenueAmount><SalesRevenueAmountCurrencyISOAlpha3Code="CAD”>1040000</SalesRevenueAmount>
"SalesRevenueAmount": [ { "@CurrencyISOAlpha3Code": "USD", "$":1000000 }, { "@CurrencyISOAlpha3Code":"CAD", "$": 1040000 } ]
8 Repeating Aggregate <FamilyTreeMemberRole><FamilyTreeMemberRoleTextDNBCodeValue="12773">Parent</FamilyTreeMemberRoleText></FamilyTreeMemberRole><FamilyTreeMemberRole><FamilyTreeMemberRoleTextDNBCodeValue="12775">Global Ultimate</FamilyTreeMemberRoleText></FamilyTreeMemberRole><FamilyTreeMemberRole><FamilyTreeMemberRoleTextDNBCodeValue="12774">Domestic Ultimate</FamilyTreeMemberRoleText></FamilyTreeMemberRole>
"FamilyTreeMemberRole": [ {"FamilyTreeMemberRoleText": { "@DNBCodeValue": 12773, "$": "Parent" }},{"FamilyTreeMemberRoleText": {
"@DNBCodeValue": 12775, "$": "GlobalUltimate" }},{"FamilyTreeMemberRoleText": { "@DNBCodeValue": 12774, "$": "DomesticUltimate" }} ]
9 Element isrepeatable as per thedefinition. Howeverit is not repeating ina specific JSONinstance.
<SalesRevenueAmountCurrencyISOAlpha3Code="USD”>1000000</SalesRevenueAmount>
"SalesRevenueAmount": [ { "@CurrencyISOAlpha3Code": "USD", "$":1000000 }]
10 Aggregate isrepeatable as per thedefinition. Howeverit is not repeating ina specific JSONinstance.
<FamilyTreeMemberRole><FamilyTreeMemberRoleTextDNBCodeValue="12773">Parent</FamilyTreeMemberRoleText></FamilyTreeMemberRole>
"FamilyTreeMemberRole": [ {"FamilyTreeMemberRoleText": { "@DNBCodeValue": 12773, "$": "Parent" }}]
11 Date Field <TransactionTimestamp>2013-07-11T11:08:48.067-04:00</TransactionTimestamp>
"TransactionTimestamp": "2013-07-11T11:10:39.110-04:00"
12 Boolean Field <StandaloneOrganizationIndicator>false</StandaloneOrganizationIndicator>
"StandaloneOrganizationIndicator": false
D&B Direct API Documentation Examples
©Dun & Bradstreet, Inc. 2014 240
# Scenario XML Instance JSON Instance
13 Numeric Field <RawScore>352</RawScore> "RawScore": 352
14 String Field <LineText>492 Koller Street</LineText> "LineText": "492 Koller Street"
D&B Direct API Documentation Examples
©Dun & Bradstreet, Inc. 2014 241
Dun & Bradstreet (D&B)
103 JFK Parkway
Short Hills, NJ 07078
www.dnb.com
©Dun & Bradstreet, Inc. 2013. All rights reserved.
top related