You are on page 1of 227

Web S e r v i c e s 8 .

0 M a n u a l
for LexisNexis Bridger Insight XG

Confidential and Proprietary


FIN02829 October 2012

LexisNexis Risk Solutions shall not be liable for technical or editorial errors or omissions
contained herein. The information in this publication is subject to change without notice and is
provided WITHOUT WARRANTY OF ANY KIND. THE ENTIRE RISK ARISING OUT OF THE USE
OF THIS INFORMATION REMAINS WITH RECIPIENT. IN NO EVENT SHALL LEXISNEXIS RISK
SOLUTIONS FL INC. BE LIABLE FOR ANY DIRECT, CONSEQUENTIAL, INCIDENTAL, SPECIAL,
PUNITIVE, OR OTHER DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, OR LOSS OF
BUSINESS INFORMATION), EVEN IF LEXISNEXIS RISK SOLUTIONS, HAS BEEN ADVISED OF
THE POSSIBILITY OF SUCH DAMAGES.
The limited warranties for these products and services are exclusively set forth in the license
agreement or other agreements accompanying such products or services. Nothing herein should be
construed as constituting a further or additional warranty.
Due to the nature of the origin of public record information, the public records and commercially
available data sources used in reports may contain errors. Source data is sometimes reported or
entered inaccurately, processed poorly or incorrectly, and is generally not free from defect. This
product or service aggregates and reports data, as provided by the public records and commercially
available data sources, and is not the source of the data, nor is it a comprehensive compilation of
the data. Before relying on any data, it should be independently verif ied.
The LexisNexis Bridger Insight XG, LexisNexis FraudPoint Score, LexisNexis InstantID,
LexisNexis InstantID International, LexisNexis News, LexisNexis Anti-Money Laundering
Solutions, Lexis Diligence, and LexisNexis Red Flags Rule Report services are not provided by
"consumer reporting agencies," as that term is def ined in the Fair Credit Reporting Act (15 U.S.C.
1681, et seq.) ("FCRA") and do not constitute "consumer reports," as that term is def ined in the
FCRA. Accordingly, the Bridger Insight XG, FraudPoint Score, InstantID, InstantID International,
LexisNexis News, Anti-Money Laundering Solutions, Lexis Diligence, and Red Flags Rule Report
services may not be used in whole or in part as a factor in determining eligibility for credit,
insurance, employment or another purpose in connection with which a consumer report may be
used under the FCRA.
Lexis, LexisNexis, and the Knowledge Burst logo are registered trademarks of Reed Elsevier
Properties Inc., used under license. Bridger Insight is a trademark of LexisNexis Risk Solutions Inc.
FraudPoint and InstantID are registered trademarks of LexisNexis Risk Solutions. Other products
and services may be trademarks or registered trademarks of their respective companies.
2012 LexisNexis Risk Solutions. All rights reserved.

C O NT E N TS

Chapter 1: Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Web Services Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Integration Process Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Active Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Polling Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Event Driven Integration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Web Services Planning. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Web Services 8.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
BIXG Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
BIXG Passwords. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Searchable Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
About This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Manual Content. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Manual Organization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Notes and Warnings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Class Hierarchies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Documentation Suggestions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Support and Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Client Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Training . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Chapter 2: Search API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Search API Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Search API Connection Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Contents |
Confidential and Proprietary
FIN02829 October 2012

Concurrent Connection C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28


Idle Time-Out Setting C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Proxy Connection C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Search API Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
AddToAcceptList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
ChangePassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
GetRecordState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
GetResultDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
GetRunDetails. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
IndexAcceptList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Search. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
SetRecordState. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Wire. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Chapter 3: Event Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Event Queue Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Event Queue Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
EventProcessingComplete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
GetAlertChangedDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Contents |
Confidential and Proprietary
FIN02829 October 2012

GetBatchStatusChangedDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
GetEventNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
GetStatusChangedDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Response Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Response Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
BIAlertStateChangedResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
BIBatchStatusChangedResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
BIEventQueueResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
BIStatusChangedResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
EventItemAlertStateChanged . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
EventItemBatchStatusChanged . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
EventItemStatusChanged . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Chapter 4: Direct. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Direct Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Search Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Watchlists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Direct Connection Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Concurrent Connection C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Idle Time-Out Setting C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Proxy Connection C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Direct Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
ChangePassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Search. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
UnstructuredWire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Contents |
Confidential and Proprietary
FIN02829 October 2012

Wire. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
C# Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Chapter 5: Direct Watchlist Search Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Direct Watchlist Search Settings Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
General Search Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Match Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
ACH Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Automatic False Positive Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Watchlist Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Chapter 6: Request Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Request Class Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Request Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Request Class Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Address. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
AssignResultsTo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
AuthenticationHeader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
AutomaticFalsePositiveRules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
GeneralSearchOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Possible ID Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Possible Information Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
MatchOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Phone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
PredefinedSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Contents |
Confidential and Proprietary
FIN02829 October 2012

SearchRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
GLB Permissible Use Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
DPPA Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
UnstructuredWireRequest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
UpdateAssignResultsTo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
WatchListOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
WireRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Chapter 7: Response Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Response Class Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Response Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
BIBusinessInstantID Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
BIFraudPoint Class Hierarchy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
BIInstantID Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
BIInstantIDIntl Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
BIRecordInfo Class Hierarchy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
BIMatch Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Response Class Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
BIAchNote. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
BIAchParty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
BIAchPartyAddress. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
BIAchPartyID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
BIAchWire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
BIAdditionalInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
BIAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
BIAddressMatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
BIAKA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
BIAuditItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
BIBusinessInstantID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
BIClientReference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Contents |
Confidential and Proprietary
FIN02829 October 2012

BICountry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
BIDaysUntilPasswordExpires . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
BIDOBMatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
BIEntity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
BIFedwireAdjustment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
BIFedwireAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
BIFedwireDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
BIFedwireNote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
BIFedwireParty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
BIFedwirePartyAdditionalInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
BIFedwirePartyAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
BIFedwirePartyID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
BIFedwirePartyPhone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
BIFedwireWire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
BIFraudPoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
BIID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
BIIDMatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
BIInstantID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
BIInstantIDIntl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
BIISO20022Note. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
BIISO20022Party . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
BIISO20022PartyAdditionalInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
BIISO20022PartyAddress. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
BIISO20022PartyID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
BIISO20022PartyPhone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
BIISO20022Wire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
BIMatch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
BIMatchStrength . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
BIMatchSummary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
BIName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Contents |
Confidential and Proprietary
FIN02829 October 2012

BIPasswordChange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
BIPhone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
BIPhoneMatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
BIRecord . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
BIRecordDetailInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
BIRecordInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
BIResultDetailResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
BIRunDetailResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
BIRunInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
BISearchResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
BISummary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
BISwift4XXData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
BISwiftAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
BISwiftNote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
BISwiftParty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
BISwiftPartyAdditionalInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
BISwiftPartyAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
BISwiftPartyID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
BISwiftWire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
BIUpdateResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
BIWatchList. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
FPAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
FPIndicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
FPInput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
FPRedFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
IIDAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
IIDAddressInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
IIDAlternateName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
IIDFEINMatchResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
IIDFiling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

Contents |
Confidential and Proprietary
FIN02829 October 2012

IIDIAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
IIDIDataSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
IIDIDataSourceVerification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
IIDIDate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
IIDIException. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
IIDIHeader. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
IIDIIndicator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
IIDIInput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
IIDIndicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
IIDInput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
IIDIPassport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
IIDIResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
IIDIResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
IIDIVerificationResult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
IIDIVerificationIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
IIDRedFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
IIDReversePhone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
IIDSSNInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
IIDVerificationIndicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Response Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Watchlist Search Example with Potential Match Found . . . . . . . . . . . . . . . . . . 205
Watchlist Search Example with No Matches Found . . . . . . . . . . . . . . . . . . . . . 208
Get Record State Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Chapter 8: Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Error Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
BIError Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
GLB Error Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

Contents | 10
Confidential and Proprietary
FIN02829 October 2012

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

Contents |
Confidential and Proprietary
FIN02829 October 2012

11

Chapter

In This Chapter

Web Services
Overview, page 13
About This
Manual, page 21

Introduction

Support and
Resources, page 23

Introduction | 12
Confidential and Proprietary
FIN02829 October 2012

Web Services Overview


Web services allows you to incorporate LexisNexis Bridger Insight XG (BIXG) real-time search
functionality into your existing systems through XML. Communication from your software to the BIXG
server takes place through a 128-bit encrypted HTTPS connection.
Web services accepts XML-based messages over a simple object access protocol (SOAP). Web services
description language (WSDL) def ines the SOAP interface and allows tools to create proxy objects to
generate and invoke the appropriate SOAP methods over HTTPS. For each search request, a method
def ines an action performed either by or upon an instance of a request class. The search response also
returns information in classes, called response classes.

Integration Process Flow


The primary process models used for integration to BIXG are active, polling, and event driven. All of
these models share some common features. The integration is record based. Regardless of the method
by which data is received in BIXGa batch f ile, manual entry through one of the clients, or system-tosystem integration through a Web services calla result ID is created for every record stored in BIXG.
This primary key is then used to identify all subsequent interaction for that record.

Ac t i v e I n t eg rati on
In active integration, primary processing takes place within your integrated application. Once the
search is performed in BIXG, the response is displayed in the integrated application allowing your users
to decide on a course of action. The application can then relay messages to BIXG to change the status,
state, add a note, or add the record to a BIXG accept list.

Introduction | 13
Confidential and Proprietary
FIN02829 October 2012

Polling Integration
In polling integration, primary processing takes place in BIXG. Your integrated application can request
status updates on specif ic records at an appropriate time interval. When records reach particular
statuses or are closed in BIXG, the integrated application can then take appropriate action based on
those changes within the record in BIXG.

Introduction | 14
Confidential and Proprietary
FIN02829 October 2012

Event Driven Integration


In event driven integration, primary processing of records takes place in BIXG, which is conf igured to
keep a queue of certain events that occur during the processing. The integrated application retrieves
the queued events at regular intervals and marks their processing as complete, removing them from
the queue. This is similar to the polling integration, however, instead of querying on specif ic records,
certain actions generate an event that can be seen on the queue. These actions include changing the
alert state, batch run status or record status. This is designed for a workflow similar to the polling
integration, but can handle larger volumes of records without as many calls to check on the status of
those records.

Introduction | 15
Confidential and Proprietary
FIN02829 October 2012

Web Services Planning


To use Web services, at a minimum you must determine:
How to implement the service based on your existing system architecture.
How to implement the service based on your security requirements.
What input information you want to search.
What type of searches you want to perform.
Which functions you should include in the call.
How you want to manage results and logging.
What load and response time requirements are anticipated.
Who is responsible for system maintenance and password changes.
Who will manage error handling and problem alerting.

The user performing Web services searches must have BIXG privileges related to the actions they
perform. See the Smart Client User Manual, Roles section.

Introduction | 16
Confidential and Proprietary
FIN02829 October 2012

Web Services 8.0


The Web Services 8.0 interface was released with BIXG 3.4. You can still use earlier BIXG Web services
interfaces. However, new functionality provided in the 3.4 version is not available in older Web services
interfaces.
The following table lists the available Web services interfaces and the product functionality they can
access.
Web Service Interface Alignment with Product Functionality
Web Services Interface

Product Functionality

Web Services 1.0

BIXG 2.3

Web Services 2.0

BIXG 2.4

Web Services 3.0

BIXG 2.5

Web Services 4.0

BIXG 2.6

Web Services 5.0

BIXG 3.0

Web Services 6.0

BIXG 3.1

Web Services 7.0

BIXG 3.2 and 3.3

Web Services 8.0

BIXG 3.4

BIXG Functionality
There are two ways to integrate BIXG with Web services: Search API and Direct.
With Search API, clients use predef ined searches created in a Smart Client or Browser Client interface
to perform searches. Result records generated by the search are stored in the BIXG results database and
accessed through a client interface. You can also perform accept list indexing and result processing
tasks.

Introduction | 17
Confidential and Proprietary
FIN02829 October 2012

With Direct, clients def ine the search parameters when they perform a search. Result records
generated by the search are not stored in the BIXG results database and cannot be accessed through a
Smart Client or Browser Client.
The following table shows the differences in available functionality to help you determine which Web
service will best meet your business needs.
Search API vs Direct Functionality
Functionality
Assign alerts to users

Search API
X

Create custom, on-the-fly searches

Event queuing

Index accept lists

Perform LexisNexis FraudPoint Score searches

Perform LexisNexis InstantID searches

Perform LexisNexis InstantID International searches

Reference saved predefined searches

Search custom watchlists

Stores results in a BIXG database

Stores no results in a BIXG database


Suppress subsequent false positives with accept lists

Direct

X
X

Introduction | 18
Confidential and Proprietary
FIN02829 October 2012

Search API vs Direct Functionality (Continued)


Functionality

Search API

Suppress subsequent false positives with White List (by


referencing saved predefined searches)

Update result records' record statuses

View results through Smart Client or Browser Client

Direct

You can integrate optional due diligence services into BIXG. The services are distinct from BIXG
and may require you to sign a separate agreement and to meet additional credentialing
requirements prior to accessing the service. For more information, contact a sales representative.

BIXG Passwords
BIXG passwords expire at least every 60 days. Search responses include a BIDaysPasswordExpires class
when the password will expire in 10 or less days. You can code to this class to have Web services
automatically change the password using the ChangePassword method.
For more information, see:
For Search API, "ChangePassword" on page 32
For Direct, "ChangePassword" on page 68
"BIDaysUntilPasswordExpires" on page 133

Searchable Data
Parsed data is organized into def ined f ields, allowing the service to treat like information the same for
more relevant results.You can search business, individual, text, or unknown records. A text record
contains one required f ield of unparsed text and optional ID f ields. An unknown record is one in which
you have not identif ied the entity type. Other f ields in the text record are not searched or stored in the
XG database. You can search EFT (electronic funds transfer) data, including:

Introduction | 19
Confidential and Proprietary
FIN02829 October 2012

ACH f iles, including IAT (international ACH transaction).


For information on ACH record content and format, see:
www.nacha.org

For information on the ACH data processed by BIXG, refer to the following knowledge base article
in Client Services at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1515
Fedwire f iles, including FAIM 3.0 and the CTP (customer transfer plus) format.
For information on Fedwire record content and format, see:
www.frbservices.org

For information on the Fedwire data processed by BIXG, refer to the following knowledge base
article in Client Services at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1516
ISO 20022 f iles in pain 001.001.02 format.
For information on ISO 20022 record content and format, see:
www.iso20022.com

For information on the ISO 20022 data processed by BIXG, refer to the following knowledge base
article in Client Services at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1516
SWIFT f iles in MT101, MT103, MT202, MT202COV, MT740, or MT742 formats.
For information on SWIFT record content and format, see:
www.swift.com

For information on the SWIFT data processed by BIXG, refer to the following knowledge base article
in Client Services at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1514
Unparsed data is not organized into def ined f ields. You can search unparsed data in batch using the
XG-Unstructured format as an unstructured or text record. A text record contains one required f ield of
unparsed text and optional ID f ields. To search data that is not well parsed, Bridger Insight XG must
search f iles one text string at a time, yielding different results than searching a f ile with identif ied
f ields.

Introduction | 20
Confidential and Proprietary
FIN02829 October 2012

About This Manual


References to other sections of this document may be active hyperlinks. You can click on the link to
take you to the referenced section.
You will f ind information and instructions on performing tasks in BIXG. For errors, troubleshooting,
alternative functionality, and the most up-to-date product changes, see the Bridger Insight knowledge
base available on the Client Services website at:
https://support.bridgerinsight.lexisnexis.com
You can also access a glossary def ining industry and commonly-used terms on the Client Services
website at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id= 1482
To learn more about new and updated features in BIXG, see the release notes at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1475
A Help system is available from within the application. Press F1 to view a Help page associated with the
window you are viewing.

Audience
This manual contains technical information and is geared primarily for C# programmers. You should
also have a good understanding of XML, SOAP, classes, methods, and WSDL. Web services should be
used by staff with the necessary technical expertise. If not set up appropriately, your system could
become unusable.

Manual Content
This manual contains information about two BIXG Web services: Search API and Direct. You may not
have access to both services.

Introduction | 21
Confidential and Proprietary
FIN02829 October 2012

Manual Organization
This manual is separated into several main sections: Introduction, Search API, Direct, Request Classes,
Response Classes, and Errors.

Conventions
We use the following conventions to relate information.

Notes and Wa rnings

s
i

This is a note icon. It precedes helpful information.


This is a warning icon. It precedes information to help prevent you from negatively affecting your
BIXG system or processes.

Class Hierarchies
A class hierarchy is provided as part of each class def inition. This class hierarchy def ines how the class
is incorporated into a method.
Hierarchy: SearchRequest>Request>Account

Documentation Suggestions
Your suggestions for document improvement are welcome. Send comments or suggestions via email to:
TechnicalPublications@lexisnexis.com
Or mail comments or suggestions to:
Technical Publications
LexisNexis
1819 S. 22nd Avenue

Introduction | 22
Confidential and Proprietary
FIN02829 October 2012

Bozeman, MT 59718
USA

Support and Resources


Support and resources are available to BIXG clients who have purchased the product. Support and
resources are not available to trial users.

Te c h n i c a l S u p p o rt
Standard technical support is included at no additional cost with the BIXG annual fee. Premier Support
is available at an additional cost. For more information, contact your sales representative.
To access the knowledge base, Live Chat, Ask a Question, and other support services, you must f irst
register for a free Client Services account at:
https://support.bridgerinsight.lexisnexis.com
Your BIXG product code, provided to you by LexisNexis, is required to create an account.
Live Chat Support
Chat with one of our customer support representatives
Available: 10 a.m.5 p.m. Eastern Time (UT -4/-5), MondayFriday, excluding major U.S. holidays
United States Phone Support
Phone Number: 1 800 915 8930
Available: 8 a.m.8 p.m. Eastern Time (UT -4/-5), MondayFriday, excluding major U.S. holidays
United Kingdom Phone Support
Phone Number: 08-08 234 9605
Available: 9 a.m.1 a.m. UT, MondayFriday, excluding major U.S. holidays

Introduction | 23
Confidential and Proprietary
FIN02829 October 2012

Asia Phone Support


Singapore: +65 6349 0122
Japan: +65 6349 0192 or 00531 65 0560
Hong Kong: +65 6349 0193 or 800 965 201
China: + 65 6349 0194 or 400 120 2367
Available: 9 a.m.6 p.m. Singapore Time (UT +8), MondayFriday, excluding major holidays
Other Areas Phone Support
Phone Number: +1 406 556 3055
Available: 9 a.m.1 a.m. UT, MondayFriday, excluding major U.S. holidays

Support is offered in English through all standard support channels.

Client Services
The Client Services website provides access to related documentation, knowledge base articles,
eLearning modules, and Web-based support: https://support.bridgerinsight.lexisnexis.com
Using your product code, create a Client Services account to:
Search the knowledge base and request notif ications of article updates.
Submit, track, and update your product questions.
Set up a prof ile of search defaults and contact information.
Download software installation and upgrade executables.
Download manuals, white papers, and training guides.
Take eLearning courses.

Tr aining
There is BIXG training offered at no additional cost. These instructor-led web trainings and eLearning
modules are available at the Client Services website:

Introduction | 24
Confidential and Proprietary
FIN02829 October 2012

https://support.bridgerinsight.lexisnexis.com/ClientServices/content/training.aspx

Introduction | 25
Confidential and Proprietary
FIN02829 October 2012

Chapter

In This Chapter

Search API
Overview, page 27

Search API

Search API
Connection
Management,
page 28
Search API
Methods, page 30

Search API | 26
Confidential and Proprietary
FIN02829 October 2012

Search API Overview


Search API is a published WSDL interface that supports the integration of watchlist and certain
optional due diligence searching with standard development tools via XML. Search results are written
to your LexisNexis Bridger Insight XG (BIXG) results database for further processing. You can access
result records through a Smart Client or Browser Client interface.
In Search API, you can perform searches on:
Watchlists
LexisNexis FraudPoint Score
LexisNexis InstantID
LexisNexis InstantID International
Search API methods allow you to perform these searches using predef ined searches created in a Smart
Client. You can also index accept lists and perform result processing tasks.
Search API makes use of BIXG functionality set up within the application. To understand the powerful
features of BIXG, you should familiarize yourself with the following functionality:
Accept Listssee the Smart Client User Manual, "Accept Lists" chapter.
Predef ined Searchessee the Smart Client User Manual, "Predef ined Searches" chapter.
Result Recordssee the Smart Client User Manual, "Search Results" chapter.
User Accesssee the Smart Client User Manual, "User Access" chapter.
FraudPoint Score, InstantID, and InstantID Internationalsee the Due Diligence Service Manual.
Search API also offers an Event Queue. The Event Queue checks BIXG for alert state, batch status, or
record status changes. The Event Queue allows you to continue processing transactions when actions
have been performed in BIXG. See "Event Queue Overview" on page 48.

Search API | 27
Confidential and Proprietary
FIN02829 October 2012

Search API Connection Management


You can use ServicePointManager to manage the number of concurrent connections, and idle time-out
settings. Managing your connections may help improve Web service performance. For example, the
default concurrent connection setting is lower than BIXG Web services can support.
If you are using a proxy server, you also need to set up the proxy connection.

Your proxy server must support HTTPS 1.1 tunneling.

For more information on ServicePointManager, visit the Microsoft Development Network at:
http://msdn.microsoft.com/en-us/default.aspx

Concurrent Connection C# Example


namespace ServicePointTest
{
class Program
{
private const string PROXY_SERVER = "";
private const string PROXY_PORT = "";
private const string BASE_URI = "http://BZNDOARD-XPD";
private const string SEARCHAPI_PATH = "/XGWebServices/8.0/SearchAPI1.asmx";
static void Main(string[] args)
{
ServicePointManager.DefaultConnectionLimit = 10;
}
}
}

Idle Time-Out Setting C# Example


namespace ServicePointTest
{
class Program

Search API | 28
Confidential and Proprietary
FIN02829 October 2012

{
private const string PROXY_SERVER = "";
private const string PROXY_PORT = "";
private const string BASE_URI = "http://BZNDOARD-XPD";
private const string SEARCHAPI_PATH = "/XGWebServices/8.0/SearchAPI1.asmx";
static void Main(string[] args)
{
ServicePointManager.MaxServicePointIdleTime = 10000;
}
}
}

Proxy Connection C# Example


namespace ServicePointTest
{
class Program
{
private const string PROXY_SERVER = "";
private const string PROXY_PORT = "";
private const string BASE_URI = "http://BZNDOARD-XPD";
private const string SEARCHAPI_PATH = "/XGWebServices/8.0/SearchAPI1.asmx";
static void Main(string[] args)
{
IWebProxy Iproxy = null;
if(!string.IsNullOrEmpty(PROXY_SERVER))
{
string proxyAdd = "http://" + PROXY_SERVER + ":" + PROXY_PORT;
// Create a proxy object.
WebProxy DefaultProxy = new WebProxy(proxyAdd, true);
// Set the proxy that all HttpWebRequest instances use.
WebRequest.DefaultWebProxy = DefaultProxy;
// Get the base interface for proxy access for the
// WebRequest-based classes.
Iproxy = WebRequest.DefaultWebProxy;

Search API | 29
Confidential and Proprietary
FIN02829 October 2012

}
SearchAPI(clURI, Iproxy);
}
}
}

Search API Methods


The following methods are available within the Search API service:
AddToAcceptList, page 31 (3)
ChangePassword, page 32
GetRecordState, page 34

(2)

GetResultDetails, page 36

(2)

GetRunDetails, page 37

(2)

IndexAcceptList, page 38

(4)

Search, page 40 (1)


SetRecordState, page 42
Wire, page 45
A description, syntax, parameters, and return values are provided for each method. In addition, C#
code examples are given.
Classes are used as parameters for certain methods. These classes are made up of multiple properties
grouped together as one object. For more information about classes discussed in the method
descriptions, see "Request Classes" on page 84.
Depending on your account, you may be able to view a list of Search API operations at:
https://bridgerinsight.lexisnexis.com/webservices/8.0/searchapi1.asmx
https://bridgerinsight2.lexisnexis.com/webservices/8.0/searchapi1.asmx

Search API | 30
Confidential and Proprietary
FIN02829 October 2012

AddToAcceptList
The AddToAcceptList method adds an entity you searched and determined to be false positive to a
specif ied accept list. Changes made to an accept list are not available for searching until the list is
indexed.

To add an entity to multiple accept lists, call the method again indicating a different accept list name.

AddToAcceptList Description
Details
Syntax

BIUpdateResponse AddToAcceptList(long lResultID, string


sAcceptListName string sComments)

Parameters
lResultID

System-defined result ID
The result ID is returned in:
BIRecord response class. See "BIRecord" on page 165.
EventItemAlertStateChanged response class. See
"EventItemAlertStateChanged" on page 61.
EventItemStatusChanged response class. See "EventItemStatusChanged" on
page 62.

sAcceptListName

String with the name of the accept list you want to add the entity to
For enterprise-wide accept lists, you can only add entities to lists created in the
BIXG client that uses the same credentials as those used in the method.

sComments

String with a note to indicate why the entity was added to the accept list
Users can be required to provide a note when they take certain actions for a result
record. If a required note is not entered, an error is returned.

s
Return Values

To avoid possible errors and provide a detailed record history,


always enter a note. See the Smart Client User Manual,
"Process Settings" section.

BIUpdateResponse class indicating if the addition of the entity to the accept list
was successful

Search API | 31
Confidential and Proprietary
FIN02829 October 2012

