Loading

dnb-logo
Direct 2.0
Collapse

Search Compliance Alerts

D&B Compliance Screening is a powerful solution providing organizations advanced screening of customers and suppliers to ensure global regulatory compliance with a growing range of Global AML/KYC and Anti Corruption regulations.

Leveraging multiple databases, including global watch lists, regulatory authority actions, law enforcement sources, and global news sources, updated daily, businesses have the most comprehensive and broad-reaching compliance screening solution to address all compliance program needs.

This function allows a customer to specify a subject (organizations and/or individuals) to be submitted for compliance screening. Validated requests will be processed against the customer agreed screening list and provide an instant response.

Update History

No modifications have been made to this data layer since the initial release.

Product Request

Overview

An organization (or individual) name is a required input. Address input is optional but it is advisable to include. For organizations domiciled in the United States and Canada, including a state or territory significantly improves the quality of the results.

Global Availability

The Search Compliance Alerts data layer is available for businesses domiciled in the following countries:

CountryISO Code
United States of AmericaUS
BelgiumBE
FranceFR
GermanyDE
ItalyIT
NetherlandsNL
PortugalPT
SpainES
United KingdomGB
AustraliaAU
New ZealandNZ
AndorraAD
AnguillaAI
Antigua & BarbudaAG
ArubaAW
BahamasBS
BarbadosBB
BelizeBZ
BermudaBM
BoliviaBO
British Virgin IslandsVG
CanadaCA
Cayman IslandsKY
ChileCL
ColombiaCO
Costa RicaCR
DenmarkDK
DominicaDM
Dominican RepublicDO
EcuadorEC
El SalvadorSV
Faero IslandsFO
FinlandFI
GreenlandGL
GrenadaGD
GuatemalaGT
GuyanaGY
HaitiHT
HondurasHN
IrelandIE
JamaicaJM
JapanJP
LuxembourgLU
MexicoMX
MonacoMC
MontserratMS
Netherlands AntillesAN
Bonaire, Sint Eustatius And SabaBQ
CuraçaoCW
Sint Maarten (dutch)SX
NicaraguaNI
NorwayNO
PanamaPA
Saint Kitts & NevisKN
Saint LuciaLC
Saint VincentVC
San MarinoSM
SurinameSR
SwedenSE
TaiwanTW
Trinidad And TobagoTT
Turks And CaicosTC
VenezuelaVE
AfghanistanAF
AlbaniaAL
AlgeriaDZ
American SamoaAS
AngolaAO
ArgentinaAR
ArmeniaAM
AustriaAT
AzerbaijanAZ
BahrainBH
BangladeshBD
Benin, Peoples Republic ofBJ
BhutanBT
Bosnia And HerzegovinaBA
BotswanaBW
BrazilBR
BruneiBN
BulgariaBG
Burkina FasoBF
Burma (myanmar)MM
BurundiBI
BelarusBY
Kampuchea (prev. Cambodia)KH
CameroonCM
Cape Verde, Republic ofCV
Central Africa RepublicCF
Chad, Republic ofTD
China, Peoples Republic ofCN
Christmas IslandCX
Comoros RepublicKM
Congo Democratic RepublicCD
Cook IslandsCK
CroatiaHR
CyprusCY
Turkish Republic of Northern CyprusXT
Czech RepublicCZ
DjiboutiDJ
EgyptEG
Equatorial GuineaGQ
EritreaER
EstoniaEE
EthiopiaET
Falkland IslandsFK
FijiFJ
French GuianaGF
French Polynesia/tahitiPF
Gabon RepublicGA
GambiaGM
GeorgiaGE
GhanaGH
GibraltarGI
GreeceGR
GuadeloupeGP
GuamGU
Guinea BissauGW
Guinea, Republic ofGN
Hong Kong SARHK
HungaryHU
IcelandIS
IndiaIN
IndonesiaID
IranIR
IraqIQ
IsraelIL
Ivory Coast/cote D'ivoireCI
JordanJO
KazakhstanKZ
KenyaKE
KiribatiKI
Korea, Republic ofKR
KuwaitKW
KyrgyzstanKG
LaosLA
LatviaLV
LebanonLB
LesothoLS
LiberiaLR
LibyaLY
LiechtensteinLI
LithuaniaLT
Macao SARMO
North MacedoniaMK
MadagasgarMG
MalawiMW
MalaysiaMY
MaldivesMV
MaliML
MaltaMT
Marianas IslandsMP
Marshall IslandsMH
MartiniqueMQ
MauritaniaMR
MauritiusMU
MoldovaMD
MontenegroME
MoroccoMA
MozambiqueMZ
NamibiaNA
NauruNR
NepalNP
New CaledoniaNC
NigerNE
NigeriaNG
Norfolk IslandNF
OmanOM
PakistanPK
Papua New GuineaPG
ParaguayPY
PeruPE
PhilippinesPH
PolandPL
QatarQA
Reunion IslandRE
RomaniaRO
Russian FederationRU
RwandaRW
Saint HelenaSH
Saint Pierre Et MiquelonPM
Sao Tome & PrincipeST
Saudi ArabiaSA
SenegalSN
SerbiaRS
SeychellesSC
Sierra LeoneSL
SingaporeSG
SlovakiaSK
SloveniaSI
Solomon IslandsSB
SomaliaSO
South AfricaZA
Sri LankaLK
SudanSD
South SudanSS
EswatiniSZ
SwitzerlandCH
SyriaSY
TajhikstanTJ
TanzaniaTZ
ThailandTH
TogoTG
Tokelau IslandsTK
TongaTO
TunisiaTN
TurkeyTR
TurkmenistanTM
TuvaluTV
UgandaUG
UkraineUA
United Arab EmiratesAE
UruguayUY
UzbekistanUZ
VanuatuVU
VietnamVN
Western SamoaWS
YemenYE
ZambiaZM
ZimbabweZW
CongoCG
Puerto RicoPR
Holy See (vatican City State)VA
Serbia & MontenegroCS
KosovoXK