C # E x a mp l e
// Create a Web reference named WebServiceSearchAPI1 to the Search API website.
WebServiceSearchAPI1.SearchAPI1 clSearchAPI1 = new WebServiceSearchAPI1.SearchAPI1();
// Set the service URL.
clSearchAPI1.Url = "Search API website";
// Build a SOAP header and set user credentials.
clSearchAPI1.AuthenticationHeaderValue =
new WebServiceSearchAPI1.AuthenticationHeader();
clSearchAPI1.AuthenticationHeaderValue.sCustomerID = "Your Client ID";
clSearchAPI1.AuthenticationHeaderValue.sUserID = "Your User ID";
clSearchAPI1.AuthenticationHeaderValue.sPassword = "Your Password";
// Result ID should be set to the BIRecord.ResultID
//from the response that indicated the match.
long lResultID = 1;
// Call the method.
WebServiceSearchAPI1.BIUpdateResponse clBISearchResponse = clSearchAPI1.AddToAcceptList(
lResultID,
"Accept List Name",
"Notes");

ChangePassword
The ChangePassword method changes the BIXG password associated with the user ID. This password
expires at least every 60 days. (Password expiration is set through a Smart Client. See the Smart Client
Manual, "Security Settings" section.)
This password can also be changed through a Smart Client.

Search API | 32
Confidential and Proprietary
FIN02829 October 2012

Passwords should be secure and confidential.

BIPasswordChange Description
Details
Syntax

BIPasswordChange ChangePassword(string sNewPassword)

Parameters
sNewPassword

Return Values

String with the new BIXG password


This password replaces the existing password associated with the user ID.
Passwords:
Are case sensitive.
Must contain letters and numbers.
Must be 8-20 characters.
Must be changed at least 60 days.
Cannot contain the user ID or its reverse.
Users cannot use the previous 12 passwords.
BIPasswordChange class indicating if the password change was successful

C # E x a mp l e
// Create a Web reference named WebServiceSearchAPI1 to the Search API website.
// NOTE: Access the common interface here. This is not in the SearchAPI class.
WebServiceSearchAPI1.Common clCommon = new WebServiceSearchAPI1.Common();
WebServiceSearchAPI1.SearchRequest clSearchRequest =
new WebServiceSearchAPI1.SearchRequest();
// Set the search URL.
clCommon.Url = "Search API website";
// Build a SOAP header and set user credentials.
clCommon.AuthenticationHeaderValue =
new WebServiceSearchAPI1.AuthenticationHeader();
clCommon.AuthenticationHeaderValue.sCustomerID = "Your Client ID";

Search API | 33
Confidential and Proprietary
FIN02829 October 2012

clCommon.AuthenticationHeaderValue.sUserID = "Your User ID";


clCommon.AuthenticationHeaderValue.sPassword = "Your Password";
//Change the password.
WebServiceSearchAPI1.BIPasswordChange clPassword = clCommon.ChangePassword(
"Your New BIXG Password");

GetRecordState
The GetRecordState method contains the record state (alert state, assignment, division, status) for a
specif ied result record. The record state indicates at which stage the result record is at in your
organization's result process.
GetRecordState Description
Details
Syntax

BIUpdateResponse GetRecordState(long lResultID)

Parameters
lResultID

System-defined result ID
The result ID is returned in:
BIRecord response class. See "BIRecord" on page 165.
EventItemAlertStateChanged response class. See
"EventItemAlertStateChanged" on page 61.
EventItemStatusChanged response class. See "EventItemStatusChanged" on
page 62.

Return Values

BIUpdateResponse class indicating if the result's record state information was


obtained successfully

C # E x a mp l e
// Create a Web reference named WebServiceSearchAPI1 to the Search API website.
WebServiceSearchAPI1.SearchAPI1 clSearchAPI1 = new WebServiceSearchAPI1.SearchAPI1();

Search API | 34
Confidential and Proprietary
FIN02829 October 2012

// Set the service URL.


clSearchAPI1.Url = "Search API website";
// Build a SOAP header and set user credentials.
clSearchAPI1.AuthenticationHeaderValue =
new WebServiceSearchAPI1.AuthenticationHeader();
clSearchAPI1.AuthenticationHeaderValue.sCustomerID = "Your Client ID";
clSearchAPI1.AuthenticationHeaderValue.sUserID = "Your User ID";
clSearchAPI1.AuthenticationHeaderValue.sPassword = "Your Password";
// Result ID should be set to the BIRecord.ResultID
//from the response that indicated the match.
long lResultID = 1;
// Call the method.
WebServiceSearchAPI1.BIUpdateResponse clBISearchResponse =
clSearchAPI1.GetRecordState(lResultID);

Search API | 35
Confidential and Proprietary
FIN02829 October 2012

GetResultDetails
The GetResultDetails method returns result information about the provided result ID. A unique result
ID is given to each BIXG result record in the BIRecord class of a search response. See "BIRecord" on
page 165.
GetResultDetails Description
Details
Syntax

BIResultDetailResponse GetResultDetails(long id)

Parameters
id

Return Values

System-defined resultID
The result ID is returned in:
BIRecord response class. See "BIRecord" on page 165.
EventItemAlertStateChanged response class. See
"EventItemAlertStateChanged" on page 61.
EventItemStatusChanged response class. See "EventItemStatusChanged" on
page 62.
BIResultDetailResponse class containing results data

C # E x a mp l e
// Create a Web reference named WebServiceSearchAPI1 to the Search API website.
WebServiceSearchAPI1.SearchAPI1 clSearchAPI1 = new WebServiceSearchAPI1.SearchAPI1();
// Set the service URL.
clSearchAPI1.Url = "Search API website";
// Build a SOAP header and set user credentials.
clSearchAPI1.AuthenticationHeaderValue =
new WebServiceSearchAPI1.AuthenticationHeader();
clSearchAPI1.AuthenticationHeaderValue.sCustomerID = "Your Client ID";
clSearchAPI1.AuthenticationHeaderValue.sUserID = "Your User ID";

Search API | 36
Confidential and Proprietary
FIN02829 October 2012

clSearchAPI1.AuthenticationHeaderValue.sPassword = "Your Password";


// Get result details.
long id = 1;
WebServiceSearchAPI1.BIResultDetailResponse response =
clSearchAPI1.GetResultDetails(id);

GetRunDetails
The GetRunDetails method returns result information about the provided run ID.
GetRunDetails Description
Details
Syntax

BIRunDetailResponse GetRunDetails(long id)

Parameters
id

Return Values

System-defined run ID
The run ID is returned in:
BIRunInfo response class. See "BIRunInfo" on page 171.
EventItemBatchStatusChanged response class. See
"EventItemBatchStatusChanged" on page 61.
BIRunDetailResponse class containing run data

C # E x a mp l e
// Create a Web reference named WebServiceSearchAPI1 to the Search API website.
WebServiceSearchAPI1.SearchAPI1 clSearchAPI1 = new WebServiceSearchAPI1.SearchAPI1();
// Set the service URL.
clSearchAPI1.Url = "Search API website";

Search API | 37
Confidential and Proprietary
FIN02829 October 2012

// Build a SOAP header and set user credentials.


clSearchAPI1.AuthenticationHeaderValue =
new WebServiceSearchAPI1.AuthenticationHeader();
clSearchAPI1.AuthenticationHeaderValue.sCustomerID = "Your Client ID";
clSearchAPI1.AuthenticationHeaderValue.sUserID = "Your User ID";
clSearchAPI1.AuthenticationHeaderValue.sPassword = "Your Password";
// Get run details.
long id = 1;
WebServiceSearchAPI1.BIRunDetailResponse response = clSearchAPI1.GetRunDetails(id);

IndexAcceptList
The IndexAcceptList method indexes a specif ied accept list.
If the accept list is restricted to a division, the user ID must have access to that division. For enterprisewide accept lists, a user ID from the BIXG client that created the list must index the list.
You can use this method to index both accept lists set to automatically index or manually index in
BIXG.

You should only use this method for large accept lists. To prevent heavy load on the servers, you
should not call IndexAcceptList more than once or twice a day.

IndexAcceptList Description
Details
Syntax

BIUpdateResponse IndexAcceptList(string sAcceptListName)

Parameters
sAcceptListName
Return Values

String with the name of the accept list you want to index
BIUpdateResponse class indicating if the indexing of the accept list was successful

Search API | 38
Confidential and Proprietary
FIN02829 October 2012

C # E x a mp l e
// Create a Web reference named WebServiceSearchAPI1 to the Search API website.
WebServiceSearchAPI1.SearchAPI1 clSearchAPI1 = new WebServiceSearchAPI1.SearchAPI1();
// Set the service URL.
clSearchAPI1.Url = "Search API website";
// Build a SOAP header and set user credentials.
clSearchAPI1.AuthenticationHeaderValue =
new WebServiceSearchAPI1.AuthenticationHeader();
clSearchAPI1.AuthenticationHeaderValue.sCustomerID = "Your Client ID";
clSearchAPI1.AuthenticationHeaderValue.sUserID = "Your User ID";
clSearchAPI1.AuthenticationHeaderValue.sPassword = "Your Password";
// Index the accept list.
WebServiceSearchAPI1.BIUpdateResponse clBISearchResponse =
clSearchAPI1.IndexAcceptList("Accept List Name");

Search API | 39
Confidential and Proprietary
FIN02829 October 2012

Search
Search sends standard structured entity information to the BIXG server for processing using a specif ied
predef ined search. For unstructured or EFT (electronic funds transfer) searches, see "Wire" on page 45.
Search Description
Details
Syntax

BISearchResponse CustomSearch(SearchRequest clSearchRequest, string


sPredefineSearchName, AssignResultsTo clAssignResultsTo)

Parameters
clAssignResultsTo

AssignResultsTo class that assigns alerts to a user or role


See "AssignResultsTo" on page 89.
Alerts can be viewed by the assigned user or users who belong to the assigned
role through a Smart Client or Browser Client. See the Smart Client User Manual,
"Result Viewing" section.

clSearchRequest

SearchRequest class defining the search criteria


See "SearchRequest" on page 101.

sPredefinedSearchName

String with the name of the predefined search you want BIXG to use when
performing the search
This predefined search must be created in a Smart Client. If the predefined search
is restricted to a role, you must belong to that role. See the Smart Client User
Manual, "Predefined Searches" chapter.
If due diligence services are included in the predefined search, credentials must be
set up through a Smart Client.

Return Values

BISearchResponse class containing search results


For more information on possible results, see "Response Classes" on page 108.

C # E x a mp l e
// Create a Web reference named WebServiceSearchAPI1 to the Search API website.
WebServiceSearchAPI1.SearchAPI1 clSearchAPI1 = new WebServiceSearchAPI1.SearchAPI1();

Search API | 40
Confidential and Proprietary
FIN02829 October 2012

// Set the service URL.


clSearchAPI1.Url = "Search API website";
// Build a SOAP header and set user credentials.
clSearchAPI1.AuthenticationHeaderValue =
new WebServiceSearchAPI1.AuthenticationHeader();
clSearchAPI1.AuthenticationHeaderValue.sCustomerID = "Your Client ID";
clSearchAPI1.AuthenticationHeaderValue.sUserID = "Your User ID";
clSearchAPI1.AuthenticationHeaderValue.sPassword = "Your Password";
// Create a Request object.
clSearchRequest.Requests = new WebServiceSearchAPI1.Request[1];
// Create a Name object.
clSearchRequest.Requests[0] = new WebServiceSearchAPI1.Request();
clSearchRequest.Requests[0].Entity = WebServiceSearchAPI1.Entity.Individual;
clSearchRequest.Requests[0].Name = new WebServiceSearchAPI1.Name();
clSearchRequest.Requests[0].Name.First = "Imaginary";
clSearchRequest.Requests[0].Name.Last = "Person";
// Create an AssignResultsTo object.
WebServiceSearchAPI1.AssignResultsTo clAssignResultsTo = new
WebServiceSearchAPI1.AssignResultsTo();
clAssignResultsTo.Roles = new String[1];
clAssignResultsTo.Roles[0] = "Organization Role";
clAssignResultsTo.RecordAssignmentType =
WebServiceSearchAPI1.BIRecordAssignmentType.RECORD_ASSIGN_ROLE;
// Call the search.
WebServiceSearchAPI1.BISearchResponse clBISearchResponse = clSearchAPI1.Search(
clSearchRequest,
"PredefinedSearchName",
clAssignResultsTo);

Search API | 41
Confidential and Proprietary
FIN02829 October 2012

SetRecordState
The SetRecordState method changes the record state of a result record.
SetRecordState Description
Details
Syntax

BIUpdateResponse SetRecordState(long lResultID, string sRecordStatus,


BIAlertState eAlertState, UpdateAssignResultsTo clUpdateAssignResultsTo, string
sNotes)

Parameters
clUpdateAssignResultsTo

A class defining the new assigned user or role


See "UnstructuredWireRequest" on page 105.
You cannot assign the result record to a user/role if the alert state is set to Closed.

eAlertState

Alert state of the result record


The values are Open and Closed.

lResultID

System-defined result ID
The result ID is returned in:
BIRecord response class. See "BIRecord" on page 165.
EventItemAlertStateChanged response class. See
"EventItemAlertStateChanged" on page 61.
EventItemStatusChanged response class. See "EventItemStatusChanged" on
page 62.

Search API | 42
Confidential and Proprietary
FIN02829 October 2012

SetRecordState Description (Continued)


Details
sNotes

String with the note providing additional information for the result record
Users can be required to provide a note when they take certain actions on a result
record. If a required note is not entered, an error is returned.

s
sRecordStatus

String with the record status of the result record


The value must correspond with a record status set up in a Smart Client. See the
Smart Client Manual, "System Values" section.
The values are not case-sensitive. When processed, the case of the value will
reflect the default case used in the Smart Client.
BIXG can be configured to require a record status when you close alerts or reassign
records. If a required record status is not set, an error is returned.

s
Return Values

To avoid possible errors and provide a detailed record history,


always enter a note. See the Smart Client Manual, "Process
Settings" section.

To avoid possible errors and clearly indicate what stage the result
record is at in your result process, always set a record status.
See the Smart Client Manual, "Process Settings" section.

BIUpdateResponse class indicating if the record state changes were successful

C # E x a mp l e
// Create a Web reference named WebServiceSearchAPI1 to the Search API website.
WebServiceSearchAPI1.SearchAPI1 clSearchAPI1 = new WebServiceSearchAPI1.SearchAPI1();
// Set the service URL.
clSearchAPI1.Url = "Search API website";
// Build a SOAP header and set user credentials.
clSearchAPI1.AuthenticationHeaderValue =
new WebServiceSearchAPI1.AuthenticationHeader();
clSearchAPI1.AuthenticationHeaderValue.sCustomerID = "Your Client ID";
clSearchAPI1.AuthenticationHeaderValue.sUserID = "Your User ID";

Search API | 43
Confidential and Proprietary
FIN02829 October 2012

clSearchAPI1.AuthenticationHeaderValue.sPassword = "Your Password";


//Result ID should be set to the BIRecord.ResultID
//from the response that indicated the match.
long lResultID = 1; // Record ID
WebServiceSearchAPI1.BIAlertState eAlertState = WebServiceSearchAPI1.BIAlertState.Open;
// Create an UpdateAssignResultsTo object.
WebServiceSearchAPI1.UpdateAssignResultsTo clUpdateAssignTo =
new WebServiceSearchAPI1.UpdateAssignResultsTo();
clAssignUpdateAssignTo.RecordAssignmentType =
WebServiceSearchAPI1.BIRecordAssignmentType.RECORD_ASSIGN_ROLE;
clUpdateAssignTo.RoleOrUser = "Organization Role";
// Call the method.
WebServiceSearchAPI1.BIUpdateResponse clBISearchResponse = clSearchAPI1.SetRecordState(
lResultID,
"New Record Status",
eAlertState,
clUpdateAssignResultsTo,
"Notes");

Search API | 44
Confidential and Proprietary
FIN02829 October 2012

Wire
The Wire method sends EFT or unstructured data to the BIXG server for watchlist searching using a
specif ied predef ined search. For standard, structured data searches, see "Search" on page 40.
Wire Description
Details
Syntax

BISearchResponse WirePredefinedSearch(WireRequest WireRequest, string


sPredefinedSearchName, AssignResultsTo clAssignResultsTo)

Accept lists cannot be used in a wire search using the


Unstructured wire type. Even if they are enabled in the
predefined search, BIXG will ignore the accept lists when
performing the search.

Parameters
clAssignResultsTo

Optional AssingResultsTo class that assigns the search results to another user or
role
See "AssignResultsTo" on page 89.

sPredefinedSearchName

String with the name of the predefined search you want BIXG to use when
performing the search
This predefined search must be created through a Smart Client. The predefined
search cannot include due diligence settings. See the Smart Client User Manual,
"Predefined Searches" chapter.

WireRequest

WireRequest class specifing the search request


See "WireRequest" on page 106.

Return Values

BISearchResponse class containing watchlist results

C # E x a mp l e
// Create a Web reference named WebServiceSearchAPI1 to the Search API website.
WebServiceSearchAPI1.SearchAPI1 clSearchAPI1 = new WebServiceSearchAPI1.SearchAPI1();

Search API | 45
Confidential and Proprietary
FIN02829 October 2012

// Set the service URL.


clSearchAPI1.Url = "Search API website";
// Build a SOAP header and set user credentials.
clSearchAPI1.AuthenticationHeaderValue =
new WebServiceSearchAPI1.AuthenticationHeader();
clSearchAPI1.AuthenticationHeaderValue.sCustomerID = "Your Client ID";
clSearchAPI1.AuthenticationHeaderValue.sUserID = "Your User ID";
clSearchAPI1.AuthenticationHeaderValue.sPassword = "Your Password";
// Create a WireRequest object.
WebServiceSearchAPI1.WireRequest clWireRequest=
new WebServiceSearchAPI1.WireRequest;
clWireRequest.Type = WebServiceSearchAPI1.WireType.FEDWIRE
clWireRequest.Wire = "{1510}{5100}B*SAMPLE WIRE*{6500}";
// Note: When processing EFT files set the WireRequest.Wire value
// to the contents of the file. There is a 1 MB size limit.
// Create an AssignResultsTo object.
WebServiceSearchAPI1.AssignResultsTo clAssignResultsTo =
new WebServiceSearchAPI1.AssignResultsTo();
clAssignResultsTo.Roles = new string[1];
clAssignResultsTo.Roles[0] = "Compliance Officer";
clAssignResultsTo.RecordAssignmentType =
WebServiceSearchAPI1.BIRecordAssignmentType.RECORD_ASSIGN_ROLE;
// Call the search.
WebServiceSearchAPI1.BISearchResponse clBISearchResponse = clSearchAPI.Wire(
clWireRequest,
"Predefined Search",
clAssignResultsTo);

Search API | 46
Confidential and Proprietary
FIN02829 October 2012

Chapter

In This Chapter

Event Queue
Overview, page 48
Event Queue
Methods, page 48

Event Queue

Response Classes,
page 56

Event Queue | 47
Confidential and Proprietary
FIN02829 October 2012

Event Queue Overview


The Event Queue can notify external systems via the Search API Web service when selected LexisNexis
Bridger Insight XG (BIXG) events occur. These events include:
An alert state changes for a result record.
A batch run status changes for a batch search.
A record status changes for a result record.
Before you send messages to your external system, you must conf igure BIXG through a Smart Client to
generate messages when the selected events occur. See the Smart Client User Manual, "Process
Settings" section.

Event Queue Methods


The following methods are available within the Event Queue:
EventProcessingComplete, page 49
GetAlertChangedDetails, page 50
GetBatchStatusChangedDetails, page 52
GetEventNotif ication, page 53
GetStatusChangedDetails, page 55
A description, syntax, parameters, and return values are provided for each method. In addition, C#
code examples are given.
Classes are used as parameters for certain methods. These classes are made up of multiple properties
grouped together as one object. For more information about classes discussed in the method
descriptions, see "Request Classes" on page 84.
Depending on your account, you may be able to view a list of Event Queue operations at:
https://bridgerinsight.lexisnexis.com/webservices/8.0/searchapi1.asmx
https://bridgerinsight2.lexisnexis.com/webservices/8.0/searchapi1.asmx

Event Queue | 48
Confidential and Proprietary
FIN02829 October 2012

EventProcessingComplete
The EventProcessingComplete method notif ies the system that the event has been processed so it can
be deleted.
EventProcessingComplete Description
Details
Syntax

void EventProcessingComplete (long id)

Parameters
id

Return Values

Primary ID obtained from a call to the GetEventNotification method


See "GetEventNotification" on page 53.
None

C # E x a mp l e
// Create a Web reference named WebServiceSearchAPI1 to the Search API website.
WebServiceSearchAPI1.SearchAPI1 clSearchAPI1 = new WebServiceSearchAPI1.SearchAPI1();
// Set the service URL.
clSearchAPI1.Url = "Search API website";
// Build a SOAP header and set user credentials.
clSearchAPI1.AuthenticationHeaderValue =
new WebServiceSearchAPI1.AuthenticationHeader();
clSearchAPI1.AuthenticationHeaderValue.sCustomerID = "Your Client ID";
clSearchAPI1.AuthenticationHeaderValue.sUserID = "Your User ID";
clSearchAPI1.AuthenticationHeaderValue.sPassword = "Your Password";
// Select type of event to request.
WebServiceSearchAPI1.QueuedEventType eEventType;
eEventType = WebServiceSearchAPI1.QueuedEventType.AlertStateChanged;

Event Queue | 49
Confidential and Proprietary
FIN02829 October 2012

// Request next event of the type desired.


WebServiceSearchAPI1.BIEventQueueResponse clBIEventQueueResponse =
clSearchAPI1.GetEventNotification(eEventType);
// Verify that an event was returned.
if((clBIEventQueueResponse.Error == null) && (clBIEventQueueResponse.EventID !=0))
{
//Request the event details.
WebServiceSearchAPI1.BIAlertStatChangedResponse clBIAlertStateChangedResponse =
clSearchAPI1.GetAlertChangedDetails (clBIEventQueueResponse.EventID);
//Send event processing complete notification to close the event.
clSearchAPI1.EventProcessingComplete(clBIEventQueueResponse.Id);

GetAlertChangedDetails
The GetAlertChangedDetails method returns event information about the provided event ID.
GetAlertChangedDetails Description
Details
Syntax

BIAlertStateChangedResponse GetAlertChangedDetails(long id)

Parameters
id

Return Values

Event ID obtained from a call to the GetEventNotification method


See "GetEventNotification" on page 53.
BIAlertStateChangedResponse class containing event and record details

C # E x a mp l e
// Create a Web reference named WebServiceSearchAPI1 to the Search API website.

Event Queue | 50
Confidential and Proprietary
FIN02829 October 2012

WebServiceSearchAPI1.SearchAPI1 clSearchAPI1 = new WebServiceSearchAPI1.SearchAPI1();


// Set the service URL.
clSearchAPI1.Url = "Search API website";
// Build a SOAP header and set user credentials.
clSearchAPI1.AuthenticationHeaderValue =
new WebServiceSearchAPI1.AuthenticationHeader();
clSearchAPI1.AuthenticationHeaderValue.sCustomerID = "Your Client ID";
clSearchAPI1.AuthenticationHeaderValue.sUserID = "Your User ID";
clSearchAPI1.AuthenticationHeaderValue.sPassword = "Your Password";
// Get alert changed details.
QueuedEventType type = QueuedEventType.AlertStateChanged;
WebServiceSearchAPI1.BIEventQueueResponse eventResponse =
clsearchAPI1 GetEventNotification(type);
WebServiceSearchAPI1.BIAlertStateChangedResponse response =
clsearchAPI1.GetAlertChangedDetails(eventResponse.EventID);
// Once your processing is complete,
// call the EventProcessingComplete method.

Event Queue | 51
Confidential and Proprietary
FIN02829 October 2012

GetBatchStatusChangedDetails
The GetBatchStatusChangedDetails method returns event information about the provided event ID.
GetBatchStatusChangedDetails Description
Details
Syntax

BIBatchStatusChangedResponse GetBatchStatusChangedDetails(long id)

Parameters
id

Return Values

Event ID obtained from a call to the GetEventNotification method


See "GetEventNotification" on page 53.
BIBatchStatusChangedResponse class containing event and record details

C # E x a mp l e
// Create a Web reference named WebServiceSearchAPI1 to the Search API website.
WebServiceSearchAPI1.SearchAPI1 clSearchAPI1 = new WebServiceSearchAPI1.SearchAPI1();
// Set the service URL.
clSearchAPI1.Url = "Search API website";
// Build a SOAP header and set user credentials.
clSearchAPI1.AuthenticationHeaderValue =
new WebServiceSearchAPI1.AuthenticationHeader();
clSearchAPI1.AuthenticationHeaderValue.sCustomerID = "Your Client ID";
clSearchAPI1.AuthenticationHeaderValue.sUserID = "Your User ID";
clSearchAPI1.AuthenticationHeaderValue.sPassword = "Your Password";
//Select type of event to request
WebServiceSearchAPI1.QueuedEventType eEventType;
eEventType = WebServiceSearchAPI1.QueuedEventType.BatchStatusChanged;

Event Queue | 52
Confidential and Proprietary
FIN02829 October 2012

//Request Next event of the type desired


WebServiceSearchAPI1.BIEventQueueResponse clBIEventQueueResponse =
clSearchAPI1.GetEventNotification(eEventType);
//Verify that an event was returned.
if((clBIEventQueueResponse.Error == null) && ( clBIEventQueueResponse.EventId != 0))
{
//Request the event details.
WebServiceSearchAPI1.BIBatchStatusChangedResponse clBatchStatusChangedResponse =
clSearchAPI1.GetBatchStatusChangedDetails clBIEventQueueResponse.EventId);
//Send event processing complete notification to close the event.
clSearchAPI1.EventProcessingComplete (clBIEventQueueResponse.EventId);
}

GetEventNotification
The GetEventNotif ication method returns the next specif ied event.
GetEventNotification Description
Details
Syntax

BIEventQueueResponse GetEventNotification(QueuedEventType type)

Parameters
type

Return Values

Type of event returned


Possible values:
AlertStateChanged
BatchStatusChanged
RecordStatusChanged
All
BIEventQueueResponse class containing the event

Event Queue | 53
Confidential and Proprietary
FIN02829 October 2012

C # E x a mp l e
// Create a Web reference named WebServiceSearchAPI1 to the Search API website.
WebServiceSearchAPI1.SearchAPI1 clSearchAPI1 = new WebServiceSearchAPI1.SearchAPI1();
// Set the service URL.
clSearchAPI1.Url = "Search API website";
// Build a SOAP header and set user credentials.
clSearchAPI1.AuthenticationHeaderValue =
new WebServiceSearchAPI1.AuthenticationHeader();
clSearchAPI1.AuthenticationHeaderValue.sCustomerID = "Your Client ID";
clSearchAPI1.AuthenticationHeaderValue.sUserID = "Your User ID";
clSearchAPI1.AuthenticationHeaderValue.sPassword = "Your Password";
//Select type of event to request
WebServiceSearchAPI1.QueuedEventType eEventType;
eEventType = WebServiceSearchAPI1.QueuedEventType.BatchStatusChanged;
//Request Next event of the type desired
WebServiceSearchAPI1.BIEventQueueResponse clBIEventQueueResponse =
clSearchAPI1.GetEventNotification(eEventType);

Event Queue | 54
Confidential and Proprietary
FIN02829 October 2012

GetStatusChangedDetails
The GetStatusChangedDetails method returns event information about the provided event ID.
GetStatusChangedDetails Description
Details
Syntax

BIStatusChangedResponse GetStatusChangedDetails(long id)

Parameters
id

Return Values

Event ID obtained from a call to the GetEventNotification method


See "GetEventNotification" on page 53.
BIStatusChangedResponse class containing event and record details

C # E x a mp l e
// Create a Web reference named WebServiceSearchAPI1 to the Search API website.
WebServiceSearchAPI1.SearchAPI1 clSearchAPI1 = new WebServiceSearchAPI1.SearchAPI1();
// Set the service URL.
clSearchAPI1.Url = "Search API website";
// Build a SOAP header and set user credentials.
clSearchAPI1.AuthenticationHeaderValue =
new WebServiceSearchAPI1.AuthenticationHeader();
clSearchAPI1.AuthenticationHeaderValue.sCustomerID = "Your Client ID";
clSearchAPI1.AuthenticationHeaderValue.sUserID = "Your User ID";
clSearchAPI1.AuthenticationHeaderValue.sPassword = "Your Password";
//Select type of event to request
WebServiceSearchAPI1.QueuedEventType eEventType;
eEventType = WebServiceSearchAPI1.QueuedEventType.RecordStatusChanged;

Event Queue | 55
Confidential and Proprietary
FIN02829 October 2012

//Request Next event of the type desired


WebServiceSearchAPI1.BIEventQueueResponse clBIEventQueueResponse =
clSearchAPI1.GetEventNotification(eEventType);
//Verify that an event was returned.
if((clBIEventQueueResponse.Error == null) && (clBIEventQueueResponse.EventId != 0))
{
//Request the event details.
WebServiceSearchAPI1.BIStatusChangedResponse clStatusChangedResponse =
clSearchAPI1.GetStatusChangedDetails (clBIEventQueueResponse.EventId);
//Send event processing complete notification to close the event.
clSearchAPI1.EventProcessingComplete (clBIEventQueueResponse.EventId);
}

Response Classes
Event Queue returns response information in classes. Each class is made up of multiple properties and
other classes.
The main classes are:
BIAlertStateChangedResponse, page 57
BIBatchStatusChangedResponse, page 58
BIEventQueueResponse, page 59
BIStatusChangedResponse, page 60
The other classes are found within these classes.

Response Class Hierarchy


This model shows the Event Queue response classes.

Event Queue | 56
Confidential and Proprietary
FIN02829 October 2012

BIAlertStateChangedResponse
Hierarchy: BIAlertStateChangedResponse

The BIAlertStateChangedResponse class def ines the changed alert state event.
BIAlertStateChangedResponse Class
Name

Type

Description

DaysUntilPassword
Expires

BIDaysUntilPassword
Expires

Number of days until the password associated with the BIXG


user ID used in the request expires
See "BIDaysUntilPasswordExpires" on page 133.

Error

BIError

Error information
See "BIError Class" on page 212.

EventItem

EventItemAlertState
Changed

Alert state change information


See "EventItemAlertStateChanged" on page 61.

Record

BIRecord

Result record information


See "BIRecord" on page 165.

Event Queue | 57
Confidential and Proprietary
FIN02829 October 2012

BIBatchStatusChangedResponse
Hierarchy: BIBatchStatusChangedResponse

The BIBatchStatusChangedResponse class def ines the changed batch status event.
BIBatchStatusChangedResponse Class
Name

Type

Description

DaysUntilPassword
Expires

BIDaysUntilPassword
Expires

Number of days until the password associated with the BIXG


user ID used in the request expires
See "BIDaysUntilPasswordExpires" on page 133.

Error

BIError

Error information
See "BIError Class" on page 212.

EventItem

EventItemBatchStatus
Changed

Record status change information


See "EventItemBatchStatusChanged" on page 61.

Record

BIRecord

Result record information


See "BIRecord" on page 165.

Event Queue | 58
Confidential and Proprietary
FIN02829 October 2012

BIEventQueueResponse
Hierarchy: BIEventQueueResponse

The BIEventQueueResponse class provides event information.


BIEventQueueResponse Class
Name

Type

Description

DaysUntilPassword
Expires

BIDaysUntilPassword
Expires

Number of days until the password associated with the BIXG


user ID used in the request expires
See "BIDaysUntilPasswordExpires" on page 133.

Error

BIError

Error information
See "BIError Class" on page 212.

EventId

long

Foreign key into data


-1 indicates no event information was returned.

EventType

BIQueuedEventType

Possible values:
AlertStateChanged
BatchStatusChanged
RecordStatusChanged

Id

long

Primary key
-1 indicates no event information was returned.

QueuedAt

DateTime

UTC creation timestamp

Event Queue | 59
Confidential and Proprietary
FIN02829 October 2012

BIStatusChangedResponse
Hierarchy: BIStatusChangedResponse

The BIStatusChangedResponse class def ines the changed record status event.
BIStatusChangedResponse Class
Name

Type

Description

DaysUntilPassword
Expires

BIDaysUntilPassword
Expires

Number of days until the password associated with the BIXG


user ID used in the request expires
See "BIDaysUntilPasswordExpires" on page 133.

Error

BIError

Error information
See "BIError Class" on page 212.

EventItem

EventItemStatus
Changed

Record status change information


See "EventItemStatusChanged" on page 62.

Record

BIRecord

Result record information


See "BIRecord" on page 165.

Event Queue | 60
Confidential and Proprietary
FIN02829 October 2012

EventItemAlertStateChanged
Hierarchy: BIAlertStateChangedResponse>EventItemAlertStateChanged

The EventItemAlertStateChanged class provides changed alert state details.


EventItemAlertStateChanged Class
Name

Type

Description

EventId

long

Primary key

NewState

string

New alert state

PreviousState

string

Old alert state

ResultId

long

Unique number generated by BIXG for each result record

User

string

User associated with the event

EventItemBatchStatusChanged
Hierarchy: BIBatchStatusChangedResponse>EventItemBatchStatusChanged

The EventItemBatchStatusChanged class provides changed batch status details.


EventItemBatchStatusChanged Class
Name

Type

Description

EventId

long

Primary key

RunID

long

Unique number assigned to each batch search

Status

string

status of the batch run.

Event Queue | 61
Confidential and Proprietary
FIN02829 October 2012

EventItemStatusChanged
Hierarchy: BIStatusChangedResponse>EventItemStatusChanged

The EventItemStatusChanged class provides changed record status details.


EventItemStatusChanged Class
Name

Type

Description

EventId

long

Primary key

NewSatus

string

New alert state

PreviousStatus

string

Old alert state

ResultId

long

Unique number generated by BIXG for each result record

User

string

User associated with the event

Event Queue | 62
Confidential and Proprietary
FIN02829 October 2012

Chapter

In This Chapter

Direct Overview,
page 64
Direct Connection
Management,
page 65

Direct

Direct Methods,
page 67

Direct |
Confidential and Proprietary
FIN02829 October 2012

63

Direct Overview
Direct is a published WSDL interface that supports the integration of watchlist search capabilities into
other applications. All setup and conf iguration is accomplished through search requests and all data is
returned in search responses.

Direct search results are not written to a LexisNexis Bridger Insight XG (BIXG) results database.

Search Settings
When performing searches, you can def ine the settings you want BIXG to use in the search through the
Predef inedSearch class. You set up watchlist search settings by selecting options in:
AutomaticFalsePositiveRules, page 91
File, page 92
GeneralSearchOptions, page 93
MatchOptions, page 97

The search settings you choose can drastically change the results of searches that are performed.
Thoroughly test the settings before implementing them.

Watch lists
You may have access to search against:
BankersAccuitys Global WatchList
LexisNexis Watchlists
World-Check PEP (politically exposed person) data set
Dow Jones Watchlist (formerly Factiva Public Figures and Associates)
For more information on BankersAccuitys Global WatchList, see the following knowledge base article
on Client Services at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1555

Direct |
Confidential and Proprietary
FIN02829 October 2012

64

For more information on LexisNexis watchlists, see the LexisNexis Watchlists white paper on the Client
Services website at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1439
For more information on World-Check, see the following knowledge base article on Client Services at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=743
Optional data sets are distinct from BIXG and may require your organization to sign a separate
agreement or meet additional credentialing requirements prior to accessing these services. For more
information on these services, contact your sales representative.

When watchlists and optional data sets are referenced together, the general term of watchlist is
used.

To add watchlists to a search, see "File" on page 92.

Direct Connection Management


You can use ServicePointManager to manage the number of concurrent connections, and idle time-out
settings. Managing your connections may help improve Web service performance. For example, the
default concurrent connection setting is lower than BIXG Web services can support.
If you are using a proxy server, you also need to set up the proxy connection.

Your proxy server must support HTTPS 1.1 tunneling.

For more information on ServicePointManager, visit the Microsoft Development Network at:
http://msdn.microsoft.com/en-us/default.aspx

Concurrent Connection C# Example


namespace ServicePointTest
{
class Program

Direct |
Confidential and Proprietary
FIN02829 October 2012

65

{
private const string PROXY_SERVER = "";
private const string PROXY_PORT = "";
private const string BASE_URI = "http://BZNDOARD-XPD";
private const string XGDIRECT_PATH = "/XGWebServices/8.0/XGDirect1.asmx";
static void Main(string[] args)
{
ServicePointManager.DefaultConnectionLimit = 10;
}
}
}

Idle Time-Out Setting C# Example


namespace ServicePointTest
{
class Program
{
private const string PROXY_SERVER = "";
private const string PROXY_PORT = "";
private const string BASE_URI = "http://BZNDOARD-XPD";
private const string XGDIRECT_PATH = "/XGWebServices/8.0/XGDirect1.asmx";
static void Main(string[] args)
{
ServicePointManager.MaxServicePointIdleTime = 10000;
}
}
}

Proxy Connection C# Example


namespace ServicePointTest
{
class Program
{

Direct |
Confidential and Proprietary
FIN02829 October 2012

66

private const string PROXY_SERVER = "";


private const string PROXY_PORT = "";
private const string BASE_URI = "http://BZNDOARD-XPD";
private const string XGDIRECT_PATH = "/XGWebServices/8.0/XGDirect1.asmx";
static void Main(string[] args)
{
IWebProxy Iproxy = null;
if(!string.IsNullOrEmpty(PROXY_SERVER))
{
string proxyAdd = "http://" + PROXY_SERVER + ":" + PROXY_PORT;
// Create a proxy object.
WebProxy DefaultProxy = new WebProxy(proxyAdd, true);
// Set the proxy that all HttpWebRequest instances use.
WebRequest.DefaultWebProxy = DefaultProxy;
// Get the base interface for proxy access for the
// WebRequest-based classes.
Iproxy = WebRequest.DefaultWebProxy;
}
XGDirect(clURI, Iproxy);
}
}
}

Direct Methods
The following methods are available within the Direct service:
ChangePassword, page 68
Search, page 69
UnstructuredWire, page 72
Wire, page 73
A description, syntax, parameters, and return values are provided for each method. In addition, C#
code examples are given.

Direct |
Confidential and Proprietary
FIN02829 October 2012

67

Classes are used as parameters for certain methods. These classes are made up of multiple properties
grouped together as one object. For more information about classes discussed in the method
descriptions, see "Request Class Overview" on page 85.
Depending on your account, you may be able to view a list of Direct operations at:
https://bridgerinsight.lexisnexis.com/webservices/8.0/xgdirect1.asmx
https://bridgerinsight2.lexisnexis.com/webservices/8.0/xgdirect1.asmx

ChangePassword
The ChangePassword method changes the BIXG password associated with the user ID. This password
expires at least every 60 days.

Passwords should be secure and confidential.

ChangePassword Description
Details
Syntax

BIPasswordChange ChangePassword(string sNewPassword)

Parameters
sNewPassword

Return Values

String with the new BIXG password


This password replaces the existing password associated with the user ID.
Passwords:
Are case sensitive.
Must contain letters and numbers.
Must be 8-20 characters.
Must be changed at least 60 days.
Cannot be the reverse of the user ID.
Cannot contain the user ID.
Users cannot use the previous 12 passwords.
BIPasswordChange class indicating if the password change was successful

Direct |
Confidential and Proprietary
FIN02829 October 2012

68

C # E x a mp l e
// Create a Web reference named WebServiceXGDirect1 to the Direct website.
/ NOTE: Access the common interface here.
// This is not in the BIXG Direct1 class.
WebServiceXGDirect1.Common clCommon = new WebServiceXGDirect1.Common();
clCommon.Url = "Direct website";
// Build a SOAP header and set up BIXG credentials.
clCommon.AuthenticationHeaderValue = new WebServiceXGDirect1.AuthenticationHeader();
clCommon.AuthenticationHeaderValue.sCustomerID = "Your Client ID";
clCommon.AuthenticationHeaderValue.sUserID = "Your User ID";
clCommon.AuthenticationHeaderValue.sPassword = "Your Password";
//Change the password.
WebServiceXGDirect1.BIPasswordChange clPassword = clCommon.ChangePassword(
"Your New BIXG Password");

Search
The Search method sends standard structured entity information to the BIXG server for processing
using a specif ied predef ined search. For EFT (electronic funds transfer) or unstructured data searches,
see "Wire" on page 73.
Search Description
Details
Syntax

BISearchResponse CustomSearch(SearchRequest SearchRequest,


PredefinedSearch clPredefinedSearch)

Parameters

Direct |
Confidential and Proprietary
FIN02829 October 2012

69

Search Description (Continued)


Details
clPredefinedSearch

PredefinedSearch class defining the search settings you want BIXG to use when
performing the search
See "PredefinedSearch" on page 99.

SearchRequest

SearchRequest class specifying the search criteria


See "SearchRequest" on page 101.

R e t u r n Val ue s

BISearchResponse class containing search results


For more information on possible search results, see "Response Class Overview"
on page 109.

C # E x a mp l e
// Create a Web reference named WebServiceXGDirect1 to the Direct website.
WebServiceXGDirect1.XGDirect1 clXGDirect1 = new WebServiceXGDirect1.XGDirect1();
clXGDirect1.Url = "Direct website";
// Build a SOAP header.
clXGDirect1.AuthenticationHeaderValue =
new WebServiceXGDirect1.AuthenticationHeader();
clXGDirect1.AuthenticationHeaderValue.sCustomerID = "Your Client ID";
clXGDirect1.AuthenticationHeaderValue.sUserID = "Your User ID";
clXGDirect1.AuthenticationHeaderValue.sPassword = "Your Password";
// Create a request.
WebServiceXGDirect1.SearchRequest clSearchRequest =
new WebServiceXGDirect1.SearchRequest();
// Create a Session object.
clSearchRequest.Session = new WebServiceXGDirect1.Session();
clSearchRequest.Session.ClientReference = "ClientReference";
// Create a Requests object.

Direct |
Confidential and Proprietary
FIN02829 October 2012

70

clSearchRequest.Requests = new WebServiceXGDirect1.Request[1];


clSearchRequest.Requests[0] = new WebServiceXGDirect1.Request();
clSearchRequest.Requests[0].Entity = WebServiceXGDirect1.Entity.Individual;
// Create a Name object.
clSearchRequest.Requests[0].Name = new WebServiceXGDirect1.Name();
clSearchRequest.Requests[0].Name.First = "Imaginary";
clSearchRequest.Requests[0].Name.Last = "Person";
// Create an Identification object.
clSearchRequest.Requests[0].Identifications = new WebServiceXGDirect1.Identification[1];
clSearchRequest.Requests[0].Identifications[0] =
new WebServiceXGDirect1.Identification();
clSearchRequest.Requests[0].Identifications[0].Type = WebServiceXGDirect1.IDType.SSN;
clSearchRequest.Requests[0].Identifications[0].Number = "###-##-####";
// Create a PredefinedSearch class.
WebServiceXGDirect1.PredefinedSearch clPredefinedSearch =
new WebServiceXGDirect1.PredefinedSearch();
// Create a WatchListOptions class.
clPredefinedSearch.WatchListOptions = new WebServiceXGDirect1.WatchListOptions();
clPredefinedSearch.WatchListOptions.Files = new WebServiceXGDirect1.File[1];
clPredefinedSearch.WatchListOptions.Files[0] = new WebServiceXGDirect1.File();
clPredefinedSearch.WatchListOptions.Files[0].Score = 80;
clPredefinedSearch.WatchListOptions.Files[0].Name = "OFAC SDN";
// Call the search.
WebServiceXGDirect1.BISearchResponse clBISearchResponse = clXGDirect1.Search(
clSearchRequest,
clPredefinedSearch);

Direct |
Confidential and Proprietary
FIN02829 October 2012

71

UnstructuredWire
Sends up to 100 unstructured text strings, up to 1 MB in size each, to the BIXG server for watchlist
searching using selected search settings.
For more information on search settings, see "Direct Watchlist Search Settings Overview" on page 77.
For standard, structured data searches, see "Search" on page 69.
UnstructuredWire Description
Details
Syntax

BISearchResponse UnstructuredWire(WireRequest WireRequest,


WatchListOptions clPredefinedSearch)

Parameters
clPredefinedSearch

PredefinedSearch class defining search settings you want BIXG to use when
performing the search
See "PredefinedSearch" on page 99.

UnstructuredWireRequest

UnstructuredWireRequest class defining the search criteria


See "UnstructuredWireRequest" on page 105.

Return Values

BISearchResponse class containing watchlist results

C # E x a mp l e
// Create a Web reference named WebServiceXGDirect1 to the Direct website.
WebServiceXGDirect1.XGDirect1 clXGDirect1 = new WebServiceXGDirect1.XGDirect1();
clXGDirect1.Url = "Direct website";
// Build a SOAP header.
clXGDirect1.AuthenticationHeaderValue =
new WebServiceXGDirect1.AuthenticationHeader();
clXGDirect1.AuthenticationHeaderValue.sCustomerID = "Your Client ID";
clXGDirect1.AuthenticationHeaderValue.sUserID = "Your User ID";

Direct |
Confidential and Proprietary
FIN02829 October 2012

72

clXGDirect1.AuthenticationHeaderValue.sPassword = "Your Password";


// Create an UnstructuredWireRequest object.
WebServiceXGDirect1.UnstructuredWireRequest clUnstructuredWireRequest =
new WebServiceXGDirect1.UnstructuredWireRequest();
// Provide text strings to search.
clUnstructuredWireRequest.Wires = new string[2];
clUnstructuredWireRequest.Wires[0] = "{1510}{5100}B*SAMPLE DATA 1*{6500}";
clUnstructuredWireRequest.Wires[1] = "{1510}{5100}B*SAMPLE DATA 2*{6500}";
// Create a WatchListOptions object.
WebServiceXGDirect1.WatchListOptions clWatchListOptions =
new WebServiceXGDirect1.WatchListOptions();
// Select watchlists.
clWatchListOptions.Files = new WebServiceXGDirect1.File[1];
clWatchListOptions.Files[0] = new WebServiceXGDirect1.File();
clWatchListOptions.Files[0].Score = 80;
clWatchListOptions.Files[0].Name = "OFAC SDN";
// Call the search.
WebServiceXGDirect1.BISearchResponse clBISearchResponse = clXGDirect1.UnstructuredWire(
clUnstructuredWireRequest,
clWatchListOptions)

Wire
Sends a single EFT or unstructured data string, up to 1 MB in size, to the BIXG server for watchlist
searching using predef ined search settings.

Direct |
Confidential and Proprietary
FIN02829 October 2012

73

For more information on predef ined search settings, see "Direct Watchlist Search Settings Overview"
on page 77. For standard, structured data searches, see "Search" on page 69.
Wire Description
Details
Syntax

BISearchResponse WireCustom(WireRequest WireRequest, WatchListOptions


clPredfinedSearch)

Parameters
clPredefinedSearch

PredefinedSearchclass defining search settings you want BIXG to use when


performing the search
See "PredefinedSearch" on page 99.

WireRequest

WireRequest class defining the search criteria


See "WireRequest" on page 106.

Return Values

BISearchResponse class containing watchlist results

C # E x a mp l e
// Create a Web reference named WebServiceXGDirect1 to the Direct website.
WebServiceXGDirect1.XGDirect1 clXGDirect1 = new WebServiceXGDirect1.XGDirect1();
clXGDirect1.Url = "Direct website";
// Build a SOAP header.
clXGDirect1.AuthenticationHeaderValue =
new WebServiceXGDirect1.AuthenticationHeader();
clXGDirect1.AuthenticationHeaderValue.sCustomerID = "Your Client ID";
clXGDirect1.AuthenticationHeaderValue.sUserID = "Your User ID";
clXGDirect1.AuthenticationHeaderValue.sPassword = "Your Password";
// Create a WireRequest object.
WebServiceXGDirect1.WireRequest clWireRequest new WebServiceXGDirect1.WireRequest()
clWireRequest.Type = WebServiceXGDirect1.WireType.FEDWIRE;

Direct |
Confidential and Proprietary
FIN02829 October 2012

74

clWireRequest.Wire = "{1510}{5100}B*SAMPLE WIRE*{6500}";


// Note: When processing EFT files set the clWireRequest.Wire value to the contents of
// the file. There is a 1 MB size limit.
// Create a WatchListOptions object.
WebServiceXGDirect1.WatchListOptions clWatchListOptions =
new WebServiceXGDirect1.WatchListOptions();
// Select watchlists.
clWatchListOptions.Files = new WebServiceXGDirect1.File[1];
clWatchListOptions.Files[0] = new WebServiceXGDirect1.File();
clWatchListOptions.Files[0].Score = 80;
clWatchListOptions.Files[0].Name = "OFAC SDN";
// Call the search.
WebServiceXGDirect1.BISearchResponse clBISearchResponse = clXGDirect1.Wire(
clWireRequest,
clWatchListOptions)

Direct |
Confidential and Proprietary
FIN02829 October 2012

75

Chapter

In This Chapter

Direct Watchlist
Search Settings
Overview, page 77

D i r e c t Wa t c h l i s t S e a r c h
Settings

General
Search
Options, page
77
Match
Options, page
78
ACH
Options, page
79
Automatic
False Positive
Rules, page
80
Watchlist
Options, page
82

Direct Watchlist Search Settings |


Confidential and Proprietary
FIN02829 October 2012

76

Direct Watchlist Search Settings Overview


LexisNexis Bridger Insight XG (BIXG) Direct allows you to perform watchlist searching against your
input information. Using the Predef inedSearch class, you can def ine many settings that will affect how
BIXG will search the records included in the request. These settings include:
General Search Options, page 77
Match Options, page 78
ACH Options, page 79
Automatic False Positive Rules, page 80
Watchlist Options, page 82
For more information on Predef inedSearch properties, see "Predef inedSearch" on page 99.

General Search Options


Use general search options to control how searches are performed and the potential matches reported.
These options are set in the GeneralSearchOptions class. See "GeneralSearchOptions" on page 93.

Direct Watchlist Search Settings |


Confidential and Proprietary
FIN02829 October 2012

77

General Search Option Descriptions


General Search Option

Description

ScanNameFor
BlockedCountries

True searches name fields for country names included in country watchlists. Name
properties include Business, First, Full, Generation, Middle, and Last.
For example, you select this option and "Bank of Iran" is your input business
name. You search against a country watchlist that contains "Iran"BIXG would
report a potential match because the country name is in a name field.

IgnoreMatches
AgainstVessels

True prevents vessel name matches from being reported.


If you do not do business with entities associated with vessels, you might choose
to select this option to help reduce the false positives reported.

UseNonWorldToken
CountrySearch

True searches for country names in run-together words.

ScanAddressFor
BlockedCountries

True searches unparsed addressesin Street1 and Street2 properties for country
names included in country watchlists.
For example, you select this option and enter "1 Cuba Street, Anytown, AA 00012"
in the Street1 property. You search against a country watchlist that contains
"Cuba"BIXG would report a potential match.

IncreaseScoresfor
FirstNameInitials

True increases the confidence score for matches on first name initials.

IncreaseScoresFor
SingleWordOrg
Names

True increases the confidence score for matches on single-word organization


names. For example, this option may increase scores for matches on acronyms.

Match Options
By default, BIXG uses names (individual or business) to identify candidate records that might become
potential matches. When it f inds close name matches, it uses other input data elements provided to
ref ine the conf idence score. If the conf idence score exceeds minimum score thresholds, the candidate
records are reported as potential matches.

Direct Watchlist Search Settings |


Confidential and Proprietary
FIN02829 October 2012

78