Data Layer Entitlement

For customers in U.S. and Canadian markets, the API is provisioned for specific collections of products, reports, and/or features (collectively referred to as data layers) for production and trial usage. Entitlement is not required for testing in the sandbox environment.

  • This product is entitled as "Compliance Patriot Act" for D&B Direct 2.0 customers.

For customers in the UK, Ireland, Belgium, Netherlands and Luxembourg markets, the API is provisioned as a specific set of data layers for production, trial, and sandbox usage.

  • This particular data layer is included in the D&B Direct Onboard 2.0 suite.

To obtain the entitlement for this, contact your local Customer Service Center.

Specification

Sample Request (Search Alerts)
GET http://direct.dnb.com/V4.0/compliancecheck/entities/alerts?SubjectName=SAMPLE%20CO%20LTD&SubjectTypeText=P&CandidatePerPageMaximumQuantity=5&CandidateDisplayStartSequenceNumber=1
Authorization: <My Token>
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.

SubjectName

string up to 256 chars.Required

SubjectTypeText

string up to 256 chars.Required

A number that identifies the system or the software application from where this request originated. / A number used to uniquely identfy the D&amp;B business segment or delivery channel from where this request originated.

BirthDate date, Optional

The date on which the principal which is an individual was born.

StreetAddressLine-n 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.

PrimaryTownName string, Optional

The name of the town or city recognized by the Postal Authority for delivering mail.

TerritoryName string, Optional

The name of the locally governed area which forms part of a centrally governed nation as received by D&amp;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..

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.

CountryName string, Optional

The name of the country of this address.

CandidatePerPageMaximumQuantity integer less than or equal to 1,000, Optional
CandidateDisplayStartSequenceNumber integer less than or equal to 1,000, Optional
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.

CustomerBillingEndorsementText string at least 1 chars. up to 240 chars., Optional up to 5x

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.

Endpoint

Use the following endpoint for requesting this product. The {version} is dependent on the underlying service delivering the product.