You can set BIXG to consider other data elements (match options) when it is looking for candidate
records. If you choose these options, BIXG compares these input data elements, along with the names,
to list data to identify potential matches. Choosing these options can help you set BIXG to report
matches based on specif ic data types.
These options are set in the MatchOptions class. See "MatchOptions" on page 97.
Match options include:
NameBIXG uses name elements to identify candidate records to perform f inal matching
comparisons against. This option is always selected.
AddressBIXG uses name elements to identify candidate records to perform f inal matching
comparisons against.
IDsBIXG uses name elements to identify candidate records to perform f inal matching
comparisons against.
PhoneNumbersBIXG uses phone elements to identify candidate records to perform f inal
matching comparisons against.
For consistent scoring, you may each record in the request to include the f ields affected by your
selected match options.

ACH Options
The international Automated Clearing House (ACH) transaction (IAT) structure includes two
indicators which are used to communicate that an OFAC match was found for one of the entities
associated with the transaction by screeners external to BIXG. The indicators are: Gateway operator
OFAC screening indicator and Secondary OFAC screening indicator.
BIXG reports a match if it processes an IAT record with either of these indicators present. If BIXG f inds
both indicators in a record, it creates only one record. BIXG reports the match against the originating
entity, and if that entity is not included in the record, it reports the match against the f irst parsed
entity. Along with the match reported because of the indicators, BIXG may also report additional
potential matches for entities associated with the record.
You can conf igure BIXG to not report matches when these indicators are present. These options are set
in the MatchOptions class. See "MatchOptions" on page 97.

Direct Watchlist Search Settings |


Confidential and Proprietary
FIN02829 October 2012

79

ACH options include:


IgnoreGatewayOFACIndicatorACHGatewayOperatorIf set to true, prevents result records from
generating for gateway operator screening indicators.
IgnoreSecondaryOFACIndicatorIf set to true, prevents result records from generating for
secondary screening indicators.

Automatic False Positive Rules


You can set Automatic False Positive rules to help automate decisions that are obvious or clerical in
nature. These rules set an Automatic False Positive status when the input entity name matches a
watchlist entity name, but other selected data elements do not. For example, your organization may
decide to treat all cases where the input entity and list entity are of different gender as false positives.
You can set BIXG to automatically indicate such matches as false positive.
These options are set in the AutomaticFalsePositiveRules class. See "AutomaticFalsePositiveRules" on
page 91.
When a potential match meets an Automatic False Positives rule, the AutomaticFalsePositive property
in the BIRecord class is set to true. See "BIRecord" on page 165.
When multiple potential watchlist matches are reported for an input entity, BIXG only sets the record
status to Automatic False Positive when all matches meet at least one of the selected rules.

Direct Watchlist Search Settings |


Confidential and Proprietary
FIN02829 October 2012

80

When all potential matches for an input entity meet Automatic False Positive rules, you can conf igure
BIXG to not return the result.
Automatic False Positive Rule Descriptions
Automatic False Positive
Rule

Description

DateOfBirth

If set to true, BIXG applies Automatic False Positive rules when the name is a
potential match, but the date of birth matches below a system-defined scoring
threshold.

DateOfBirthTolerance

You can determine how many months input dates of birth can vary from a
watchlist date of birth before a result record is set to Automatic False Positive. For
example, the date of birth in a watchlist record is 4/15/1950. If you enter 2 in the
Tolerance field, an input date of birth between 2/15/1950 and 6/15/1950 would not
be set to Automatic False Positive.

IDs

If set to true, BIXG applies Automatic False Positive rules when the name is a
potential match, but the ID number matches below a system-defined scoring
threshold.

Gender

If set to true, BIXG applies Automatic False Positive rules when the name is a
potential match, but the gender does not match.

Addresses

If set to true, BIXG applies Automatic False Positive rules when the name
generates a potential match, but the address matches below a system-defined
scoring threshold.

Countries

If set to true, BIXG applies Automatic False Positive rules when the name is a
potential match, but the country matches below a system-defined scoring
threshold.

PhoneNumbers

If set to true, BIXG applies Automatic False Positive rules when the name is a
potential match, but the phone number matches below a system-defined scoring
threshold.

Direct Watchlist Search Settings |


Confidential and Proprietary
FIN02829 October 2012

81

Automatic False Positive Rule Descriptions (Continued)


Automatic False Positive
Rule

Description

EntityType

If set to true, BIXG applies Automatic False Positive rules when the name is a
potential match, but the entity type does not match.

Citizenship

If set to true, BIXG applies Automatic False Positive rules when the name is a
potential match, but the citizenship does not match.

DoNotWriteResults

If set to true, BIXG does not return a result if all potential matches for the input
entity meet an Automatic False Positive rule.

Watchlist Options
You can compare your input information to different types of data your organization may have access
to. When this data is referenced together, the general term of "watchlists" is used. These options are set
in the File class. See "File" on page 92.
This data includes:
BankersAccuitys Global WatchListFor more information, see the following knowledge base
article on Client Services at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1555
LexisNexis watchlistsFor more information, see the LexisNexis Watchlists white paper on the
Client Services website at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1439
PEP data setsTypically these are politically exposed persons (PEP) f iles available at an additional
cost. For information on World-Check, refer to the following knowledge base articles on Client
Services at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1460
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1211

White papers are updated regularly. Be sure to access the most recent version to keep informed
about watchlist changes.

Direct Watchlist Search Settings |


Confidential and Proprietary
FIN02829 October 2012

82

Watchlists and data sets are products distinct from BIXG and may require your organization to sign a
separate agreement and meet additional credentialing requirements prior to accessing these services.
For each watchlist, you can set several search options. These include:
NameUse the f ile in the search. You can also set this by selecting the corresponding f ile check
box directly on the Predef ined Search window.
ScoreSet the minimum conf idence score (50-100) a match must meet before it is reported. This is
not a percentage. It indicates how closely the input entity matched the watchlist entity. A score of 90
indicates the match is closer than a potential match with a score of 80. Your organization's risk
tolerance may vary depending on the data matched.
IgnoreWeakAKAsFor certain watchlists, exclude low-quality AKAs in a watchlist record from
being searched. This allows you to focus searches on higher-quality entity information.

Direct Watchlist Search Settings |


Confidential and Proprietary
FIN02829 October 2012

83

Chapter

In This Chapter

Request Class
Overview, page 85
Request Class
Def initions, page
87

Request Classes

Request Classes |
Confidential and Proprietary
FIN02829 October 2012

84

Request Class Overview


For each LexisNexis Bridger Insight XG (BIXG) search request, the settings and input information
provided in the method are often grouped in a class. Each class is made up of multiple properties and/
or other classes. You can use some classes for both Search API and Direct, while other classes are
specif ic to a certain Web service.
You can search watchlists in Search API or Direct. For Search API, depending on your product choice,
you can also search these optional due diligence services:
LexisNexis FraudPoint Score
LexisNexis InstantID
LexisNexis InstantID International

Request Class Hierarchy


This graphic shows the relationship between request classes and which classes are used by each Web
service.

Request Classes |
Confidential and Proprietary
FIN02829 October 2012

85

Request Classes |
Confidential and Proprietary
FIN02829 October 2012

86

Request Class Definitions


This section describes all available request classes. The class def inition lists the class's name, hierarchy,
and description. It also provides a table of class properties with their names, types, and descriptions. If
the property is another class, the type is italicized.

Account
Hierarchy: SearchRequest>Request>Account

The Account class contains input account information.


You can provide an account ID or member ID in the Identif ication request class. See "Identif ication" on
page 95.
Accout Description
Name

Type

Amount

string

Date

string

GroupID

string

OtherData

string

ProviderID

string

Type

string

Description

Account creation date (YYYY-MM-DD)

User-defined information related to the account

User-defined information identifying the type of account

For records searched in Search API, this type


will be listed in the Type dropdown in the BIXG
interface. Consider making this information
consistent for better data management.

Request Classes |
Confidential and Proprietary
FIN02829 October 2012

87

Address
Hierarchy: SearchRequest>Request>Address

The Address class contains input address information.


Address Description
Name

Type

Description

BuildingNumber

string

City

string

Country

string

PostalCode

string

Postal code or area

State

string

State or province

Street1

string

Address line 1
May contain unparsed address information

Street2

string

Address line 2
May contain unparsed address information
This information is not used in InstantID International
searches.

StreetName

string

City or town

Request Classes |
Confidential and Proprietary
FIN02829 October 2012

88

Address Description (Continued)


Name

Type

Description

StreetType

string

For example: Avenue, Drive, Street, Boulevard

SubBuildingNumber

string

For example: unit, suite, apartment, or flat number

Type

AddressType

Type of address
Enumeration:
Current
Mailing
Previous
Unknown

If you provide an address, you must specify a


type. "None" is not a valid type.

AssignResultsTo
Hierarchy: AssignResultsTo

This class is only available for Search API.


The AssignResultsTo class assigns result records flagged as alerts to specif ied roles or users. You can
also restrict record access to a division. See the Smart Client User Manual, "Alert Processing" section.

Request Classes |
Confidential and Proprietary
FIN02829 October 2012

89

Divisions, roles, and users are set up through a Smart Client. See the Smart Client User Manual, "User
Access" chapter.
AssignResultsTo Description
Name

Type

Description

Division

string

Restricts result record access to the specified division


Only users in that division can process the alerts.

EmailNotification

bool

True sends a single email message to each user or users in


specified roles who were assigned alerts for each completed
search request

If the results are restricted to division, only


users within a role that has access to that
division will receive an email message.

Default: false
RecordAssignmentType

BIRecordAssignment
Type

Specifies if you are assigning alerts to roles or users


Enumeration:
RECORD_ASSIGN_ROLE
RECORD_ASSIGN_USER

Roles

List<string>

Roles to be assigned alerts


If multiple roles are specified, the alerts are assigned to all
specified roles.

If you included a Division property, only users


within the roles that have access to the
specified division can process the alerts.

This property is typically used when the search request


contains an array of records.
Users

List<string>

Users to be assigned alerts


If multiple users are selected, alerts are assigned to single
users in a round-robin fashion.

If you included a Division property, only users


who have access to the specified division will
be assigned alerts.

Request Classes |
Confidential and Proprietary
FIN02829 October 2012

90

AuthenticationHeader
Hierarchy: AuthenticationHeader

The AuthenticationHeader class provides the SOAP authentication header used to gain access to BIXG
Web Services.
AuthenticationHeader Description
Name

Type

Description

sCustomerID

string

Client ID identifying the BIXG instance of the user sending the


request

sPassword

string

Password of the user sending the request


See "BIXG Passwords" on page 19.

sUserID

string

Credential identifying the user sending the request

The user must have BIXG role privileges


related to the actions being performed. See
the Smart Client User Manual, Roles section.

AutomaticFalsePositiveRules
Hierarchy: PredefinedSearch>WatchListOptions>AutomaticFalsePositiveRules

This class is only available for Direct.

Request Classes |
Confidential and Proprietary
FIN02829 October 2012

91

The AutomaticFalsePositiveRules class def ines your Automatic False Positive rules. For more
information, see "Automatic False Positive Rules" on page 80.
AutomaticFalsePositiveRules Description
Name

Type

Description

Addresses

bool

Default: false

Citizenship

bool

Default: false

Countries

bool

Default: false

DateOfBirth

bool

Default: false

DateOfBirthTolerance

int

Default: 0

DoNotWriteResults

bool

Default: false

EntityType

bool

Default: true

Gender

bool

Default: false

IDs

bool

Default: false

PhoneNumbers

bool

Default: false

File
Hierarchy: PredefinedSearch>WatchListOptions>Files>File

This class is only available for Direct.


The File class def ines the settings for each watchlist to be searched. You cannot search against accept
lists or custom watchlists in Direct. For more information, see "Watchlist Options" on page 82.

Request Classes |
Confidential and Proprietary
FIN02829 October 2012

92

When entering watchlist names, you must enter the exact f ile name without the f ile extension (.bdf,
.cdf ). For LexisNexis watchlist f ile names, see the LexisNexis Watchlists white paper on the Client
Services website at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1439
For BankersAccuitys Global WatchList f ile names, see the following knowledge base article on Client
Services at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1555
The World-Check Premium Plus f ile name is WorldCheck Premium Plus. For standard World-Check
f ile names, refer to the following knowledge base article on Client Services at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1211
For Dow Jones Watchlist f ile names, refer to the following knowledge base article on Client Services at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=732
File Description
Name

Type

Description

IgnoreWeakAKAs

boolean

Default: false

Name

string

Watchlist name without the file extension (.bdf, .cdf)

Score

int

Default: 80

Lower minimum scores may increase the


potential matches reported. Test different
settings to determine the ones that best
suit your organization's risk tolerance.

GeneralSearchOptions
Hierarchy: PredefinedSearch>WatchListOptions>GeneralSearchOptions

This class is only available for Direct.

Request Classes |
Confidential and Proprietary
FIN02829 October 2012

93

The GeneralSearchOptions class def ines your general watchlist search options. For more information,
see "General Search Options" on page 77.
GeneralSearchOptions Description
Name

Type

Description

GenerateResultsForAll
RecordsChecked

bool

True returns a result record for each search performed, even if


no potential matches were reported
Default: false

IgnoreMatches
AgainstVessels

bool

Default: false

IncreaseScoresfor
FirstNameInitials

bool

IncreaseScoresForSingle
WordOrgNames

bool

ScanAddressFor
BlockedCountries

bool

Default: false

ScanNameFor
BlockedCountries

bool

Default: false

UseNonWordToken
CountrySearch

bool

Request Classes |
Confidential and Proprietary
FIN02829 October 2012

94

Identification
Hierarchy: SearchRequest>Request>Identification

The Identif ication class contains input ID information.


Identification Description
Name

Type

Description

DateExpires

DateTime

Date the ID expires (YYYY-MM-DD)

DateIssued

DateTime

Date the ID was issued (YYYY-MM-DD)

IssuedBy

string

Issuing state or country

Label

string

User-defined ID information
For Search API, you can only view this label in a BIXG interface
for ID numbers with an Other ID type.

MachineReadable1

string

Machine-readeable line for passports or visas

MachineReadable2

string

Machine-readeable line for passports or visas

Number

string

Type

IDType

For possible values, see "Possible ID Types" on page 95.

Possible ID Types
The following are possible Type values:
None (Returned for results only)

BankPartyID

ABARouting

Cedula

AccountID

ChipsUID

AlienRegistration

CustomerNumber

BankIdentif ierCode

DriversLicense

Request Classes |
Confidential and Proprietary
FIN02829 October 2012

95

DUNS

NIT

EFTCode

OtherID

EIN

Passport

GlobalLocationNumber

Proprietary_UID

IBAN

SSN

IBEI

SwiftBEI

MemberID

SwiftBIC

MilitaryID

TaxID

NationalID

Visa

Information
Hierarchy: SearchRequest>Request>Information

The Information class contains additional information to help identify the input entity.
Information Description
Name

Type

Description

Info

string

User-defined input entity information

Type

InfoType

For possible values, see "Possible Information Types" on page


96.

Possible Information Types


The following are possible Type values:
Citizenship

EyeColor

Complexion

HairColor

DateOfBirth

Height

DistinguishingMarks

Incident

Request Classes |
Confidential and Proprietary
FIN02829 October 2012

96

IP Address

VesselCallSign

MothersMaidenName

VesselFlag

Nationality

VesselGRT

Occupation

VesselOwner

OtherInfo

VesselTonnage

PlaceOfBirth

VesselType

Position

Weight

Race

"None" is not a valid type.

MatchOptions
Hierarchy: PredefinedSearch>WatchListOptions>MatchOptions

This class is only available for Direct.


The MatchOptions class def ines data element match options and ACH (Automated Clearing House)
match options. For more information, see "Match Options" on page 78 and "ACH Options" on page 79.
MatchOptions Description
Name

Type

Description

Address

bool

Default: true

IDs

bool

Default: true

IgnoreGatewayOFAC
Indicator

bool

Default: false

IgnoreSecondary
OFACIndicator

bool

Default: false

PhoneNumbers

bool

Default: true

Request Classes |
Confidential and Proprietary
FIN02829 October 2012

97

Name
Hierarchy: SearchRequest>Request>Name

The Name class contains the input name and gender information.
Name Description
Name

Type

Description

Business

string

Required for business entity types.

First

string

First and Last or Full required for individual entity types. All
records within a search request must contain the same
properties.

Full

string

Required for unknown entity types.


First and Last or Full required for individual entity types. All
records within a search request must contain the same
properties.

Records with a full name can only be


searched against watchlists.

Gender

string

Only include for individual entity types. Required if passport


information is provided for an InstantID International search.

Generation

string

Entity's generation (i.e. Jr., III)only include for individual


entity types.

Last

string

First and Last or Full required for individual entity types. All
records within a search request must contain the same
properties.

Middle

string

Only include for individual entity types.

Text

string

Required for text entity type.

Title

string

Only include for individual entity types.

Request Classes |
Confidential and Proprietary
FIN02829 October 2012

98

Phone
Hierarchy: SearchRequest>Request>Phone

The Phone class contains input phone number information.


Phone Description
Name

Type

Description

Number

string

Phone number
This must be a 10-digit number.

Type

PhoneType

Possible values:
None (Returned for results only)
Business
Cell
Fax
Home
Work
Unknown

"None" is not a valid type.

PredefinedSearch
Hierarchy: PredefinedSearch

This class is only available for Direct.


The Predef inedSearch class def ines the settings used in a search.

Request Classes |
Confidential and Proprietary
FIN02829 October 2012

99

These settings affect your organization's results. Test these settings thoroughly before including
them in your business process.

PredefinedSearch Description
Name
WatchListOptions

Type
WatchListOptions

Description
Watchlist search settings
See "WatchListOptions" on page 106.

Request
Hierarchy: SearchRequest>Request

The Request class contains an input record for an individual, business, unknown, or text entity to be
searched. For more information on data you can search, see "Searchable Data" on page 19.
Request Description
Name

Type

Description

Account

Account

Account information
See "Account" on page 87.

AdditionalInformation

List<Information>

Array of additional input entity information


For example: date of birth, weight, or mother's maiden name
Date of birth is required if passport information is provided for
an InstantID International search.
See "Information" on page 96.

Addresses

List<Address>

Array of address information


An address is required for InstantID business searches.
See "Address" on page 88.

Request Classes | 100


Confidential and Proprietary
FIN02829 October 2012

Request Description (Continued)


Name
Entity

Type
Entity

Description
Entity type
Enumeration:
Individual
Business
Unknown
Text
This property is required for all searches.

Records with an unknown or text entity type


can only be searched against watchlists.

Identifications

List<Identification>

Array of identification information


See "Identification" on page 95.

Name

Name

Name information
Required for all searches.
See "Name" on page 98.

Phones

List<Phone>

Array of phone information


See "Phone" on page 99.

SearchRequest
Hierarchy: SearchRequest

The SearchRequest class contains parsed, or structured, input records to be searched and session
information.

Request Classes | 101


Confidential and Proprietary
FIN02829 October 2012

A maximum of 100 records can be sent in one request. BIXG automatically numbers these records from
0-99. You can use these numbers to track which records did not have watchlist matches.
SearchRequest Description
Name

Type

Description

Requests

List<Request>

Array of requests
See "Request" on page 100.

Session

Session

Session properties needed for the search


For Search API, this class is required forInstantID or
FraudPoint Score searches.
See "Session" on page 102.

Session
Hierarchy: SearchRequest>Session

The Session class contains the client reference and compliance use codes.
Session Description
Name

Type

Description

ClientReference

string

Optional user-defined property you may provide to identify


the request
This property is returned in BIClientReference. See
"BIClientReference" on page 130.

DPPA

int

DPPA code required for InstantID or FraudPoint Score


searches
For more information, see "DPPA Codes" on page 104.

GLB

int

Permissible purpose required for InstantID or FraudPoint


Score searches
For more information, see "GLB Permissible Use Codes" on
page 103.

Request Classes | 102


Confidential and Proprietary
FIN02829 October 2012

GLB Permissible Use Codes


This table displays a list of GLB codes for InstantID or FraudPoint Score. To obtain a list of your
available GLB codes, view the Select GLB Permissible Purpose window when you log in to BIXG.
GLB Permissible Use Code Descriptions
Description

Code

Fraud Prevention or Detection


For use to protect against or prevent actual or potential fraud, unauthorized transactions, claims, or
other liability

Legal Compliance
For use to comply with Federal, State, or local laws, rules, and other applicable legal requirements

Required Institutional Risk Control


For required institutional risk control, or for resolving customer disputes or inquiries

Transactions Authorized by Consumer


As necessary to effect, administer, or enforce a transaction requested or authorized by the consumer

Use by Persons Acting in a Fiduciary Capacity on Behalf of the Consumer


For use by persons acting in a fiduciary or representative capacity on behalf of the consumer

12

Use by Persons Holding a Legal or Beneficial Interest Relating to the Consumer


For use by persons holding a legal or beneficial interest relating to the consumer

No Permissible Purpose
Resolving Customer Disputes or Inquiries
As allowed by the Right to Financial Privacy Act of 1978

Request Classes | 103


Confidential and Proprietary
FIN02829 October 2012

DPPA Codes
This table displays a list of all potentially-valid DPPA choices and their descriptions for InstantID or
FraudPoint Score.
DPPA Code Descriptions
Description

Code

Litigation
Use in connection with a civil, criminal, administrative, or arbitral proceeding, including the service of
process, investigation in anticipation of litigation, the execution or enforcement of judgments, or
compliance with the orders of any court.1

Debt Recovery/Fraud
For use in the normal course of business but only to verify the accuracy of personal information
submitted by the individual to the business; and if the submitted information is incorrect, to obtain the
correct information, but only for the purposes of preventing fraud by, pursuing legal remedies against, or
recovering on a debt or security interest against, the individual.

Government Agency or On Government Behalf


Use by a court, law enforcement agency or other government agency or entity, acting directly on behalf
of a government agency.

Insurer
Use by an insurer or insurance support organization, in connection with claims investigation activities or
antifraud activities.

Motor Vehicle
Use for any matter regarding motor vehicle or driver safety or theft (except by motor vehicle
manufacturers).

No Permissible Purpose

Request Classes | 104


Confidential and Proprietary
FIN02829 October 2012

UnstructuredWireRequest
Hierarchy: UnstructuredWireRequest

This class is only available for Direct.


The UnstructuredWireRequest class contains up to 100 unstructured data strings, up to 1 MB in size
each, to be searched. BIXG does not return the input information from this search. For more
information on data you can search, see "Searchable Data" on page 19.
UnstructuredWireRequest Description
Name

Type

Description

Session

Session

Session information
See "Session" on page 102.

Wires

List<string>

Array of strings containing EFT or unstructured data

UpdateAssignResultsTo
Hierarchy: UpdateAssignResultsTo

This class is only available for Search API.


The UpdateAssignResultsTo class changes who a result record is assigned to.
UpdateAssignResultsTo Description
Name

Type

Description

RecordAssignmentType

BIRecordAssignment
Type

Indicates if you are assigning the record to a role or user


Enumeration:
RECORD_ASSIGN_ROLE
RECORD_ASSIGN_USER

RoleOrUser

string

Name of the role or user

Request Classes | 105


Confidential and Proprietary
FIN02829 October 2012

WatchListOptions
Hierarchy: PredefinedSearch>WatchListOptions

This class is only available for Direct.


The WatchListOptions class def ines watchlist search settings.
WatchListOptions Description
Name

Type

Description

AutomaticFalsePositive
Rules

AutomaticFalsePositive
Rules

Automatic False Positives rules


See "AutomaticFalsePositiveRules" on page 91.

Files

List<File>

Array of watchlists to be searched


See "File" on page 92.

GeneralSearchOptions

GeneralSearchOptions

General search options


See "GeneralSearchOptions" on page 93.

MatchOptions

MatchOptions

Match options
See "MatchOptions" on page 97.

WireRequest
Hierarchy: WireRequest

The WireRequest class contains EFT (electronic funds transfer) or unstructured data to be searched.
For more information on data you can search, see "Searchable Data" on page 19.

Request Classes | 106


Confidential and Proprietary
FIN02829 October 2012

A single text string with a maximum size of 1 MB can be sent in one request. BIXG does not return the
input information that was searched using the Unstructured wire type.
WireRequest Description
Name

Type

Description

Session

Session

Session information
See "Session" on page 102.

Type

WireType

Entity type
Enumeration:
None
Unstructured (for unparsed data)
ACH
This format includes IAT (international ACH transaction).
Fedwire
This format includes FAIM 3.0.
ISO20022
This format includes pain.001.001.02.
XML within the request must be encoded before
processing.
Swift
This format includes MT 101, MT 103, MT 202, MT 202
COV, MT 740 and MT 742.

Wire

string

String containing EFT or unstructured data

Request Classes | 107


Confidential and Proprietary
FIN02829 October 2012

Chapter

In This Chapter

Response Class
Overview, page
109

Response Classes

Response Class
Def initions, page
114
Response
Examples, page
205

Response Classes | 108


Confidential and Proprietary
FIN02829 October 2012

Response Class Overview


Result information from a LexisNexis Bridger Insight XG (BIXG) search request is returned as
objects. This information is then def ined by response classes. The following response class hierarchies
provide a high-level view of the possible classes that can be returned in a search response. You may
have watchlist results from searches performed in Search API or Direct. For Search API, you may also
have results from these optional due diligence services:
LexisNexis FraudPoint Score
LexisNexis InstantID
LexisNexis InstantID International

Response Class Hierarchy


This graphic shows the main response classes. A dotted line around a class indicates the hierarchy
extends to another graphic to follow.

Response Classes | 109


Confidential and Proprietary
FIN02829 October 2012

BIBusinessInstantID Class Hierarchy


This graphic shows the response classes for InstantID business results. These classes are only returned
in Search API.

Response Classes | 110


Confidential and Proprietary
FIN02829 October 2012

BIFraudPoint Class Hierarchy


This graphic shows the response classes for FraudPoint Score results. These classes are only returned in
Search API.

BIInstantID Class Hierarchy


This graphic shows the response classes for InstantID individual results. These classes are only
returned in Search API.

Response Classes | 111


Confidential and Proprietary
FIN02829 October 2012

BIInstantIDIntl Class Hierarchy


This graphic shows the response classes for InstantID International results. These classes are only
returned in Search API.

BIRecordInfo Class Hierarchy


This graphic shows the response classes for your returned input information.

Response Classes | 112


Confidential and Proprietary
FIN02829 October 2012

Response Classes | 113


Confidential and Proprietary
FIN02829 October 2012

BIMatch Class Hierarchy


This graphic shows the response classes for watchlist results.

Response Class Definitions


This section describes all available response classes. The class def inition lists the class name, hierarchy,
and description. It also provides a table of properties with their names, types, and descriptions. If the
property is another class, the type is italicized.

Response Classes | 114


Confidential and Proprietary
FIN02829 October 2012

BIAchNote
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIAchWire>BIAchNote

The BIAchNote class contains ACH note input information.


BIAchNote Description
Name

Type

AuthorizationCodeOrCardExpirationDate

string

ChangeCode

string

ContestedDishonoredReturnReasonCode

string

CORTraceSequenceNumber

string

DateOfDeath

string

DateOriginalEntryReturned

string

DishonoredReturnReasonCode

string

DishonoredReturnSettlementDate

string

DishonoredReturnTraceNumber

string

ForeignPaymentAmount

string

ForeignTraceNumber

string

NetworkIdentificationCode

string

Note

string

OriginalEntryTraceNumber

string

Description

Response Classes | 115


Confidential and Proprietary
FIN02829 October 2012

BIAchNote Description (Continued)


Name

Type

OriginalForwardEntryPaymentAmount

string

OriginalReceivingDFIdentification

string

OriginalSettlementDate

string

ReceiverIdentificationNumber

string

ReferenceInformation1

string

ReferenceInformation2

string

RefusedCORCode

string

ReturnReasonCode

string

ReturnSettlementDate

string

ReturnTraceNumber

string

SequenceNumber

string

TerminalIdentificationCode

string

TraceNumber

string

TransactionDate

string

TransactionDescription

string

TransactionSerialNumber

string

Description

Response Classes | 116


Confidential and Proprietary
FIN02829 October 2012

BIAchNote Description (Continued)


Name

Type

TransactionTime

string

TransactionTypeCode

string

Type

string

Description

BIAchParty
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIAchWire>BIAchParty

The BIAchParty class contains ACH party input information.


BIAchParty Description
Name

Type

Description

AdditionalInfoList

List<string>

AddressList

List<BIAchParty
Address>

Array of addresses
See "BIAchPartyAddress" on page 119.

IDList

List<BIAchPartyID>

Array of party ID numbers


See "BIAchPartyID" on page 120.

Name

string

Type

WirePartyType

See "Party Types" on page 117.

Party Types
The following are the possible party types that can be returned for EFT searches:
None

AccountCredited

Response Classes | 117


Confidential and Proprietary
FIN02829 October 2012

AccountDebited

IntermediaryAgent

AccountIdentif ication

IntermediaryAgentAccount

AccountServicingFI

IntermediaryFI

AccountWithInstitution

InstructingFI

AdviseThroughFI

InstructingParty

Applicant

Issuer

ApplicantFI

IssuingFI

AvailableWithFI

Invoicee

Benef iciary

Invoicer

Benef iciaryFI

NegotiatingFI

ChargesAccount

OrderingCustomer

ChargesAccountAgent

OrderingFI

ChequeDeliverTo

OriginalCreditMandateSigner

ChequeFrom

OriginalCreditorAgent

Contact

OriginalCreditorAgentAccount

CorrespondentFI

OriginalDebtor

CreditMandateSigner

OriginalDebtorAccount

Creditor

OriginalDebtorAgent

CreditorAccount

OriginalDebtorAgentAccount

CreditorAgent

OriginalReceivingFI

CreditorAgentAccount

Originator

Debtor

OriginationFI

DebtorAccount

PrimaryDocumentIssuer

DebtorAgent

Principal

DebtorAgentAccount

Receiver

DocumentIssuer

ReceiversCorrespondent

Drawee

ReceivingFI

ForwardingAgent

ReimbursingFI

InitiatingParty

Remittance

Response Classes | 118


Confidential and Proprietary
FIN02829 October 2012

SecondaryDocumentIssuer

ThirdReimbursementFI

SenderOfCashLetter

UltimateCreditor

SendersCorrespondent

UltimateDebtor

SendingFI

BIAchPartyAddress
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIAchWire>BIAchParty>BIAchPartyAddress

The BIAchPartyAddress class contains ACH party address input information.


BIAchPartyAddress Description
Name

Type

City

string

CityStateProvince

string

Country

string

CountryPostalCode

string

PostalCode

string

StateProvince

string

StreetAddress

string

Type

AddressType

Description

Type values:
None
Current
Mailing
Previous
Unknown

Response Classes | 119


Confidential and Proprietary
FIN02829 October 2012

BIAchPartyID
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIAchWire>BIAchParty>BIAchPartyID

The BIAchPartyID class contains ACH party ID input information.


BIAchPartyID Description
Name

Type

Number

string

Type

IDType

Description

For possible values, see "Possible ID


Types" on page 95.

BIAchWire
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIAchWire

The BIAchWire class contains ACH input information. For information on record content and format,
see: www.nacha.org
BIAchWire Description
Name

Type

BatchNumber

string

CardExpirationDate

string

CardTransactionTypeCode

string

CompanyEntryDescription

string

CompanyEntry DescriptiveDate

string

EffectiveEntryDate

string

Description

Response Classes | 120


Confidential and Proprietary
FIN02829 October 2012

BIAchWire Description (Continued)


Name

Type

Description

FileCreationDate

string

FileCreationTime

string

FileIdentification

string

ForeignExchangeIndicator

string

ForeignExchangeReference

string

ForeignExchangeReferenceIndicator

string

GatewayOperatorOFACScreeningIndicator

string

IATIndicator

string

IdentificationNumber

string

ISODesitinationCountryCode

string

ISODestinationCurrencyCode

string

ISOOriginatingCurrencyCode

string

NoteList

List<BIAchNote>

Array of notes
See "BIAchNote" on page 115.

PartyList

List<BIAchParty>

Array of parties
See "BIAchParty" on page 117.

ItemTypeIndicator

string

JulianDateOnWhichThisAdviceIsCreated

string

Response Classes | 121


Confidential and Proprietary
FIN02829 October 2012

BIAchWire Description (Continued)


Name

Type

PaymentTypeCode

string

ProcessControlField

string

ReferenceCode

string

RefusedAcknowledgmentCode

string

SecondaryOFACScreeningIndicator

string

ServiceClassCode

string

SettlementDate

string

StandardEntryClassCode

string

TotalAmount

string

TraceNumber

string

TransactionCode

string

Description

Response Classes | 122


Confidential and Proprietary
FIN02829 October 2012

BIAdditionalInfo
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIAdditionalInfo
Hierarchy: BISearchResponse>BIRecord>BIWatchList>BIMatch>BIEntity>BIAdditionalInfo

The BIAdditionalInfo class contains additional information provided for the input entity or a watchlist
entity.
BIAdditionalInfo Description
Name

Type

Comments

string

Information

string

Type

InfoType

Description
Uncategorized additional entity
information

For possible values, see "Possible


Information Types" on page 96.

BIAddress
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIAddress
Hierarchy: BISearchResponse>BIRecord>BIWatchList>BIMatch>BIEntity>BIAddress

The BIAddress class contains address information provided for the input entity or a watchlist entity.
BIAddress Description
Name

Type

Description

City

string

City or town

Comments

string

Uncategorized additional watchlist entity


information

Country

string

Response Classes | 123


Confidential and Proprietary
FIN02829 October 2012

BIAddress Description (Continued)


Name

Type

Description

PostalCode

string

Postal code or area

State

string

State or province

Street1

string

Address line 1
May contain unparsed address
information

Street2

string

Address line 2
May contain unparsed address
information

Type

AddressType

Type values:
None (Returned for results only)
Current
Mailing
Previous
Unknown (Returned for results only)

Response Classes | 124


Confidential and Proprietary
FIN02829 October 2012

BIAddressMatch
Hierarchy: BISearchResponse>BIRecord>BIWatchList>BIMatch>BIAddressMatch

The BIAddressMatch class contains address match information for watchlist searches.
BIAddressMatch Description
Name

Type

Description

AddressType

AddressType

Type values:
None (Returned for results only)
Current
Mailing
Previous
Unknown (Returned for results only)

InputValue

string

Input address combined into one return


value

ListValue

string

Watchlist address

Score

int

Address score

Response Classes | 125


Confidential and Proprietary
FIN02829 October 2012

BIAKA
Hierarchy: BISearchResponse>BIRecord>BIWatchList>BIMatch>BIEntity>BIAKA

The BIAKA class contains alternative names for a watchlist entity.


BIAKA Description
Name

Type

Description

Comments

string

Uncategorized additional entity


information

MatchStrength

BIMatchStrength

Match strength indicator for a potential


watchlist match
See "BIMatchStrength" on page 159.

Name

BIName

See "BIName" on page 161.

Type

AKAType

Possible values:
None
AKA (also known as)
FKA (formerly known as)
NKA (now known as)

Response Classes | 126


Confidential and Proprietary
FIN02829 October 2012

BIAuditItem
Hierarchy: BIUpdateResponse>BIRecordInfo>BIAuditItem

The BIAuditItem contains changes made to the result record.


BIAuditItem Description
Name

Type

Description

Date

DateTime

Date and time the change occurred

Event

string

Possible strings:
Added to Accept List
Added to Custom Watchlist
Alert Checkout
Alert Closed
Alert Created
Alert Open
Alert threshold met
Attachment Deleted
Due Diligence Search Conducted
Factiva Media search conducted
Merged to Accept List
Note Added
OFAC Report Generated
Reassigned
Record Created
Record created by legacy conversion on
<Date>
Record created in legacy product.
Record Details Changed
Record Rerun
Status Changed
Watchlist Search Conducted

User

string

User who made the change

Note

string

User-defined information

Response Classes | 127


Confidential and Proprietary
FIN02829 October 2012

BIBusinessInstantID
Hierarchy: BISearchResponse>BIRecord>BIBusinessInstantID

The BIBusinessInstantID class contains InstantID business results if you searched against this optional
due diligence service.
For possible index descriptions, see the LexisNexis InstantIDAnalyzing Results white paper on the
Client Services website at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1442
BIBusinessInstantID Description
Name

Type

Description

BankruptcyFilingsCount

int

Number of bankruptcy filings

ComprehensiveVerificationIndex

int

Overall risk index(0, 10, 20, 30, 40 or 50)

CorrectedCompanyName

string

Errors

List<BIError>

Array of error information


See "Error Class" on page 212.

FEINMatchResults

List<IIDFEINMatch
Result>

Array of FEIN information


See "IIDFEINMatchResult" on page 191.

Input

IIDInput

Input information
See "IIDInput" on page 199.

IIDReversePhone

IIDReversePhone

Associated name and address information


See "IIDReversePhone" on page 203.

MostRecentBankrupctyFiling

IIDFiling

MostRecentJudgmentFiling

IIDFiling

Most recent bankruptcy and judgment


information
See "IIDFiling" on page 191.

Response Classes | 128


Confidential and Proprietary
FIN02829 October 2012

BIBusinessInstantID Description (Continued)


Name

Type

Description

NameAddressPhoneIndicator

int

Business name-address-phone
verification index used to calculate the
overall risk index returned in the
ComprehensiveVerificationIndex property

NameAddressFEINIndicator

int

Business name-address-FEIN verification


index used to calculate the overall risk
index returned in the
ComprehensiveVerificationIndex property

NameAddressSSNIndicator

int

Business name-address-SSN verification


index used to calculate the overall risk
index returned in the
ComprehensiveVerificationIndex property

PhoneOfNameAddress

string

Phone number related to the name and


address

Phonetype

string

Possible values:
B = Blank Input
0 = Residential
2 = Business
7 = Mobile/Cellular
8 = Pager

ReleasedJudgmentLienCount

int

Number of released judgments

RiskIndicators

List<IIDIndicator>

Array of risk codes


See "IIDIIndicator" on page 196.

Response Classes | 129


Confidential and Proprietary
FIN02829 October 2012

BIBusinessInstantID Description (Continued)


Name

Type

Description

UnreleasedJudgmentLienCount

int

Number of unreleased judgments

VerificationIndicators

IIDVerificationIndicators

Business verification results


See "IIDVerificationIndicators" on page
204.

VerifiedInput

IIDInput

Input information found in InstantID data


sources
See "IIDInput" on page 199.

BIClientReference
Hierarchy: BISearchResponse>BIClientReference

The BIClientReference class def ines the client reference.


BIClientReference Description
Name
Reference

Type
string

Description
Optional user-defined property provided
in the call you may use to identify the
request

Response Classes | 130


Confidential and Proprietary
FIN02829 October 2012

BICountry
Hierarchy: BISearchResponse>BIRecord>BIWatchList>BIMatch>BICountry

The BICountry class contains the best watchlist match information and details for a watchlist country.
This class is only returned for watchlist matches on country records.
BICountry Description
Name

Type

Description

AKAList

List<string>

Array of AKAs provided by the source


agency that are associated with the
country

CityList

List<string>

Array of cities provided by the source


agency that are associated with the
country

Comments

string

Uncategorized additional entity


information

Country

string

Country listed in the record

CountryCodeList

List<string>

Array of country codes provided by the


source agency that are associated with
the country

CountryTermList

List<string>

Array of country terms provided by the


source agency that are associated with
the country

DateListed

string

Date the country was added to the


watchlist

Response Classes | 131


Confidential and Proprietary
FIN02829 October 2012

BICountry Description (Continued)


Name

Type

Description

EntityType

ResponseEntityType

Possible values:
None
Unknown
Individual
Business
Vessel
Wire
Text

ListReferenceNumber

string

Source list reference number used by


LexisNexis

PortsList

List<string>

Array of ports provided by the source


agency that are associated with the
country

ReasonListed

string

Reason the country was added to the


watchlist

Response Classes | 132


Confidential and Proprietary
FIN02829 October 2012

BIDaysUntilPasswordExpires
Hierarchy: BISearchResponse>BIDaysUntilPasswordExpires

The BIDaysUntilPasswordExpires class indicates how many days until the password associated with the
BIXG user ID used in the search request expires. This class is only returned if the password will expire
in 10 or less days.
BIDaysUntilPasswordExpires Description
Name
Days

Type
int

Description
Days left until the password associated
with the BIXG user ID used in the search
request expires

BIDOBMatch
Hierarchy: BISearchResponse>BIRecord>BIMatch>BIDOBMatch

The BIDOBMatch class returns DOB match information for watchlist searches.
BIDOBMatch Description
Name

Type

InputValue

string

ListValue

string

Score

int

Description

Date of birth match score (0-100) used to


help calculate the overall confidence
score

Response Classes | 133


Confidential and Proprietary
FIN02829 October 2012

BIEntity
Hierarchy: BISearchResponse>BIRecord>BIWatchList>BIMatch>BIEntity

The BIEntity class contains watchlist information, including the watchlist record that best matched
your entity. This class is only returned if a watchlist search was performed and reported a match on an
entity record.
BIEntity Description
Name

Type

Description

AdditionalInfoList

List<BIAdditionalInfo>

Array of additional information


See "BIAdditionalInfo" on page 123.

AddressList

List<BIAddress>

Array of address information


See "BIAddress" on page 123.

AKAList

List<BIAKA>

Array of AKA information


See "BIAKA" on page 126.

Comments

string

Uncategorized additional entity


information

DateListed

string

Date the entity was added to the watchlist

Gender

string

Possible strings:
Female
Male
None
Unknown

IDList

List<BIID>

Array of ID information
See "BIID" on page 146.

Name

BIName

See "BIName" on page 161.

PhoneList

List<BIPhone>

Array of phone information


See "BIPhone" on page 163.

Response Classes | 134


Confidential and Proprietary
FIN02829 October 2012

BIEntity Description (Continued)


Name

Type

Description

EntityType

ResponseEntityType

Possible values:
None
Unknown
Individual
Business
Vessel
Wire
Text

ListReferenceNumber

string

Source list reference number used by


LexisNexis

ReasonListed

string

Reason the entity was added to the


watchlist

BIFedwireAdjustment
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIFedwireWire>BIFedwireAdjustment

The BIFedwireAdjustment class contains Fedwire adjustment input information.


BIFedwireAdjustment Description
Name

Type

AdditionalInformation

string

AdjustmentReasonCode

string

Description

Response Classes | 135


Confidential and Proprietary
FIN02829 October 2012

BIFedwireAdjustment Description (Continued)


Name

Type

Amount

string

CreditDebitIndicator

string

CurrencyCode

string

Description

BIFedwireAmount
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIFedwireWire>BIFedwireAmount

The BIFedwireAmount class contains Fedwire transaction amount input information.


BIFedwireAmount Description
Name

Type

Amount

string

CurrencyCode

string

Description

Response Classes | 136


Confidential and Proprietary
FIN02829 October 2012

BIFedwireDocument
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIFedwireWire>BIFedwireDocument

The BIFedwireDocument class contains Fedwire document input information.


BIFedwireDocument Description
Name

Type

DocumentIdentificationNumber

string

DocumentTypeCode

string

Issuer

string

ProprietaryDocumentTypeCode

string

Tag

int

Description

BIFedwireNote
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIFedwireWire>BIFedwireNote

The BIFedwireNote class contains Fedwire note input information.


BIFedwireNote Description
Name

Type

Note

string

Tag

string

Description

Response Classes | 137


Confidential and Proprietary
FIN02829 October 2012

BIFedwireParty
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIFedwireWire>BIFedwireAParty

The BIFedwireParty class contains Fedwire party input information.


BIFedwireParty Description
Name

Type

Description

AdditionalInfoList

List<BIFedwireParty
AdditionalInfo>

Array of additional information


See "BIFedwirePartyAdditionalInfo" on
page 139.

AddressList

List<BIFewireParty
Address>

Array of address information


See "BIFedwirePartyAddress" on page
139.

EntityType

ResponseEntityType

Possible values:
None
Unknown
Individual
Business
Vessel
Wire
Text

PhoneList

List<FedwireParty
Phone>

Array of phone numbers


See "BIFedwirePartyPhone" on page 142.

FieldList

List <string>

IDList

List<BIFedwirePartyID>

Name

string

Type

WirePartyType

Array of party ID numbers


See "BIFedwirePartyID" on page 141.

See "Party Types" on page 117.

Response Classes | 138


Confidential and Proprietary
FIN02829 October 2012

BIFedwirePartyAdditionalInfo
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIFedwireWire>BIFedwireParty>BIFedwirePa
rtyAdditionalInfo

The BIFedwirePartyAdditionalInfo class contains Fedwire party additional input information.


BIFedwirePartyAdditionalInfo Description
Name

Type

Country

string

Info

string

ParsedInfo

string

Type

InfoType

Description

For possible values, see "Possible


Information Types" on page 96.

BIFedwirePartyAddress
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIFedwireWire>BIFedwireParty>BIFedwirePa
rtyAddress

The BIFedwirePartyAddress class contains Fedwire party address input information.


BIFedwirePartyAddress Description
Name

Type

AddressLine1

string

AddressLine2

string

AddressLine3

string

Description

Response Classes | 139


Confidential and Proprietary
FIN02829 October 2012

BIFedwirePartyAddress Description (Continued)


Name

Type

AddressLine4

string

AddressLine5

string

AddressLine6

string

AddressLine7

string

BuildingNumber

string

City

string

Country

string

Department

string

PostalCode

string

StateProvince

string

StreetName

string

SubDepartment

string

Description

Response Classes | 140


Confidential and Proprietary
FIN02829 October 2012

BIFedwirePartyID
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIFedwireWire>BIFedwireParty>BIFedwirePa
rtyID

The BIFedwirePartyID class contains Fedwire party ID input information.


BIFedwirePartyID Description
Name

Type

CountryCode

string

Issuer

string

Number

string

Type

IDType

Description

For possible values, see "Possible ID


Types" on page 95.

Response Classes | 141


Confidential and Proprietary
FIN02829 October 2012

BIFedwirePartyPhone
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIFedwireWire>BIFedwireParty>BIFedwirePa
rtyPhone

The BIFedwirePartyPhone class contains Fedwire party phone input information.


BIFedwirePartyPhone Description
Name

Type

Number

string

Type

PhoneType

Description

Possible values:
None (Returned for results only)
Business
Cell
Fax
Home
Work
Unknown

Response Classes | 142


Confidential and Proprietary
FIN02829 October 2012

BIFedwireWire
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIFedwireWire

The BIFedwireWire class contains Fedwire input information. For information on data content and
record format, see: www.frbservices.org
BIFedwireWire Description
Name

Type

Description

ActualAmountList

List<BIFedwireAmount>

Array of amount information


See "BIFedwireAdjustment" on page 135.

AdjustmentList

List<BIFedwire
Adjustment>

Array of adjustment information


See "BIFedwireAdjustment" on page 135.

AdjustmentEffectiveDate

string

AdjustmentReasonCode

string

BusinessFunctionCode

string

ChargeList

List<BIFedwireAmount>

Array of amount information


See "BIFedwireAdjustment" on page 135.

CurrencyInstructedAmount

BIFedwireAmount

Array of amount information


See "BIFedwireAdjustment" on page 135.

DetailsOfCharges

string

DocumentDateList

List<string>

DocumentList

List<BIFedwire
Document>

DollarAmount

string

Array of document information


See "BIFedwireDocument" on page 137.

Response Classes | 143


Confidential and Proprietary
FIN02829 October 2012

BIFedwireWire Description (Continued)


Name

Type

Description

ExchangeRate

string

GrossAmountList

List<BIFedwireAmount>

Array of amount information


See "BIFedwireAmount" on page 136.

InstructedAmount

BIFedwireAmount

Array of amount information


See "BIFedwireAmount" on page 136.

LocalInstrumentCode

string

LocalInstrumentProprietaryCode

string

NegotiatedDiscountList

List<BIFedwireAmount>

Array of amount information


See "BIFedwireAmount" on page 136.

NoteList

List <BIFedwireNote>

Array of notes
See "BIFedwireNote" on page 137.

PartyList

List <BIFedwireParty>

Array of parties
See "BIFedwireParty" on page 138.

PaymentNotificationIndicator

string

ReferenceForBeneficiary

string

RemittanceLocationMethod

string

SenderReferenceNumber

string

Sender SuppliedInformation

string

TypeCode

string

Response Classes | 144


Confidential and Proprietary
FIN02829 October 2012

BIFraudPoint
Hierarchy: BISearchResponse>BIRecord>BIFraudPoint

The BIFraudPoint class contains FraudPoint Score results if you searched against this optional due
diligence service.
BIFraudPoint Description
Name

Type

Description

Errors

List<BIError>

Error information
See "Error Class" on page 212.

Input

FPInput

Input information
See "FPInput" on page 188.

RedFlags

List<FPRedFlag>

Array of red flag information


See "FPRedFlag" on page 188.

RiskIndicators

List<FPIndicator>

Array of risk information


See "FPIndicator" on page 187.

Score

int

FraudPoint Score value indicating fraud


potential

Response Classes | 145


Confidential and Proprietary
FIN02829 October 2012

BIID
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIID
Hierarchy: BISearchResponse>BIRecord>BIWatchList>BIMatch>BIEntity>BIID

The BIID class contains ID information for your entity or a watchlist entity.
BIID Description
Name

Type

Comments

string

DateExpires

string

DateIssued

string

IssuedBy

string

Label

string

Number

string

Type

IDType

Description
Uncategorized additional watchlist entity
information

Agency that issued the ID

For possible values, see "Possible ID


Types" on page 95.

Response Classes | 146


Confidential and Proprietary
FIN02829 October 2012

BIIDMatch
Hierarchy: BISearchResponse>BIRecord>BIMatch>BIIDMatch

The BIIDMatch class contains ID watchlist match information.


BIIDMatch Description
Name

Type

Description

IDType

IDType

For possible values, see "Possible ID


Types" on page 95.

InputValue

string

Input ID

ListValue

string

Watchlist ID

Score

int

ID match score (0-100) used to help


calculate the overall cofidence score

BIInstantID
Hierarchy: BISearchResponse>BIRecord>BIInstantID

The BIInstantID class contains InstantID individual results if you searched against this optional due
diligence service.
For possible index descriptions and follow-up actions, see the LexisNexis InstantIDAnalyzing Results
white paper at:

Response Classes | 147


Confidential and Proprietary
FIN02829 October 2012

https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1442
BIInstantID Description
Name

Type

Description

AddressHistory

List<IIDAddressInfo>

Array of address information


See "IIDAddressInfo" on page 190.

AlternateNames

List<IIDAlternateName>

Array of other possible names


See "IIDAlternateName" on page 190.

ComprehensiveVerificationIndex

int

Overall risk index(0, 10, 20, 30, 40, or 50)

Errors

List<BIError>

Array of error information


See "Error Class" on page 212.

Input

IIDInput

Input information
See "IIDInput" on page 199.

IIDReversePhone

IIDReversePhone

Associated name and address information


See "IIDReversePhone" on page 203.

NameAddressPhone

IIDIndicator

Name, address, phone correlation


See "IIDIndicator" on page 198.

NameAddressSSN

IIDIndicator

Name, address, SSN correlation


See "IIDIndicator" on page 198.

PhoneOfNameAddress

string

Phone number result

PotentialFollowupActions

List<IIDIndicator>

Array of possible follow-up actions users


can take to verify the entity
See "IIDIndicator" on page 198.

RedFlags

List<IIDRedFlag>

Array of reported red flags


See "IIDRedFlag" on page 203.

Response Classes | 148


Confidential and Proprietary
FIN02829 October 2012

BIInstantID Description (Continued)


Name

Type

Description

RiskIndicators

List<IIDIndicator>

Array of risk indicators


See "IIDIndicator" on page 198.

SSNInfo

IIDSSNInfo

SSN results
See "IIDSSNInfo" on page 204.