Endpoint (ComplianceCheck)
GET https://direct.dnb.com/V{version}/compliancecheck/entities/alerts

Testing

This operation is currently unavailable in the D&B Direct sandbox (test) environment.

Product Response

NOTE: The D&B Direct REST implementation uses the BadgerFish approach for JSON with some minor variations.

Specification

The following is a list of the possible data fields returned by this operation in the JSON response. Samples are provided for testing successful and failed retrieval, and to demonstrate the basic layout of a response. The data returned in samples may not represent actual values that this feature will deliver.

NOTE: The D-U-N-S Number returned in the response will be a nine-digit zero-padded, numeric value.

Sample Response (Search Alerts)
{"SearchComplianceAlertsResponse": {
   "@ServiceVersionNumber": "4.0",
   "TransactionDetail":    {
      "ApplicationTransactionID": "ServiceGovernance-Samples",
      "ServiceTransactionID": "ServiceGovernance-Samples",
      "TransactionTimestamp": "2016-09-26T05:48:10.338-04:00"
   },
   "TransactionResult":    {
      "SeverityText": "Information",
      "ResultID": "CM000",
      "ResultText": "SUCCESS"
   },
   "SearchComplianceAlertsResponseDetail":    {
      "CandidateMatchedQuantity": 1,
      "CandidateReturnedQuantity": 1,
      "SubjectAlertDetail": [      {
         "AlertEntityID": "12345678",
         "AlertEntitySystemID": "a72d4c09cbc1ae285d3f3d53eb346aa4",
         "AlertDate": "2012-05-14",
         "EntityMatchDetail": {"EntityMatchScore": 90},
         "ReferenceDetail": [         {
            "SourceName": "RiskConnect",
            "PublicationDate": "2016-09-21"
         }],
         "Name": {"PrimaryName": "Test Name"},
         "Assessment": {"SupplierRiskScore": {"RawScore": "80"}}
      }]
   }
}}


There are no differences in the response for these products.