VerifiedInput

IIDInput

Input information found in InstantID data


sources
See "IIDInput" on page 199.

BIInstantIDIntl
Hierarchy: BISearchResponse>BIRecord>BIInstantIntl

The BIInstantIDIntl class contains InstantID International results if you searched against this optional
due diligence service.
BIInstantIDIntl Description
Name
Response

Type
IIDIResponse

Description
InstantID International results
See "IIDIResponse" on page 200.

Response Classes | 149


Confidential and Proprietary
FIN02829 October 2012

BIISO20022Note
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIISO20022Wire>BIISO20022Note

The BIISO20022Note class contains ISO 20022 note input information.


BIISO20022Note Description
Name

Type

Note

string

Tag

string

Description

BIISO20022Party
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIISO20022Wire>BIISO20022Party

The BIISO20022Party class contains ISO 20022 party input information.


BIISO20022Party Description
Name

Type

Description

AdditionalInfoList

List<BIISO20022Party
AdditionalInfo>

Array of additional information


See "BIISO20022PartyAdditionalInfo" on
page 151.

AddressList

List<BIISO20022Party
Address>

Array of address information


See "BIISO20022PartyAddress" on page
152.

IDList

List<BIISO20022PartyID
>

Array of party ID numbers


See "BIISO20022PartyID" on page 153.

Name

string

Response Classes | 150


Confidential and Proprietary
FIN02829 October 2012

BIISO20022Party Description (Continued)


Name

Type

Description

NoteList

List <string>

Array of notes

PhoneList

List<BIISO20022Party
Phone>

Array of phone numbers


See "BIISO20022PartyPhone" on page
154.

Type

WirePartyType

See "Party Types" on page 117.

BIISO20022PartyAdditionalInfo
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIISO20022Wire>BIISO20022Party>
BIISO20022PartyAdditionalInfo

The BIISO20022PartyAdditionalInfo class contains ISO 20022 additional input information.


BIISO20022PartyAdditionalInfo Description
Name

Type

CountryOfBirth

string

Info

string

Type

InfoType

ParsedInfo

string

ProvinceOfBirth

string

Description

For possible values, see "Possible


Information Types" on page 96.

Response Classes | 151


Confidential and Proprietary
FIN02829 October 2012

BIISO20022PartyAddress
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIISO20022Wire>BIISO20022Party>
BIISO20022PartyAddress

The BIISO20022PartyAddress class contains ISO 20022 address input information.


BIISO20022PartyAddress Description
Name

Type

Type

AddressType

BuildingNumber

string

City

string

Country

string

Department

string

PostalCode

string

StateProvince

string

StreetName

string

SubDepartment

string

Description
Type values:
None
Current
Mailing
Previous
Unknown

Response Classes | 152


Confidential and Proprietary
FIN02829 October 2012

BIISO20022PartyID
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIISO20022Wire>BIISO20022Party>
BIISO20022PartyID

The BIISO20022PartyID class contains ISO20022 party ID input information.


BIISO20022PartyID Description
Name

Type

Issuer

string

Label

string

Number

string

Type

IDType

Description

For possible values, see "Possible ID


Types" on page 95.

Response Classes | 153


Confidential and Proprietary
FIN02829 October 2012

BIISO20022PartyPhone
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIISO20022Wire>BIISO20022Party>BIISO20
022PartyPhone

The BIISO20022PartyPhone class contains ISO 20022 phone input information.


BIISO20022PartyPhone Description
Name

Type

Number

string

Type

PhoneType

Description

Possible values:
None (Returned for results only)
Business
Cell
Fax
Home
Work
Unknown

Response Classes | 154


Confidential and Proprietary
FIN02829 October 2012

BIISO20022Wire
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIISO20022Wire

The BIISO20022Wire class contains ISO 20022 input information. For information on record content
and format, see: www.iso20022.com
BIISO20022Wire Description
Name

Type

ChequeMaturityDate

string

ChequeNumber

string

ContractIdentification

string

CreationDateTime

string

CurrencyOfTransfer

string

DateOfSignature

string

EndToEndIdentification

string

EquivalentAmount

string

EquivalentAmountCurrency

string

ExchangeRate

string

ExchangeRateType

string

FinalCollectionDate

string

FirstCollectionDate

string

InstructedAmount

string

Description

Response Classes | 155


Confidential and Proprietary
FIN02829 October 2012

BIISO20022Wire Description (Continued)


Name

Type

InstructedAmountCurrency

string

InstructionIdentification

string

MandateIdentification

string

MessageIdentification

string

NoteList

List<BIISO20022Note>

OriginalFinalCollectionDate

string

OriginalMandateIdentification

string

PartyList

List<BIISO20022Party>

PaymentInformationIdentification

string

PaymentMethod

string

PoolingAdjustmentDate

string

PreNotificationDate

string

PreNotificationIdentification

string

RequestedCollectionDate

string

RequestedExecutionDate

string

Description

Array of notes
See "BIISO20022Note" on page 150.

Array of parties
See "BIISO20022Party" on page 150.

Response Classes | 156


Confidential and Proprietary
FIN02829 October 2012

BIMatch
Hierarchy: BISearchResponse>BIRecord>BIWatchList>BIMatch

The BIMatch class contains the best watchlist match information for a watchlist entity.
BIMatch Description
Name

Type

Description

AddressMatches

List<BIAddressMatch>

Array of address match information


Returned only for watchlist matches on
entity records.
See "BIAddressMatch" on page 125.

BestCountry

string

Country that most closely matched the


input information

BestCountryScore

int

Score of the country that most closely


matched the input information.
If a valid score is not available, -1 is
returned.

BestName

string

Name that most closely matched your


entity

BestNameScore

int

Score of the name that most closely


matched the customer information
If a valid score is not available, -1 is
returned.

CountryDetails

BICountry

Country match informationreturned


only for watchlist matches on country
records.
See "BICountry" on page 131.

DistributionDate

DateTime

Date the watchlist was last distributed by


LexisNexis

Response Classes | 157


Confidential and Proprietary
FIN02829 October 2012

BIMatch Description (Continued)


Name

Type

Description

DOBMatches

List<BIDOBMatch>

Array of date of birth match information


returned only for watchlist matches on
entity records.
See "BIDOBMatch" on page 133.

EntityDetails

BIEntity

Entity match informationreturned only


for watchlist matches on entity records.
See "BIEntity" on page 134.

EntityName

string

Main entity name from the watchlist that


generated the potential match

EntityScore

int

Confidence score (0-100) generated by


BIXG that indicates how closely the
watchlist record matched the entity
information
If a valid score is not available,
-1 is returned.

Error

BIError

Error information
See "Error Class" on page 212.

FileName

string

Watchlist against which the potential


match was generated

GatewayOFACScreeningIndicator

string

Indicates if a third-party service found


Office of Foreign Assets Control (OFAC)
matches before the record was searched
in BIXG.

IDMatches

List<BIIDMatch>

Array of ID match informationreturned


only for watchlist matches on entity
records
See "BIIDMatch" on page 147.

Response Classes | 158


Confidential and Proprietary
FIN02829 October 2012

BIMatch Description (Continued)


Name

Type

Description

MatchSummary

BIMatchSummary

Match summary informationreturned


only for result records with potential
watchlist matches on data elements other
than name.
See "BIMatchSummary" on page 160.

PhoneMatches

List<BIPhoneMatch>

Array of phone match information


returned only for watchlists containing
entity records.
See "BIPhoneMatch" on page 164.

SecondaryOFACScreeningIndicator

string

Indicates if a third-party service found


Office of Foreign Assets Control (OFAC)
matches before the record was searched
in BIXG.

SourceDate

DateTime

Date and time the watchlist information


was last updated by the source agency

BIMatchStrength
Hierarchy: BISearchResponse>BIRecord>BIWatchList>BIMatch>BIEntity>BIAKA>BIMatchStrength

The BIMatchStrength class contains AKA watchlist match information.


BIMatchStrength Description
Name
BIMatchStrength

Type
enumeration

Description
Possible Values:
NA
Strong
Weak

Response Classes | 159


Confidential and Proprietary
FIN02829 October 2012

BIMatchSummary
Hierarchy: BISearchResponse>BIRecord>BIWatchList>BIMatch>BIMatchSummary

The BIMatchSummary class contains the result summary of a potential watchlist match on data
elements other than name.
BIMatchSummary Description
Name

Type

Description

AddressMatches

List<BISummary>

Array of address match summary


information
See "BISummary" on page 175.

DOBMatches

List<BISummary>

Array of DOB match summary information


See "BISummary" on page 175.

Gender

BISummary

Gender match summary information


See "BISummary" on page 175.

IDMatches

List<BISummary>

Array of match information


See "BISummary" on page 175.

PhoneMatches

List<BISummary>

Array of phone match summary


information
See "BISummary" on page 175.

Response Classes | 160


Confidential and Proprietary
FIN02829 October 2012

BIName
Hierarchy: BISearchResponse>BIRecord>BIBusinessInstantID>IIDInput>BIName
Hierarchy: BISearchResponse>BIRecord>BIBusinessInstantID>IIDReversePhone>BIName
Hierarchy: BISearchResponse>BIRecord>BIInstantID>IIDInput>BIName
Hierarchy: BISearchResponse>BIRecord>BIInstantID>IIDReversePhone>BIName
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailsInfo>BIName
Hierarchy: BISearchResponse>BIRecord>BIWatchList>BIMatch>BIEntity>BIName
Hierarchy: BISearchResponse>BIRecord>BIWatchList>BIMatch>BICountry>BIName
Hierarchy: BISearchResponse>BIRecord>BIWatchList>BIMatch>BIEntity>BIAKA>BIName

The BIName class def ines your entity's name or a watchlist entity's name.
BIName Description
Name

Type

Description

Business

string

Entity's business name


If the business name is returned, no other
name properties are returned.

First

string

Entity's first name

Full

string

Entity's full name


If the full name is returned, no other
name properties are returned.

Generation

string

Entity's generation
For example: Jr., III

Last

string

Entity's last name

Middle

string

Entity's middle name

Text

string

Additional information

Title

string

Entity's title or position

Response Classes | 161


Confidential and Proprietary
FIN02829 October 2012

BIPasswordChange
Hierarchy: BIPasswordChange

The BIPasswordChange class contains password change information.


BIPasswordChange Description
Name

Type

Description

Error

BIError

Error information
See "Error Class" on page 212.

PasswordHasChanged

bool

True indicates that the password was


successfully changed.

Response Classes | 162


Confidential and Proprietary
FIN02829 October 2012

BIPhone
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BIPhone
Hierarchy: BISearchResponse>BIRecord>BIWatchList>BIMatch>BIEntity>BIPhone
Hierarchy: BISearchResponse>BIRecord>BIWatchList>BIMatch>BICountry>BIPhone

The BIPhone class contains phone information for your entity or a watchlist entity.
BIPhone Description
Name

Type

Description

Comments

string

Uncategorized additional watchlist entity


information

Number

string

Phone number

Type

PhoneType

Possible values:
None (Returned for results only)
Business
Cell
Fax
Home
Work
Unknown

Response Classes | 163


Confidential and Proprietary
FIN02829 October 2012

BIPhoneMatch
Hierarchy: BISearchResponse>BIRecord>BIWatchList>BIMatch>BIPhoneMatch

The BIPhoneMatch class returns phone watchlist match information.


BIPhoneMatch Description
Name

Type

Description

InputValue

string

Input phone information

ListValue

string

Watchlist phone information

Type

PhoneType

Possible values:
None (Returned for results only)
Business
Cell
Fax
Home
Work
Unknown

Score

int

Phone match score (0-100) used to help


calculate the overall confidence score

Response Classes | 164


Confidential and Proprietary
FIN02829 October 2012

BIRecord
Hierarchy: BISearchResponse>BIRecord

The BIRecord class contains result record information.


BIRecord Description
Name

Type

Description

BusinessInstantID

BIBusinessInstantID

InstantID business results


See "BIAuditItem" on page 127.

FraudPoint

BIFraudPoint

FraudPoint Score results


See "BIFraudPoint" on page 145.

InstantID

BIInstantID

InstantID individual results


See "BIInstantID" on page 147.

InstantIDIntl

BIInstantIDIntl

InstantID International results


See "BIInstantIDIntl" on page 149.

Record

long

Sequential number given by BIXG to each


result record generated by the search
request
For EFT searches, BIXG does not return
the entity information when no watchlist
matches are found. You can use this
number to track the record.

RecordDetailInfo

BIRecordDetailInfo

Input information
See "BIRecordDetailInfo" on page 166.

RequestIndex

int

Sequential number (0-99) given by BIXG


to each search sent in the request

Response Classes | 165


Confidential and Proprietary
FIN02829 October 2012

BIRecord Description (Continued)


Name

Type

Description

ResultID

long

Unique number generated by BIXG for


each result record that Search API users
can view in a Smart Client or the
GetResultDetails method. See
"GetResultDetails" on page 36.
For Direct, this property is 0.

Status

string

Automatic False Positive returned if


watchlist search results met specified
Automatic False Positive rules.

WatchList

BIWatchList

Watchlist search results


See "BIWatchList" on page 186.

BIRecordDetailInfo
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo

The BIRecordDetailInfo class contains entity input information.


BIRecordDetailInfo Description
Name

Type

AccountAmount

string

AccountDate

string

AccountGroupId

string

AccountOtherData

string

AccountProviderId

string

Description

User-defined account information

Response Classes | 166


Confidential and Proprietary
FIN02829 October 2012

BIRecordDetailInfo Description (Continued)


Name

Type

Description

AccountType

string

AdditionalInfoList

List<BIAdditionalInfo>

Array of other entity information


See "BIAdditionalInfo" on page 123.

AddressList

List<BIAddress>

Array of address information


See "BIAddress" on page 123.

AchWire

BIAchWire

ACH information
See "BIAchWire" on page 120.

FedwireWire

BIFedwireWire

Fedwire information
See "BIFedwireWire" on page 143.

ISO20022

BIISO20022Wire

ISO 20022 information


See "BIISO20022Wire" on page 155.

SwiftWire

BISwiftWire

SWIFT information
See "BISwiftWire" on page 180.

EntityType

ResponseEntityType

Possible values:
None
Unknown
Individual
Business
Vessel
Wire
Text

Gender

string

Gender type

IDList

List<BIID>

Array of ID information
See "BIID" on page 146.

Response Classes | 167


Confidential and Proprietary
FIN02829 October 2012

BIRecordDetailInfo Description (Continued)


Name

Type

Description

Name

BIName

Name information
See "BIName" on page 161.

PhoneList

List<BIPhone>

Array of phone information


See "BIPhone" on page 163.

SearchDate

DateTime

Date (DD-MM-YYYY) and 24-hour local


time (HH:MM:SS) of the search

WireContext

string

If a match is generated, the user-provided


EFT information where the match was
found is returned

WireType

ResponseWireType

Type values:

None
ACH
Fedwire
ISO20022
SWIFT
Unstructured

Response Classes | 168


Confidential and Proprietary
FIN02829 October 2012

BIRecordInfo
Hierarchy: BIUpdateResponse>BIRecordInfo

The BIRecordInfo class contains information about the updated result record.
BIRecordInfo Description
Name

Type

Description

AddedToAcceptList

boolean

True indicates the record was added to an


accept list

AlertState

string

Returns Open or Close to indicate if the


result record is flagged for further review

AssignmentList

List<string>

Users or roles assigned to the record

BIRecordAssignmentType

AssignmentType

Possible values:
Record_Assign_User
Record_Assign_Role

Division

string

Division that can access the record

HistoryList

List<BIAuditItem>

Array of record change information


See "BIRecord" on page 165.

Status

string

Record status

Response Classes | 169


Confidential and Proprietary
FIN02829 October 2012

BIResultDetailResponse
Hierarchy: BIResultDetailResponse

The BIResultDetailResponse class returns result record information for the provided result ID. A
unique result ID is given to each BIXG result record in the BIRecord class of a search response. See
"BIRecord" on page 165.
BIResultDetailResponse Description
Name

Type

Description

DaysUntilPasswordExpires

BIDaysUntilPassword
Expires

Number of days until the password


associated with the BIXG user ID used in
the request expires
See "BIDaysUntilPasswordExpires" on
page 133.

Error

BIError

Error information
See "Error Class" on page 212.

Record

BIRecord

Result record information


See "BIRecord" on page 165.

Response Classes | 170


Confidential and Proprietary
FIN02829 October 2012

BIRunDetailResponse
Hierarchy: BIRunDetailResponse

The BIRunDetailResponse class returns processing information.


BIRunDetailResponse Description
Name

Type

Description

DaysUntilPasswordExpires

BIDaysUntilPassword
Expires

Number of days until the password


associated with the BIXG user ID used in
the request expires
See "BIDaysUntilPasswordExpires" on
page 133.

Error

BIError

Error information
See "Error Class" on page 212.

RunInfo

BIRunInfo

Run information
See "BIRecord" on page 165.

BIRunInfo
Hierarchy: BIRunDetailResponse>BIRunInfo

The BIRunInfo class returns processing information on the search performed.


BIRunInfo Description
Name

Type

Description

AlertCount

int

Number of alerts generated from the


batch search

DivisionID

int

Division which can access results

ErrorCount

int

Number of result errors returned

Response Classes | 171


Confidential and Proprietary
FIN02829 October 2012

BIRunInfo Description (Continued)


Name

Type

Description

Dppa

ResponseDppaChoice

EntityType

ResponseEntityType

Possible values:
None
Unknown
Individual
Business
Vessel
Wire
Text

ErrorMessage

string

Error message about issues encountered


during processing. This does not include
error messages generated for specific
result records.

FileFormatName

string

Custom format used in the batch search

FileName

string

Batch file searched

Glb

byte

Gramm-Leach-Bliley (GLB) permissible


purpose

LastUpdateTimeUtc

DateTime

Last time in UTC the run was updated

NumRecordsProcessed

int

Number of input records processed

PredefinedSearchName

string

Predefined search settings used

ProcessingState

ProcessingStateType

Possible values:
BI_PROCESSING_STATE_COMPLETED
BI_PROCESSING_STATE_PROCESSING
BI_PROCESSING_STATE_CANCELED
BI_PROCESSING_STATE_INTERRUPTED
BI_PROCESSING_STATE_ERROR

Response Classes | 172


Confidential and Proprietary
FIN02829 October 2012

BIRunInfo Description (Continued)


Name

Type

Description

ResultsFile1

string

Output file name 1

ResultsFile2

string

Output file name 2

RunID

long

Unique number assigned to each batch


search

StartTimeUtc

DateTime

Batch search start time in UTC

SubmitType

string

Origin of the search (For example,


RealTime, Batch).

TotalNumRecords

int

Number of records in the file

TotalNumRows

int

Number of rows in the file

WLMatchCount

int

Number of input records generating


watchlist matches.

UserName

string

User who performed the search

WireType

ResponseWireType

Type values:

None
ACH
Fedwire
ISO20022
SWIFT
Unstructured

Response Classes | 173


Confidential and Proprietary
FIN02829 October 2012

BISearchResponse
Hierarchy: BISearchResponse

The BISearchResponse class contains all response information.


BISearchResponse Description
Name

Type

Description

ClientReference

BIClientReference

Optional user-defined pass-through


property used to identify the search
See "BIClientReference" on page 130.

DaysUntilPasswordExpires

BIDaysUntilPassword
Expires

Number of days until the password


associated with the BIXG user ID used in
the search expires
See "BIDaysUntilPasswordExpires" on
page 133.

Error

BIError

Error information
See "Error Class" on page 212.

RecordList

List<BIRecord>

Array of result record information


See "BIRecord" on page 165.

Response Classes | 174


Confidential and Proprietary
FIN02829 October 2012

BISummary
Hierarchy: BISearchResponse>BIRecord>BIWatchList>BIMatch>BIMatchSummary>BISummary

The BISummary class contains the data element match summary of a potential watchlist match on
data elements other than name.
BISummary Description
Name

Type

Description

Input

string

Input information

List

string

Watchlist information

Score

int

Match score of the data element that


helps calculate the overall confidence
score

Type

string

Specific type of the data (current address,


mailing address, passport, and so on)

BISwift4XXData
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BISwiftWire>BISwift4XXData

The BISwift4XXData class contains SWIFT MT 430 input information.


BISwift4XXData Description
Name

Type

AdditionalInformation

string

Amount

string

CurrencyCode

string

Description

Response Classes | 175


Confidential and Proprietary
FIN02829 October 2012

BISwift4XXData Description (Continued)


Name

Type

Date

string

MaturityPeriodType

string

NumberOfDaysOrMonths

string

Description

BISwiftAmount
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BISwiftWire>BISwiftAmount

The BISwiftAmount class contains SWIFT transaction amount input information.


BISwiftAmount Description
Name

Type

AdditionalInformation

string

Amount

string

CurrencyCode

string

Date

string

MaturityPeriodType

string

NumberOfDaysOrMonths

string

Description

Response Classes | 176


Confidential and Proprietary
FIN02829 October 2012

BISwiftNote
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BISwiftWire>BISwiftNote

The BISwiftWire class contains SWIFT note input information.


BISwiftWire Description
Name

Type

Note

string

Tag

string

Description

BISwiftParty
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BISwiftWire>BISwiftParty

The BISwiftParty class contains SWIFT party input information.


BISwiftParty Description
Name

Type

Description

AdditionalInfoList

List<BISwiftParty
AdditionalInfo>

Array of additional information


See "BISwiftPartyAdditionalInfo" on page
178.

AddressList

List<BISwiftParty
Address>

Array of address information


See "BISwiftPartyAddress" on page 179.

IDList

List<BISwiftPartyID>

Array of party ID numbers


See "BISwiftPartyID" on page 180.

Name

string

Type

WirePartyType

See "Party Types" on page 117.

Response Classes | 177


Confidential and Proprietary
FIN02829 October 2012

BISwiftPartyAdditionalInfo
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BISwiftWire>BISwiftParty>BISwiftPartyAdditio
nalInfo

The BISwiftPartyAdditionalInfo class contains SWIFT party additional input information.


BISwiftPartyAdditionalInfo Description
Name

Type

Country

string

Info

string

Number

string

Type

InfoType

ParsedInfo

string

Description

For possible values, see "Possible


Information Types" on page 96.

Response Classes | 178


Confidential and Proprietary
FIN02829 October 2012

BISwiftPartyAddress
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BISwiftWire>BISwiftParty>
BISwiftPartyAddress

The BISwiftPartyAddress class contains SWIFT party address input information.


BISwiftPartyAddress Description
Name

Type

AddressLine1

string

AddressLine2

string

AddressLine3

string

AddressLine4

string

City

string

Country

string

Description

Response Classes | 179


Confidential and Proprietary
FIN02829 October 2012

BISwiftPartyID
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BISwiftWire>BISwiftParty>BISwiftPartyID

The BISwiftParty class contains SWIFT party ID input information.


BISwiftParty Description
Name

Type

CountryCode

string

Issuer

string

Number

string

Type

IDType

Description

For possible values, see "Possible ID


Types" on page 95.

BISwiftWire
Hierarchy: BISearchResponse>BIRecord>BIRecordDetailInfo>BISwiftWire

The BISwiftWire class contains SWIFT input information. For information on record content and
format, see: www.swift.com
BISwiftWire Description
Name

Type

Description

AdditionalAmount

BISwiftAmount

See "BISwiftAmount" on page 176.

AdjustmentAmount

BISwiftAmount

See "BISwiftAmount" on page 176.

AdviceTypeA

string

AdviceTypeB

string

Response Classes | 180


Confidential and Proprietary
FIN02829 October 2012

BISwiftWire Description (Continued)


Name

Type

Description

Amount

BISwiftAmount

See "BISwiftAmount" on page 176.

AmountOfCharges

BISwiftAmount

See "BISwiftAmount" on page 176.

AmountOutstanding

BISwiftAmount

See "BISwiftAmount" on page 176.

ApplicableRules

string

AvailableBy

string

BankOperationCode

string

ClaimingBanksReference

string

ConfirmationInstructions

string

CustomerSpecifiedReference

string

DecreaseAmount

BISwiftAmount

Date

string

DateMessageAcknowledged

string

DateOfAdvice

string

DateOfAmendment

string

DateOfCashLetter

string

DateOfCollectionOrder

string

DateOfExpiry

string

See "BISwiftAmount" on page 176.

Response Classes | 181


Confidential and Proprietary
FIN02829 October 2012

BISwiftWire Description (Continued)


Name

Type

Description

DateOfIssue

string

DateOfOriginalAuthorization

string

DateOfReductionOrRelease

string

DetailsOfCharges

string

DocumentaryCreditNumber

string

ExchangeRate

string

FormOfDocumentaryCredit

string

FurtherIdentification

string

FXDealReference

string

IncreaseAmount

BISwiftAmount

IssuingBanksReference

string

InstructedAmount

BISwiftAmount

LatestDateOfShipment

string

MaximumCreditAmount

string

MessageType

string

Message information

MT4XXRepeatedSequenceList

List<BISwift4XXData>

Array of MT 430 data


See "BISwift4XXData" on page 175.

NetAmount

BISwiftAmount

See "BISwiftAmount" on page 176.

See "BISwiftAmount" on page 176.

See "BISwiftAmount" on page 176.

Response Classes | 182


Confidential and Proprietary
FIN02829 October 2012

BISwiftWire Description (Continued)


Name

Type

Description

NewAmount

BISwiftAmount

See "BISwiftAmount" on page 176.

NewDateofExpiry

string

NoteList

List<BISwiftNote>

Array of notes
See "BISwiftNote" on page 177.

OriginalAmount

BISwiftAmount

See "BISwiftAmount" on page 176.

OriginalOrderedAmount

BISwiftAmount

See "BISwiftAmount" on page 176.

OriginalMessageDate

string

OriginalMessageNumber

string

OriginalMessageType

string

PartialShipments

string

PartyList

List<BISwiftParty>

PercentageCreditAmountTolerance

string

PlaceOfExpiry

string

PresentingBanksReference

string

PrincipalAmount

BISwiftAmount

PrincipalsReference

string

ProceedsRemitted

BISwiftAmount

Array of parties
See "BISwiftParty" on page 177.

See "BISwiftAmount" on page 176.

See "BISwiftAmount" on page 176.

Response Classes | 183


Confidential and Proprietary
FIN02829 October 2012

BISwiftWire Description (Continued)


Name

Type

Description

ReceiversCharges

BISwiftAmount

See "BISwiftAmount" on page 176.

ReceiversReference

string

ReferenceToPreAdvice

string

ReimbursingBanksCharges

string

ReimbursingBanksReference

string

RelatedReference

string

RelatedSequenceReference

string

RequestExecutionDate

string

SendersChargesA

BISwiftAmount

See "BISwiftAmount" on page 176.

SendersChargesB

BISwiftAmount

See "BISwiftAmount" on page 176.

SendersChargesList

List<BISwiftAmount>

SendersReference

string

SubMessageType

string

TotalAmount

BISwiftAmount

TransactionReference

string

See "BISwiftAmount" on page 176.

Response Classes | 184


Confidential and Proprietary
FIN02829 October 2012

BISwiftWire Description (Continued)


Name

Type

TransactionTypeCode

string

TransferringBanksReference

string

Transshipment

string

Description

BIUpdateResponse
Hierarchy: BIUpdateResponse

The BIUpdateResponse class contains record update information.


BIUpdateResponse Description
Name

Type

Description

Error

BIError

Error information
See "Error Class" on page 212.

Successful

boolean

True indicates the request succeeded

RecordInfo

BIRecordInfo

Record information
See "BIRecordInfo" on page 169.

Response Classes | 185


Confidential and Proprietary
FIN02829 October 2012

BIWatchList
Hierarchy: BISearchResponse>BIRecord>BIWatchList

The BIWatchList class indicates the status of a watchlist search and contains an array of potential
matches.
BIWatchList Description
Name

Type

Description

MatchList

List<BIMatch>

Array of potential watchlist matches


See "BIMatch" on page 157.

Status

BISearchStatusType

Indicates if a watchlist search was


performed and if results were returned.
Type values:
NotSearched
NoResults
Results

FPAddress
Hierarchy: BISearchResponse>BIRecord>BIFraudPoint>FPInput>FPAddress

The FPAddress class contains FraudPoint Score address information.


FPAddress Description
Name
City

Type

Description

string

Response Classes | 186


Confidential and Proprietary
FIN02829 October 2012

FPAddress Description (Continued)


Name

Type

PostalCode

string

State

string

Street1

string

Description

FPIndicator
Hierarchy: BISearchResponse>BIRecord>BIFraudPoint>FPIndicator
Hierarchy: BISearchResponse>BIRecord>BIFraudPoint>FPRedFlag>FPIndicator

The FPIndicator class returns FraudPoint Score risk indicators or red flags. For possible risk indicators
and red flags, see the LexisNexis FraudPoint ScoreAnalyzing Results white paper on the Client
Services website at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1441
FPIndicator Description
Name

Type

Description

string

RiskCode

string

Description

Response Classes | 187


Confidential and Proprietary
FIN02829 October 2012

FPInput
Hierarchy: BISearchResponse>BIRecord>BIFraudPoint>FPInput

The FPInput class def ines FraudPoint Score input information.


FPInput Description
Name

Type

Address

FPAddress

DOB

string

Name

BIName

Phone

string

SSN

string

Description
See "FPAddress" on page 186.

See "BIName" on page 161.

FPRedFlag
Hierarchy: BISearchResponse>BIRecord>BIFraudPoint>FPRedFlag

The FPRedFlag class returns FraudPoint Score red flags. For possible red flags, see the LexisNexis
FraudPoint ScoreAnalyzing Results white paper on the Client Services website at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1441
FPRedFlag Description
Name

Type

Description

Name

string

Red flag category name

RiskIndicators

List<FPIndicator>

Array of red flags


See "FPIndicator" on page 187.

Response Classes | 188


Confidential and Proprietary
FIN02829 October 2012

IIDAddress
Hierarchy: BISearchResponse>BIRecord>BIInstantID>IIDAddressInfo>IIDAddress
Hierarchy: BISearchResponse>BIRecord>BIBusinessInstantID>IIDAddressInfo>IIDAddress
Hierarchy: BISearchResponse>BIRecord>BIInstantID>IIDInput>IIDAddress
Hierarchy: BISearchResponse>BIRecord>BIBusinessInstantID>IIDInput>IIDAddress
Hierarchy: BISearchResponse>BIRecord>BIBusinessInstantID>IIDFiling>IIDAddress
Hierarchy: BISearchResponse>BIRecord>BIBusinessInstantID>IIDFEINMatchResult>IIDAddress
Hierarchy: BISearchResponse>BIRecord>BIBusinessInstantID>IIDReversePhone>IIDAdress
Hierarchy: BISearchResponse>BIRecord>BIInstantID>IIDReversePhone>IIDAdress

The IIDAddress class contains InstantID address information.


IIDAddress Description
Name

Type

City

string

PostalCode

string

State

string

Street1

string

Description

Response Classes | 189


Confidential and Proprietary
FIN02829 October 2012

IIDAddressInfo
Hierarchy: BISearchResponse>BIRecord>BIInstantID>IIDAddressInfo

The IIDAddressInfo class contains InstantID address information, including when the address was f irst
and last reported.
IIDAddressInfo Description
Name

Type

Description

Address

IIDAddress

Address detail information.


See "IIDAddress" on page 189.

DateFirstSeen

string

Date first in public records

DateLastSeen

string

Last date in public records

IIDAlternateName
Hierarchy: BISearchResponse>BIRecord>BIInstantID>IIDAlternateName

The IIDAlternateName class contains InstantID last name and when the name was last seen.
IIDAlternateName Description
Name

Type

LastName

string

LastSeenDate

string

Description

Last date in public record

Response Classes | 190


Confidential and Proprietary
FIN02829 October 2012

IIDFEINMatchResult
Hierarchy: BISearchResponse>BIRecord>BIBusinessInstantID>IIDFEINMatchResult

The IIDFEINMatchResult class contains InstantID business match information.


IIDFEINMatchResult Description
Name

Type

Address

IIDAddress

CompanyName

string

Description
Address detail information
See "IIDAddress" on page 189.

IIDFiling
Hierarchy: BISearchResponse>BIRecord>BIBusinessInstantID>IIDFiling

The IIDFiling class contains InstantID civil f iling information for businesses.
IIDFiling Description
Name

Type

Description

Address

IIDAddress

Address detail information.


See "IIDAddress" on page 189.

Date

string

Date of the filing

Name

string

Name

Type

string

Type of filing

Response Classes | 191


Confidential and Proprietary
FIN02829 October 2012

IIDIAddress
Hierarchy: BISearchResponse>BIRecord>BIInstantIDIntl>IIDIResponse>IIDResult>IIDIInput>IIDIAddress

The IIDIAddress class contains InstantID International input address information.


IIDIAddress Description
Name

Type

Description

City

string

City or town

Country

string

PostalCode

string

Province

string

StreetAddress1

string

StreetName

string

StreetNumber

string

Building number

StreetSuffix

string

For example: Avenue, Drive, Street,


Boulevard

UnitDesignation

string

For example: unit, suite, apartment, or


flat number

Postal code or area

Address line 1
May contain unparsed address
information

Response Classes | 192


Confidential and Proprietary
FIN02829 October 2012

IIDIDataSource
Hierarchy: BISearchResponse>BIRecord>BIInstantIDIntl>IIDIResponse>IIDResult>IIDIDataSource

The IIDIDataSource class contains InstantID International data source verif ication results.
IIDIDataSource Description
Name

Type

DataSourceName

string

DataSoureError

string

DataSourceID

string

DataSourceMessage

string

DataSourceType

string

DataSourceVerifications

List<IIDIDataSource
Verification>

Description

Error code

Error message

Array of data source verification results.


See "IIDIDataSourceVerification" on page
194.

Response Classes | 193


Confidential and Proprietary
FIN02829 October 2012

IIDIDataSourceVerification
Hierarchy: BISearchResponse>BIRecord>BIInstantIDIntl>IIDIResponse>IIDResult>IIDIDataSource>IIDIData
SourceVerification

The IIDIDataSourceVerif ication class contains InstantID International data source verif ication details.
IIDIDataSourceVerification Description
Name

Type

FieldName

string

Verification

string

Description

Possible values:
1 = Match
0 = No Match
-1 = Missing
-2 = No Tag
-3 = Error

Response Classes | 194


Confidential and Proprietary
FIN02829 October 2012

IIDIDate
Hierarchy: BISearchResponse>BIRecord>BIInstantIDIntl>IIDIResponse>IIDResult>IIDIInput>IIDIDate
Hierarchy: BISearchResponse>BIRecord>BIInstantIDIntl>IIDIResponse>IIDIResult>IIDInput>IIDIPassport>II
DIDate

The IIDIDate class contains InstantID International expiration date input information for passports or
visas.
IIDIDate Description
Name

Type

Day

string

Month

string

Year

string

Description

IIDIException
Hierarchy: BISearchResponse>BIRecord>BIInstantIDIntl>IIDIResponse>IIDIHeader>IIDIException

The IIDIException class contains InstantID International error information.


IIDIException Description
Name

Type

Code

int

Message

string

Source

string

Description
Error information

Origin of the error

Response Classes | 195


Confidential and Proprietary
FIN02829 October 2012

IIDIHeader
Hierarchy: BISearchResponse>BIRecord>BIInstantIDIntl>IIDIResponse>IIDIHeader

The IIDIHeader class contains information to identify the InstantID International search and indicate
its status.
IIDIHeader Description
Name

Type

Description

Exceptions

List<IIDIException>

Array of errors
See "IIDIException" on page 195.

Message

string

Optional status description

QueryId

string

Submitted query ID

Status

string

Response status

TransactionId

string

Unique transaction identifier

IIDIIndicator
Hierarchy: BISearchResponse>BIRecord>BIInstantIDIntl>IIDIResponse>IIDIResult>IIDIIndicator

The IIDIIndicator class contains InstantID International risk indicators. For possible risk indicators,
see the LexisNexis InstantID InternationalAnalyzing Results white paper on the Client Services
website at:

Response Classes | 196


Confidential and Proprietary
FIN02829 October 2012

https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1443
IIDIIndicator Description
Name

Type

Description

string

RiskCode

string

Description

Risk indicator code

IIDIInput
Hierarchy: BISearchResponse>BIRecord>BIInstantIDIntl>IIDIResponse>IIDIResult>IIDIInput

The IIDIInput class contains InstantID International input information.


IIDIInput Description
Name

Type

Description

Address

IIDIAdress

See "IIDIAddress" on page 192.

DOB

IIDIDate

See "IIDIDate" on page 195.

HomePhone

string

IPAddress

string

Name

BIName

NationalIDCountry

string

See "BIName" on page 161.

Response Classes | 197


Confidential and Proprietary
FIN02829 October 2012

IIDIInput Description (Continued)


Name

Type

Description

NationalIDNumber

string

Passport

IIDIPassport

Passport information
See "IIDIPassport" on page 200.

Visa

IIDIPassport

Visa information
See "IIDIPassport" on page 200.

IIDIndicator
Hierarchy: BISearchResponse>BIRecord>BIInstantID>IIDIndicator
Hierarchy: BISearchResponse>BIRecord>BIBusinessInstantID>IIDIndicator
Hierarchy: BISearchResponse>BIRecord>BIInstantID>IIDRedFlag>IIDIndicator
Hierarchy: BISearchResponse>BIRecord>BIBusinessInstantID>IIDRedFlag>IIDIndicator

The IIDIndicator class returns InstantID risk indicators or red flags. For possible risk indicators and red
flags, see the LexisNexis InstantIDAnalyzing Results white paper on the Client Services website at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1442
IIDIndicator Description
Name

Type

Description

Description

string

Risk indicator or red flag description

RiskCode

string

Risk indicator or red flag code

Response Classes | 198


Confidential and Proprietary
FIN02829 October 2012

IIDInput
Hierarchy: BISearchResponse>BIRecord>BIInstantID>IIDInput
Hierarchy: BISearchResponse>BIRecord>BIBusinessInstantID>IIDInput

The IIDInput class def ines InstantID input and verif ied information.
IIDInput Description
Name

Type

Address

IIDAddress

County

string

DOB

string

DOBVerified

string

FEIN

string

Name

BIName

Phone

string

SSN

string

Description
See "IIDAddress" on page 189.

See "BIName" on page 161.

Response Classes | 199


Confidential and Proprietary
FIN02829 October 2012

IIDIPassport
Hierarchy: BISearchResponse>BIRecord>BIInstantIDIntl>IIDIResponse>IIDIResult>IIDInput>IIDIPassport

The IIDIPassport class contains InstantID International passport or visa information.


IIDIPassport Description
Name

Type

Country

string

ExpirationDate

IIDIDate

MachineReadableLine1

string

MachineReadableLine2

string

Number

string

Description

See "IIDIDate" on page 195.

IIDIResponse
Hierarchy: BISearchResponse>BIRecord>BIInstantIntl>IIDIResponse

The IIDIResponse class contains InstantID International search response.


IIDIResponse Description
Name

Type

Description

Header

IIDIHeader

Search request information


See "IIDIHeader" on page 196.

Result

IIDIResult

InstantID International results


See "IIDIResult" on page 201.

Response Classes | 200


Confidential and Proprietary
FIN02829 October 2012

IIDIResult
Hierarchy: BISearchResponse>BIRecord>BIInstantIDIntl>IIDIResponse>IIDIResult

The IIDIResult class contains InstantID International results. For information on verif ication levels, see
the LexisNexis InstantID InternationalAnalyzing Results white paper on the Client Services website
at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1443
IIDIResult Description
Name

Type

Description

ComplianceLevel

string

KYC (know your customer) verification


level 0-3

DataSourceResults

List<IIDIDataSource>

Array of verification details.


See "IIDIDataSource" on page 193.

InputEcho

IIDIInput

Input Information
See "IIDIInput" on page 197.

PassportNumberValidated

boolean

True indicates the passport number was


validated.

RiskIndicators

List<IIDIIndicator>

Array of risk indicator information


See "IIDIIndicator" on page 196.

VerificationIndex

IIDIVerificationIndex

Returned indexes
See "IIDIVerificationIndex" on page 202.

VerificationResults

List<IIDIVerification
Result>

Array of verification results


See "IIDIVerificationResult" on page 202.

VisaNumberValidated

boolean

True indicates the visa number was


validated.

Response Classes | 201


Confidential and Proprietary
FIN02829 October 2012

IIDIVerificationResult
Hierarchy: BISearchResponse>BIRecord>BIInstantIDIntl>IIDIResponse>IIDResult>IIDIVerificationResult

The IIDIVerif icationResult class contains InstantID International verif ication details.
IIDIVerificationResult Description
Name

Type

Count

string

FieldName

string

IsVerfied

string

Description

Possible values:
match
nomatch

IIDIVerificationIndex
Hierarchy: BISearchResponse>BIRecord>BIInstantIDIntl>IIDIResponse>IIDIResult>IIDIVerificationIndex

The IIDIVerf icationIndex class contains InstantID International verif ication index information. For
possible index values, see the LexisNexis InstantID InternationalAnalyzing Results white paper on
the Client Services website at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1443
IIDIVerficationIndex Description
Name

Type

Description

CitVL

string

No longer used

ComVL

string

No longer used

IVI

string

International verification index

Response Classes | 202


Confidential and Proprietary
FIN02829 October 2012

IIDRedFlag
Hierarchy: BISearchResponse>BIRecord>BIInstantID>IIDRedFlag

The IIDRedFlag class returns InstantID red flags. For possible red flags, see the LexisNexis InstantID
Analyzing Results white paper on the Client Services website at:
https://support.bridgerinsight.lexisnexis.com/clientservices/content/faq.aspx?id=1442
IIDRedFlag Description
Name

Type

Name

string

RiskIndicators

List<IIDIndicator>

Description

Array of red flags


See "IIDIIndicator" on page 196.

IIDReversePhone
Hierarchy: BISearchResponse>BIRecord>BIBusinessInstantID>IIDReversePhone
Hierarchy: BISearchResponse>BIRecord>BIInstantID>IIDReversePhone

The IIDReversePhone class returns name and address information associated with the input phone
number.
IIDReversePhone Description
Name

Type

Description

Address

IIDAddress

See "IIDAddress" on page 189.

Name

BIName

See "BIName" on page 161.

Response Classes | 203


Confidential and Proprietary
FIN02829 October 2012

IIDSSNInfo
Hierarchy: BISearchResponse>BIRecord>BIInstantID>IIDSSNInfo

The IIDSSNInfo class returns InstantID SSN result information.


IIDSSNInfo Description
Name

Type

Description

IssuedEndDate

string

End date SSN was issued

IssuedLocation

string

SSN issue location

IssuedStartDate

string

Start date SSN was issued

IIDVerificationIndicators
Hierarchy: BISearchResponse>BIRecord>BIBusinessInstantID>IIDVerificationIndicators

The IIDVerif icationIndicators class returns InstantID business verif ication information.
IIDVerificationIndicators Description
Name

Type

Address

string

City

string

FEIN

string

Name

string

Description

Response Classes | 204


Confidential and Proprietary
FIN02829 October 2012

IIDVerificationIndicators Description (Continued)


Name

Type

Phone

string

PostalCode

string

State

string

Description

Response Examples
Response examples are shown as XML SOAP representations of unparsed response objects.

Watchlist Search Example with Potential Match Found


<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<SearchResponse xmlns="https://bridgerinsight.lexisnexis.com/webservices/8.0">
<SearchResult>
<RecordList>
<Record>
<Status />
<Record>1</Record>
<ResultID>117</ResultID>
<RecordDetailInfo>
<EntityType>Individual</EntityType>
<Gender>None</Gender>
<SearchDate>4/5/2007 3:02:01 PM</SearchDate>
<Name>
<Full>Imaginary Person</Full>

Response Classes | 205


Confidential and Proprietary
FIN02829 October 2012

<First>Imaginary</First>
<Last>Person</Last>
</Name>
<AdditionalInfoList>
<AdditionalInfo>
<Type>DateOfBirth</Type>
<Information>05/05/1955</Information>
</AdditionalInfo>
</AdditionalInfoList>
<AddressList>
<Address>
<Type>Current</Type>
<Street1>123 Main St</Street1>
<City>Anytown</City>
<State>AA</State>
<PostalCode>12345</PostalCode>
</Address>
</AddressList>
<PhoneList>
<Phone>
<Type>Business</Type>
<Number>5555554444</Number>
</Phone>
</PhoneList>
</RecordDetailInfo>
<WatchList>
<Status>Results</Status>
<MatchList>
<Match>
<BestCountryScore>-1</BestCountryScore>
<BestNameScore>100</BestNameScore>
<EntityScore>100</EntityScore>
<BestName>PERSON, Imaginary</BestName>
<EntityName>PERSON, Imaginary</EntityName>
<FileName>CUSTOMEXAMPLE.BDF</FileName>
<FileDate>12/27/2006 12:04:50 PM</FileDate>

Response Classes | 206


Confidential and Proprietary
FIN02829 October 2012

<EntityDetails>
<EntityType>Individual</EntityType>
<Gender>None</Gender>
<Name>
<Full>Imaginary Person</Full>
<First>Imaginary</First>
<Last>PERSON</Last>
</Name>
<AKAList>
<AKA>
<Type>AKA</Type>
<Name>
<Full>Image Person</Full>
<First>Image</First>
<Last>PERSON</Last>
</Name>
</AKA>
</AKAList>
<AdditionalInfoList>
<AdditionalInfo>
<Type>DateOfBirth</Type>
<Information>05 May 55</Information>
</AdditionalInfo>
<AdditionalInfoList>
</EntityDetails>
</Match>
</MatchList>
</WatchList>
</Record>
</RecordList>
</SearchResult>
</SearchResponse>
</soap:Body>
</soap:Envelope>

Response Classes | 207


Confidential and Proprietary
FIN02829 October 2012

Watchlist Search Example with No Matches Found


<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<SearchResponse xmlns="https://bridgerinsight.lexisnexis.com/webservices/8.0">
<SearchResult>
<RecordList>
<Record>
<Status />
<Record>1</Record>
<ResultID>118</ResultID>
<RecordDetailInfo>
<EntityType>Individual</EntityType>
<Gender>None</Gender>
<SearchDate>4/5/2007 3:04:53 PM</SearchDate>
<Name>
<Full>Imaginary Person</Full>
<First>Imaginary</First>
<Last>Person</Last>
</Name>
<AdditionalInfoList>
<AdditionalInfo>
<Type>DateOfBirth</Type>
<Information>05/05/1955</Information>
</AdditionalInfo>
</AdditionalInfoList>
<AddressList>
<Address>
<Type>Current</Type>
<Street1>123 Main St</Street1>
<City>Anytown</City>
<State>AA</State>
<PostalCode>12345</PostalCode>
</Address>
</AddressList>

Response Classes | 208


Confidential and Proprietary
FIN02829 October 2012

<IDList>
<ID>
<Type>DriversLicense</Type>
<Number>#########</Number>
</ID>
<ID>
<Type>SSN</Type>
<Number>#########</Number>
</ID>
</IDList>
<PhoneList>
<Phone>
<Type>Business</Type>
<Number>5555554444</Number>
</Phone>
</PhoneList>
</RecordDetailInfo>
<WatchList>
<Status>NoResults</Status>
</WatchList>
</Record>
</RecordList>
</SearchResult>
</SearchResponse>
</soap:Body>
</soap:Envelope>

Get Record State Example


<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<BIUpdateResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">

Response Classes | 209


Confidential and Proprietary
FIN02829 October 2012

<Successful xmlns="https://bridgerinsight.lexisnexis.com/webservices/8.0">true</
Successful>
<RecordInfo xmlns="https://bridgerinsight.lexisnexis.com/webservices/8.0">
<AlertState>Open</AlertState>
<AssignmentList>
<Assignment>admin</Assignment>
</AssignmentList>
<AssignmentType>RECORD_ASSIGN_USER</AssignmentType>
<AddedToAcceptList>false</AddedToAcceptList>
<HistoryList>
<History>
<Date>2007-10-18T23:11:08.76Z</Date>
<User>System</User>
<Note>Alert threshold met</Note>
<Event>Alert Opened</Event>
</History>
<History>
<Date>2007-10-18T23:10:57.48Z</Date>
<User>Administrator</User>
<Note>Record created from real-time search</Note>
<Event>Record Created</Event>
</History>
</HistoryList>
</RecordInfo>
</BIUpdateResponse>
</soap:Body>
</soap:Envelope>

Response Classes | 210


Confidential and Proprietary
FIN02829 October 2012

Chapter

In This Chapter

Error Class, page


212
Error Codes, page
213

Errors

Error Messages,
page 217

Errors | 211
Confidential and Proprietary
FIN02829 October 2012

Error Class
LexisNexis Bridger Insight XG (BIXG) returns error codes in the following class.

BIError Class
A BIError class is returned if an error occurred.
BIError Description
Type

Name

Description

string

Message

Description of the error that occurred.


See "Error Messages" on page 217.

int

Code

Corresponding error code. Not all errors


contain a code. See "Error Class" on page
212.

GLB Error Example


This error occurred because the GLB permissible purpose included in the ID Verif ication search is not
valid for the client's business type.
This error example is shown as an XML SOAP representation of unparsed response objects.
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<SearchResponse xmlns="https://bridgerinsight.lexisnexis.com/webservices/8.0">
<SearchResult>
<Error>
<Message>GLB choice is not valid.</Message>
<Code>256</Code>
</Error>

Errors | 212
Confidential and Proprietary
FIN02829 October 2012

</SearchResult>
</SearchResponse>
</soap:Body>
</soap:Envelope>

Error Codes
If an error occurs, an error code may be returned. The following table lists possible BIXG system and
Web Services error codes:

These error codes are specific to Web Services. Other codes related to BIXG may be returned as
well.

Error Codes and Labels


Dec Code

Hex Code

Label

0x00000000

BRIDGER_INSIGHT_NO_ERROR

0x00000001

BRIDGER_INSIGHT_ACCESS_DENIED

0x00000002

BRIDGER_INSIGHT_ALREADY_OPEN

0x00000003

BRIDGER_INSIGHT_CANNOT_GROW

0x00000004

BRIDGER_INSIGHT_FILE_NOT_FOUND

0x00000005

BRIDGER_INSIGHT_INVALID_FILE

0x00000006

BRIDGER_INSIGHT_INVALID_OBJECT

0x00000007

BRIDGER_INSIGHT_INVALID_OPERATION

0x00000008

BRIDGER_INSIGHT_INVALID_PARAMETER

Errors | 213
Confidential and Proprietary
FIN02829 October 2012

Error Codes and Labels (Continued)


Dec Code

Hex Code

Label

0x00000009

BRIDGER_INSIGHT_IO_ERROR

10

0x0000000A

BRIDGER_INSIGHT_LOAD_ERROR

11

0x0000000B

BRIDGER_INSIGHT_NO_SERVER_AVAILABLE

12

0x0000000C

BRIDGER_INSIGHT_NO_THREAD

13

0x0000000D

BRIDGER_INSIGHT_NOT_FOUND

14

0x0000000E

BRIDGER_INSIGHT_NOT_OPEN

15

0x0000000F

BRIDGER_INSIGHT_NOT_SUPPORTED

16

0x00000010

BRIDGER_INSIGHT_OUT_OF_MEMORY

17

0x00000011

BRIDGER_INSIGHT_SERIALIZATION_ERROR

18

0x00000012

BRIDGER_INSIGHT_SERVER_CRASHED

19

0x00000013

BRIDGER_INSIGHT_THREAD_ABORTED

20

0x00000014

BRIDGER_INSIGHT_THREAD_ERROR

21

0x00000015