Name Characteristics
SearchComplianceAlertsResponse Aggregate,
SearchComplianceAlertsResponse @ServiceVersionNumber Attribute,
SearchComplianceAlertsResponse { TransactionDetail Aggregate, Required

Records information necessary to process a particular request. Examples of a request is the ordering of a product.

SearchComplianceAlertsResponse { TransactionDetail { ApplicationTransactionID Element, string up to 64 chars. Optional

A number assigned by the calling application to uniquely identify this request.

SearchComplianceAlertsResponse { TransactionDetail { ServiceTransactionID Element, string up to 64 chars. Required

A number assigned by the D&B service to uniquely identify this transaction.

SearchComplianceAlertsResponse { TransactionDetail { TransactionTimestamp Element, date & time 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: SearchComplianceAlertsResponse { TransactionDetail Aggregate,
SearchComplianceAlertsResponse { TransactionResult Aggregate, Required

An aggregate that can repeat multiple times to record the different outcomes of the transaction.

SearchComplianceAlertsResponse { TransactionResult { SeverityText Element, string up to 16 chars. Required

Text that records the criticality of the outcome, e.g., Information, Warning, Error, Fatal.

SearchComplianceAlertsResponse { TransactionResult { ResultID Element, string up to 32 chars. Required

An alphanumeric string that uniquely identifies the outcome of the transaction.

SearchComplianceAlertsResponse { TransactionResult { ResultText Element, string up to 512 chars. Optional

Text that explains the outcome of the transaction.

SearchComplianceAlertsResponse { 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.

SearchComplianceAlertsResponse { TransactionResult { ResultMessage { ResultMessageID Element, string up to 30 chars. Optional

An alphanumeric string that uniquely identifies the additional information regarding the outcome of the transaction.

SearchComplianceAlertsResponse { TransactionResult { ResultMessage { ResultDescription Element, string up to 512 chars. Required

Text that describes the additional information regarding the outcome of the transaction.

SearchComplianceAlertsResponse { TransactionResult { ResultMessage { NonSpecificDataProviderText Element, 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: SearchComplianceAlertsResponse { TransactionResult { ResultMessage Aggregate,
End: SearchComplianceAlertsResponse { TransactionResult Aggregate,
SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail Aggregate, Optional

 

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { CandidateMatchedQuantity Element, int Required

The number of subjects identified as possible prospects in the repository.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { CandidateReturnedQuantity Element, int Optional

The number of subjects actually returned as possible prospects in the repository based on the search criteria.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail Aggregate, Optional (Infinite)
SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { AlertEntityID Element, string up to 32 chars. Optional

An alphanumeric value that uniquely identifies the Vendor.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { AlertEntitySystemID Element, string up to 100 chars. Optional

ID needed to call the OrderProductRequest for gettig the Entity Details in PDF / XML format

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { AlertDate Element, date Optional

Date when the alert was created.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { EntityMatchDetail Aggregate, Optional

Records the details of the score indicating the degree of the match to the inquiry name.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { EntityMatchDetail { EntityMatchScore Element, 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: SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { EntityMatchDetail Aggregate,
SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { ReferenceDetail Aggregate, Optional (Infinite)

Records the source details of the data which was originally obtained by D&B.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { ReferenceDetail { SourceName Element, string up to 400 chars. Optional

Text recording the name of the source from which the alert data was originally obtained.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { ReferenceDetail { PublicationName Element, string up to 500 chars. Optional

Name of the publication.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { ReferenceDetail { PublicationDate Element, date Optional

The date of publication.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { ReferenceDetail { WebPageURL Element, string up to 500 chars. Optional

Records the internet link of the publication content.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { ReferenceDetail { PublisherName Element, string up to 512 chars. Optional

Name of the company or person that publishes products.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { ReferenceDetail { SourceListName Element, 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.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { ReferenceDetail { SourceTypeText Element, string up to 256 chars. Optional

Text denoting the category of the source; e.g., internet, publication, media.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { ReferenceDetail { ContentText Element, string Optional (Infinite)

Text that records the body of the news item.

End: SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { ReferenceDetail Aggregate,
SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { 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.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { EventDetail { EventTypeText Element, string up to 3 chars. Optional

Text that describes the category of the event.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { EventDetail { EventText Element, string up to 2000 chars. Optional (Infinite)

Free form text recording additional details about the event.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { EventDetail { EventDate Element, date Optional

The date when the event occured.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { EventDetail { EndDate Aggregate, date & time Optional

Date when the event action was no longer in affect.

End: SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { EventDetail Aggregate,
SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { Name Aggregate, SupplierNameDetail Optional

Records the names used to identify this supplier.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { Name { PrimaryName Element, string Required

Name of the subject by which it is primarily known / identified.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { Name { KnownByName Element, 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.

End: SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { Name Aggregate,
SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { Assessment Aggregate, Optional

Records the appraisal/opinion assigned to this Subject by an entity other than the D&amp;B Worldwide Network (WWN).

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { 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.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { Assessment { SupplierRiskScore { RawScore Element, 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.

End: SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { Assessment { SupplierRiskScore Aggregate,
End: SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail { Assessment Aggregate,
End: SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { SubjectAlertDetail Aggregate,
SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { InquiryReferenceDetail Aggregate, Optional

Records data that allows the customer to specify information to be linked to this request in order to support subsequent searches.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { InquiryReferenceDetail { CustomerReferenceText Element, 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.

SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { InquiryReferenceDetail { CustomerBillingEndorsementText Element, 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: SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail { InquiryReferenceDetail Aggregate,
End: SearchComplianceAlertsResponse { SearchComplianceAlertsResponseDetail Aggregate,
End: SearchComplianceAlertsResponse Aggregate,

Response Codes & Error Handling

Successful service requests will return a CM000 response code in the TransactionResult ResultID field.

When there is No match returned during screening, Services will return CM018 response code.

Operation-specific supplemental response code explanations:

What to do Next