BRIDGER_INSIGHT_THREAD_EXISTS

22

0x00000016

BRIDGER_INSIGHT_TIMED_OUT

23

0x00000017

BRIDGER_INSIGHT_UNHANDLED_ERROR

24

0x00000018

BRIDGER_INSIGHT_UNKNOWN_PATH

25

0x00000019

BRIDGER_INSIGHT_WEB_ERROR

Errors | 214
Confidential and Proprietary
FIN02829 October 2012

Error Codes and Labels (Continued)


Dec Code

Hex Code

Label

26

0x0000001A

BRIDGER_INSIGHT_XML_ERROR

536870913

0x20000001

BRIDGER_INSIGHT_ALREADY_CONNECTED

536870914

0x20000002

BRIDGER_INSIGHT_CRYPTO_FAILED

536870915

0x20000003

BRIDGER_INSIGHT_DATA_FILE_ERRORS

536870916

0x20000004

BRIDGER_INSIGHT_DATA_TRUNCATED

536870917

0x20000005

BRIDGER_INSIGHT_INVALID_CREDENTIALS

536870918

0x20000006

BRIDGER_INSIGHT_INVALID_DATA

536870919

0x20000007

BRIDGER_INSIGHT_INVALID_FORMAT

536870920

0x20000008

BRIDGER_INSIGHT_INVALID_VALUE

536870921

0x20000009

BRIDGER_INSIGHT_MISMATCHED_DLLS

536870922

0x2000000A

BRIDGER_INSIGHT_PARSE_FAILED

536870923

0x2000000B

BRIDGER_INSIGHT_PASSWORD_EXPIRED

536870924

0x2000000C

BRIDGER_INSIGHT_PASSWORD_CHANGE_FAILED

536870925

0x2000000D

BRIDGER_INSIGHT_PASSWORD_MUST_CHANGE

536870926

0x2000000E

BRIDGER_INSIGHT_PROVIDER_ERROR

536870927

0x2000000F

BRIDGER_INSIGHT_RECORD_LOCKED

536870928

0x20000010

BRIDGER_INSIGHT_TOO_LONG

Errors | 215
Confidential and Proprietary
FIN02829 October 2012

Error Codes and Labels (Continued)


Dec Code

Hex Code

Label

536870929

0x20000011

BRIDGER_INSIGHT_USER_LOCKED

536870930

0x20000012

BRIDGER_INSIGHT_VALIDATION_FAILED

536870931

0x20000013

BRIDGER_INSIGHT_BATCH_TOO_LARGE

536870932

0x20000014

BRIDGER_INSIGHT_TOO_MANY_ERRORS

536870933

0x20000015

BRIDGER_INSIGHT_INVALID_ENCODING

536870934

0x20000016

BRIDGER_INSIGHT_APPLICATION_CLOSED

536870935

0x20000017

BRIDGER_INSIGHT_INVALID_IP_ADDRESS

536870936

0x20000018

BRIDGER_INSIGHT_INITIALIZATION_FAILED

536870937

0x20000019

BRIDGER_INSIGHT_INVALID_VERSION

536870939

0x2000001B

BRIDGER_INSIGHT_UNMANAGED_OP_FAILED

536870940

0x2000001C

BRIDGER_INSIGHT_INVALID_CLIENT_ID

536870941

0x2000001D

BRIDGER_INSIGHT_INVALID_PRODUCT_CODE

536870942

0x2000001E

BRIDGER_INSIGHT_TRIAL_LAPSED

536870943

0x2000001F

BRIDGER_INSIGHT_USER_DISABLED

536870944

0x20000020

BRIDGER_INSIGHT_RECOVERY_FAILED

536870945

0x20000021

BRIDGER_INSIGHT_INVALID_USER_ID

536870946

0x20000022

BRIDGER_INSIGHT_USER_ID_CHANGE_FAILED

Errors | 216
Confidential and Proprietary
FIN02829 October 2012

Error Codes and Labels (Continued)


Dec Code

Hex Code

Label

536870947

0x20000023

BRIDGER_INSIGHT_INVALID_PASSWORD

536870948

0x20000024

BRIDGER_INSIGHT_INVALID_PREDEFINED_SEARCH

536870950

0x20000026

BRIDGER_INSIGHT_SEARCH_CORE_ERROR

256

0x00000100

WS_INPUT_ERROR

257

0x00000101

WS_RESULT_PARSE_ERROR

258

0x00000102

WS_TOO_MANY_RECORDS

259

0x00000103

WS_INVALID_PROVIDER

260

0x00000104

WS_SERVICE_NOT_ALLOWED

261

0x00000105

WS_SEARCH_ERROR

262

0x00000106

WS_PREDEFINED_SEARCH_ERROR

263

0x00000107

WS_RESULT_ASSIGNMENT_ERROR

Error Messages
If an error occurs, one of the following error messages may be returned:
BI System: Failed to login
BI System: Change Password Required
BI System: Invalid Credentials
BI System: Missing Customer ID

Errors | 217
Confidential and Proprietary
FIN02829 October 2012

BI System: Missing User ID


BI System: Missing Password
BI System: Password Expiration
Password Change Failed
Unknown Request
Customer does not have access to Direct Web Services
Customer does not have access to Integrated Web Services
Watchlist capabilities are not enabled for this account
Web Services validation error. \'{0}\' type can not be \'None\'
Business name cannot be include for entity type Individual
Name object can only contain business name for entity type Business
Name object can only contain full or parsed names for entity type Individual
Name object can only contain business name or parsed names for entity type Individual
Provider selected can only accept parsed names as valid input
Session tag is required for this search to include DPPA and GLB
Name object is null or empty
String <string> was not recognized as a valid DOB
Request is empty
Name tag is required
The maximum number of records to process in a search is 100
Predef ined search is not specif ied
Predef ined search <predef ined search> was not found
GLB choice is not valid
DPPA choice is not valid
Name tag does not meet minimum requirements to perform the search
Web Services Custom
Web Services Predef ined Search
WatchList: Must specify watchlist f iles
WatchList: File <f ile name> in the array was not found among available f iles

Errors | 218
Confidential and Proprietary
FIN02829 October 2012

Predef ined search does not contain any searches


Predef ined search <predef ined search name> does not support wire.
Predef ined search <predef ined search name> contains provider \'{1}\' which can not conduct a
search in Web Services
AppSettings.LoggingPath is missing or empty from the web.conf ig
Failed to create logging directory \'{0}\'
Web Services encountered an error ({0})
Record {0} was not found
User <user name> does not have access to update this record
Result ID must be greater than 0
Record Status <record status> is unknown
To open a record you must provide a user or role to assign it to
User <user name> does not have access to add a record to an accept list
Failed to get the accept lists
Accept List <accept list name> was not found

These messages are specific to Web Services. Other messages related to BIXG may be returned
as well.

Errors | 219
Confidential and Proprietary
FIN02829 October 2012

Index

Account class, 87
account information, 166
input, 87
ACH
notes, 115
OFAC match
properties, 97
party address, 119
party data, 117
party ID, 120
results, 120
ACH options
setting, 97
additional information, 123
input, 96
Address class, 88
addresses, 123
Automatic False Positive
rule, 91
input, 88
match, 125
AddToAcceptList, 31
C# example, Search API, 32
AKAs, 126
alert assignment, 89
AssignResultsTo class, 89
AuthenticationHeader
class, 91
Automatic False Positive rules
setting, 91
AutomaticFalsePositiveRules
class, 91

BIAchNote class, 115


BIAchParty class, 117
BIAchPartyAddress class, 119
BIAchPartyID class, 120
BIAchWire class, 120
BIAdditionalInfo class, 123
BIAddress class, 123
BIAddressMatch, 125
BIAKA, 126
BIAlertStateChangedRespons
e class, 57
BIAuditItem, 127
BIBatchStatusChangedRespo
nse class, 58
BIBusinessInstantID, 128
BIBusinessInstantID class
hierarchy, 110
BIClientReference, 130
BICountry, 131
BIDaysUntilPasswordExpires,
133
BIDOBMatch, 133
BIEntity, 134
BIEventQueueResponse
class, 59
BIFedwireAdjustment, 135
BIFedwireAmount, 136
BIFedwireDocument, 137
BIFedwireNote, 137
BIFedwireParty, 138
BIFedwirePartyAdditionalInf
o, 139
BIFedwirePartyAddress, 139

BIFedwirePartyID, 141
BIFedwirePartyPhone, 142
BIFedwireWire, 143
BIFraudPoint, 145
BIFraudPoint class
hierarchy, 111
BIID, 146
BIIDMatch, 147
BIInstantID, 147
BIInstantID class
hierarchy, 111
BIInstantIDIntl, 149
BIInstantIDIntl class
hierarchy, 112
BIISO20022Note, 150
BIISO20022Party, 150
BIISO20022PartyAdditionalIn
fo, 151
BIISO20022PartyAddress, 152
BIISO20022PartyID, 153
BIISO20022PartyPhone, 154
BIISO20022Wire, 155
BIMatch, 157
BIMatch class
hierarchy, 114
BIMatchStrength, 159
BIMatchSummary, 160
BIName, 161
BIPasswordChange, 162
BIPhone, 163
BIPhoneMatch, 164
BIRecord, 165
BIRecordDetailInfo, 166
BIRecordInfo, 169
BIRecordInfo class

Index | 220
Confidential and Proprietary
FIN02829 October 2012

hierarchy, 112
BIResultDetailResponse, 170
BIResultDetailResponse class
hierarchy, 109
BIRunDetailResponse, 171
BIRunDetailResponse class
hierarchy, 109
BIRunInfo, 171
BISearchResponse, 174
BISearchResponse class
hierarchy, 109
BIStatusChangedResponse
class, 60
BISummary, 175
BISwift4XXData, 175
BISwiftAmount, 176
BISwiftNote, 177
BISwiftParty, 177
BISwiftPartyAdditionalInfo, 1
78
BISwiftPartyAddress, 179
BISwiftPartyID, 180
BISwiftWire, 180
BIUpdateResponse, 185
BIUpdateResponse class
hierarchy, 109
BIWatchList, 186
Bridger Insight XG
functionality, 17
C
C# examples, Direct
ChangePassword, 69
Search, 70
UnstructuredWire, 72
Wire, 74
C# examples, Event Queue
EventProcessingComplete,
49
GetAlertChangedDetails, 5
0
GetBatchStatusChangedD
etails, 52

GetEventNotification, 54
GetStatusChangedDetails,
55
C# examples, Search API
ChangePassword, 33
GetRecordState, 34
C# examples, Search API
AddToAcceptList, 32
GetResultDetails, 36
GetRunDetails, 37
IndexAcceptList, 39
Search, 40
SetRecordState, 43
Wire, 45
CBTs, 24
ChangePassword
C# example, Direct, 69
C# example, Search API, 33
Direct, 68
Search API, 32
citizenship
Automatic False Positive
rule, 91
input, 96
class hierarchies, 22
classes, request
Account, 87
Address, 88
AssignResultsTo, 89
AutomaticFalsePositiveRul
es, 91
classes, request
AuthenticationHeader, 9
1
definitions, 87
File, 92
GeneralSearchOptions, 93
hierarchy, 85
Identification, 95
Information, 96
MatchOptions, 97
Name, 98
overview, 85
Phone, 99

PredefinedSearch, 99
Request, 100
SearchRequest, 101
Session, 102
UnstructuredWireRequest
, 105
UpdateAssignResultsTo, 1
05
WatchListOptions, 106
WireRequest, 106
classes, response
BIAchNote, 115
BIAchParty, 117
BIAchPartyAddress, 119
BIAchPartyID, 120
BIAchWire, 120
BIAdditionalInfo, 123
BIAddress, 123
BIAddressMatch, 125
BIAKA, 126
BIAlertStateChangedResp
onse, 57
BIAuditItem, 127
BIBatchStatusChangedRes
ponse, 58
BIBusinessInstantID, 128
BIClientReference, 130
BICountry, 131
BIDaysUntilPasswordExpires, 133
BIDOBMatch, 133
BIEntity, 134
BIEventQueueResponse, 5
9
BIFedwireAdjustment, 135
BIFedwireAmount, 136
BIFedwireDocument, 137
BIFedwireNote, 137
BIFedwireParty, 138
BIFedwirePartyAdditionalI
nfo, 139
BIFedwirePartyAddress, 13
9
BIFedwirePartyID, 141

Index | 221
Confidential and Proprietary
FIN02829 October 2012

BIFedwirePartyPhone, 142
BIFedwireWire, 143
BIFraudPoint, 145
BIID, 146
BIIDMatch, 147
BIInstantID, 147
BIInstantIDIntl, 149
BIISO20022Note, 150
BIISO20022Party, 150
BIISO20022PartyAddition
alInfo, 151
BIISO20022PartyAddress,
152
BIISO20022PartyID, 153
BIISO20022PartyPhone, 15
4
BIISO20022Wire, 155
BIMatch, 157
BIMatchStrength, 159
BIMatchSummary, 160
BIName, 161
BIPasswordChange, 162
BIPhone, 163
BIPhoneMatch, 164
BIRecord, 165
BIRecordDetailInfo, 166
BIRecordInfo, 169
BIResultDetailResponse, 1
70
BIRunDetailResponse, 171
BIRunInfo, 171
BISearchResponse, 174
BIStatusChangedResponse
, 60
BISummary, 175
BISwift4XXData, 175
BISwiftAmount, 176
BISwiftNote, 177
BISwiftParty, 177
BISwiftPartyAdditionalInf
o, 178
BISwiftPartyAddress, 179
BISwiftPartyID, 180
BISwiftWire, 180

BIUpdateResponse, 185
BIWatchList, 186
definitions, 114
EventItemAlertStateChang
ed, 61
EventItemBatchStatusCha
nged, 61
EventItemStatusChanged,
62
FPAddress, 186
FPIndicator, 187
FPInput, 188
FPRedFlag, 188
hierarchy,
BIBusinessInstantID
class, 110
hierarchy, BIFraudPoint
class, 111
hierarchy, BIInstantID
class, 111
hierarchy, BIInstantIDIntl
class, 112
hierarchy, BIMatch
class, 114
hierarchy, BIRecordInfo
class, 112
hierarchy,
BIResultDetailResponse
class, 109
hierarchy,
BIRunDetailResponse
class, 109
hierarchy,
BISearchResponse
class, 109
hierarchy,
BIUpdateResponse
class, 109
IIDAddress, 189
IIDAddressInfo, 190
IIDAlternateName, 190
IIDFEINMatchResult, 191
IIDFiling, 191
IIDIAddress, 192

IIDIDataSource, 193
IIDIDataSourceVerificatio
n, 194
IIDIDate, 195
IIDIException, 195
IIDIHeader, 196
IIDIIndicator, 196
IIDIInput, 197
IIDIndicator, 198
IIDInput, 199
IIDIPassport, 200
IIDIResponse, 200
IIDIResult, 201
IIDIVerficationIndex, 202
IIDIVerificationResult, 202
IIDRedFlag, 203
IIDReversePhone, 203
IIDSSNInfo, 204
IIDVerificationIndicators,
204
overview, 109
client ID, 91
client reference, 130
Client Services website, 23
conventions, 22
conventions, class
hierarchies, 22
countries
Automatic False Positive
rule, 91
credentials, 91
D
data set
Dow Jones Watchlist, 64
Factiva Public Figures and
Associates, 64
World-Check, 64
data sets
adding Dow Watchlist to
searches, 92
adding World-Check to
searches, 92

Index | 222
Confidential and Proprietary
FIN02829 October 2012

date of birth
see DOBs
Direct
overview, 64
search settings, 64
division restriction, 89
DOBs
Automatic False Positive
rule, 91
input, 96
Dow Jones Watchlist, 64, 92
DPPA codes, 104
drivers licenses
input, 95
due diligence
adding Dow Watchlist to
searches, 92
adding World-Check to
searches, 92
Dow Jones Watchlist, 64
World-Check, 64
E
EFT
ACH information, 120
ACH notes, 115
ACH party address, 119
ACH party data, 117
ACH party ID, 120
Fedwire adjustment
info, 135
Fedwire document
info, 137
Fedwire information, 143
Fedwire notes, 137
Fedwire party additional
info, 139
Fedwire party address, 139
Fedwire party data, 138
Fedwire party ID, 141
Fedwire party phone, 142
Fedwire transaction
amount, 136

ISO 20022 additional


info, 151
ISO 20022 address, 152
ISO 20022 notes, 150
ISO 20022 party data, 150
ISO 20022 party ID, 153
ISO 20022 phone
number, 154
ISO20022 information, 155
SWIFT information, 180
SWIFT MT 430 data, 175
SWIFT notes, 177
SWIFT party additional
info, 178
SWIFT party address, 179
SWIFT party data, 177
SWIFT party ID, 180
SWIFT transaction
amount, 176
EINs
input, 95
entity type
Automatic False Positive
rule, 91
input, 100
errors
codes, 213
examples, 212
messages, 217
object response, 212
Event Queue
overview, 48
EventItemAlertStateChanged
class, 61
EventItemBatchStatusChange
d class, 61
EventItemStatusChanged
class, 62
EventProcessingComplete, 49
C# example, Event
Queue, 49

F
Factiva Public Figures and
Associates, 92
false positives
setting Automatic False
Positive status, 91
Fedwire
adjustment info, 135
document info, 137
notes, 137
party address, 139
party addtional info, 139
party data, 138
party ID, 141
party phone, 142
results, 143
transaction amount, 136
File class, 92
FPAddress, 186
FPIndicator, 187
FPInput, 188
FPRedFlag, 188
FraudPoint
address, 186
indicator response, 187
input response, 188
red flag response, 188
FraudPoint Score
DPPA codes, 104
GLB codes, 103
response, 145
G
gender
input, 98
general search options
setting, 93
GeneralSearchOptions
class, 93
GetAlertChangedDetails, 50
C# example, Event
Queue, 50

Index | 223
Confidential and Proprietary
FIN02829 October 2012

GetBatchStatusChangedDetai
ls, 52
C# example, Event
Queue, 52
GetEventNotification, 53
C# example, Event
Queue, 54
GetRecordState, 34
C# example, Search API, 34
GetResultDetails, 36
C# example, Search API, 36
GetRunDetails, 37
C# example, Search API, 37
GetStatusChangedDetails, 55
C# example, Event
Queue, 55
GLB codes, 103
H
hierarchies
request class, 85
response class,
BIResultDetailResponse,
109
response class,
BIRunDetailResponse, 10
9
response class,
BISearchResponse, 109
response class,
BIUpdateResponse, 109
hierarchy
response class,
BIBusinessInstantID, 110
response class,
BIFraudPoint, 111
response class,
BIInstantID, 111
response class,
BIInstantIDIntl, 112
response class,
BIMatch, 114
response class,

BIRecordInfo, 112
I
Identification class, 95
identity
match, 147
IDs, 146
Automatic False Positive
rule, 91
client, 91
drivers license, 95
EIN, 95
input, 95
national ID, 95
passport, 95
SSN, 95
user, 91
visa, 95
IIDAddress, 189
IIDAddressInfo, 190
IIDAlternateName, 190
IIDFEINMatchResult, 191
IIDFiling, 191
IIDIAddress, 192
IIDIDataSource, 193
IIDIDataSourceVerification, 1
94
IIDIDate, 195
IIDIException, 195
IIDIHeader, 196
IIDIIndicator, 196
IIDIInput, 197
IIDIndicator, 198
IIDInput, 199
IIDIPassport, 200
IIDIResponse, 200
IIDIResult, 201
IIDIVerficationIndex, 202
IIDIVerificationResult, 202
IIDRedFlag, 203
IIDReversePhon, 203
IIDSSNInfo, 204

IIDVerificationIndicators, 20
4
IndexAcceptList, 38
C# example, Search
API, 39
Information class, 96
input
account information, 87
additional information, 96
address, 88
citizenship, 96
DOB, 96
drivers license, 95
EIN, 95
entity type, 100
gender, 98
ID, 95
IP address, 96
name, 98
national ID, 95
passport, 95
phone number, 99
SSN, 95
text, 98
visa, 95
Instant International
IIDIAddress, 192
IIDIDataSource, 193
IIDIDataSourceVerificatio
n, 194
IIDIDate, 195
IIDIException, 195
IIDIHeader, 196
IIDIIndicator, 196
IIDIInput, 197
IIDIPassport, 200
InstantID
address, 189, 190
alternate name
response, 190
BIInstantID, 147
business results, 128
business, filing
response, 191

Index | 224
Confidential and Proprietary
FIN02829 October 2012

business, match
response, 191
business, verification
response, 204
DPPA codes, 104
GLB codes, 103
indicator response, 198
input response, 199
red flag response, 203
reverse phone, 203
SSN response, 204
InstantID International
IIDIResult, 201
IIDIVerficationIndex, 202
IIDIVerificationResult, 202
InstantIDIntl
BIInstantID, 149
IIDIResponse, 200
IP addresses
input, 96
ISO 20022
additional info, 151
address, 152
notes, 150
party data, 150
party ID, 153
phone number, 154
ISO20022
results, 155
M
manual
audience for, 21
organization of, 22
match options
setting, 97
MatchOptions class, 97
methods, Direct
ChangePassword, 68
descriptions, 67
UnstructuredWire, 72
Wire, 73
methods, Direct

Search, 69
methods, Event Queue
descriptions, 48
EventProcessingComplete,
49
GetAlertChangedDetails, 5
0
GetBatchStatusChangedD
etails, 52
GetEventNotification, 53
GetStatusChangedDetails,
55
methods, Search API
ChangePassword, 32
methods, Search API
AddToAcceptList, 31
descriptions, 30
GetResultDetails, 36
GetRunDetails, 37
IndexAcceptList, 38
Search, 40, 69
SetRecordState, 42
Wire, 45
methods, SearchAPI
GetRecordState, 34
N
Name class, 98
names, 161
input, 98
national IDs
input, 95
O
object response error, 212
OFAC match indicator
setting, 97
optional data sets, 64

P
passports
input, 95
passwords, 91
changing, 162
expiration countdown, 133
Phone class, 99
phone numbers, 163, 164
Automatic False Positive
rule, 91
input, 99
predefined searches
see searching
PredefinedSearch class, 99
R
record details, 166
record, result
account information, 166
ACH information, 120
ACH notes, 115
ACH party address, 119
ACH party data, 117
ACH party ID, 120
additional information, 123
addresses, 123, 125
AKAs, 126
details, 166
Fedwire adjustument
info, 135
Fedwire document
info, 137
Fedwire information, 143
Fedwire party additional
info, 139
Fedwire party address, 139
Fedwire party data, 138
Fedwire party ID, 141
Fedwire party phone, 142
Fedwire transaction
amount, 136
Fedwirenotes, 137

Index | 225
Confidential and Proprietary
FIN02829 October 2012

IDs, 146
ISO 20022, 150
ISO 20022 additional
info, 151
ISO 20022 address, 152
ISO 20022 party data, 150
ISO 20022 party ID, 153
ISO 20022 phone
number, 154
ISO20022 information, 155
name, 161
phone number, 163, 164
Swift information, 180
Swift MT 430 data, 175
SWIFT notes, 177
SWIFT party additional
info, 178
SWIFT party address, 179
SWIFT party data, 177
SWIFT party ID, 180
SWIFT transaction
amount, 176
record, watchlist
additional information, 123
addresses, 123, 125
AKAs, 126
country match, 131
entity match, 134
IDs, 146
match information, 157,
186
match strength, 159
match summary, 160, 175
name, 161
phone number, 163, 164
Request class, 100
request classes
see classes, request
response classes
see classes, response
response examples, 205
result record
see record, result
results

assigning, 89
BusinessInstantID, 128
emailing notification, 89
FraudPoint Score, 145
reassigning, 105
restricting to division, 89
S
Search
C# example, Direct, 70
C# example, Search
API, 40
Direct, 69
Search API, 40, 69
search
client reference, 130
password expiration
countdown, 133
search request, 100
search response, 165, 174
Search API
overview, 27
searching
ACH option properties, 97
Automatic False Positive
rule properties, 91
EFT data, 106
excluding low-quality
AKAs, 92
general search option
properties, 93
match option
properties, 97
no match results
returned, 93
OFAC match
properties, 97
setting data files, 92
unstructured data, single
string, 106
wires, 106
SearchRequest class, 101
Session class, 102

SetRecordState, 42
C# example, Search API, 43
SSNs
input, 95
support
Client Services website, 23
how to obtain, 23
technical support, 23
T
text
input, 98
training, 24
U
UnstructuredWire
C# example, Direct, 72
Direct, 72
UnstructuredWireRequest
class, 105
UpdateAssignResultsTo
class, 105
user ID, 91
V
visas
input, 95
W
watchlist country, 131
watchlist entity, 134
WatchListOptions class, 106
watchlists
adding to searches, 92
Web services
Bridger Insight XG
functionality, 17
compatibility, 17
overview, 13

Index | 226
Confidential and Proprietary
FIN02829 October 2012

Wire
C# example, Direct, 74
C# example, Search
API, 45
Direct, 73
Search API, 45
WireRequest class, 106
wires
Fedwire adjustment
info, 135
Fedwire document
info, 137
Fedwire information, 143
Fedwire notes, 137
Fedwire party additional

info, 139
Fedwire party address, 139
Fedwire party data, 138
Fedwire party ID, 141
Fedwire party phone, 142
Fedwire transaction
amount, 136
ISO 20022 additional
info, 151
ISO 20022 address, 152
ISO 20022 notes, 150
ISO 20022 party data, 150
ISO 20022 phone
number, 154
ISO20022 information, 155

ISO20022 party ID, 153


SWIFT information, 180
SWIFT MT 430 data, 175
SWIFT notes, 177
SWIFT party additional
info, 178
SWIFT party address, 179
SWIFT party data, 177
SWIFT party ID, 180
SWIFT transaction
amount, 176
World-Check, 64
searching, 92

Index | 227
Confidential and Proprietary
FIN02829 October 2012

You might also like