2016 XG WebServices REST
E D U G N O I T A T N E M E L P M
REST API
I
for LexisNexis® Bridger Insight® XG (XG) 5 Web Services
I
BIS298-EN_US — 28 December 2023
CONFIDENTIAL
CONFIDENTIAL
The recipient of this material (hereinafter "the Material") acknowledges that it contains confidential and proprietary data the disclosure to, or use of which by, third parties will be damaging to LexisNexis Risk Solutions and its affiliated companies (hereinafter "LexisNexis Risk Solutions"). Therefore, recipient agrees to hold the Material in strictest confidence, not to make use of it other than for the purpose for which it is being provided, to release it only to employees requiring such information, and not to release or disclose it to any other party. Upon request, recipient will return the Material together with all copies and modifications, if any, to LexisNexis Risk Solutions.
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 "as-is" without a warranty of any kind. Nothing herein should be construed as constituting a warranty, as any applicable warranty is exclusively contained in your signed agreement with LexisNexis Risk Solutions.
All names, addresses, birth dates or other identifying information in the text, or on the sample reports and screens shown in this document, are of fictitious persons and entities and have been created for illustrative purposes only. Any similarity to the name of any real person, school, business, other entity, address, date of birth, or other identifying information is purely coincidental.
LexisNexis, LexID, and the Knowledge Burst logo are registered trademarks of RELX Inc. Bridger Insight is a registered trademark of LexisNexis Risk Solutions Inc. FraudPoint and InstantID are registered trademarks of LexisNexis Risk Solutions FL Inc. WorldCompliance is a registered trademark of World Compliance, Inc. Other products and services may be trademarks or registered trademarks of their respective companies.
© 2023 LexisNexis Risk Solutions
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 2
CONFIDENTIAL
Con t ent s
Chapter 1: Bridger Insight XG. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Searchable Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
REST API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
About This Publication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Audience. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Content. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Publication Suggestions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Customer Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Customer Support Hub. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Chapter 2: REST API Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Communication Protocols. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
REST API Endpoints. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Request Authentication and Credentials. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
Application Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
Chapter 3: Token Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Issue Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
OAuth2Token Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Chapter 4: Lists Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
DataFiles Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
DataFileInfo Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Search Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Search Request Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23
Search Request Class Hierarchy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
AssignmentInfo Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
ClientContext Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
EntitySearchRequest Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
SearchConfiguration Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Search Input Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 3
CONFIDENTIAL
Search Response Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Search Response Class Hierarchy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Record Information Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
FraudPoint Score Result Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
InstantID Result Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47
List Screening Result Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
WorldCompliance Data Plus Result Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67
Chapter 5: Results Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Run Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Run Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
RunInfo Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
SearchRuns Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Run Management Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Result Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Record Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88
Records Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89
SearchRecords Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
SetRecordState Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Result Management Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Chapter 6: ListMaintenance Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
List Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
AddList Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
DeleteList Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
IndexList Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .112
List Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113
SearchLists Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
UpdateList Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
List Management Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
List Record Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
AddRecord Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
GetRecord Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 4
CONFIDENTIAL
ResultRecord Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .126
List Record Management Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .127
Chapter 7: EFT Parsed Input Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
ACH Parsed Input Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
ParsedACH Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
ParsedACHAdditionalInfo Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
ParsedACHAddress Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .140
ParsedACHField Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .140
ParsedACHID Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
ParsedACHNote Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .141
ParsedACHParty Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Fedwire Parsed Input Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
ParsedFedwire Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143
ParsedFedwireAdditionalInfo Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
ParsedFedwireAddress Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
ParsedFedwireAmount Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
ParsedFedwireField Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
ParsedFedwireID Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147
ParsedFedwireNote Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
ParsedFedwireParty Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
ParsedFedwirePhone Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .148
ISO 20022 Parsed Input Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .149
ParsedISO20022 Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
ParsedISO20022AdditionalInfo Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
ParsedISO20022Address Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
ParsedISO20022Field Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152
ParsedISO20022ID Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
ParsedISO20022Note Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
ParsedISO20022Party Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
ParsedISO20022Phone Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
SWIFT Parsed Input Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 5
CONFIDENTIAL
ParsedSWIFT Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
ParsedSWIFTAdditionalInfo Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
ParsedSWIFTAddress Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
ParsedSWIFTAmount Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
ParsedSWIFTField Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .164
ParsedSWIFTID Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
ParsedSWIFTNote Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
ParsedSWIFTOriginalMessage Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
ParsedSWIFTParty Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
EFT Party Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Chapter 8: Entity Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Input Entity Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Date Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
InputAccount Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
InputAdditionalInfo Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
InputAddress Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
InputID Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
InputName Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
InputPhone Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Entity Record Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
EntityAdditionalInfo Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .175
EntityAddress Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
EntityAKA Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
EntityID Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
EntityName Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
EntityPhone Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Entity Criteria Classes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
EntityCriteriaAdditionalInfo Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
EntityCriteriaAddress Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .179
EntityCriteriaID Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Possible Type Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 6
CONFIDENTIAL
Possible Additional Information Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .180
Possible ID Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .181
Chapter 9: Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Error Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
ResultError Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 7
CONFIDENTIAL
Chapter 1
Brid ger Insight XG
LexisNexis® Bridger Insight® XG (XG) is a risk management product that lets you use search services to compare your input entities against public and proprietary data. This functionality helps you lower compliance costs and protect yourself from regulatory risk.
As part of the search, you tell XG which settings to use, who to assign the alerts to, and whether to store the results in the XG database.
You also use XG to complete case management and workflow actions on the alerts and to manage batch runs. A batch run contains the details about a batch search or an alert import and any associated alerts. You can query, view, update, and delete alerts that are stored in the XG database. For example, you can change the alert assignment or add an alert to an accept list.
In addition, you use XG to manage accept lists and custom screening lists. Accept lists can help you suppress list screening matches in new searches that you have already processed and determined to be false positives or determined that updates to the entity records need to be monitored. Custom screening lists can help you flag entities in list screening searches that are unique to your organization.
Searchable Data
XG lets you search either structured input data or unstructured input data.
Structured data is organized into defined fields that lets XG treat like information the same for more relevant results. You can use custom formats to search business entity records, individual entity records, or unknown entity records. You can also use the following corresponding default formats to search payment transaction data:
ACH (Automated Clearing House) files
For information about ACH record content and format, see https://www.nacha.org. For information about supported ACH formats and the data that is processed by XG, see the related article that is available on the LexisNexis® Risk Solutions Customer Support Hub at https://lnrs.my.site.com/ CustomerSupportHub/s/article/2093.
Fedwire files
For information about Fedwire record content and format, see https://www.frbservices.org. For information about Fedwire file processing in XG, see the related article that is available on the Customer Support Hub at https://lnrs.my.site.com/CustomerSup...s/article/2148.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 8
CONFIDENTIAL
ISO (International Organization for Standardization) 20022 files
For information about ISO 20022 record content and format, see https://www.iso20022.org. For information about ISO 20022 file processing in XG, see the related article that is available on the Customer Support Hub at https://lnrs.my.site.com/CustomerSup...s/article/2064.
SWIFT (Society for Worldwide Interbank Financial Telecommunication) files
For information about SWIFT record content and format, see https://www.swift.com. For information about SWIFT file processing in XG, see the related article on the Customer Support Hub at https://lnrs.my.site.com/CustomerSup...s/article/1883 or https://lnrs.my.site.com/ CustomerSupportHub/s/article/2635.
For information about supported ACH formats and the data processed by XG, see the appropriate payment screening technical reference guide that is available on the Customer Support Hub.
Unstructured data is not organized into defined fields. You can search unstructured data as a text record or by using the Unstructured format. A text record contains one required field of unstructured text and optional ID fields. When you search unstructured data, XG must search files one text string at a time. This type of search may yield different results than when XG searches a file with identified fields.
REST API
The REST API for XG lets you incorporate the XG search functionality into your existing systems. The REST API provides several interfaces. Each request sends a JSON (JavaScript object notation) message with a method that defines the action to be performed.
XG also offers a SOAP API. For more information, see the related documentation on the Library page on the Customer Support Hub at https://lnrs.my.site.com/CustomerSup...s/article/2057.
The REST API includes the following interfaces:
Token Interface
You use the Token interface to access the web service.
Lists Interface
You use the Lists interface to perform searches. You can specify a predefined search that was created in the XG application. You can search screening lists that are provided by LexisNexis® Risk Solutions to help your organization conduct due diligence and comply with global mandates and government regulations. You can view the lists that are available for searching.
Results Interface
You use the Results interface to retrieve specified alerts, alerts that meet specified criteria, or runs that met specified criteria. You can change case management and workflow options for alerts.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 9
CONFIDENTIAL
ListMaintenance Interface
You use the ListMaintenance interface to manage accept lists and custom screening lists. You can add, query, view, update, and delete a list or add records to a list. You can index a custom screening list.
LexisNexis Risk Solutions provides the Swagger schema that defines the REST API.
The Swagger schema includes functionality that is not currently supported for the REST API. Supported functionality is described in this publication. LexisNexis Risk Solutions reserves the right to make backward compatible changes.
The way that you access the REST API depends on your product and environment:
XG Service
Depending on your account, you access the Swagger schema at https://
To view the schema in an interactive environment, you can go to https://editor.swagger.io, click File, click Import URL, enter the URL, and click OK.
LexisNexis Risk Solutions does not provide this interactive environment. The URL or interface options may change or be different from the provided description.
XG Enterprise
The Swagger schema location is configured when you install the product. See the LexisNexis® Bridger Insight® XG Enterprise Installation technical reference guide.
About This Publication
This publication provides information about how to use the XG REST API. References to other sections may be active hyperlinks. You can click the link to take you to the referenced section.
Audience
This publication contains technical information and is primarily written for programmers. You should also have a good understanding of JSON, REST (representational state transfer), and HTTP methods. The XG REST API should be used by staff with the necessary technical expertise. If not set up appropriately, then your system could become unusable.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 10
CONFIDENTIAL
Content
This publication is primarily organized by interfaces and shared classes. Class descriptions are ordered alphabetically.
Conventions
This publication uses various conventions to provide specific information. These conventions are described in the following sections.
Informat ion I co n s
LexisNexis Risk Solutions uses icons to highlight specific types of information.
This note icon precedes important information.
This tip icon precedes helpful information.
This warning icon precedes information that is intended to help prevent you from negatively affecting your processes.
Publication Suggestions
Your suggestions for publication improvements are welcome.
Send comments or suggestions to: TechnicalPublications@lexisnexisrisk.com.
Customer Support
Support and resources are available to XG clients who have purchased the product. The level of support that LexisNexis Risk Solutions provides varies based on the complexity of the XG installation and the contracted terms. For more information about the contracted terms, contact your sales representative.
For more information, see the Customer Support for LexisNexis® Bridger Insight® XG technical reference guide at https://lnrs.my.site.com/CustomerSup...s/article/1992.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 11
CONFIDENTIAL
Customer Support Hub
The Customer Support Hub provides access to web-based support for XG.
You can access the following resources at https://lnrs.my.site.com/CustomerSupportHub/s/:
Knowledge Base
The knowledge base provides articles to help you quickly learn more about a specific topic or to troubleshoot issues. The knowledge base also provides articles that contain technical documentation that you can download. For a list of technical documentation, view the library article at https://lnrs.my.site.com/ CustomerSupportHub/s/article/2057.
Support Requests
You can submit and manage support requests and chat live with a support representative.
Training
You can access self-paced courses or register for instructor-led courses that are delivered by webinar. Based on contracted terms, your customer contact can also schedule a remote or on-site training session with your technical account manager ("TAM") to refresh your end users, customer contacts, and administrators about product features and processes.
User Profile and Settings
You can manage the settings for your profile, account, and email notifications.
To access support and resources, you need a user account to access the Customer Support Hub.
R equest Ac ces s t o t he C us tomer Su pp ort Hub
You need a user account to access the Customer Support Hub.
Procedure:
1.
Go to https://lnrs.my.site.com/CustomerSupportHub/s/.
2.
Click Contact Support, and click your industry.
3.
Click your product.
4.
Provide your information, and indicate that you want access to the Customer Support Hub.
5.
Click Submit.
Result: After LexisNexis® Risk Solutions Customer Support creates your user account, you receive an email notification with your credentials.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 12
CONFIDENTIAL
Chapter 2
REST A PI S etup
The REST API for LexisNexis® Bridger Insight® XG (XG) provides setup flexibility.
Communication Protocols
The XG REST API supports JSON (JavaScript object notation) as the communication format, sent over HTTPS.
REST API Endpoints
The XG REST API provides endpoints for each method.
The base location for the REST API is https://
The REST API methods are located at the following endpoints:
Token Interface
The Issue method is located at /api/Token/Issue.
Lists Interface
The DataFiles method is located at /api/Lists/DataFiles.
The Search method is located at /api/Lists/Search.
Results Interface
The Record method is located at /api/Results/Record.
The Records method is located at /api/Results/Records.
The Run method is located at /api/Results/Run.
The RunInfo method is located at /api/Results/RunInfo.
The SearchRecords method is located at /api/Results/SearchRecords.
The SearchRuns method is located at /api/Results/SearchRuns.
The SetRecordState method is located at /api/Results/SetRecordState.
ListMaintenance Interface
The AddList method is located at /api/ListMaintenance/AddList.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 13
CONFIDENTIAL
The AddRecord method is located at /api/ListMaintenance/Record.
The GetRecord method is located at /api/ListMaintenance/Record.
The DeleteList method is located at /api/ListMaintenance/DeleteList.
The IndexList method is located at /api/ListMaintenance/IndexList.
The List method is located at /api/ListMaintenance/List.
The ResultRecord method is located at /api/ListMaintenance/ResultRecord.
The SearchLists method is located at /api/ListMaintenance/SearchLists.
The UpdateList method is located at /api/ListMaintenance/UpdateList.
Request Authentication and Credentials
The REST API uses a time-limited JWT (JSON Web Token) to authenticate requests.
Depending on your web service configuration, you request the JWT from XG or from your organization's Azure AD client. You pass the token to XG web services in the Authorization header in each request under the Bearer authorization scheme. Depending on the settings for the JWT issuer and the frequency of the web service requests, a new JWT may be required for each request.
JWT Issued by XG
By default, the REST API uses a JWT that is issued by XG. You pass the XG user ID, client ID, and password for the user who makes the request in the Authorization header of the Issue method. The Issue method returns a JWT in the access_token property of the OAuth2Token class.
JWT Issued by Azure AD
XG Enterprise clients that use Azure AD for identity federation can configure the REST API to accept a JWT that is generated by Azure AD instead of XG. Clients must set up their own Azure AD client and a method to request the JWT from Azure AD.
LexisNexis® Risk Solutions does not assist with Azure AD setup.
If you use Azure AD to issue the JWT, then you need to pass the base64-encoded XG client ID and user ID separated by a forward slash in the X-ClientInfo header in each REST API request. For example, an XG user with the client ID XGClient and the user ID Admin1 uses the client info parameter XGClient/Admin1. The authorization parameter base64-encoded is WEdDbGllbnQvQWRtaW4x. For some methods, you can also pass the client ID and user ID in the ClientID and UserID properties of the ClientContext class. If you also pass the credentials in the X-ClientInfo header, then the REST API ignores these properties in the ClientContext class.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 14
CONFIDENTIAL
LexisNexis Risk Solutions recommends that you pass the credentials in the X-ClientInfo header rather than in the ClientContext class. Not all methods accept user credentials through the ClientContext class.
Application Setup
Certain features must be set up in the XG application before you can use the XG REST API.
User Settings
The user that sends the request must have an existing and active XG account and must have the division access and the role access that is required to perform the actions.
Your organization can create a user account that is used for only web services. This option is displayed only if web services are enabled for the client instance. The option is activated only if IP settings are enabled in the client instance. The password for the user account never expires. For more information, see the LexisNexis® Bridger Insight® XG Help.
Predefined Searches
To use the XG REST API, you must specify a predefined search that was set up in the XG application. The user that sends the request must have the division access and the role access that is configured for the predefined search. For more information, see the LexisNexis® Bridger Insight® XG Help.
Enterprise Manager Settings
To use the XG REST API, XG Enterprise clients need to configure the web service settings in Enterprise Manager for each client instance.
For XG Service clients, LexisNexis Risk Solutions configures these settings for you.
The following product options in the client instance setup must be configured:
REST
The XG client instance needs to be configured to accept JWT authentication for requests to the Lists interface.
For XG Service, and XG Enterprise clients that use XG to authenticate requests, the REST option needs to be set to Bridger JWT.
For XG Enterprise clients that use Azure AD to authenticate requests, the REST option needs to be set to Azure JWT and the Azure JWT Options settings need to be configured.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 15
CONFIDENTIAL
JWT Options for Azure AD
For XG Enterprise clients that use Azure AD to authenticate requests, the following settings need to be configured:
Azure AD ClientID
This field contains the Azure application ID.
Azure AD Tenant
This field contains the primary domain for the Azure tenant. For example,
Azure AD Audience
This field contains the URI (Uniform Resource Identifier) for the Azure application ID. Typically the application ID URI is a combination of the Azure tenant primary domain and the Azure client name.
Azure AD Instance
This field always contains https://login.microsoftonline.com/{0}.
API Authentication Key
The API (application programming interface) key, which you use to authenticate your requests, needs to be generated for each XG client instance. XG Enterprise clients generate their API key in Enterprise Manager. XG Service clients receive an API key from LexisNexis Risk Solutions.
You include the XG API key in the X-API-Key HTTP header of requests to the Lists interface.
The XG API key does not expire. If your API key is compromised, then you can regenerate a new API key. You need to immediately update the API key in XG web services to prevent errors.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 16
CONFIDENTIAL
Chapter 3
Tok en In t erface
The REST API for LexisNexis® Bridger Insight® XG (XG) provides a Token interface that lets you request a JWT (JSON Web Token) from the XG authentication server.
The Token interface provides a JWT through XG sign-in credentials. To use the Token interface, the REST option in Enterprise Manager must be set to Bridger JWT. If the REST option is set to Azure JWT, then you use Azure AD to generate the tokens instead.
Issue Method
The Issue method sends the credential information to the XG server to request a JWT. The JWT expires after a period of time that is set in your XG environment's configuration. You need to update the JWT before the token expires to prevent errors.
The method is sent with the following HTTP request properties:
Request Line
The request uses the POST HTTP method. The request is sent to the following endpoint on the host server: /api/Token/Issue.
Required Headers Authorization
The request uses the Basic authorization scheme. For the authorization parameters, the username is the XG client ID and user ID, separated with a forward slash, and the password is the XG user password. The authorization parameter is Base64 encoded.
For example, a user with the client ID XGClient, the user ID Admin1 and the password $amp1ePa$$w0rd! uses the authorization parameter XGClient/Admin1:$amp1ePa$$w0rd!. The authorization parameter base64-encoded is WEdDbGllbnQvQWRtaW4xOiRhbXAxZVBhJCR3MHJkIQ==.
Host
The request is sent to https://
Body
The request does not contain a body.
Return Values
The response returns a string that contains the authentication results in the OAuth2Token class.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 17
CONFIDENTIAL
Issue Request Example
The following code shows an example of the HTTP request. The code that you send is different.
POST /api/Token/Issue HTTP/1.1
Host:
Authorization: Basic
Content-Type: application/json;charset=UTF-8
Content-Length: 0
OAuth2Token Class
The OAuth2Token class contains a JWT and associated metadata.
Class Elements
Name
Type
Description
token_type
String
This element contains the token type. XG accepts bearer tokens.
expires_in
Integer
This element contains the token lifetime in seconds. The JWT expires after a period of time that is set in your XG environment's configuration.
expires_on
Integer
This element contains the date and time when the token expires. This element contains the date and time before which the token is invalid. This element contains the resource that issued the token. This element contains the JWT.
not_before
Integer
resource
String
access_token
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 18
CONFIDENTIAL
Chapter 4
Lists Int e rface
The REST API for LexisNexis® Bridger Insight® XG (XG) provides a Lists interface that lets you perform searches on your input information.
You can choose to write search results to your XG database for further processing. You can access these alerts through the XG application.
The Lists interface lets you view information about available accept lists and screening lists. You can perform list screening searches on accept lists, custom screening lists, and screening lists that are provided by LexisNexis® Risk Solutions. You can also include the LexisNexis® FraudPoint® Score service and LexisNexis® InstantID® in your searches.
For each search request, you need to specify a predefined search that was created in the XG application. The predefined search tells XG which settings to use in the search.
DataFiles Method
The DataFiles method returns a list of the available accept lists, custom screening lists, and screening lists that are provided by LexisNexis Risk Solutions.
The method is sent with the following HTTP request properties:
Request Line
The request uses the POST HTTP method. The request is sent to the following endpoint on the host server: /api/Lists/DataFiles.
Required Headers Authorization
The request uses a bearer JWT (JSON Web Token) for authentication.
Content-Type
The request contains a JSON (JavaScript object notation) message.
Host
The request is sent to https://
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 19
CONFIDENTIAL
X-API-Key
The request contains the API (application programming interface) authentication key for your client instance. XG Enterprise clients generate their API key in Enterprise Manager. XG Service clients receive an API key from LexisNexis Risk Solutions.
X-ClientInfo
This header is not required for Bridger JWT authentication. If the request uses a JWT that was generated by Azure AD, then the request can contain the base64-encoded XG client ID and user ID separated by a forward slash in the X-ClientInfo header. If the request uses this header, then XG ignores the ClientID and UserID elements in the ClientContext class.
Body
The request contains the ClientContext class.
Return Values
The response contains a DataFileInfo class for each available list.
DataFiles Request Example
The following code shows an example of the HTTP request. The code that you send is different.
POST /api/Lists/DataFiles HTTP/1.1
Host:
Authorization: Bearer
Content-Type: application/json
X-API-Key:
{
"ClientContext": {...}
}
DataFileInfo Class
The DataFileInfo class contains information about the accept list, the custom screening list, or the screening list that was provided by LexisNexis Risk Solutions.
Class Elements
Name
Type
Description
Custom Description FileDate
Boolean String DateTime
True indicates that the file is a custom screening list. This element contains the list description. This element contains the date (YYYY-MM-DD) and 24-hour local time (HH:MM:SS) that LexisNexis Risk Solutions provided the file.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 20
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
HasWeakAKAs
Boolean
True indicates that the file has low-quality AKA (also known as) information. This element contains the system-generated number that identifies the list. This element contains the list name. This element contains the date (YYYY-MM-DD) and 24- hour local time (HH:MM:SS) that the source agency provided the file. This element contains the delimited list of the search criteria that is available for the file. You cannot include this entire list in a search request. For more information about search criteria, see the appropriate search criteria documentation that is available on the LexisNexis® Risk Solutions Customer Support Hub.
ID
GUID
Name PublishedDate
String DateTime
SearchCriteria
String
Type
DataFileType
This element contains the data file type. Possible values: • UDF (XG file) • ADF (accept list) • BDF (entity list) • CDF (country list) • SDF (XG file)
Search Method
The Search method sends the input entity information to the XG server for processing using the specified predefined search.
The method is sent with the following HTTP request properties:
Request Line
The request uses the POST HTTP method. The request is sent to the following endpoint on the host server: /api/Lists/Search.
Required Headers Authorization
The request uses a bearer JWT for authentication.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 21
CONFIDENTIAL
Content-Type
The request contains a JSON message.
Host
The request is sent to https://
X-API-Key
The request contains the API authentication key for your client instance. XG Enterprise clients generate their API key in Enterprise Manager. XG Service clients receive an API key from LexisNexis Risk Solutions.
X-ClientInfo
This header is not required for Bridger JWT authentication. If the request uses a JWT that was generated by Azure AD, then the request can contain the base64-encoded XG client ID and user ID separated by a forward slash in the X-ClientInfo header. If the request uses this header, then XG ignores the ClientID and UserID elements in the ClientContext class.
Body
The request contains the EntitySearchRequest class.
Return Values
The response contains the SearchResults class.
Search Request Example
The following code shows an example of the HTTP request. The code that you send is different.
POST /api/Lists/Search HTTP/1.1
Host:
Authorization: Bearer
Content-Type: application/json
X-API-Key:
{
"EntitySearchRequest": { "ClientContext": {...},
"SearchConfiguration": {...},
"SearchInput": {...}
} }
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 22
CONFIDENTIAL
Search Request Classes
In the search request, you include the input information that you want to search and the name of the predefined search that you want XG to use in the search.
Some classes contain other classes as properties. The classes are described in alphabetical order.
Search Request Class Hierarchy
A class hierarchy depicts the structure of the classes.
The following class hierarchy depicts the structure of the search request:
"EntitySearchRequest Class" on page 28
"ClientContext Class" on page 25 "SearchConfiguration Class" on page 28 "AssignmentInfo Class" on page 23
"SearchInput Class" on page 34
"InputRecord Class" on page 32
"InputBasicID Class" on page 30 "InputEFT Class" on page 31 "InputEntity Class" on page 31
"InputAccount Class" on page 170 "InputAdditionalInfo Class" on page 170
"Date Class" on page 82 "InputAddress Class" on page 170 "InputID Class" on page 172
"Date Class" on page 82
"InputName Class" on page 173 "InputPhone Class" on page 174
"InputText Class" on page 33
"InputID Class" on page 172
"Date Class" on page 82
AssignmentInfo Class
The AssignmentInfo class sets division access and assigns alerts to specified roles or users. You can also restrict record access to a division.
Divisions, roles, and users are set up through the XG application. See the LexisNexis® Bridger Insight® XG Help.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 23
CONFIDENTIAL
Class Elements
Name
Type
Description
Division
String
This element restricts alert access to the specified division. Only users in the specified division can process the alerts generated from the search. This element is required.
EmailNotification
Boolean
True sends a single email message to each specified user or users in specified roles who were assigned alerts for each completed request.
If the results are restricted to a division, then only users within a role that has access to that division receive an email message.
XG does not send an email if the user has received an email for a different alert within the past 60 minutes. The email messages do not provide details about the alert. The default value is false.
RolesOrUsers
List
This element contains the role or the users to be assigned alerts. You must specify either one role or one or more users, not both. If you specify a role, then the role must include users who belong to a division that can access the alerts. If you specify users, then you must specify the user ID and not the user name. If you specify multiple users, then the alerts are assigned in a round-robin fashion to specified users. If you included a Division element, then only the users who belong to the specified division are assigned alerts. This element contains the assignment type. Possible values: • Role • Unknown • User The Unknown value is not valid in a request.
Type
AssignmentType
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 24
CONFIDENTIAL
ClientContext Class
The ClientContext class contains the XG client information and the XG session information.
Class Elements
Name
Type
Description
ClientID
String
This element contains the client ID that identifies the XG web services instance that sent the request. This property is required for requests authenticated with the Azure JWT option if the client ID is not passed in the request header.
ClientReference
String
This element contains optional user-defined information to identify the request. For Search requests, this property is returned in the SearchResult class.
DPPA
DPPAChoiceType
This element contains the DPPA (Driver's Privacy Protection Act) permissible use. Possible values: • NA • Choice0 • Choice1 • Choice2 The default value is NA. This value is not valid if a DPPA permissible use is required. This property is required for FraudPoint Score searches or InstantID searches on individual entities.
• Choice3 • Choice4 • Choice6
GLB
Integer
This element contains the GLBA (Gramm-Leach-Bliley Act) permissible use. Possible values: • 0 • 1 • 2 • 3 This property is required for FraudPoint Score searches or InstantID searches.
• 5 • 6 • 7 • 12
UserID
String
This element contains the user ID that identifies the user who sends the request.
The user must have the division access and the role access that is required to perform the requested actions. See the LexisNexis® Bridger Insight® XG Help.
This property is required for requests authenticated with the Azure JWT option if the user ID is not passed in the request header.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 25
CONFIDENTIAL
DPPA Pe rmis s ibl e U ses Users must set a DPPA permissible use for each individual search against LexisNexis® FraudPoint® or InstantID.
By entering your response and proceeding with your search, you certify to LexisNexis Risk Solutions that you are in, and assume full responsibility for, compliance with DPPA in accordance with your response herein and you agree to indemnify, defend, and hold harmless LexisNexis Risk Solutions from any breach of such certification by you, your agents, or contacts and any damages, fees, and costs associated therewith. Information from this file may not be used to determine a customer's eligibility for credit, insurance, or employment pursuant to the Fair Credit Reporting Act, (15 USC Sec. 1681).
Users can set one of the following possible DPPA permissible uses. The service searches against driver licenses, motor vehicle registrations, and boat registrations for the states that recognize the permissible use that you set. If you set No Permissible Use, the service does not search driver licenses, motor vehicle registrations, or boat registrations.
DPPA Permissible Uses
Input Value
Name
Description
Choice0
No Permissible Use
For persons who do not have a DPPA permissible use. Use by a court, law enforcement agency or other government agency or entity, acting directly on behalf of a government agency. Use for any matter regarding motor vehicle or driver safety or theft (except by motor vehicle manufacturers). 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. 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. Use by an insurer or insurance support organization, in connection with claims investigation activities or anti-fraud activities.
Choice1
Court, Law Enforcement, or Government Agencies
Choice2
Motor Vehicle Safety or Theft
Choice3
Use in the Normal Course of Business
Choice4
Civil, Criminal, Administrative, or Arbitral Proceedings
Choice6
Insurance
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 26
CONFIDENTIAL
GLBA Pe rm issib l e U ses
Users must set a GLBA exception (permissible use) for each search against FraudPoint Score or InstantID.
Misrepresenting your access is a violation of the LexisNexis Risk Solutions subscriber agreement and may be a violation of federal and state laws. Any use of LexisNexis Risk Solutions information other than for the selected purpose is grounds for account termination and may be referred to the FTC (Federal Trade Commission), law enforcement, or the appropriate state investigative agency.
Users can set one of the following possible GLBA permissible uses. The service searches the data that is regulated by the GLBA that you set and the data that is not regulated by the GLBA. If you set No Permissible Use, the service searches the data that is not regulated by the GLBA. The use of information obtained from these databases is limited to use with the ordinary course and scope of the user's business or profession. The user represents and warrants that such use is for lawful and appropriate purpose.
GLBA Permissible Uses
Input Value
Name
Description
0
No Permissible Use
For persons who do not have a GLBA permissible use. To the extent specifically permitted or required under other provisions of laws and in accordance with the Right to Financial Privacy Act of 1978, to law enforcement agencies, self- regulatory organizations or for an investigation on a matter related to public safety. As necessary to effect, administer, or enforce a transaction requested or authorized by the consumer. Use by persons, or their representatives, holding a legal or beneficial interest relating to the consumer. To protect against or prevent actual or potential fraud, unauthorized transactions, claims or other liability. In required institutional risk control programs. In complying with federal, state, or local laws, rules, and other applicable legal requirements. Use by persons acting in a fiduciary or representative capacity on behalf of the consumer.
Law Enforcement/self-regulatory organizations/public safety
1
Transactions Authorized by Consumer
3
Persons with a Legal/Beneficial Interest in the Consumer
5
Fraud Prevention and Detection
6 7
Required Institutional Risk Control Legal Compliance
12
Persons Acting in a Fiduciary Capacity for the Consumer
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 27
CONFIDENTIAL
EntitySearchRequest Class
The EntitySearchRequest class contains the search request information that is sent to the XG REST API. This class is required for all Search requests to return successful results.
Class Elements
Name
Type
Description
ClientContext
ClientContext
The ClientContext class contains the XG client information and the XG session information. This element is required.
Configuration
SearchConfiguration
The SearchConfiguration class contains the settings to be used in a search. This element is required.
Input
SearchInput
The SearchInput class contains the input records. This element is required.
SearchConfiguration Class
The SearchConfiguration class contains the settings to be used in a search. This class is required for all Search requests to return successful results.
These settings affect your organization's results. Test these settings thoroughly before including them in your business process.
Class Elements
Name
Type
Description
AssignResultTo
AssignmentInfo
The AssignmentInfo class sets division access and assigns alerts to specified roles or users. If this property is not included in a request, then alerts are unassigned.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 28
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
DuplicateMatch Suppression
Boolean
True sets XG to not generate duplicate matches from the request when an open alert already contains an identical match. To suppress a duplicate match, the following conditions must be met: • The input information is in a standard structured format. The input information cannot be an unstructured record or a payment transaction record (EFT (electronic funds transfer) record).
• The list match in the two alerts must be
identical.
• The input information in the two alerts must be identical (for example, uppercase/lowercase or date formats).
• The existing alert must be current (not archived)
with an open alert state.
This feature does not suppress duplicate matches from real-time searches. The feature also does not suppress matches that contain errors.
When this feature is configured, alerts that contain the following validation message are suppressed: The name is empty or contains invalid data.
The default value is false.
DuplicateMatch SuppressionSameDivision Only
Boolean
True sets XG to not generate duplicate matches only for alerts that can be accessed by the same division. The default value is false.
ExcludeScreeningList Matches
Boolean
True sets XG to exclude list matches for an alert in the response. This option can help reduce network traffic. The response only returns the following elements in the ResultRecord class: • Record • ResultID • RunID • HasScreeningListMatches • RecordStatus If this element is set to false, then the ResultRecord class does not return the HasScreeningListMatches and RecordStatus elements. The default value is false.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 29
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
PredefinedSearchName
String
This element contains a predefined search that was created in the XG user interface. Predefined searches provide a specific set of settings that XG uses to perform searches. Automating the selection of these search settings helps you establish more efficient and consistent searching. You must have the division access and the role access that is required to use the predefined search. XG ignores the result assignment settings in the predefined search if you provide the AssignResultTo property. If search services other than list screening are included in the predefined search, then service credentials must be set up through the XG user interface. This element is required.
WriteResultsToDatabase
Boolean
True sets XG to store the search results in the XG database. The default value is false.
Search Input Classes
The search request includes the classes that contain the input entity information.
InputBas icI D Cl as s
The InputBasicID class contains the input ID. This element is typically used to search screening list data for a specific proprietary ID for the entity that is provided by the source agency or by LexisNexis Risk Solutions. Matches to this search are not included in alerts and are not stored in the result database.
Class Elements
Name
Type
Description
Number Type
String IDType
This element contains the ID number. This element contains the ID type. The ID type is typically ProprietaryUID. This element is required.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 30
CONFIDENTIAL
InputEFT C l ass
The InputEFT class contains input payment transaction information or input unstructured information. This element is used to search unstructured data or payment transaction data.
XG does not return the input information that was searched using the Unstructured EFT type.
Class Elements
Name
Type
Description
EFTID
String
This element contains a user-defined number that identifies the input EFT. This ID replaces the system- generated EFT ID that is displayed for results that are from payment alert queries in the application.
If your organization provides a value that overrides the LexisNexis Risk Solutions default value, then your organization must ensure that the values are unique.
Type
EFTType
This element contains the payment transaction type. Possible values: • None • ACH • Fedwire • ISO20022 • SWIFT • Unstructured None is not valid in a request. XML in ISO20022 requests must be encoded before processing.
Value
String
This element contains the input payment transaction record or the input unstructured record.
InputEnt ity Cl as s
The InputEntity class contains the structured input record for business entities, individual entities, or unknown entities. This element is used to search data that is parsed into a structured format.
Class Elements
Name
Type
Description
Account
InputAccount
The InputAccount class contains the account information that helps identify the input entity. The InputAdditionalInfo class contains the additional information that helps identify the input entity. The InputAddress class contains the input address information. An address is required for InstantID business searches.
AdditionalInfo
List
Addresses
List
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 31
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
EntityType
InputEntityType
This element contains the entity type. Possible values: • None • Business • Individual • Unknown None is not valid in a request.
Records with an unknown entity type can only be searched against screening lists.
This element is required.
Gender
GenderType
This element contains the entity gender type. Possible values: • None • Female • Male • Unknown None is not valid in a request. You use this element only for individual entities.
IDs Name
List
The InputID class contains the input ID information. The InputName class contains the input name information. This element is required.
Phones
List
The InputPhone class contains the input phone number information.
InputRe co rd C l ass
The InputRecord class contains an input record to be searched. This class is required for all Search requests to return successful results.
You must provide one of the following elements, which are ordered from highest to lowest priority:
1. 2. 3. 4.
InputEntity InputText InputEFT InputBasicID
If you provide more than one, then XG searches only the element with the highest priority.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 32
CONFIDENTIAL
Class Elements
Name
Type
Description
EFT
InputEFT
The InputEFT class contains input payment transaction information or input unstructured information. This element is used to search unstructured data or payment transaction data. The InputEntity class contains the structured input record for business entities, individual entities, or unknown entities. This element is used to search data that is parsed into a structured format. The InputBasicID class contains the input ID. This element is typically used to search screening list data for a specific proprietary ID for the entity that is provided by the source agency or by LexisNexis Risk Solutions. This element contains the user-defined number that identifies the record in the request. The same number is returned in the Record element of the ResultRecord class. For payment data searches and unstructured data searches, XG does not return the input information when no list matches are reported. You can use this number to track the record.
Entity
InputEntity
ID
InputBasicID
RecordID
Long
Text
InputText
The InputText class contains the input information for a text record. This element is used to search unstructured data that also contains a defined ID.
InputTe xt Cl ass
The InputText class contains the input information for a text record. This element is used to search unstructured data that also contains a defined ID.
Class Elements
Name
Type
Description
IDs Text
InputID String
The InputID class contains the input ID information. This element contains the input text string.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 33
CONFIDENTIAL
Searc hI npu t Cl ass
The SearchInput class contains the input records. For a search that includes entity records or text records, the request can contain a maximum of 100 records. For a search that contains payment transaction records, the request can contain multiple records with a total maximum size of 1 MB for the entire search input. This class is required for all Search requests to return successful results.
Class Elements
Name
Type
Description
BlockID Records
String List
This element contains the block ID. The InputRecord class contains an input record to be searched. This element is required.
Search Response Classes
The XG REST API returns search responses as JSON objects.
This information is defined by the following classes:
• "Record Information Classes" on page 37 • "FraudPoint Score Result Classes" on page 45 • "InstantID Result Classes" on page 47 • "List Screening Result Classes" on page 55
Some classes contain other classes as properties. The classes are described in alphabetical order.
Search Response Class Hierarchy
A class hierarchy depicts the structure of the classes.
The following class hierarchy depicts the structure of the search request:
"SearchResults Class" on page 44
"ResultRecord Class" on page 40
"FraudPointResults Class" on page 46 "FPInput Class" on page 45
"FPAddress Class" on page 45 "InputName Class" on page 173
"FPRedFlag Class" on page 46
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 34
CONFIDENTIAL
"FPRiskIndicator Class" on page 46
"FPRiskIndicator Class" on page 46 "ResultError Class" on page 182 "InstantIDBusinessResults Class" on page 52 "IIDFEINMatch Class" on page 49
"IIDAddress Class" on page 48
"IIDFiling Class" on page 49
"IIDAddress Class" on page 48
"IIDInput Class" on page 49
"IIDAddress Class" on page 48 "InputName Class" on page 173
"IIDReversePhone Class" on page 50 "IIDAddress Class" on page 48 "InputName Class" on page 173
"IIDRiskIndicator Class" on page 50 "IIDVerificationIndicators Class" on page 51 "IIDWatchlist Class" on page 51
"IIDAddress Class" on page 48
"ResultError Class" on page 182 "InstantIDIndividualResults Class" on page 53
"IIDAddressHistory Class" on page 48
"IIDAddress Class" on page 48
"IIDAlternateName Class" on page 48 "IIDInput Class" on page 49
"IIDAddress Class" on page 48 "InputName Class" on page 173
"IIDRedFlag Class" on page 50
"IIDRiskIndicator Class" on page 50
"IIDReversePhone Class" on page 50 "IIDAddress Class" on page 48 "InputName Class" on page 173
"IIDRiskIndicator Class" on page 50 "IIDSSNInfo Class" on page 51 "IIDWatchlist Class" on page 51
"IIDWatchlist Class" on page 51
"ResultError Class" on page 182
"ResultRecordDetails Class" on page 41
"InputAdditionalInfo Class" on page 170
"Date Class" on page 82 "InputAddress Class" on page 170 "InputID Class" on page 172
"Date Class" on page 82
"InputName Class" on page 173 "ParsedACH Class" on page 138
"ParsedACHField Class" on page 140 "ParsedACHNote Class" on page 141
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 35
CONFIDENTIAL
"ParsedACHParty Class" on page 143
"ParsedACHAdditionalInfo Class" on page 139 "ParsedACHAddress Class" on page 140 "ParsedACHID Class" on page 141
"ParsedFedwire Class" on page 143
"ParsedFedwireField Class" on page 146
"ParsedFedwireAmount Class" on page 146
"ParsedFedwireNote Class" on page 147 "ParsedFedwireParty Class" on page 147
"ParsedFedwireAdditionalInfo Class" on page 144 "ParsedFedwireAddress Class" on page 145 "ParsedFedwireNote Class" on page 147 "ParsedFedwireID Class" on page 147 "ParsedFedwirePhone Class" on page 148
"ParsedISO20022 Class" on page 149
"ParsedISO20022Field Class" on page 152 "ParsedISO20022Note Class" on page 152 "ParsedISO20022Party Class" on page 153
"ParsedISO20022AdditionalInfo Class" on page 150 "ParsedISO20022Address Class" on page 150 "ParsedISO20022ID Class" on page 152 "ParsedISO20022Note Class" on page 152 "ParsedISO20022Phone Class" on page 154
"ParsedSWIFT Class" on page 154
"ParsedSWIFTField Class" on page 164
"ParsedSWIFTAmount Class" on page 163 "ParsedSWIFTOriginalMessage Class" on page 165
"ParsedSWIFTNote Class" on page 164 "ParsedSWIFTParty Class" on page 165
"ParsedSWIFTAdditionalInfo Class" on page 162 "ParsedSWIFTAddress Class" on page 162 "ParsedSWIFTID Class" on page 164
"InputPhone Class" on page 174 "RecordState Class" on page 39
"AuditItem Class" on page 38 "WatchlistMatchState Class" on page 45
"ResultError Class" on page 182
"WatchlistResults Class" on page 56
"OFACReportInfo Class" on page 55
"OFACInstitutionInfo Class" on page 55
"ResultError Class" on page 182 "WLAddressMatch Class" on page 56 "WLCitizenshipMatch Class" on page 57 "WLCountryDetails Class" on page 57 "WLDOBMatch Class" on page 58 "WLEntityDetails Class" on page 58
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 36
CONFIDENTIAL
"EntityAdditionalInfo Class" on page 175 "EntityAddress Class" on page 175 "EntityAKA Class" on page 176 "EntityID Class" on page 176
"Date Class" on page 82
"EntityName Class" on page 177 "EntityPhone Class" on page 177
"WLMatch Class" on page 60
"AdverseMedia Class" on page 67 "CountryAssociation Class" on page 67 "Enforcement Class" on page 68 "MSB Class" on page 68 "OtherSegment Class" on page 69
"CountryAssociation Class" on page 67
"PEP Class" on page 70 "Registration Class" on page 71 "Relationship Class" on page 72 "Sanction Class" on page 73 "SOE Class" on page 74
"CountryAssociation Class" on page 67
"Vessel Class" on page 74 "WLIDMatch Class" on page 59 "WLMatchConflicts Class" on page 64 "WLMatchFile Class" on page 64 "WLMatchFprDetails Class" on page 65 "WLMatchSummary Class" on page 65
"WLMatchSummaryItem Class" on page 66
"WLPhoneMatch Class" on page 66
Record Information Classes
The search response includes the classes that contain information about the record details, the record state, and the record history.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 37
CONFIDENTIAL
AuditI te m Cl as s
The AuditItem class contains the events that are associated with an alert. For auditing purposes, this record history can provide an account of your organization's processing actions on the entity.
Class Elements
Name
Type
Description
Date
DateTime
This element contains the date (YYYY-MM-DD) and the 24-hour local time (HH:MM:SS) that the event was added to the record history. This element contains the event type. Possible values: • Added to Accept List • Added to Custom Screening List • Alert Decision Applied • Alert Opened or Closed • Archive Transfer • Attachment Added or Attachment
Event
String
Deleted
• Decision Tags Changed • Field Truncated • LexisNexis FraudPoint • LexisNexis InstantID • LexisNexis InstantID International • LexisNexis News • List Screening Search Conducted • Match Note Added • Match Note Updated • New Note • OFAC Report Generated • Reassigned • Record Created • Record Details Changed • Record Rerun • Status Changed • XG4 Alert Transfer
Note
String
For a Note Added event, this element contains the note that was provided by the user. For other events, this element contains system information about the event.
User
String
This element contains the user name of the person who performed the event.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 38
CONFIDENTIAL
RecordStat e C l ass
The RecordState class contains a combination of case management options and workflow options for the alert.
Class Elements
Name
Type
Description
AddedToAcceptList
Boolean
True indicates that the alert was added to an accept list. This element contains the alert state. Possible values: • None • Closed • Open • Unassigned None is not valid in a request. Unassigned is only returned for alerts that did not contain results. For example, this value is set if the search generated an error but not an alert.
AlertState
AlertStateType
AssignedTo
List
This element contains the user or the list of roles. You cannot assign the alert to a user or role if the state is set to Closed. Only users who belong to the division can process the alert.
AssignmentType
AssignmentType
This element contains the assignment type. Possible values: • Role • Unknown • User
Division
String
This element contains the division that can access the alert. Only users who belong to the division can process the alert.
History
List
The AuditItem class contains the events that are associated with an alert. This element is only returned as part of search results. The WatchlistMatchState class contains the decision information if separate decisions were set for each list match in the alert.
MatchStates
List
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 39
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
Note Status
String String
This element contains user-defined information. This element contains the alert status. The status value must correspond with an alert status set up in the XG application. The values are not case sensitive and will reflect the default case used in the XG application. To avoid possible errors and clearly indicate what stage the alert is at in your result process, XG can be configured to require an alert status when alerts are closed or reassigned. If a required alert status is not set, then an error is returned.
ResultRec ord Cl ass
The ResultRecord class contains information about the alert.
When you add the alert to an accept list or a custom screening list, XG ignores the information that is not relevant to list searching. For example, results from search services other than list screening are not added to an accept list or a custom screening list.
Class Elements
Name
Type
Description
AttachmentIDs
List
This element contains the system-generated number that identifies a file attached to the alert. This element contains the user-defined EFT ID. The FraudPointResults class contains the FraudPoint Score results. True indicates that the alert contains list matches. This element is returned only if ExcludeScreeningListMatches parameter is set to true in the request to exclude list matches in the response.
EFTID FraudPoint
String FraudPointResults
HasScreeningListMatches
Boolean
InstantIDBusiness
InstantIDBusinessResults
The InstantIDBusinessResults class contains the results for InstantID business searches. The InstantIDIndividualResults class contains the results for InstantID individual searches. The LexisNexis® InstantID® International service is no longer available. This class and its elements are not defined. This element contains the user-defined number that identifies the alert in the request.
InstantIDIndividual
InstantIDIndividual Results InstantIDIntlIndividual Results
InstantIDIntlIndividual
Record
Long
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 40
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
RecordDetails
ResultRecordDetails
The ResultRecordDetails class contains the account information, the input data, and the other details about the alert. This element is required when you add the alert to an accept list or custom screening list.
RecordStatus
String
This element contains the current status of the alert. This element is returned only if the ExcludeScreeningListMatches parameter is set to true in the request to exclude list matches in the response.
ResultID
Long
This element contains the system-generated number that identifies the alert. This element is required when you add the alert to an accept list.
RunID
Long
This element contains the system-generated number that identifies the search if the alerts were stored in the XG database. This element is required when you add the alert to an accept list.
Watchlist
WatchlistResults
The WatchlistResults class indicates the status of the list search and contains potential matches. This element is required when you add the alert to an accept list.
ResultRec ordD et ail s Class
The ResultRecordDetails class contains the account information, the input data, and the other details about the alert.
Class Elements
Name
Type
Description
AcceptListID
Long
This element contains the system-generated number that identifies the accept list to which the record was added. This element contains the account amount. This element contains the account date. This element contains the account group ID. This element contains the user-defined account data. This element contains the account provider ID. This element contains the account type. True indicates that the alert was added to an accept list.
AccountAmount AccountDate AccountGroupID AccountOtherData AccountProviderID AccountType AddedToAcceptList
String String String String String String Boolean
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 41
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
AdditionalInfo
List
The InputAdditionalInfo class contains the additional information that helps identify the input entity. The InputAddress class contains the input address information. If you add the record to an accept list, then this element or the IDs element is required.
Addresses
List
CustomWatchlistIDs
List
This element contains the system-generated number that identifies the custom screening list to which the record was added. This element contains the division that can access the alert. Only users who belong to the division can process the alert.
Division
String
DPPA
DPPAChoiceType
This element contains the DPPA permissible use. Possible values: • NA • Choice0 • Choice1 • Choice2 The default value is NA. This value is not valid if a DPPA permissible use is required. This property is required for FraudPoint Score searches or InstantID searches on individual entities.
• Choice3 • Choice4 • Choice6
EFTContext
String
If a list match is generated, then this element contains the input payment transaction information in which the match was found. This element contains the payment transaction type. Possible values: • None • ACH • Fedwire • ISO20022 • SWIFT • Unstructured
EFTType
EFTType
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 42
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
EntityType
ResultEntityType
This element contains the entity type. Possible values: • Business • Individual • Text • Unknown • Unstructured
Only business entities and individual entities can be added to accept lists or custom screening lists.
Error
ResultError
The ResultError class returns any errors that were generated during a search. This element contains the entity gender type. Possible values: • None • Female • Male • Unknown None is not valid in a request.
Gender
GenderType
GLB
Integer
This element contains the GLBA permissible use. Possible values: • 0 • 1 • 2 • 3 This property is required for FraudPoint Score searches or InstantID searches.
• 5 • 6 • 7 • 12
IDs
List
The InputID class contains the input ID information. If you add the record to an accept list, then this element or the Addresses element is required.
LastUpdatedDate
DateTime
This element contains the date (YYYY-MM-DD) and the 24-hour local time (HH:MM:SS) that the alert was last updated. The InputName class contains the input name information. This element is required if you add the record to an accept list or custom screening list.
Name
InputName
ParsedACH ParsedFedwire
ParsedACH ParsedFedwire
The ParsedACH class contains the input information. The ParsedFedwire class contains the Fedwire input information.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 43
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
ParsedISO20022
ParsedISO20022
The ParsedISO20022 class contains the ISO (International Organization for Standardization) 20022 input information. The class contains some SWIFT (Society for Worldwide Interbank Financial Telecommunication) ISO 20022 information that is available only for searches that use the SWIFT EFT input type. The ParsedSWIFT class contains the SWIFT input information. The InputPhone class contains the input phone number information. The RecordState class contains a combination of case management options and workflow options for the alert. This element contains the date (YYYY-MM-DD) and the 24-hour local time (HH:MM:SS) that XG performed the search. This element contains the text string for an input text record.
ParsedSWIFT
ParsedSWIFT
Phones
List
RecordState
RecordState
SearchDate
DateTime
Text
String
Searc hR esu l ts Cl as s
The SearchResults class contains the search results.
Class Elements
Name
Type
Description
BlockID ClientReference
String String
This element contains the block ID. This element contains user-defined information to track the search. The ResultRecord class contains information about the alert. This element contains the XG version that was used to perform the search (for example, 5.0.0.1764).
Records
List
SearchEngineVersion
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 44
CONFIDENTIAL
Watchlist Mat ch St ate Class
The WatchlistMatchState class contains the decision information if separate decisions were set for each list match in the alert.
Class Elements
Name
Type
Description
MatchID
MatchID
This element contains the system-generated number that identifies the list match. This element contains the list match state. Possible values: • FalsePositive • TrueMatch
Type
WatchlistMatchStateType
FraudPoint Score Result Classes
The search response includes the classes that contain FraudPoint Score results.
FPAddr e ss Cl as s
The FPAddress class contains the input address information.
Class Elements
Name
Type
Description
City PostalCode State Street1
String String String String
This element contains the city. This element contains the postal code. This element contains the state. This element contains the street address.
FPInput C l ass
The FPInput class contains the input information.
Class Elements
Name
Type
Description
Address
FPAddress
The FPAddress class contains the input address information. This element contains the DOB (date of birth). The InputName class contains the input name information.
DOB Name
String InputName
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 45
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
Phone SSN
String String
This element contains the phone number. This element contains the SSN (Social Security number).
FPRedFlag C l ass
The FPRedFlag class contains the red flag details.
For possible red flags, see the LexisNexis® FraudPoint® Score Analyzing Results white paper that is available on the Customer Support Hub at https://lnrs.my.site.com/CustomerSup...s/article/2086.
Class Elements
Name
Type
Description
Name RiskIndicators
String List
This element contains the red flag category name. The FPRiskIndicator class contains the red flags details.
FPRiskIn dicato r Cl ass
The FPRiskIndicator class contains the risk indicator details or the red flag details.
For possible risk indicators or red flags, see the LexisNexis® FraudPoint® Score Analyzing Results white paper that is available on the Customer Support Hub at https://lnrs.my.site.com/ CustomerSupportHub/s/article/2086.
Class Elements
Name
Type
Description
Description
String
This element contains the description of the risk indicator or the red flag. This element contains the risk code that is associated with the risk indicator or the red flag.
RiskCode
String
FraudPoint R esul t s Class
The FraudPointResults class contains the FraudPoint Score results.
For information about the score that is returned, see the LexisNexis® FraudPoint® Score Analyzing Results white paper that is available on the Customer Support Hub at https://lnrs.my.site.com/ CustomerSupportHub/s/article/2086.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 46
CONFIDENTIAL
Class Elements
Type
Description
Name
Errors
List
The ResultError class returns any errors that were generated during a search. The index indicates the identity profile is at risk for being a victim of identity fraud perpetrated by a close associate. For example, the individual has high-risk relatives and close associates. The index range is 1-9. The FPInput class contains the input information. The index indicates the risk that the identity is being intentionally manipulated. For example, there is a suspicious amount of variation of the PII (personally identifiable information) associated with this identity. The index range is 1-9. The FPRedFlag class contains the red flag details. The FPRiskIndicator class contains the risk indicator details. This element contains the score that indicates a fraud potential. The index indicates the risk that the transaction is in connection with a real identity that has been compromised. For example, the identity is applying with a new address that is not likely associated with the true owner of the identity. The index range is 1-9. The index indicates the level of suspicious and high- risk activity that was previously observed for the input elements. For example, the input elements are tied to records that were previously deemed to be suspicious or high risk. The index range is 1-9. The index indicates the risk that the input identity is a synthetic identity. For example, this identity is only reported by credit bureaus or is missing characteristics of normal identities. The index range is 1-9. The index indicates the identity profile is at risk for being a victim of identity fraud. For example, a high- occupancy location or minors. The index range is 1-9.
FriendlyFraudIndex
Integer
Input ManipulatedIdentity Index
FPInput Integer
RedFlags RiskIndicators
List
Score
Integer
StolenIdentityIndex
Integer
SuspiciousActivityIndex
Integer
SyntheticIdentityIndex
Integer
VulnerableVictimIndex
Integer
InstantID Result Classes
The search response includes the classes that contain InstantID results.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 47
CONFIDENTIAL
IIDAddre ss Cl ass
The IIDAddress class contains the input address information and the other addresses InstantID found were associated with the input entity.
Class Elements Elements
Name
Type
Description
City County PostalCode State Street1
String String String String String
This element contains the city. This element contains the county. This element contains the postal code. This element contains the state. This element contains the street address.
IIDAddre ssH is to ry Class
The IIDAddressHistory class contains the other addresses associated with the input entity.
Class Elements
Name
Type
Description
Address
IIDAddress
The IIDAddress class contains the input address information and the other addresses InstantID found were associated with the input entity. This element contains the date that InstantID first found the address in public records. This element contains the date that InstantID last found the address in public records. This element indicates whether the address is the most likely current address of the input entity.
DateFirstSeen
String
DateLastSeen
String
IsBestAddress
String
IIDAlternat eN am e Class
The IIDAlternateName class contains an alternative last name that is associated with the InstantID input entity.
Class Elements
Name
Type
Description
LastName LastSeenDate
String String
This element contains the alternative last name. This element contains the date that InstantID last found the alternative last name in public records.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 48
CONFIDENTIAL
IIDFEI NM at ch Cl as s
The IIDFEINMatch class contains the company name and address that are associated with the input FEIN (federal employer identification number).
Class Elements
Name
Type
Description
Address
IIDAddress
The IIDAddress class contains the input address information and the other addresses InstantID found were associated with the input entity. This element contains the company name.
CompanyName
String
IIDFiling Cl ass
The IIDFiling class contains the civil filing information that is returned for the input business.
Class Elements
Name
Type
Description
Address
IIDAddress
The IIDAddress class contains the input address information and the other addresses InstantID found were associated with the input entity. This element contains the date of the civil filing. This element contains the name on the civil filing. This element contains the type of civil filing.
Date Name Type
String String String
IIDInput Cl as s
The IIDInput class contains the input information and the verified information.
Class Elements
Name
Type
Description
Address
IIDAddress
The IIDAddress class contains the input address information and the other addresses InstantID found were associated with the input entity. This element contains the DOB. This element indicates whether the DOB is verified. Possible values: • 0 = False • 1 = True
DOB DOBVerified
String String
FEIN Name
String InputName
This element contains the FEIN. The InputName class contains the input name information. This element contains the phone number. This element contains the SSN.
Phone SSN
String String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 49
CONFIDENTIAL
IIDRedFla g Cl as s
The IIDRedFlag class contains the red flags.
Class Elements
Name
Type
Description
Name RiskIndicators
String List
This element contains the red flag category. The IIDRiskIndicator class contains the red flags.
IIDRever s eP ho n e Cl ass
The IIDReversePhone class contains the name and the address that are associated with the input phone number.
Class Elements
Name
Type
Description
Address
IIDAddress
The IIDAddress class contains the input address information and the other addresses InstantID found were associated with the input entity. The InputName class contains the input name information.
Name
InputName
IIDRisk I nd icat or Cl ass
The IIDRiskIndicator class contains the risk indicators and the red flags. For individual searches, this class also returns the NAP (name, address, and phone number) verification value and the NAS (name, address, and SSN) verification value.
For more information about InstantID results, see the LexisNexis® InstantID® Analyzing Results white paper that is available on the Customer Support Hub at https://lnrs.my.site.com/ CustomerSupportHub/s/article/2087.
Class Elements
Name
Type
Description
Description
String
This element contains the description of the risk indicator. This element contains the risk code that is associated with the risk indicator or the red flag.
RiskCode
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 50
CONFIDENTIAL
IIDSSNIn fo Cl as s
The IIDSSNInfo class contains the SSN result information.
Class Elements
Name
Type
Description
IssuedEndDate
String
This element contains the end date of the time period that the SSN was issued. This element contains the location where the SSN was issued. This element contains the start date of the time period that the SSN was issued.
IssuedLocation
String
IssuedStartDate
String
IIDVerificat ionI n dicators Clas s
The IIDVerificationIndicators class contains the verification information that is returned for InstantID business searches.
Class Elements
Name
Type
Description
Address City FEIN Name Phone PostalCode State
String String String String String String String
This element contains the street address. This element contains the city. This element contains the FEIN. This element contains the business name. This element contains the phone number. This element contains the postal code. This element contains the state.
IIDWatch l ist Cl as s
The IIDWatchlist class contains the list information.
The IIDWatchlist class is never returned because XG provides its own list screening.
Class Elements
Name
Type
Description
Address
IIDAddress
The IIDAddress class contains the input address information and the other addresses InstantID found were associated with the input entity. This element contains the county. This element contains the entity name. This element contains the first name. This element contains the last name.
County EntityName FirstName LastName
String String String String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 51
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
RecordNumber Table
String String
This element contains the record number. This element contains the table.
InstantIDB usin es sR esults Class
The InstantIDBusinessResults class contains the results for InstantID business searches.
For possible results, see the LexisNexis® InstantID® Analyzing Results white paper that is available on the Customer Support Hub at https://lnrs.my.site.com/CustomerSup...s/article/2087.
Class Elements
Name
Type
Description
BankruptcyFilingsCount
Integer
This element contains the number of bankruptcy filings. This element contains the overall risk index (0, 10, 20, 30, 40, or 50). This element contains the corrected company name. The ResultError class returns any errors that were generated during a search. The IIDFEINMatch class contains the company name and address that are associated with the input FEIN. The IIDInput class contains the input information and the verified information. The IIDFiling class contains the civil filing information that is returned for the input business. The IIDFiling class contains the civil filing information that is returned for the input business. This element contains the BNAF (business name- address-FEIN) verification index that is used to calculate the overall risk index that is returned in the ComprehensiveVerificationIndex element. This element contains the business name-address- phone verification index that is used to calculate the overall risk index that is returned in the ComprehensiveVerificationIndex element. This element contains the BNAS (business name- address-SSN) verification index that is used to calculate the overall risk index that is returned in the ComprehensiveVerificationIndex element. This element contains the phone number that is related to the input name and the input address.
Comprehensive VerificationIndex CorrectedCompanyName Errors
Integer
String List
FEINMatches
List
Input
IIDInput
MostRecentBankrupcty Filing MostRecentJudgment LienFiling NameAddressFEIN Indicator
IIDFiling
IIDFiling
Integer
NameAddressPhone Indicator
Integer
NameAddressSSN Indicator
Integer
PhoneOfNameAddress
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 52
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
PhoneType
String
This element contains the phone type. Possible values: • B = Blank Input • 0 = Residential • 2 = Business • 7 = Mobile/Cellular • 8 = Pager
ReleasedJudgmentLien Count ReversePhone
Integer
This element contains the number of released judgments. The IIDReversePhone class contains the name and the address that are associated with the input phone number. This element contains the IIDRiskIndicator class contains the risk indicators. This element contains the number of unreleased judgments. The IIDVerificationIndicators class contains the verification information that is returned for InstantID business searches. The IIDInput class contains the input information and the verified information. This element is always null.
IIDReversePhone
RiskIndicators
List
UnreleasedJudgment LienCount VerificationIndicators
Integer
IIDVerificationIndicators
VerifiedInput
IIDInput
Watchlist
IIDWatchlist
InstantIDI n dividu al Results Clas s
The InstantIDIndividualResults class contains the results for InstantID individual searches.
For possible results, see the LexisNexis® InstantID® Analyzing Results white paper that is available on the Customer Support Hub at https://lnrs.my.site.com/CustomerSup...s/article/2087.
Class Elements
Name
Type
Description
AddressHistory
List
The IIDAddressHistory class contains the other addresses associated with the input entity. The IIDAlternateName class contains an alternative last name that is associated with the InstantID input entity. This element contains the overall risk index (0, 10, 20, 30, 40, or 50). This element contains the match level for the DOB verification. The ResultError class returns any errors that were generated during a search.
AlternateNames
List
Comprehensive VerificationIndex DOBMatchLevel
Integer
Integer
Errors
List
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 53
CONFIDENTIAL
Class Elements (Continued)
Description
Name
Type
The IIDInput class contains the input information and the verified information. The LexID® number is associated with the input entity. The IIDRiskIndicator class contains the NAP results. The IIDRiskIndicator class contains the NAS results. This element contains the phone number that is associated with the input name and the input address. The IIDRiskIndicator class contains the risk indicators and the red flags. The IIDRedFlag class contains the red flags. The IIDReversePhone class contains the name and the address that are associated with the input phone number. The IIDRiskIndicator class contains the risk indicators. The IIDSSNInfo class contains the SSN result information. The IIDInput class contains the input information and the verified information. This element is always null.
Input
IIDInput
LexID NameAddressPhone NameAddressSSN PhoneOfNameAddress
String IIDRiskIndicator IIDRiskIndicator String
PotentialFollowupActions
List
RedFlags ReversePhone
List
RiskIndicators SSNInfo
List
VerifiedInput
IIDInput
Watchlist
IIDWatchlist
DOB Match Levels
The DOB match level indicates the level of the match between the input DOB and the DOB found for the input entity.
Possible DOB Match Levels
Web Service Value
Description
0
No DOB found or no DOB submitted
1
Nothing matches
2
Only Day matches
3
Only Month matches
4
Only Day and Month match
5
Only Day and Year match
6
Only Year matches
7
Only Month and Year match
8
Month, Day, and Year match
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 54
CONFIDENTIAL
List Screening Result Classes
The search response includes the classes that contain the list screening results. These results include match information and list entity information.
For more information about screening lists that are provided by LexisNexis Risk Solutions, see the related documentation on the Library page on the Customer Support Hub at https://lnrs.my.site.com/ CustomerSupportHub/s/article/2057.
If you searched the LexisNexis® WorldCompliance™ Data Plus list, then the search response includes additional result classes.
OFACI nst itu tio n Inf o Class
The OFACInstitutionInfo class contains the information of the originating institution, the intermediary institution, or the beneficiary institution listed in the OFAC (Office of Foreign Assets Control) report.
Class Elements
Name
Type
Description
Address Name Type
String String String
This element contains the address. This element contains the name. This element contains the type.
OFACR epo rtI n fo Cl ass
The OFACReportInfo class contains the OFAC report information.
An OFAC report can be generated in the XG user interface for each alert that contains potential list matches against the OFAC lists. For more information, see the LexisNexis® Bridger Insight® XG Help.
Class Elements
Name
Type
Description
ActionDate
String
This element contains the date that the action was taken. This element contains additional data. This element contains additional relevant information. This element contains the amount of the transaction. The OFACInstitutionInfo class contains the information of the originating institution, the intermediary institution, or the beneficiary institution listed in the OFAC report. This element contains the name of the signer. This element contains the preparation date of the report. This element contains the reason for the report.
AdditionalData AdditionalRelevantInfo Amount Institutions
String String String List
NameOfSigner PreparerDate
String String
Reason
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 55
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
ReportType
OFACReportType
This element contains the report type. Possible values: • Blocked • Rejected
TitleOfSigner TransactionDate
String String
This element contains the title of the signer. This element contains the transaction date.
Watchlist Res u l ts Cl ass
The WatchlistResults class indicates the status of the list search and contains potential matches.
Class Elements
Name
Type
Description
Matches
List
The WLMatch class contains the list match information. This element contains the status that indicates whether a list screening search was performed and whether results were returned. Possible values: • NotSearched • NoResults • Results
Status
WLSearchStatusType
WLAddre ssM at ch Cl ass
The WLAddressMatch class contains the address match information.
Class Elements
Name
Type
Description
InputValue ListValue
String String
This element contains the input address. This element contains the address for the list entity.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 56
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
Score
Integer
This element contains the address match score (0- 100) that is used to help calculate the overall match confidence score. This element contains the address type. Possible values: • None • Current • Mailing • Previous • Unknown None is not valid in a request. This element is required.
Type
AddressType
WLCitize n s hipM at ch Class
The WLCitizenshipMatch class contains the citizenship information for list entity matches.
Class Elements
Name
Type
Description
InputValue ListValue Score
String String Integer
This element contains the input citizenship value. This element contains the citizenship. This element contains the citizenship score (0-100) for the list entity.
WLCou nt ryDetail s Cl ass
The WLCountryDetails class contains the best match information and details for a list country match.
Class Elements
Name
Type
Description
AKAs
List
This element contains AKA values that are associated with the country match. This element contains the cities that are associated with the country match. This element contains the country codes that are associated with the country match. This element contains additional uncategorized information about the country match. This information may include source contact information and web addresses.
Cities
List
Codes
List
Comments
String
Country
String
This element contains the country in the list record.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 57
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
DateListed
String
This element contains the date that the country was added to the list. This element contains the source list reference number that is used by LexisNexis Risk Solutions. This element contains the ports that are associated with the country match. This element contains the reason the country was added to the list. This element contains the country terms that are associated with the country match.
ListReferenceNumber
String
Ports
List
ReasonListed
String
Terms
List
WLDOBMatc h C l ass
The WLDOBMatch class contains the DOB information for list entity matches.
Class Elements
Name
Type
Description
InputValue ListValue Score
String String Integer
This element contains the input DOB. This element contains the DOB for the list entity. This element contains the DOB match score (0-100) that is used to help calculate the overall match confidence score.
WLEntity Detail s Cl ass
The WLEntityDetails class contains the screening list information, including the list record that best matched your input entity.
Class Elements
Name
Type
Description
AdditionalInfo
List
The EntityAdditionalInfo class contains the additional information that helps identify the list entity. The EntityAddress class contains the address information. The EntityAKA class contains the alternative name information. This element contains uncategorized additional information about the list entity. This information may include source contact information, web addresses, or email addresses. This element contains the date that the entity was added to the list.
Addresses
AKAs
List
Comments
String
DateListed
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 58
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
EntityType
ListEntityType
This element contains the entity type. Possible values: • None • Business • Individual • Unknown • Vessel None is not valid in a request.
Gender
String
This element contains the entity gender type. Possible values: • None • Female • Male • Unknown None is not valid in a request.
IDs ListReferenceNumber
List
The EntityID class contains the entity ID information. This element contains the source list reference number that is used by LexisNexis Risk Solutions. The EntityName class contains the name information. The EntityPhone class contains the phone number information. This element contains the reason that the entity was added to the list.
Name Phones
EntityName List
ReasonListed
String
WLIDMatch Cl ass
The WLIDMatch class contains the ID information for list entity matches.
Class Elements
Name
Type
Description
InputValue ListValue Score
String String Integer
This element contains the input ID. This element contains the ID for the list entity. This element contains the ID match score (0-100) that is used to help calculate the overall match confidence score. This element contains the ID type. This element is required.
Type
IDType
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 59
CONFIDENTIAL
WLMa tch Cl ass
The WLMatch class contains the list match information.
Class Elements
Name
Type
Description
AcceptListID
Long
This element contains a system-generated number that identifies the accept list the alert was added to. True indicates that the alert was added to an accept list. The WLAddressMatch class contains the address match information. This element is returned only for matches on list entity records.
AddedToAcceptList
Boolean
Addresses
List
AddressName AdverseMedias
Boolean List
This element contains the address name. The AdverseMedia class contains information from credible, published news sources that describe a crime that was committed, including web sites, international newspapers, magazines and periodicals, broadcasts, press releases, and news wires. True indicates that XG set the LexisNexis® WorldCompliance™ match to the False Positive disposition option because another WorldCompliance match in the alert was set to True Match. XG was configured to handle multiple matches in this manner using the TrueMatchSetsOthersToFalsePositive element.
AutoFalsePositive
Boolean
BestAddressIsPartial
Boolean
True indicates that the best address match was to a partial address. This element contains the country that most closely matched the input information. This element contains the score of the country that most closely matched the input information.
BestCountry
String
BestCountryScore
Integer
If a valid score is not available, then -1 is returned.
BestCountryType
CountryPhraseType
This element contains the type of the BestCountry element. Possible values: • None • AlternateName • City None is not valid in a request.
• Code • Port • Term
BestName
String
This element contains the entity name that most closely matched the input information.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 60
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
BestNameScore
Integer
This element contains the score of the name that most closely matched the input information.
If a valid score is not available, then -1 is returned.
CheckSum
Integer
A system-generated number that is used by XG to determine if True Match records have changed. The WLCitizenshipMatch class contains the citizenship information for list entity matches. The WLMatchConflicts class contains the match conflicts. The CountryAssociation class contains the country association information for the list entity match from the WorldCompliance Data Plus list. This class and its elements are not defined.
Citizenships
List
Conflicts
CountryAssociations
List
CountryDetails
WLCountryDetails
The WLCountryDetails class contains the best match information and details for a list country match. This element is returned only for matches on list country records.
DateModified
DateTime
This element contains the date when the record was last updated. This element contains the date that the list entity was listed as deceased. The WLDOBMatch class contains the DOB information for list entity matches. This element is returned only for matches on list entity records.
DeceasedDate
String
DOBs
List
Enforcements
List
The Enforcement class contains information from monitoring material that is published by official government agencies, industry regulators, and disciplinary boards for events that meet the qualifying standards and definitions. The WLEntityDetails class contains the screening list information, including the list record that best matched your input entity. This element is returned only for matches on list entity records.
EntityDetails
WLEntityDetails
EntityName
String
This element contains the main entity name from the list record that generated the potential match. This element contains the match confidence score (0- 100) that XG generated to indicate how closely the list record matched the input entity information.
EntityScore
Integer
If a valid score is not available, then -1 is returned.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 61
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
EntityUniqueID
String
This element contains a system-generated number that identifies the entity. The ResultError class returns any errors that were generated during a search. This element contains the type of data element that generated a false match update. Possible values: • None • BestName • DOB • Gender • AKA
Error
ResultError
FalseMatchUpdate
FalseMatchUpdateType
• Ids • Address • Phone • Citizenship
FalsePositive
Boolean
True indicates that the match decision was set to False Positive. The WLMatchFile class contains the information about the list that contained the potential match. True indicates that a third-party service found OFAC matches before the record was searched in XG. This element contains a system-generated number that identifies the match. The WLIDMatch class contains the ID information for list entity matches. This element is returned only for matches on list entity records.
File
WLMatchFile
GatewayOFACScreening Indicator ID
Boolean
Long
IDs
List
MatchIMDSDetails
WLMatchFprDetails
The WLMatchFprDetails class contains the results from LexisNexis® Intelligent Match Decision Solution (IMDS). True indicates that this match is the result of a match re-alert. A match re-alert occurs when the match information in the list has changed.
MatchReAlert
Boolean
MatchXML
WLMatchSummary
The WLMatchSummary class contains the summary of a potential list match when data elements other than name were used to find the match. This element is returned only for alerts with potential list matches on data elements other than name.
MSBs
List
The MSB class contains information about MSB (money services business) entities that are registered with the Central Bank of the United Arab Emirates or as required under the BSA (Bank Secrecy Act) regulations at 31 CFR (Code of Federal Regulations) 1022.380(a)-(f). The OFACReportInfo class contains the OFAC report information.
OFACInfo
OFACReportInfo
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 62
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
OtherSegments
List
The OtherSegment class contains additional data segment information that does not align with the main WorldCompliance data segments. The PEP class contains information about individuals who act in a senior prominent public function or their family members and associates. The WLPhoneMatch class contains the phone information for list entity matches. This element is returned only for matches on list entity records.
PEPs
List
Phones
List
PreviousResultID ReasonListed
Long String
This element contains the previous result ID. This element contains the reason that the entity was listed in the list. The Relationship class contains information about related entities. The Registration class contains information about list entities that have registered with certain enforcement or regulatory agencies for specific purposes. This element contains the date (YYYY-MM-DD) and 24-hour local time (HH:MM:SS) that XG generated the alert. The Sanction class contains information about entities that are listed under legal and public decree by a regional organization, an international organization, or sovereign government that imposes restrictive measures on a foreign state or entities to advance certain foreign policy or national security objectives. True indicates that a third-party service found OFAC matches before the record was searched in XG. The SOE class contains information about entities that have connections to government funding that can make the SOE (state-owned enterprise) or SWF (sovereign wealth fund) vulnerable to corruption. This element indicates the deceased state for the list entity. Possible values: • Unknown • Alive
Relationships
List
Registrations
List
ResultDate
DateTime
Sanctions
List
SecondaryOFACScreening Indicator SOEs
Boolean
List
Status
EntityDeceasedStateType
• Deceased • NotApplicable
TrueMatch
Boolean
True indicates that the match decision was set to True Match. The Vessel class contains information about vessels that are registered with IHS Markit™.
Vessels
List
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 63
CONFIDENTIAL
WLMa tchC onf l ict s Class
The WLMatchConflicts class contains the match conflicts.
Class Elements
Name
Type
Description
AddressConflict
Boolean
True indicates that the input address and the address for the list entity did not match. True indicates that the input citizenship and the citizenship for the list entity did not match. True indicates that the input country and the country for the list entity did not match. True indicates that the input DOB and the DOB for the list entity did not match. True indicates that the input entity type and the entity type of the list entity did not match. True indicates that the input gender and gender for the list entity did not match. True indicates that the input ID and the ID for the list entity did not match. True indicates that the input phone and the phone for the list entity did not match.
CitizenshipConflict
Boolean
CountryConflict
Boolean
DOBConflict
Boolean
EntityTypeConflict
Boolean
GenderConflict
Boolean
IDConflict
Boolean
PhoneConflict
Boolean
WLMa tchFil e Cl ass
The WLMatchFile class contains the information about the list that contained the potential match.
Class Elements
Name
Type
Description
Build
DateTime
This element contains the date (YYYY-MM-DD) and 24-hour local time (HH:MM:SS) that LexisNexis Risk Solutions built the list. True indicates that the list is a custom screening list. This element contains a system-generated number that identifies the list. This element contains the list name. This element contains the date (YYYY-MM-DD) and 24-hour local time (HH:MM:SS) that LexisNexis Risk Solutions published the list. This element contains the data file type. Possible values: • UDF (XG file) • ADF (accept list) • BDF (entity list) • CDF (country list) • SDF (XG file)
Custom ID
Boolean Unsigned Integer
Name Published
String DateTime
Type
DataFileType
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 64
CONFIDENTIAL
WLMa tchFp rDet ail s Class
The WLMatchFprDetails class contains the results from IMDS.
Class Elements
Name
Type
Description
IsIMDSFalsePositive
Boolean
This element indicates whether the match was determined to be an automatic false positive. This element contains the false positive confidence score that was determined for the match. This element contains the reason codes that were returned for the match. This element contains the rules for IMDS that were used in the search. This element contains the version of the rules for IMDS that were used in the search.
Confidence
Integer
ReasonCodes
String
RulesName
String
Version
String
WLMa tchS u mm ary Class
The WLMatchSummary class contains the summary of a potential list match when data elements other than name were used to find the match.
Class Elements
Name
Type
Description
AddressMatches
List
The WLMatchSummaryItem class contains the data element match summary of a potential list match on data elements other than the name. The WLMatchSummaryItem class contains the data element match summary of a potential list match on data elements other than the name. The WLMatchSummaryItem class contains the data element match summary of a potential list match on data elements other than the name. The WLMatchSummaryItem class contains the data element match summary of a potential list match on data elements other than the name. The WLMatchSummaryItem class contains the data element match summary of a potential list match on data elements other than the name. The WLMatchSummaryItem class contains the data element match summary of a potential list match on data elements other than the name.
CitizenshipMatches
List
DOBMatches
List
Gender
WLMatchSummaryItem
IDMatches
List
PhoneMatches
List
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 65
CONFIDENTIAL
WLMa tchS u mm aryIt em Class
The WLMatchSummaryItem class contains the data element match summary of a potential list match on data elements other than the name.
Class Elements
Name
Type
Description
Input List Score
String String Integer
This element contains the input information. This element contains the list match information. This element contains the data element score that helps calculate the overall match confidence score. This element contains the specific data type. Examples of data type include current address, mailing address, or passport.
Type
String
WLPhoneM atch Cl ass
The WLPhoneMatch class contains the phone information for list entity matches.
Class Elements
Name
Type
Description
InputValue ListValue
String String
This element contains the input phone number. This element contains the phone number for the list entity. This element contains the phone match score (0- 100) that is used to help calculate the overall match confidence score. This element contains the phone type. Possible values: • Business • Cell • Fax • Home • Work • Unknown • None None is not valid in a request. This element is required.
Score
Integer
Type
PhoneType
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 66
CONFIDENTIAL
WorldCompliance Data Plus Result Classes
The search response may include the classes that contain results for the WorldCompliance Data Plus list. These results are part of the list screening results and include list entity information.
The WorldCompliance data is organized into multiple segments. For information about WorldCompliance Data Plus segments, see the Segments for LexisNexis® WorldCompliance™ Data Plus technical reference guide at https://lnrs.my.site.com/CustomerSup...s/article/2481.
Adver se M edia Cl ass
The AdverseMedia class contains information from credible, published news sources that describe a crime that was committed, including web sites, international newspapers, magazines and periodicals, broadcasts, press releases, and news wires.
Class Elements
Name
Type
Description
DateModified
DateTime
This element contains the date when the entry was last updated. This element contains the adverse media type. This element contains the WorldCompliance data source that published the information. This element contains the record subcategories.
Description Source
String String
SubCategories
List
Country Ass o ciat ion Class
The CountryAssociation class contains the country association information for the list entity match from the WorldCompliance Data Plus list. This class is no longer returned.
Class Elements
Name
Type
Description
Country CountryISO
String String
This element contains the associated country name. This element contains the associated country's ISO code.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 67
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
OwnershipPercentage
Double
This element contains the country ownership percentage for an SOE. The value is a maximum five-digit number, with two digits always in the decimal place (for example, 100.00 or 45.98).
Type
CountryAssociationType
This element contains the type of association that the entity has with a country. Possible values: • Associated • CountryOfBuild • Flag • Headquarters • None
• Ownership • PEP • Residency • SpecialVotingRi
ght
Enforce m ent Cl as s
The Enforcement class contains information from monitoring material that is published by official government agencies, industry regulators, and disciplinary boards for events that meet the qualifying standards and definitions.
Class Elements
Name
Type
Description
Country
String
This element containsthe country or territory where the enforcement source is published. This element contains the date when the entry was last updated. This element contains the WorldCompliance data source that published the information. This element contains the record subcategories.
DateModified
DateTime
Source
String
SubCategories
List
MSB C lass
The MSB class contains information about MSB entities that are registered with the Central Bank of the United Arab Emirates or as required under the BSA regulations at 31 CFR 1022.380(a)-(f).
Class Elements
Name
Type
Description
AuthorizedSignature
String
This element contains the date that the MSB registration was authorized. This element contains the date when the entry was last updated.
DateModified
DateTime
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 68
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
NumberOfBranches
String
This element contains the number of MSB branches or branch offices. This element contains the date that the registration application was received. This element contains the type of registration that the MSB applied for. Possible values: • None • CorrectedReport • InitialRegistration • Renewal • Reregistration
ReceiveDate
String
RegistrationType
MSBRegistrationType
SubCategories Source
List
This element contains the record subcategories. This element contains the WorldCompliance data source that published the information. This element indicates whether the MSB is registered in the United States or in the United Arab Emirates. Possible values: • US • UAE
Type
MSBType
OtherSe g m ent Cl as s
The OtherSegment class contains additional data segment information that does not align with the main WorldCompliance data segments.
Class Elements
Name
Type
Description
DateModified
DateTime
This element contains the date when the entry was last updated. This element contains the WorldCompliance data source that published the information. This element contains the record subcategories. This element contains the segment type. Possible values: • AssociatedEntity • OwnershipOrControl • SWIFTBIC
Source
String
SubCategories Type
List
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 69
CONFIDENTIAL
PEP C lass
The PEP class contains information about individuals who act in a senior prominent public function or their family members and associates.
Class Elements
Name
Type
Description
AdminLevel
String
This element contains the WorldCompliance label for the PEP (politically exposed person) role level of government. This element contains the first-level administrative unit of the PEP role within a government or organization. This element contains the second-level administrative unit of the PEP role within a government or organization. This element contains the third-level administrative unit of the PEP role within a government or organization. This element contains the fourth-level administrative unit of the PEP role within a government or organization. This element contains the top-level administrative unit of the PEP role within a government or organization. The CountryAssociation class contains the country association information for the list entity match from the WorldCompliance Data Plus list. This class and its elements are not defined.
AdminUnit1
String
AdminUnit2
String
AdminUnit3
String
AdminUnit4
String
Country
String
CountryAssociations
List
CountryRole
PEPCountryRolesType
This element contains the PEP country role. Possible values: • Unknown • MicroPEP • PEP
DateModified
DateTime
This element contains the date when the entry was last updated. This element contains the effective date of the PEP role. This element contains the type of effective date of the PEP role. Possible values: • None • Appointed • Elected
EffectiveDate
String
EffectiveDateType
PEPEffectiveDateType
• Official • Reported
ExpirationDate
String
This element contains the expiration date of the PEP role.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 70
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
ExpirationDateType
PEPExpirationDateType
This element contains the type of expiration date of the PEP role. Possible values: • None • Appointed • Elected
• Official • Reported
GoverningInstitution
String
This element contains the authoritative body within a given area of government in which the PEP serves. This element contains the role within the governing institution in which the PEP serves. This element contains whether the entity is a primary PEP. True indicates that the entity is a primary PEP. False indicates that the entity is a secondary PEP.
GoverningRole
String
IsPrimary
Boolean
Source
String
This element contains the WorldCompliance data source that published the information. This element contains the PEP status. Possible values: • Active • Inactive • Unknown
Status
PEPStatusType
SubCategories
List
This element contains the record subcategories.
Registrat ion Cl as s
The Registration class contains information about list entities that have registered with certain enforcement or regulatory agencies for specific purposes.
Class Elements
Name
Type
Description
DateModified
DateTime
This element contains the date when the entry was last updated. This element contains the WorldCompliance data source that published the information.
Source
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 71
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
SubCategories Type
List
This element contains the record subcategories. This element contains the registration type. Possible values: • FATCA
The entity is registered under FATCA (Foreign Account Tax Compliance Act) .
• MarijuanaRegBus • The entity is an MRB (marijuana registered
business).
Relations hip Cl ass
The Relationship class contains information about related entities.
Class Elements
Name
Type
Description
DateModified
DateTime
This element contains the date when the entry was last updated. This element contains WorldCompliance GUID (globally unique identifier) for the related entity. This element contains the name of the related entity. This element contains the relationship group. Possible values: • Associations • Companies • Family
EntityId
Integer
EntityName Group
String String
• MSOEMSWF • None
The MSOEMSWF group indicates that the entity is either an MSOE (member of state- owned enterprises) or an MSWF (members of sovereign wealth funds).
OwnershipPercentage
Double
This element contains the company-to-company ownership percentage that WorldCompliance researchers identity from open sources. The value is a maximum five-digit number, with two digits always in the decimal place (for example, 100.00 or 45.98).
Segments
String
This element contains risk categories to which the entity is linked. This element contains the WorldCompliance data source that published the information. This element contains the record subcategories. This element contains the relationship type.
Source
String
SubCategories Type
List
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 72
CONFIDENTIAL
Possible Relationship Types
Relationship data can include relationship types.
The following relationship types are available:
• None • Accountant • Advisor • AffiliatedCompany • AffiliatedOrganization • Associate • Aunt • Brother • Brotherinlaw • CoDefendant • Controller • Cousin • Daughter • Daughterinlaw • DecisionInflAdvisor • DecisionInflExecutive • DecisionInflKeyMember
• Mother • Motherinlaw • Nephew • Niece • Owner • RealEstateProfessional • RegisteredAgent • Relative • Sister • Sisterinlaw • Son • Soninlaw • Spouse • Uncle • Wife
• DomesticPartner • Employee • Executive • ExHusband • ExSpouse • ExWife • Father • Fatherinlaw • Friend • GrandChild • Grandfather • Grandmother • Husband • KeyMember • LegalCouncil • MgmtCtrlExecutive • MgmtCtrlKeyMember
Sanction C l ass
The Sanction class contains information about entities that are listed under legal and public decree by a regional organization, an international organization, or sovereign government that imposes restrictive measures on a foreign state or entities to advance certain foreign policy or national security objectives.
Class Elements
Name
Type
Description
Country
String
This element contains the country or territory where the sanction source is published. This element contains the date when the entry was last updated. This element contains the WorldCompliance data source that published the information. This element contains the record subcategories.
DateModified
DateTime
Source
String
SubCategories
List
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 73
CONFIDENTIAL
SOE Class
The SOE class contains information about entities that have connections to government funding that can make the SOE or SWF (sovereign wealth fund) vulnerable to corruption.
Class Elements
Name
Type
Description
CountryAssociations
List
The CountryAssociation class contains the country association information for the list entity match from the WorldCompliance Data Plus list. This class and its elements are not defined.
DateModified
DateTime
This element contains the date when the entry was last updated. This element contains a sector or industry in which the SOE or SWF operates. This element contains the current ownership status of the SOE and SWF entity. True indicates that there is active government ownership of the entity. False indicates that the entity was privatized or dissolved, or that the government otherwise divested ownership.
Domain
List
IsActive
Boolean
Source
String
This element contains the WorldCompliance data source that published the information. This element contains the record subcategories. This element contains the country ownership percentage for an SOE or SWF entity. The value is a maximum five-digit number, with two digits always in the decimal place (for example, 100.00 or 45.98).
SubCategories TotalOwnershipCountry Percentage
List
Vessel C las s
The Vessel class contains information about vessels that are registered with IHS Markit.
Class Elements
Name
Type
Description
CallSign DateModified
String DateTime
This element contains the vessel's call sign. This element contains the date when the entry was last updated. This element contains the vessel's DOC (Department Of Compliance) company name. This element contains the vessel's DOC company code. This element contains the country or flag of controlling interest for the vessel's DOC company. This element contains the country of domicile for the vessel's DOC company.
DOCCompany
String
DOCCompanyCode
String
DOCCompanyCountryOf Control DOCCompanyCountryOf Domicile
String
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 74
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
DOCCompanyCountryOf Registration Flag FlagEffectiveDate
String
This element contains the country or flag of registration for the vessel's DOC company. This element contains the ship's flag. This element contains the date the ship's flag went into effect. This element contains the vessel's most recent previous name. This element contains the measure of a ship's overall internal volume. The gross tonnage is used to determine port dues and registration fees. This element contains the name of the controlling interest behind a fleet and the ultimate beneficiary from ownership (the parent company of the registered owner). This element contains the company code for the vessel's group beneficial owner. This element contains the country or flag of controlling interest for the vessel's group beneficial owner. This element contains the country of domicile for the vessel's group beneficial owner. This element contains the country or flag of registration for the vessel's group beneficial owner. This element contains the name of the company that is responsible for commercial decisions concerning the employment of the vessel and the direct beneficiary of profits from the vessel's operations. This element contains the company code and decode name for the vessel's operator. This element contains the country or flag of controlling interest for the vessel's operator. This element contains the country of domicile for the vessel's operator. This element contains the country or flag of registration for the vessel's operator. This element contains the name of the company that holds the legal title of ownership that appears on the vessel's registration documents. This element contains the port and corresponding code which that on the stern of the vessel under the ship name. The port of registry, or hailing port, is the port at which the vessel is registered with a flag authority. This element contains the decoded name of the vessel's registered owner.
String String
FormerVesselName
String
GrossTonnage
String
GroupBeneficialOwner
String
GroupBeneficialOwner CompanyCode GroupBeneficialOwner CountryOfControl
String
String
GroupBeneficialOwner CountryOfDomicile GroupBeneficialOwner CountryOfRegistration Operator
String
String
String
OperatorCompanyCode
String
OperatorCountryOf Control OperatorCountryOf Domicile OperatorCountryOf Registration Owner
String
String
String
String
PortOfRegistry
String
RegisteredOwner CompanyCode
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 75
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
RegisteredOwnerCountry OfControl RegisteredOwnerCountry OfDomicile RegisteredOwnerCountry OfRegistration Shipbuilder
String
This element contains the country or flag of controlling interest for the vessel's registered owner. This element contains the country of domicile for the vessel's registered owner. This element contains the country or flag of registration for the vessel's registered owner. This element contains the name of the shipbuilder that constructed the vessel. This element contains the name of the shipbuilder subcontractor. This element contains the yard or hull number that was issued by the subcontracted shipyard. This element contains the name of the company that was designated by the vessel's owner or charter to be responsible for the day-to-day commercial operation of the vessel. This element contains the IMO (International Maritime Organization) code for the vessel's ship manager. This element contains the country or flag of controlling interest for the vessel's ship manager. This element contains the country of domicile for the vessel's ship manager. This element contains the country or flag of registration for the vessel's ship manager. This element contains the vessel's present trading status. The trading status indicates the physical state of the vessel at the time. This element contains the date that the vessel's trading (activity) status became applicable. This element contains the WorldCompliance data source that published the information. This element contains the record subcategories. This element contains the name of the vessel's technical manager. This element contains the company code for the vessel's technical manager. This element contains the country where the vessel's control of decisions lies. This element contains the country where the vessel's company is domiciled. This element contains the country where the vessel's company is incorporated.
String
String
String
ShipbuilderSub Contractor ShipbuilderSub ContractorYardHull ShipManager
String
String
String
ShipManagerCompany Code
String
ShipManagerCountryOf Control ShipManagerCountryOf Domicile ShipManagerCountryOf Registration ShipStatus
String
String
String
String
ShipStatusEffectiveDate
String
Source
String
SubCategories TechnicalManager
List
TechnicalManager CompanyCode TechnicalManager CountryOfControl TechnicalManager CountryOfDomicile TechnicalManager CountryOfRegistration
String
String
String
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 76
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
Type
VesselType
This element indicates whether the IHS Markit registered vessel is associated with other sanctions information. Possible values: • IHS
The vessel has a country flag that is associated with a high-risk country on the FATF (Financial Action Task Force) "call for action" list or the FATF list of "countries with strategic deficiencies."
• IHSOFAC
The vessel is registered with IHS Markit and is also listed on a targeted OFAC sanctions source.
VesselType
String
This element contains the IHS Markit Statcode 5 vessel type identifier. The identifier describes the vessel type (for example, General Cargo Ship, Container Ship, or Vehicles Carrier). This element contains the total weight of cargo a vessel carries or can carry at a particular draft in tonnes (1,000 kg). This element contains the number that is assigned to the vessel during construction. This number is also referred to as a hull number. This element contains the year that the vessel was completed and put into service.
Weight
String
YardNumber
String
YearOfBuild
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 77
CONFIDENTIAL
Chapter 5
Res ul ts I n terfac e
The Results interface lets you manage your alerts. You can also manage alerts through the LexisNexis® Bridger Insight® XG (XG) application.
For more information, see the LexisNexis® Bridger Insight® XG Help.
Run Management
The Results interface lets you manage the runs that are stored in the XG database. A run contains the details about a search that was performed and the alerts that were generated.
The Results interface lets you perform the following actions on runs:
• View a run. • Search for a run. • Delete a run.
Run Method
The Run method deletes a specified run.
The method is sent with the following HTTP request properties:
Request Line
The request uses the DELETE HTTP method. The request is sent to the following endpoint on the host server: /api/Results/Run/{id}. The in-path {id} parameter contains the system-generated number that identifies the run. To obtain a run ID, you use the SearchRuns method to search for the run.
Required Headers Authorization
The request uses a bearer JWT (JSON Web Token) for authentication.
Content-Type
The request contains a JSON (JavaScript object notation) message.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 78
CONFIDENTIAL
Host
The request is sent to https://
X-API-Key
The request contains the API (application programming interface) authentication key for your client instance. XG Enterprise clients generate their API key in Enterprise Manager. XG Service clients receive an API key from LexisNexis® Risk Solutions.
X-ClientInfo
This header is not required for Bridger JWT authentication. If the request uses a JWT that was generated by Azure AD, then the request can contain the base64-encoded XG client ID and user ID separated by a forward slash in the X-ClientInfo header. If the request uses this header, then XG ignores the ClientID and UserID elements in the ClientContext class.
Body
The request does not contain a body.
Return Values
If the method succeeds, then the response returns True. If the method fails or generates an error, then the response returns an Error class.
Run Request Example
The following code shows an example of the HTTP request. The code that you send is different.
DELETE /api/Results/Run/{id} HTTP/1.1
Host:
Authorization: Bearer
Content-Type: application/json
X-API-Key:
X-ClientInfo:
Content-Length: 0
RunInfo Method
The RunInfo method returns the information about the specified run.
The method is sent with the following HTTP request properties:
Request Line
The request uses the GET HTTP method. The request is sent to the following endpoint on the host server: /api/Results/RunInfo/{id}.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 79
CONFIDENTIAL
The in-path {id} parameter contains the system-generated number that identifies the run. To obtain a run ID, you use the SearchRuns method to search for the run.
Required Headers Authorization
The request uses a bearer JWT for authentication.
Content-Type
The request contains a JSON message.
Host
The request is sent to https://
X-API-Key
The request contains the API authentication key for your client instance. XG Enterprise clients generate their API key in Enterprise Manager. XG Service clients receive an API key from LexisNexis Risk Solutions.
X-ClientInfo
This header is not required for Bridger JWT authentication. If the request uses a JWT that was generated by Azure AD, then the request can contain the base64-encoded XG client ID and user ID separated by a forward slash in the X-ClientInfo header. If the request uses this header, then XG ignores the ClientID and UserID elements in the ClientContext class.
Body
The request does not contain a body.
Return Values
The response contains the RunInfo class.
RunInfo Request Example
The following code shows an example of the HTTP request. The code that you send is different.
GET /api/Results/RunInfo/{id} HTTP/1.1
Host:
Authorization: Bearer
Content-Type: application/json X-API-Key:
X-ClientInfo:
Content-Length: 0
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 80
CONFIDENTIAL
SearchRuns Method
The SearchRuns method returns the runs that meet the specified criteria.
The method is sent with the following HTTP request properties:
Request Line
The request uses the POST HTTP method. The request is sent to the following endpoint on the host server: /api/Results/SearchRuns.
Required Headers Authorization
The request uses a bearer JWT for authentication.
Content-Type
The request contains a JSON message.
Host
The request is sent to https://
X-API-Key
The request contains the API authentication key for your client instance. XG Enterprise clients generate their API key in Enterprise Manager. XG Service clients receive an API key from LexisNexis Risk Solutions.
X-ClientInfo
This header is not required for Bridger JWT authentication. If the request uses a JWT that was generated by Azure AD, then the request can contain the base64-encoded XG client ID and user ID separated by a forward slash in the X-ClientInfo header. If the request uses this header, then XG ignores the ClientID and UserID elements in the ClientContext class.
Body
The request contains the ResultRunsRequest class.
Return Values
The response contains the RunInfo class.
ResultRunsRequest Request Example
The following code shows an example of the HTTP request. The code that you send is different.
POST /api/Results/SearchRuns HTTP/1.1
Host:
Authorization: Bearer
Content-Type: application/json
X-API-Key:
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 81
CONFIDENTIAL
{
"ResultRunsRequest": {
"ClientContext": {...},
"RunsCriteria": {...}
}
}
Run Management Classes
The classes that are returned in the request or the response vary depending on the batch run management method. Some classes contain other classes as elements. The classes are described in alphabetical order. Classes that are used in multiple web service interfaces may be described in another section.
Run Mana g emen t Cl as s Hierarc hy
A class hierarchy depicts the structure of the classes.
The following class hierarchy depicts the structure of the run management classes:
"ResultRunsRequest Class" on page 83 "ClientContext Class" on page 25 "RunsCriteria Class" on page 83
"Date Class" on page 82
"RunInfo Class" on page 85
Date Clas s
The Date class contains date information.
When possible, you should use the parsed elements instead of the Unparsed element for optimal results.
Class Elements
Name
Type
Description
Day
Integer
This element contains the day value in a structured date. This element contains the month value in a structured date.
Month
Integer
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 82
CONFIDENTIAL
Class Elements (Continued)
Description
Name
Type
This element contains the unstructured date value. If your client instance is configured to use the ISO (International Organization for Standardization) date format in web services, then input dates are required to be in a YYYY-MM-DD format. If your client instance is configured to use U.S. or U.K. formats in web services, then no format requirements exist for input dates.
Unparsed
String
This element contains the year value in a structured date.
Year
Integer
ResultRu nsR equ es t Class
The ResultRunsRequest class contains the result runs request information that is sent to the XG REST API.
Class Elements
Name
Type
Description
ClientContext
ClientContext
The ClientContext class contains the XG client information and the XG session information. This element is required.
Criteria
RunsCriteria
The RunsCriteria class defines the criteria a run must meet to be returned in a query. This element is required.
RunsCriteria Cl ass
The RunsCriteria class defines the criteria a run must meet to be returned in a query. Batch runs must meet the criteria from each specified element to be returned.
Class Elements
Name
Type
Description
DateEnd
Date
This element contains the latest date that the run was performed. The Date class contains date information. This element contains the earliest date that the run was performed. The Date class contains date information.
DateStart
Date
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 83
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
Type
EFTType
This element contains the payment transaction type. Possible values: • None • ACH • Fedwire • ISO20022 • SWIFT • Unstructured None is not valid in a request. XML in ISO20022 requests must be encoded before processing.
EntityType
ResultEntityType
This element contains the entity type. Possible values: • Business • Individual • Text • Unknown • Unstructured
FileName
String
This element contains the name of the batch file that was searched. This element contains the name of the predefined search.
PredefinedSearch
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 84
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
ProcessingState
ProcessingStateType
This element contains the processing state. Possible values: • None • Canceled • Completed • Error • Incomplete • Interrupted • Processing
SubmitType
RunsCriteriaSubmitType
This element contains the run type. Possible values: • All • AutomaticBatch • Batch • Import • None • RealTime • WebServices You can provide more than one SubmitType element. Runs that meet any of the possible values provided in the request are returned.
RunInfo Cl ass
The RunInfo class contains the run information.
Class Elements
Name
Type
Description
AlertCount Division
Integer String
This element contains the number of alerts generated. This element contains the division that can access the search results. This element contains a system-generated number that identifies the division.
DivisionID
Integer
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 85
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
DPPA
DPPAChoiceType
This element contains the DPPA (Driver's Privacy Protection Act) permissible use. Possible values: • NA • Choice0 • Choice1 • Choice2 The default value is NA. This value is not valid if a DPPA permissible use is required. This property is required for LexisNexis® FraudPoint® Score searches or LexisNexis® InstantID® searches on individual entities.
• Choice3 • Choice4 • Choice6
Type
EFTType
This element contains the payment transaction type. Possible values: • None • ACH • Fedwire • ISO20022 • SWIFT • Unstructured None is not valid in a request. XML in ISO20022 requests must be encoded before processing.
EntityType
ResultEntityType
This element contains the entity type. Possible values: • Business • Individual • Text • Unknown • Unstructured
ErrorCount
Integer
This element contains the number of errors that the search generated. This element contains a system-generated error that prevented the run from being completed. This element contains the batch file that was searched. A custom format that identified the fields in the batch file.
ErrorMessage
String
FileName
String
FileFormatName
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 86
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
GLB
Integer
This element contains the GLBA (Gramm-Leach-Bliley Act) permissible use. Possible values: • 0 • 1 • 2 • 3 This property is required for FraudPoint Score searches or InstantID searches.
• 5 • 6 • 7 • 12
LastUpdateTime
DateTime
This element contains the date (YYYY-MM-DD) and 24-hour local time (HH:MM:SS) that the run was updated. This element contains the number of records that were searched. This element contains the name of the predefined search. This element contains the processing state. Possible values: • None • Canceled • Completed • Error • Incomplete • Interrupted • Processing
NumRecordsProcessed
Integer
PredefinedSearchName
String
ProcessingState
ProcessingStateType
ResultsFile1 ResultsFile2 RunID
String String Long
This element contains the result file. This element contains the result file. This element contains a system-generated number that identifies the run. This element contains the date (YYYY-MM-DD) and 24-hour local time (HH:MM:SS) that the search was started. This element contains the submit type. This element contains the number of records in the batch file. This element contains the number of rows in the batch file. This element contains the user name of the user who initiated the search. This element contains the number of potential matches that were generated.
StartTime
DateTime
SubmitType TotalNumRecords
String Integer
TotalNumRows
Integer
UserName
String
WLMatchCount
Integer
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 87
CONFIDENTIAL
Result Management
The Results interface lets you manage the alerts that are stored in the XG database.
The Results interface lets you perform the following actions on alerts:
• View an alert that contains specific information. • Delete an alert. • Query for alerts that contain specific information.
Record Method
The Record method deletes a specified alert.
The method is sent with the following HTTP request properties:
Request Line
The request uses the DELETE HTTP method. The request is sent to the following endpoint on the host server: /api/Results/Record/{id}. The in-path {id} parameter contains the system-generated number that identifies the record. To obtain a result ID, you use the SearchRecords method to search for the alert. The ID is also returned for the alert in a search response.
Required Headers Authorization
The request uses a bearer JWT for authentication.
Content-Type
The request contains a JSON message.
Host
The request is sent to https://
X-API-Key
The request contains the API authentication key for your client instance. XG Enterprise clients generate their API key in Enterprise Manager. XG Service clients receive an API key from LexisNexis Risk Solutions.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 88
CONFIDENTIAL
X-ClientInfo
This header is not required for Bridger JWT authentication. If the request uses a JWT that was generated by Azure AD, then the request can contain the base64-encoded XG client ID and user ID separated by a forward slash in the X-ClientInfo header. If the request uses this header, then XG ignores the ClientID and UserID elements in the ClientContext class.
Body
The request does not contain a body.
Return Values
If the method succeeds, then the response returns True. If the method fails or generates an error, then the response returns an Error class. The result ID is also returned.
Record Request Example
The following code shows an example of the HTTP request. The code that you send is different.
DELETE /api/Results/Record/{id} HTTP/1.1
Host:
Authorization: Bearer
Content-Type: application/json
X-API-Key:
X-ClientInfo:
Content-Length: 0
Records Method
The Records method returns the specified alerts.
The method is sent with the following HTTP request properties:
Request Line
The request uses the POST HTTP method. The request is sent to the following endpoint on the host server: /api/Results/Records.
Required Headers Authorization
The request uses a bearer JWT for authentication.
Content-Type
The request contains a JSON message.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 89
CONFIDENTIAL
Host
The request is sent to https://
X-API-Key
The request contains the API authentication key for your client instance. XG Enterprise clients generate their API key in Enterprise Manager. XG Service clients receive an API key from LexisNexis Risk Solutions.
X-ClientInfo
This header is not required for Bridger JWT authentication. If the request uses a JWT that was generated by Azure AD, then the request can contain the base64-encoded XG client ID and user ID separated by a forward slash in the X-ClientInfo header. If the request uses this header, then XG ignores the ClientID and UserID elements in the ClientContext class.
Body
The request contains the ResultRecordsRequest class.
Return Values
The response contains a ResultRecord class for each available result.
DataFiles Request Example
The following code shows an example of the HTTP request. The code that you send is different.
POST /api/Results/Records HTTP/1.1
Host:
Authorization: Bearer
Content-Type: application/json
X-API-Key:
{
"ResultRecordsRequest": {
"ClientContext": {...},
"Ids": [...]
}
}
SearchRecords Method
The SearchRecords method returns the alerts that meet the specified criteria in the result query.
The method is sent with the following HTTP request properties:
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 90
CONFIDENTIAL
Request Line
The request uses the POST HTTP method. The request is sent to the following endpoint on the host server: /api/Results/SearchRecords.
Required Headers Authorization
The request uses a bearer JWT for authentication.
Content-Type
The request contains a JSON message.
Host
The request is sent to https://
X-API-Key
The request contains the API authentication key for your client instance. XG Enterprise clients generate their API key in Enterprise Manager. XG Service clients receive an API key from LexisNexis Risk Solutions.
X-ClientInfo
This header is not required for Bridger JWT authentication. If the request uses a JWT that was generated by Azure AD, then the request can contain the base64-encoded XG client ID and user ID separated by a forward slash in the X-ClientInfo header. If the request uses this header, then XG ignores the ClientID and UserID elements in the ClientContext class.
Body
The request contains the SearchResultRecordsRequest class.
Return Values
The response contains the SearchRecordResults class.
SearchResultRecordsRequest Request Example
The following code shows an example of the HTTP request. The code that you send is different.
POST /api/Results/SearchRecords HTTP/1.1
Host:
Authorization: Bearer
X-API-Key:
{
"SearchResultRecordsRequest": {
"ClientContext": {...},
"ResultsCriteria": {...},
"Position": 0,
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 91
CONFIDENTIAL
"NumberToReturn": 0
}
}
SetRecordState Method
The SetRecordState method changes a combination of case management options and workflow options for an alert.
The method is sent with the following HTTP request properties:
Request Line
The request uses the POST HTTP method. The request is sent to the following endpoint on the host server: /api/Results/SetRecordState.
Required Headers Authorization
The request uses a bearer JWT for authentication.
Content-Type
The request contains a JSON message.
Host
The request is sent to https://
X-API-Key
The request contains the API authentication key for your client instance. XG Enterprise clients generate their API key in Enterprise Manager. XG Service clients receive an API key from LexisNexis Risk Solutions.
X-ClientInfo
This header is not required for Bridger JWT authentication. If the request uses a JWT that was generated by Azure AD, then the request can contain the base64-encoded XG client ID and user ID separated by a forward slash in the X-ClientInfo header. If the request uses this header, then XG ignores the ClientID and UserID elements in the ClientContext class.
Body
The request contains the SetRecordStateRequest class.
Return Values
The response contains a boolean value.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 92
CONFIDENTIAL
SetRecordState Request Example
The following code shows an example of the HTTP request. The code that you send is different.
POST /api/Results/SetRecordState HTTP/1.1
Host:
Authorization: Bearer
Content-Type: application/json
X-API-Key:
{
"SetRecordStateRequest": {
"ClientContext": {...},
"ResultID": 0,
"RecordState":{...}
}
}
Result Management Classes
The classes that are returned in the request or the response vary depending on the result management method. Some classes contain other classes as elements. The classes are described in alphabetical order. Classes that are used in multiple web service interfaces may be described in another section.
Result Manag em ent Class Hierarc hy
A class hierarchy depicts the structure of the classes.
The following class hierarchy depicts the structure of the result management classes:
"ResultRecord Class" on page 40
"FraudPointResults Class" on page 46 "FPInput Class" on page 45
"FPAddress Class" on page 45 "InputName Class" on page 173
"FPRedFlag Class" on page 46
"FPRiskIndicator Class" on page 46
"FPRiskIndicator Class" on page 46 "ResultError Class" on page 182 "InstantIDBusinessResults Class" on page 52 "IIDFEINMatch Class" on page 49
"IIDAddress Class" on page 48
"IIDFiling Class" on page 49
"IIDAddress Class" on page 48
"IIDInput Class" on page 49
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 93
CONFIDENTIAL
"IIDAddress Class" on page 48 "InputName Class" on page 173
"IIDReversePhone Class" on page 50 "IIDAddress Class" on page 48 "InputName Class" on page 173
"IIDRiskIndicator Class" on page 50 "IIDVerificationIndicators Class" on page 51 "IIDWatchlist Class" on page 51
"IIDAddress Class" on page 48
"ResultError Class" on page 182 "InstantIDIndividualResults Class" on page 53
"IIDAddressHistory Class" on page 48
"IIDAddress Class" on page 48
"IIDAlternateName Class" on page 48 "IIDInput Class" on page 49
"IIDAddress Class" on page 48 "InputName Class" on page 173
"IIDRedFlag Class" on page 50
"IIDRiskIndicator Class" on page 50
"IIDReversePhone Class" on page 50 "IIDAddress Class" on page 48 "InputName Class" on page 173
"IIDRiskIndicator Class" on page 50 "IIDSSNInfo Class" on page 51 "IIDWatchlist Class" on page 51
"IIDAddress Class" on page 48
"ResultError Class" on page 182
"SearchRecordResults Class" on page 106 "SearchResultRecordsRequest Class" on page 106
"ClientContext Class" on page 25 "ResultsCriteria Class" on page 101 "Date Class" on page 82 "EntityCriteriaAdditionalInfo Class" on page 178 "EntityCriteriaAddress Class" on page 179 "EntityCriteriaID Class" on page 179 "FraudPointResultCriteria Class" on page 96
"FPResultCriteriaRedFlag Class" on page 95
"InstantIDIntlResultCriteria Class" on page 101
"IIDIResultCriteriaIndividual Class" on page 97
"InstantIDResultCriteria Class" on page 101
"IIDResultCriteriaBusiness Class" on page 98 "IIDResultCriteriaIndividual Class" on page 99
"IIDResultCriteriaRedFlag Class" on page 100
"ResultCriteriaAccount Class" on page 103 "ResultCriteriaEFT Class" on page 103 "ResultCriteriaRecordState Class" on page 104
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 94
CONFIDENTIAL
"Date Class" on page 82
"WatchlistResultCriteria Class" on page 108
"SetRecordStateRequest Class" on page 107 "ClientContext Class" on page 25 "RecordState Class" on page 39
"AuditItem Class" on page 38 "WatchlistMatchState Class" on page 45
Date Clas s
The Date class contains date information.
When possible, you should use the parsed elements instead of the Unparsed element for optimal results.
Class Elements
Name
Type
Description
Day
Integer
This element contains the day value in a structured date. This element contains the month value in a structured date. This element contains the unstructured date value. If your client instance is configured to use the ISO date format in web services, then input dates are required to be in a YYYY-MM-DD format. If your client instance is configured to use U.S. or U.K. formats in web services, then no format requirements exist for input dates.
Month
Integer
Unparsed
String
Year
Integer
This element contains the year value in a structured date.
FPResultCriteriaR edFlag Class
The FPResultCriteriaRedFlag class contains red flag criteria that an alert must meet to be returned in a result query.
Class Elements
Name
Type
Description
PrimaryID SecondaryID
Integer Integer
This element contains the primary ID. This element contains the secondary ID.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 95
CONFIDENTIAL
FraudPoint R esul t Criteria Cla ss
The FraudPointResultCriteria class contains the FraudPoint Score criteria that an alert must meet to be returned in a result query.
For possible risk indicators and scores, see the LexisNexis® FraudPoint® Score Analyzing Results white paper that is available on the LexisNexis® Risk Solutions Customer Support Hub at https:// lnrs.my.site.com/CustomerSupportHub/s/article/2086.
Class Elements
Name
Type
Description
ErrorText FriendlyFraudIndexStart
String Integer
This element contains the error text. This element contains the start value of the index range to be queried. The index range is 1-9.
FriendlyFraudIndexEnd
Integer
This element contains the end value of the index range to be queried. This element contains the start value of the index range to be queried. The index range is 1-9.
ManipulatedIdentity IndexStart
Integer
ManipulatedIdentity IndexEnd ProviderErrorsOnly
Integer
This element contains the end value of the index range to be queried. True includes only alerts in which the FraudPoint Score search generated an error. The default value is false.
Boolean
RedFlags
List
The FPResultCriteriaRedFlag class contains red flag criteria that an alert must meet to be returned in a result query. This element contains an integer list of the risk indicators. This element contains the highest score that the alert can have and still be returned. This element contains the lowest score that the alert can have and still be returned. This element contains the start value of the index range. The index range is 1-9.
RiskIndicators
List
ScoreEnd
Integer
ScoreStart
Integer
StolenIdentityIndexStart
Integer
StolenIdentityIndexEnd
Integer
This element contains the end value of the index range. This element contains the start value of the index range. The index range is 1-9.
SuspiciousActivityIndex Start
Integer
SuspiciousActivityIndex End
Integer
This element contains the end value of the index range.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 96
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
SyntheticIdentityIndex Start
Integer
This element contains the start value of the index range. The index range is 1-9.
SyntheticIdentityIndex End Version
Integer
This element contains the end value of the index range. This element contains the LexisNexis® FraudPoint® version that was used to perform the search. Possible values: • None • V1_0 • V2_0
FraudPointVersion
VulnerableVictimIndex Start
Integer
This element contains the start value of the index range. The index range is 1-9.
VulnerableVictimIndex End
Integer
This element contains the end value of the index range.
IIDIResult CriteriaI n dividual C lass The IIDIResultCriteriaIndividual class contains the LexisNexis® InstantID® International criteria that alerts must meet to be returned in a result query.
For possible index values and risk indicators, see the LexisNexis® InstantID® International Analyzing Results white paper that is available on the Customer Support Hub.
Class Elements
Name
Type
Description
IndexEnd
IndexLevelType
This element contains the highest index that an alert can have to be returned. Possible values: • None • Level0 • Level10 • Level20 • Level30 • Level40 • Level50 This element is required.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 97
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
IndexStart
IndexLevelType
This element contains the lowest index that an alert can have to be returned. Possible values: • None • Level0 • Level10 • Level20 • Level30 • Level40 • Level50 This element is required.
RiskIndicators
List
This element contains the risk code that is associated with the risk indicator.
IIDResult Crit eriaB u siness Class
The IIDResultCriteriaBusiness class contains the InstantID criteria that the alerts for business entities must meet to be returned in a result query.
For possible risk indicators and indexes, see the LexisNexis® InstantID® Analyzing Results white paper that is available on the Customer Support Hub at https://lnrs.my.site.com/CustomerSupportHub/s/ article/2087.
Class Elements
Name
Type
Description
IndexEnd
IndexLevelType
This element contains the highest index that an alert can have to be returned. Possible values: • None • Level0 • Level10 • Level20 • Level30 • Level40 • Level50
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 98
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
IndexStart
IndexLevelType
This element contains the lowest index that an alert can have to be returned. Possible values: • None • Level0 • Level10 • Level20 • Level30 • Level40 • Level50 This element is required.
RiskIndicators
List
This element contains the risk code that is associated with the risk indicator.
IIDResult Crit eriaIn dividual Clas s
The IIDResultCriteriaIndividual class contains the InstantID criteria that the alerts for individual entities must meet to be returned in an alert query.
For possible risk indicators and indexes, see the LexisNexis® InstantID® Analyzing Results white paper that is available on the Customer Support Hub at https://lnrs.my.site.com/CustomerSupportHub/s/ article/2087.
Class Elements
Name
Type
Description
IndexEnd
IndexLevelType
This element contains the highest index that an alert can have to be returned. Possible values: • None • Level0 • Level10 • Level20 • Level30 • Level40 • Level50
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 99
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
IndexStart
IndexLevelType
This element contains the lowest index that an alert can have to be returned. Possible values: • None • Level0 • Level10 • Level20 • Level30 • Level40 • Level50 This element is required.
NAPCriteria
Integer
This element contains the name-address-phone number verification index. This element contains the name-address-SSN number verification index. The IIDResultCriteriaRedFlag class contains the red flag criteria that alerts must meet to be returned in a query. This element contains the risk code that is associated with the risk indicator.
NASCriteria
Integer
RedFlags
List
RiskIndicators
List
IIDResult Crit eriaR edFlag Cla ss
The IIDResultCriteriaRedFlag class contains the red flag criteria that alerts must meet to be returned in a query.
For possible red flags, see the LexisNexis® InstantID® Analyzing Results white paper that is available on the Customer Support Hub at https://lnrs.my.site.com/CustomerSup...s/article/2087.
Class Elements
Name
Type
Description
PrimaryID SecondaryID
Integer Integer
This element contains the primary ID. This element contains the secondary ID.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 100
CONFIDENTIAL
InstantIDI n tl Res u l tCriteria Clas s
The InstantIDIntlResultCriteria class contains the InstantID International criteria that alerts must meet to be returned in an alert query.
Class Elements
Name
Type
Description
ErrorText Individual
String IIDIResultCriteria Individual
This element contains the error text. The IIDIResultCriteriaIndividual class contains the InstantID International criteria that alerts must meet to be returned in a result query. True includes only alerts in which the InstantID International search generated an error. The default value is false.
ProviderErrorsOnly
Boolean
InstantIDR esu l tC riteria Class
The InstantIDResultCriteria class contains the InstantID criteria that alerts must meet to be returned in an alert query.
Class Elements
Name
Type
Description
Business
IIDResultCriteriaBusiness
The IIDResultCriteriaBusiness class contains the InstantID criteria that the alerts for business entities must meet to be returned in a result query. This element contains the error text. The IIDResultCriteriaIndividual class contains the InstantID criteria that the alerts for individual entities must meet to be returned in an alert query. True includes only alerts in which the InstantID search generated an error. The default value is false.
ErrorText Individual
String IIDResultCriteria Individual
ProviderErrorsOnly
Boolean
ResultsCrit eria C l ass
The ResultsCriteria class contains the criteria that alerts must meet to be returned in a result query.
Class Elements
Name
Type
Description
Account
ResultCriteriaAccount
The ResultCriteriaAccount class contains the account criteria that alerts must meet to be returned in a result query. The EntityCriteriaAdditionalInfo class contains the additional information that the record must meet to be returned.
AdditionalInfo
EntityCriteriaAdditional Info
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 101
CONFIDENTIAL
Class Elements (Continued)
Type
Description
Name
Address
EntityCriteriaAddress
The EntityCriteriaAddress class contains the address information and the phone information that the record must meet to be returned. This element contains the name of the alert decision that was applied to the alert. This element contains the text string in an unstructured input record that contained the match. This element contains the latest date that the alert was generated. The earliest date that the alert was generated. The ResultCriteriaEFT class contains the payment transaction criteria that alerts must meet to be returned in a result query. This element contains the entity type. Possible values: • Business • Individual • Text • Unknown • Unstructured
AlertDecisionName
String
Context
String
DateEnd
Date
DateStart EFT
Date ResultCriteriaEFT
EntityType
ResultEntityType
FirstName FraudPoint
String FraudPointResultCriteria
This element contains the first name. The FraudPointResultCriteria class contains the FraudPoint Score criteria that an alert must meet to be returned in a result query. This element contains the full name. The EntityCriteriaID class contains the ID information that the record must meet to be returned. The InstantIDResultCriteria class contains the InstantID criteria that alerts must meet to be returned in an alert query. The InstantIDIntlResultCriteria class contains the InstantID International criteria that alerts must meet to be returned in an alert query.
FullName ID
String EntityCriteriaID
InstantID
InstantIDResultCriteria
InstantIDIntl
InstantIDIntlResult Criteria
The InstantID International service is no longer available.
LastName MaidenName MatchText MiddleName RecordState
String String String String ResultCriteriaRecordState
This element contains the last name. This element contains the maiden name. This element contains the match text. This element contains the middle name. The ResultCriteriaRecordState class contains the record state information that alerts must meet to be returned in a result query.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 102
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
RunIDs
List
This element contains a system-generated number that identifies the run that generated the alert. The second surname. This element contains the SSN (Social Security number) or EIN (employer identification number). This element contains the latest time the alert was generated. This element contains the earliest time the alert was generated. The WatchlistResultCriteria class contains the list criteria that alerts must meet to be returned in a list query.
SecondSurname SSNEIN
String String
TimeEnd
Time
TimeStart
Time
Watchlist
WatchlistResultCriteria
ResultC rit eriaAccou nt Class
The ResultCriteriaAccount class contains the account criteria that alerts must meet to be returned in a result query.
Class Elements
Name
Type
Description
Amount Date GroupID ID MemberID OtherData
String String String String String String
This element contains the account amount. This element contains the account date. This element contains the account group ID. This element contains the account ID. This element contains the account member ID. This element contains the other account data that the alerts must contain to be returned. This element contains the account provider ID. This element contains the account type.
ProviderID Type
String String
ResultC rit eriaE FT C lass
The ResultCriteriaEFT class contains the payment transaction criteria that alerts must meet to be returned in a result query.
Class Elements
Name
Type
Description
DollarAmount
String
The dollar amount.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 103
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
DollarAmount Comparison
ComparisonType
The dollar amount comparison type. Possible values: • None • Is • IsGreaterThan • IsGreaterThanEqual • IsLessThan • IsLessThanOrEqual • IsNull
DUNS
String
The DUNS (Data Universal Numbering System) number. The external OFAC (Office of Foreign Assets Control) indicator. The transaction ID. This element contains the payment transaction type. Possible values: • None • ACH • Fedwire • ISO20022 • SWIFT • Unstructured None is not valid in a request. XML in ISO20022 requests must be encoded before processing.
ExternalOFACIndicator
String
TransactionID Type
String EFTType
ResultC rit eriaRecordState Clas s
The ResultCriteriaRecordState class contains the record state information that alerts must meet to be returned in a result query.
Class Elements
Name
Type
Description
AlertAge
AlertAgeType
This element contains the maximum alert age in days. Possible values: • None • Days10 • Days20 • Days30 • Days60 • Days90
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 104
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
AlertState
AlertStateType
This element contains the alert state. Possible values: • None • Closed • Open • Unassigned None is not valid in a request. Unassigned is only returned for alerts that did not contain results. For example, this value is set if the search generated an error but not an alert.
AnyErrors AssignedTo
Boolean String
True returns alerts that contain errors of any type. This element contains the user or the role that is assigned to the alert. This element contains the assignment type. Possible values: • Role • Unknown • User
AssignmentType
AssignmentType
CurrentStatus
String
This element contains the status currently set for the alert. This element contains the divisions that can access the alerts. This element contains the latest date that the alert entered the current state. This element contains the earliest date that the alert entered the current state. This element contains the latest date that the current status was set. This element contains the earliest date that the current status was set. True returns alerts that contain only general search errors. The default value is false.
Divisions
List
DateStateAssignedEnd
Date
DateStateAssignedStart
Date
DateStatusAssignedEnd
Date
DateStatusAssignedStart
Date
GeneralSearchErrorsOnly
Boolean
PredefinedSearch
String
This element contains the predefined search that defined the settings used in the search. This element contains the user name of the user who changed the status. True returns alerts that have an attachment. The default value is false.
RecordChangedBy
String
RecordHasAttachments
Boolean
ResultsWithoutDivision
Boolean
True returns alerts that are not restricted to a division. The default value is false.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 105
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
ResultsWithoutStatus
Boolean
True returns alerts with no status. The default value is false.
StatusHistory
String
This element contains the status that was previously set for the alert.
ResultRec ords Req u est Class
The ResultRecordsRequest class contains the result records request information that is sent to the XG REST API.
Class Elements
Name
Type
Description
ClientContext
ClientContext
The ClientContext class contains the XG client information and the XG session information. This element is required.
IDs
List
This element contains the alert ID. This element is required.
Searc hR eco rdR esul ts Class
The SearchRecordResults class contains the record IDs of the alerts that met the criteria in a result query.
Class Elements
Name
Type
Description
RecordIDs
List
This element contains a list of record IDs that identify the records that were returned. This element contains the total number of records that were returned.
TotalNumRecords
Long
Searc hR esu l tR eco rdsRequest C lass
The SearchResultRecordsRequest class contains the result records search request information that is sent to the XG REST API.
Class Elements
Name
Type
Description
ClientContext
ClientContext
The ClientContext class contains the XG client information and the XG session information. This element is required.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 106
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
Criteria
ResultsCriteria
The ResultsCriteria class contains the criteria that alerts must meet to be returned in a result query. This element is required.
Position
Integer
This element contains the position of the first record ID to be returned. This element contains the number of record IDs, up to 100, to be returned.
NumberToReturn
Integer
SetRecordS tat eR equest Class
The SetRecordStateRequest class contains the set record state request information that is sent to the XG REST API.
Class Elements
Name
Type
Description
ClientContext
ClientContext
The ClientContext class contains the XG client information and the XG session information. This element is required.
ResultID
Long
This element contains the system-generated number that identifies the alert. This element is required.
State
RecordState
The RecordState class contains a combination of case management options and workflow options for the alert. This element is required.
Time C lass
The Time class contains time information.
Class Elements
Name
Type
Description
Hour Milliseconds
Integer Integer
This element contains the hour in a structured time. This element contains the milliseconds in a structured time. This element contains the minute in a structured time. This element contains the seconds in a structured time. This element contains the unstructured time value.
Minute Second
Integer Integer
Unparsed
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 107
CONFIDENTIAL
Watchlist Res u l tCrit eria Class
The WatchlistResultCriteria class contains the list criteria that alerts must meet to be returned in a list query.
Class Elements
Name
Type
Description
ErrorText ExcludeIfFalseMatch UpdatesOnly
String Boolean
This element contains the error text. True sets XG to not return alerts that contain only false match updates. The default value is false.
ExcludeIfTrueMatch UpdatesOnly
Boolean
True sets XG to not return alerts that contain only true match updates. The default value is false.
FalseMatchUpdatesOnly
Boolean
True sets XG to return alerts that contain only false match updates. The default value is false.
MatchDispositionFalse Positive
Boolean
True sets XG to return alerts that contain a potential screening list match that is set as a false positive. The default value is false.
MatchDispositionTrue Match
Boolean
True sets XG to return alerts that contain a potential screening list match that is set as a true match. The default value is false.
ReasonListed
String
This element contains the reason the entity was listed on the screening list. This element contains the highest score that a potential list match can have for the alert to be returned. This element contains the lowest score that a potential list match can have for the alert to be returned. True returns alerts with errors. The default value is false.
ScoreEnd
Integer
ScoreStart
Integer
SearchOnErrors
Boolean
SourceName
String
This element contains the name of the list that contained the potential match. True returns only the alerts with true match updates. The default value is false.
TrueMatchUpdatesOnly
Boolean
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 108
CONFIDENTIAL
Chapter 6
ListM ai n tenance Interfac e
LexisNexis® Bridger Insight® XG (XG) web services provide a ListMaintenance interface that you can use to manage accept lists and custom screening lists.
Accept lists use information that you added from previous XG searches to filter out list screening matches in new searches that you have already processed. Your organization has likely already determined that those matches were false positive or has determined that updates to the entity records in the match need to be monitored.
For more information about how accept lists work, see the Accept Lists and White List technical white paper that is available on the LexisNexis® Risk Solutions Customer Support Hub at https:// lnrs.my.site.com/CustomerSupportHub/s/article/1969.
Custom screening lists are used to flag countries or entities in list searches for purposes that are unique to your organization.
List Management
The ListMaintenance interface lets you manage accept lists or custom screening lists.
The ListMaintenance interface lets you perform the following actions on the lists:
• Add a list. • Delete a list. • Index a custom screening list.
Lists that are set to automatically index do not index when changes are made through XG web services. Before changes are reflected in XG, the list must be manually indexed in the XG application or using the IndexList method.
• Search for a list that contains specific information. • Update a list. • View a list.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 109
CONFIDENTIAL
AddList Method
The AddList method creates a new accept list or custom screening list.
The method is sent with the following HTTP request properties:
Request Line
The request uses the POST HTTP method. The request is sent to the following endpoint on the host server: /api/ListMaintenance/AddList.
Required Headers Authorization
The request uses a bearer JWT (JSON Web Token) for authentication.
Content-Type
The request contains a JSON (JavaScript object notation) message.
Host
The request is sent to https://
X-API-Key
The request contains the API (application programming interface) authentication key for your client instance. XG Enterprise clients generate their API key in Enterprise Manager. XG Service clients receive an API key from LexisNexis® Risk Solutions.
X-ClientInfo
This header is not required for Bridger JWT authentication. If the request uses a JWT that was generated by Azure AD, then the request can contain the base64-encoded XG client ID and user ID separated by a forward slash in the X-ClientInfo header. If the request uses this header, then XG ignores the ClientID and UserID elements in the ClientContext class.
Body
The request contains the AddListRequest class.
Return Values
The response returns the system primary key that identifies the list. If the method fails or generates an error, then the response returns an Error class.
AddList Request Example
The following code shows an example of the HTTP request. The code that you send is different.
POST /api/ListMaintenance/AddList HTTP/1.1
Host:
Authorization: Bearer
Content-Type: application/json
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 110
CONFIDENTIAL
X-API-Key:
X-ClientInfo:
{
"AddListRequest": {
"ClientContext": {...},
"ListInfo": {...}
}
}
DeleteList Method
The DeleteList method deletes the specified list.
The method is sent with the following HTTP request properties:
Request Line
The request uses the DELETE HTTP method. The request is sent to the following endpoint on the host server: /api/ListMaintenance/DeleteList/{id}. The in-path {id} parameter contains the system-generated primary key that identifies the list. To obtain the list ID, you use the SearchLists method to search for the list.
Required Headers Authorization
The request uses a bearer JWT for authentication.
Content-Type
The request contains a JSON message.
Host
The request is sent to https://
X-API-Key
The request contains the API authentication key for your client instance. XG Enterprise clients generate their API key in Enterprise Manager. XG Service clients receive an API key from LexisNexis Risk Solutions.
X-ClientInfo
This header is not required for Bridger JWT authentication. If the request uses a JWT that was generated by Azure AD, then the request can contain the base64-encoded XG client ID and user ID separated by a forward slash in the X-ClientInfo header. If the request uses this header, then XG ignores the ClientID and UserID elements in the ClientContext class.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 111
CONFIDENTIAL
Body
The request does not contain a body.
Return Values
If the method succeeds, then the response returns True. If the method fails or generates an error, then the response returns an Error class.
DeleteList Request Example
The following code shows an example of the HTTP request. The code that you send is different.
DELETE /api/ListMaintenance/DeleteList/{id} HTTP/1.1
Host:
Authorization: Bearer
Content-Type: application/json
X-API-Key:
Content-Length: 0
IndexList Method
The IndexList method manually indexes the specified custom screening list.
The method is sent with the following HTTP request properties:
Request Line
The request uses the POST HTTP method. The request is sent to the following endpoint on the host server: /api/ListMaintenance/IndexList.
Required Headers Authorization
The request uses a bearer JWT for authentication.
Content-Type
The request contains a JSON message.
Host
The request is sent to https://
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 112
CONFIDENTIAL
X-API-Key
The request contains the API authentication key for your client instance. XG Enterprise clients generate their API key in Enterprise Manager. XG Service clients receive an API key from LexisNexis Risk Solutions.
X-ClientInfo
This header is not required for Bridger JWT authentication. If the request uses a JWT that was generated by Azure AD, then the request can contain the base64-encoded XG client ID and user ID separated by a forward slash in the X-ClientInfo header. If the request uses this header, then XG ignores the ClientID and UserID elements in the ClientContext class.
Body
The request contains the IndexListRequest class.
Return Values
If the request succeeds, then the response returns True. If the request fails or there is an error, then the response returns an HTTP error code.
IndexList Request Example
The following code shows an example of the HTTP request. The code that you send is different.
POST /api/ListMaintenance/IndexList HTTP/1.1
Host:
Authorization: Bearer
Content-Type: application/json
X-API-Key:
X-ClientInfo:
{
"IndexListRequest": {
"ClientContext": {...},
"ListId": 0
}
}
List Method
The List method returns the details of the specified list.
The method is sent with the following HTTP request properties:
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 113
CONFIDENTIAL
Request Line
The request uses the GET HTTP method. The request is sent to the following endpoint on the host server: /api/ListMaintenance/List/{id}. The in-path {id} parameter contains the system-generated primary key that identifies the list. To obtain the list ID, you use the SearchLists method to search for the list.
Required Headers Authorization
The request uses a bearer JWT for authentication.
Content-Type
The request contains a JSON message.
Host
The request is sent to https://
X-API-Key
The request contains the API authentication key for your client instance. XG Enterprise clients generate their API key in Enterprise Manager. XG Service clients receive an API key from LexisNexis Risk Solutions.
X-ClientInfo
This header is not required for Bridger JWT authentication. If the request uses a JWT that was generated by Azure AD, then the request can contain the base64-encoded XG client ID and user ID separated by a forward slash in the X-ClientInfo header. If the request uses this header, then XG ignores the ClientID and UserID elements in the ClientContext class.
Body
The request does not contain a body.
Return Values
The response contains the ListInfo class.
List Request Example
The following code shows an example of the HTTP request. The code that you send is different.
GET /api/ListMaintenance/List/{id} HTTP/1.1
Host:
Authorization: Bearer
Content-Type: application/json
X-API-Key:
X-ClientInfo:
Content-Length: 0
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 114
CONFIDENTIAL
SearchLists Method
The SearchLists method returns the lists that meet the specified criteria.
The method is sent with the following HTTP request properties:
Request Line
The request uses the POST HTTP method. The request is sent to the following endpoint on the host server: /api/ListMaintenance/SearchLists.
Required Headers Authorization
The request uses a bearer JWT for authentication.
Content-Type
The request contains a JSON message.
Host
The request is sent to https://
X-API-Key
The request contains the API authentication key for your client instance. XG Enterprise clients generate their API key in Enterprise Manager. XG Service clients receive an API key from LexisNexis Risk Solutions.
X-ClientInfo
This header is not required for Bridger JWT authentication. If the request uses a JWT that was generated by Azure AD, then the request can contain the base64-encoded XG client ID and user ID separated by a forward slash in the X-ClientInfo header. If the request uses this header, then XG ignores the ClientID and UserID elements in the ClientContext class.
Body
The request contains the SearchListsRequest class.
Return Values
The response contains the ListInfo class.
SearchLists Request Example
The following code shows an example of the HTTP request. The code that you send is different.
POST /api/ListMaintenance/SearchLists HTTP/1.1
Host:
Authorization: Bearer
Content-Type: application/json
X-API-Key:
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 115
CONFIDENTIAL
X-ClientInfo:
{
"SearchListsRequest": {
"ClientContext": {...},
"ListCriteria": {...}
}
}
UpdateList Method
The UpdateList method replaces the entire list entry in the XG database for the specified list.
The changes that are made to a custom screening list are not available until the list is indexed.
The method is sent with the following HTTP request properties:
Request Line
The request uses the POST HTTP method. The request is sent to the following endpoint on the host server: /api/ListMaintenance/UpdateList.
Required Headers Authorization
The request uses a bearer JWT for authentication.
Content-Type
The request contains a JSON message.
Host
The request is sent to https://
X-API-Key
The request contains the API authentication key for your client instance. XG Enterprise clients generate their API key in Enterprise Manager. XG Service clients receive an API key from LexisNexis Risk Solutions.
X-ClientInfo
This header is not required for Bridger JWT authentication. If the request uses a JWT that was generated by Azure AD, then the request can contain the base64-encoded XG client ID and user ID separated by a forward slash in the X-ClientInfo header. If the request uses this header, then XG ignores the ClientID and UserID elements in the ClientContext class.
Body
The request contains the UpdateListRequest class.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 116
CONFIDENTIAL
Return Values
If the request succeeds, then the response returns True. If the request fails or there is an error, then the response returns an HTTP error code.
UpdateList Request Example
The following code shows an example of the HTTP request. The code that you send is different.
POST /api/ListMaintenance/UpdateList HTTP/1.1
Host:
Authorization: Bearer
Content-Type: application/json
X-API-Key:
X-ClientInfo:
{
"UpdateListRequest": {
"ClientContext": {...},
"ListInfo": {...}
}
}
List Management Classes
The classes that are provided in the request or returned in the response vary depending on the list management method that is used. The classes are described in alphabetical order.
List Manag em ent Cl ass Hierarc hy
A class hierarchy depicts the structure of the classes.
The following class hierarchy depicts the structure of the list management classes:
"AddListRequest Class" on page 118
"ClientContext Class" on page 25 "ListInfo Class" on page 119 "IndexListRequest Class" on page 118 "ClientContext Class" on page 25
"ListInfo Class" on page 119 "SearchListsRequest Class" on page 121 "ClientContext Class" on page 25 "ListCriteria Class" on page 118
"UpdateListRequest Class" on page 122
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 117
CONFIDENTIAL
"ClientContext Class" on page 25 "ListInfo Class" on page 119
AddListR equ es t Cl ass
The AddListRequest class contains the new list request information that is sent to the XG REST API.
Class Elements
Name
Type
Description
ClientContext
ClientContext
The ClientContext class contains the XG client information and the XG session information. This element is required if the request uses Azure AD JWT and does not include the X-ClientInfo header.
List
ListInfo
The ListInfo class contains the list information when you take action on a list.
The properties that are already identified within the list are required when the product updates the list. Any existing properties that are not included in the request are deleted.
This element is required.
IndexL istR equ es t Cl ass
The IndexListRequest class contains the list indexing request information that is sent to the XG REST API.
Class Elements
Name
Type
Description
ClientContext
ClientContext
The ClientContext class contains the XG client information and the XG session information. This element is required if the request uses Azure AD JWT and does not include the X-ClientInfo header.
ListId
Long
This element contains a system-generated primary key that identifies the list that contains the record. This element is required.
ListC rite ria Cl as s
The ListCriteria class contains the criteria that a list must meet to be returned in a query.
If multiple elements are included, then the list must meet all criteria to be returned.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 118
CONFIDENTIAL
Class Elements
Name
Type
Description
Divisions
List
This element contains a list of the divisions that can access the list. This element contains a system-generated primary key that identifies the list. This element contains the list name. This element contains the list type. Possible values: • None • Accept (List that contains accept list records) • Country (Custom screening list that contains
ID
GUID
Name Type
String ListType
country records)
• Entity (Custom screening list that contains
entity records)
None is not valid in a request.
ListInfo C l ass
The ListInfo class contains the list information when you take action on a list.
When you update a list, the elements that are not included in the request are deleted.
Class Elements
Name
Type
Description
AccountNumbersUnique IDs
Boolean
True sets the product to treat account numbers as unique IDs. You use this element only for accept lists. The default value is false.
AutoIndex
Boolean
True sets the product to automatically index the list when changes are made in the XG application. The default value is false.
Lists that are set to automatically index do not index when changes are made through XG web services. The list must be manually indexed in the XG application or using the IndexList method before changes are reflected in the system.
Comments Description
String String
This element contains user-defined comments. This element contains the list description is required when you add a list.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 119
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
Divisions
List
This element contains a list of the divisions that can access the list. Only users in the specified divisions can make changes to the list. This restriction does not prevent other users from using the list to search.
Encrypt
Boolean
True sets the product to encrypt the list for security. The default value is false.
EntityUniqueIDType
IDType
This element contains the type of the unique ID. The product uses the unique ID to differentiate each record from other records with similar entity information.
Every record in the list must contain a unique ID with the selected ID type.
ID
Long
This element contains a system primary key you use to identify the list that you want to modify. If this element is included when you add a list, then 0 is required. This element cannot be changed. This element is required.
Name
String
This element contains the list name that is required when you add a list. This element is required.
Publication
DateTime
This element contains the date (YYYY-MM-DD) and 24-hour local time (HH:MM:SS) that LexisNexis Risk Solutions published the list. This element contains the list type. Possible values: • None • Accept (List that contains accept list records) • Country (Custom screening list that contains
Type
ListType
country records)
• Entity (Custom screening list that contains
entity records)
None is not valid in a request. This element is required.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 120
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
UniqueID
GUID
This element contains a system-generated number that the product uses instead of the list name to identify the list. This element is required for most requests that include the ListInfo class. The element is not required for the AddList method; the element is ignored in this case.
UserSelectedStatus Required
Boolean
True sets the product to require that a user set a status when an alert is added to the list. You use the element only for accept lists. The default value is false.
Searc hLis ts Req uest Class
The SearchListsRequest class contains the list search request information that is sent to the XG REST API.
Class Elements
Name
Type
Description
ClientContext
ClientContext
The ClientContext class contains the XG client information and the XG session information. This element is required if the request uses Azure AD JWT and does not include the X-ClientInfo header.
Criteria
ListCriteria
The ListCriteria class contains the criteria that a list must meet to be returned in a query. This element is required.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 121
CONFIDENTIAL
Update List R eques t Class
The UpdateListRequest class contains the list update information that is sent to the XG REST API.
Class Elements
Name
Type
Description
ClientContext
ClientContext
The ClientContext class contains the XG client information and the XG session information. This element is required if the request uses Azure AD JWT and does not include the X-ClientInfo header.
List
ListInfo
The ListInfo class contains the list information when you take action on a list.
The properties that are already identified within the list are required when the product updates the list. Any existing properties that are not included in the request are deleted.
This element is required.
List Record Management
The ListMaintenance interface lets you manage the records in accept lists or custom screening lists.
The ListMaintenance interface lets you perform the following actions on list records:
• Add an alert to a list. • View a list record.
You can also add records that you created to custom screening lists.
Lists that are set to automatically index do not index when changes are made through XG web services. Before changes are reflected in XG, the list must be manually indexed in the XG application or using the IndexList method.
AddRecord Method
The AddRecord method adds a record that was not generated by a search to a specified custom screening list.
This method cannot be used to add a record to accept lists.
The changes that are made to a custom screening list are not available until the list is indexed.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 122
CONFIDENTIAL
The method is sent with the following HTTP request properties:
Request Line
The request uses the POST HTTP method. The request is sent to the following endpoint on the host server: /api/ListMaintenance/Record.
Required Headers Authorization
The request uses a bearer JWT for authentication.
Content-Type
The request contains a JSON message.
Host
The request is sent to https://
X-API-Key
The request contains the API authentication key for your client instance. XG Enterprise clients generate their API key in Enterprise Manager. XG Service clients receive an API key from LexisNexis Risk Solutions.
X-ClientInfo
This header is not required for Bridger JWT authentication. If the request uses a JWT that was generated by Azure AD, then the request can contain the base64-encoded XG client ID and user ID separated by a forward slash in the X-ClientInfo header. If the request uses this header, then XG ignores the ClientID and UserID elements in the ClientContext class.
Body
The request contains the following parameters:
• The system-generated primary key that identifies the list
To obtain the list ID, you use the SearchLists method to search for the list.
• The ListRecord class
The ListRecord class contains the record information when you add a record, update a record, or view record information.
Return Values
The record ID is returned for the record that was added to the list. If the method fails or generates an error, then the response returns an Error class.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 123
CONFIDENTIAL
AddRecord Request Example
The following code shows an example of the HTTP request. The code that you send is different.
POST /api/ListMaintenance/Record?listId={id} HTTP/1.1
Host:
Authorization: Bearer
Content-Type: application/json
X-API-Key:
X-ClientInfo:
Content-Length: 0
{
"ListRecord": {
"Comments": "string",
"Country": {...},
"DateListed": {...},
"Entity": {...}, "ID": {...},
"LastModified": "YYYY-MM-DDTHH:MM:SS.sssZ",
"ListID": 0,
"ReasonListed": "string",
"ReferenceNumber": "string"
}
}
GetRecord Method
The GetRecord method returns a specified record from a specified accept list or custom screening list.
The method is sent with the following HTTP request properties:
Request Line
The request uses the GET HTTP method. The request is sent to the following endpoint on the host server: /api/ListMaintenance/Record/{id}. The in-path {id} parameter contains the system-generated number that identifies the record.
Required Headers Authorization
The request uses a bearer JWT for authentication.
Content-Type
The request contains a JSON message.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 124
CONFIDENTIAL
Host
The request is sent to https://
X-API-Key
The request contains the API authentication key for your client instance. XG Enterprise clients generate their API key in Enterprise Manager. XG Service clients receive an API key from LexisNexis Risk Solutions.
X-ClientInfo
This header is not required for Bridger JWT authentication. If the request uses a JWT that was generated by Azure AD, then the request can contain the base64-encoded XG client ID and user ID separated by a forward slash in the X-ClientInfo header. If the request uses this header, then XG ignores the ClientID and UserID elements in the ClientContext class.
Body
The request contains the following parameters:
• The system-generated primary key that identifies the list
To obtain the list ID, you use the SearchLists method to search for the list.
• The system-generated primary key that identifies the record
Return Values
The ListRecord class contains the record information when you add a record, update a record, or view record information. If the method fails or generates an error, then the response returns an Error class.
GetRecord Request Example
The following code shows an example of the HTTP request. The code that you send is different.
GET /api/ListMaintenance/Record/{id}?listId={id} HTTP/1.1
Host:
Authorization: Bearer
Content-Type: application/json X-API-Key:
X-ClientInfo:
Content-Length: 0
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 125
CONFIDENTIAL
ResultRecord Method
The ResultRecord method adds a specified alert to an accept list or to an entity custom screening list. You cannot add an alert to a country custom screening list.
When you add an alert to an accept list, XG automatically changes the record as follows:
• The alert status is set to FalsePositive. • The alert assignment is set to Unassigned. • The alert state is set to Closed.
The changes that are made to a custom screening list are not available until the list is indexed.
The method is sent with the following HTTP request properties:
Request Line
The request uses the PUT HTTP method. The request is sent to the following endpoint on the host server: /api/ListMaintenance/ResultRecord.
Required Headers Authorization
The request uses a bearer JWT for authentication.
Content-Type
The request contains a JSON message.
Host
The request is sent to https://
X-API-Key
The request contains the API authentication key for your client instance. XG Enterprise clients generate their API key in Enterprise Manager. XG Service clients receive an API key from LexisNexis Risk Solutions.
X-ClientInfo
This header is not required for Bridger JWT authentication. If the request uses a JWT that was generated by Azure AD, then the request can contain the base64-encoded XG client ID and user ID separated by a forward slash in the X-ClientInfo header. If the request uses this header, then XG ignores the ClientID and UserID elements in the ClientContext class.
Body
The request contains the AddResultRecordRequest class.
Return Values
The response contains the system-generated primary key that identifies the list record.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 126
CONFIDENTIAL
ResultRecord Request Example
The following code shows an example of the HTTP request. The code that you send is different.
PUT /api/ListMaintenance/ResultRecord HTTP/1.1
Host:
Authorization: Bearer
Content-Type: application/json
X-API-Key:
X-ClientInfo:
{
"AddResultRecordRequest": {
"ClientContext": {...},
"Result": {...},
"ListID": 0
} }
List Record Management Classes
The classes that are provided in the request or returned in the response vary depending on the list record management method that is used. Some classes contain other classes as elements.
The classes are described in alphabetical order. Classes that are used in multiple web service interfaces may be described in another section.
List Re co rd M anag em ent Class Hi erarc hy
A class hierarchy depicts the structure of the classes.
The following class hierarchy depicts the structure of the list record management classes:
"AddResultRecordRequest Class" on page 131 "ClientContext Class" on page 25 "ResultInfo Class" on page 136
"ResultRecord Class" on page 40
"FraudPointResults Class" on page 46 "FPInput Class" on page 45
"FPAddress Class" on page 45 "InputName Class" on page 173
"FPRedFlag Class" on page 46
"FPRiskIndicator Class" on page 46
"FPRiskIndicator Class" on page 46 "ResultError Class" on page 182
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 127
CONFIDENTIAL
"InstantIDBusinessResults Class" on page 52 "IIDFEINMatch Class" on page 49
"IIDAddress Class" on page 48
"IIDFiling Class" on page 49
"IIDAddress Class" on page 48
"IIDInput Class" on page 49
"IIDAddress Class" on page 48 "InputName Class" on page 173
"IIDReversePhone Class" on page 50 "IIDAddress Class" on page 48 "InputName Class" on page 173
"IIDRiskIndicator Class" on page 50 "IIDVerificationIndicators Class" on page 51 "IIDWatchlist Class" on page 51
"IIDAddress Class" on page 48
"ResultError Class" on page 182 "InstantIDIndividualResults Class" on page 53
"IIDAddressHistory Class" on page 48
"IIDAddress Class" on page 48
"IIDAlternateName Class" on page 48 "IIDInput Class" on page 49
"IIDAddress Class" on page 48 "InputName Class" on page 173
"IIDRedFlag Class" on page 50
"IIDRiskIndicator Class" on page 50
"IIDReversePhone Class" on page 50 "IIDAddress Class" on page 48 "InputName Class" on page 173
"IIDRiskIndicator Class" on page 50 "IIDSSNInfo Class" on page 51 "IIDWatchlist Class" on page 51
"IIDWatchlist Class" on page 51
"ResultError Class" on page 182
"ResultRecordDetails Class" on page 41
"InputAdditionalInfo Class" on page 170
"Date Class" on page 82 "InputAddress Class" on page 170 "InputID Class" on page 172
"Date Class" on page 82
"InputName Class" on page 173 "ParsedACH Class" on page 138
"ParsedACHField Class" on page 140 "ParsedACHNote Class" on page 141 "ParsedACHParty Class" on page 143
"ParsedACHAdditionalInfo Class" on page 139 "ParsedACHAddress Class" on page 140
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 128
CONFIDENTIAL
"ParsedACHID Class" on page 141
"ParsedFedwire Class" on page 143
"ParsedFedwireField Class" on page 146
"ParsedFedwireAmount Class" on page 146
"ParsedFedwireNote Class" on page 147 "ParsedFedwireParty Class" on page 147
"ParsedFedwireAdditionalInfo Class" on page 144 "ParsedFedwireAddress Class" on page 145 "ParsedFedwireNote Class" on page 147 "ParsedFedwireID Class" on page 147 "ParsedFedwirePhone Class" on page 148
"ParsedISO20022 Class" on page 149
"ParsedISO20022Field Class" on page 152 "ParsedISO20022Note Class" on page 152 "ParsedISO20022Party Class" on page 153
"ParsedISO20022AdditionalInfo Class" on page 150 "ParsedISO20022Address Class" on page 150 "ParsedISO20022ID Class" on page 152 "ParsedISO20022Note Class" on page 152 "ParsedISO20022Phone Class" on page 154
"ParsedSWIFT Class" on page 154
"ParsedSWIFTField Class" on page 164
"ParsedSWIFTAmount Class" on page 163 "ParsedSWIFTOriginalMessage Class" on page 165
"ParsedSWIFTNote Class" on page 164 "ParsedSWIFTParty Class" on page 165
"ParsedSWIFTAdditionalInfo Class" on page 162 "ParsedSWIFTAddress Class" on page 162 "ParsedSWIFTID Class" on page 164
"InputPhone Class" on page 174 "RecordState Class" on page 39
"AuditItem Class" on page 38 "WatchlistMatchState Class" on page 45
"ResultError Class" on page 182
"WatchlistResults Class" on page 56
"OFACReportInfo Class" on page 55
"OFACInstitutionInfo Class" on page 55
"ResultError Class" on page 182 "WLAddressMatch Class" on page 56 "WLCitizenshipMatch Class" on page 57 "WLCountryDetails Class" on page 57 "WLDOBMatch Class" on page 58 "WLEntityDetails Class" on page 58
"EntityAdditionalInfo Class" on page 175 "EntityAddress Class" on page 175 "EntityAKA Class" on page 176
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 129
CONFIDENTIAL
"EntityID Class" on page 176
"Date Class" on page 82
"EntityName Class" on page 177 "EntityPhone Class" on page 177
"WLMatch Class" on page 60
"AdverseMedia Class" on page 67 "CountryAssociation Class" on page 67 "Enforcement Class" on page 68 "MSB Class" on page 68 "OtherSegment Class" on page 69
"CountryAssociation Class" on page 67
"PEP Class" on page 70 "Registration Class" on page 71 "Relationship Class" on page 72 "Sanction Class" on page 73 "SOE Class" on page 74
"CountryAssociation Class" on page 67
"Vessel Class" on page 74 "WLIDMatch Class" on page 59 "WLMatchConflicts Class" on page 64 "WLMatchFile Class" on page 64 "WLMatchFprDetails Class" on page 65 "WLMatchSummary Class" on page 65
"WLMatchSummaryItem Class" on page 66
"WLPhoneMatch Class" on page 66
"WatchlistMatchState Class" on page 45
"ListRecord Class" on page 135
"CountryInfo Class" on page 131
"CountryAKA Class" on page 131 "CountryLocation Class" on page 132
"EntityInfo Class" on page 133
"EntityAdditionalInfo Class" on page 175 "EntityAddress Class" on page 175 "EntityAKA Class" on page 176 > "EntityName Class" on page 177 "EntityID Class" on page 176 > "Date Class" on page 82 "EntityMatchInfo Class" on page 134 "EntityName Class" on page 177 "EntityPhone Class" on page 177
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 130
CONFIDENTIAL
AddRe su l tRec ordR equest Clas s
The AddResultRecordRequest class contains the result information that is sent to the XG REST API.
Class Elements
Name
Type
Description
ClientContext
ClientContext
The ClientContext class contains the XG client information and the XG session information. This element is required if the request uses Azure AD JWT and does not include the X-ClientInfo header.
Result
ResultInfo
The ResultInfo class contains the alert information that XG used to create the list record. This element is required.
ListId
Long
This element contains a system-generated primary key that identifies the list that contains the record. This element is required.
Country AK A C l ass
The CountryAKA class contains the information for a country record.
Class Elements
Name
Type
Description
AKA ID
String Long
This element contains the AKA (also known as) value. This element contains a system-generated number that identifies the entry in the record. This element contains the country AKA type. Possible values: • None • AKA • Code • Term None is not valid in a request. An example of a term is Iranian.
Type
CountryAKAType
Country I nfo Cl as s
The CountryInfo class contains the country information when you add a record, update a record, or view record information.
Class Elements
Name
Type
Description
AKAs
List
The CountryAKA class contains the information for a country record.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 131
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
Locations
List
The CountryLocation class contains the location information for a country record. This element contains the country name.
Name
String
Country Lo cat ion Cl ass
The CountryLocation class contains the location information for a country record.
Class Elements
Name
Type
Description
ID
Long
This element contains a system-generated number that identifies the entry in the record. This element contains the country name. This element contains the country location type. Possible values: • None • City • Port None is not valid in a request.
Name Type
String CountryLocationType
Date Clas s
The Date class contains date information.
When possible, you should use the parsed elements instead of the Unparsed element for optimal results.
Class Elements
Name
Type
Description
Day
Integer
This element contains the day value in a structured date. This element contains the month value in a structured date.
Month
Integer
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 132
CONFIDENTIAL
Class Elements (Continued)
Description
Name
Type
This element contains the unstructured date value. If your client instance is configured to use the ISO (International Organization for Standardization) date format in web services, then input dates are required to be in a YYYY-MM-DD format. If your client instance is configured to use U.S. or U.K. formats in web services, then no format requirements exist for input dates.
Unparsed
String
This element contains the year value in a structured date.
Year
Integer
EntityInf o C l ass
The EntityInfo class contains the entity information when you add a record, update a record, or view record information.
Class Elements
Name
Type
Description
AdditionalInfo
List
The EntityAdditionalInfo class contains the additional information that helps identify the list entity. The EntityAddress class contains the address information. The EntityAKA class contains the alternative name information. This element contains the entity type. Possible values: • None • Business • Individual • Unknown • Vessel None is not valid in a request.
Addresses
AKAs
List
EntityType
ListEntityType
Gender
GenderType
This element contains the entity gender type. Possible values: • None • Female • Male • Unknown None is not valid in a request.
IDs MatchInfo
List
The EntityID class contains the entity ID information. The EntityMatchInfo class contains information on the list entity that matched your input information.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 133
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
Name Phones
EntityName List
The EntityName class contains the name information. The EntityPhone class contains the phone number information.
EntityMatchI n fo Cl ass
The EntityMatchInfo class contains information on the list entity that matched your input information. Only accept list records contain this information.
Class Elements
Name
Type
Description
BestDOB
String
This element contains the DOB (date of birth) that most closely matched the input information. This element contains the name that most closely matched the input information. This element contains a system-generated number that is used by XG to determine if True Match records have changed. True indicates that the list is a custom screening list. The default value is false.
BestName
String
CheckSum
Integer
CustomFile
Boolean
EntityName EntityScore
String Integer
This element contains the entity name. This element contains the match confidence score (0- 100) that XG generated to indicate how closely the list record matched the input entity information. If a valid score is not available, then ‐1 is returned.
EntityUniqueID FileDate
String DateTime
This element contains the entity's unique ID. This element contains the date (YYYY-MM-DD) and 24- hour local time (HH:MM:SS) that the source agency provided the list that contained the match. This element contains the name of the list that contained the match. This element contains a system-generated number that identifies the entry in the record. This element contains the last alert result ID. This element contains the date (YYYY-MM-DD) and 24-hour local time (HH:MM:SS) that XG identified the match.
FileName
String
ID
Long
LastAlertResultID MatchDate
Long DateTime
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 134
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
MatchState
MatchStates
This element contains the state of the match. Possible values: • None • Baselined
This value indicates that XG has added the necessary information for false match updates.
• Realerted
This value indicates that XG has identified a false match update.
OriginatingResultID PublishedDate
Long DateTime
This element contains the originating result ID. This element contains the date (YYYY-MM-DD) and 24-hour local time (HH:MM:SS) that LexisNexis Risk Solutions provided the screening list that contained the match.
ListRe cord Cl ass
The ListRecord class contains the record information when you add a record, update a record, or view record information. The record can either contain country information or entity information, not both.
When you update a record, the elements that are not included are deleted or set to false.
Class Elements
Name
Type
Description
Comments Country
String CountryInfo
This element contains the user-defined comments. The CountryInfo class contains the country information when you add a record, update a record, or view record information. The element is required if the Entity element is not provided. If this element is included, then the class cannot contain the Entity element.
DateListed Entity
Date EntityInfo
The Date class contains date information. The EntityInfo class contains the entity information when you add a record, update a record, or view record information. This element is required if the Country element is not provided. If this element is included, then the class cannot contain the Country element.
ID
Long
This element contains a system-generated number that identifies the record.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 135
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
LastModified
DateTime
This element contains the date (YYYY-MM-DD) and 24-hour local time (HH:MM:SS) that the record was last modified. This element contains a system-generated primary key that identifies the list that contains the record. This element is required when you add a record to a list.
ListID
Long
ReasonListed
String
The reason the record was added to the list. You use this element only for custom screening lists.
ReferenceNumber
String
This element contains a user-defined reference value.
ResultInf o C l ass
The ResultInfo class contains the alert information that XG used to create the list record.
Only business entities or individual entities can be added to lists. When you add a record to an accept list, the record must contain a complete address or ID number.
Class Elements
Name
Type
Description
NewAlertState
AlertStateType
This element contains the alert state. Possible values: • None • Closed • Open • Unassigned
NewMatchStates
List
The WatchlistMatchState class contains the decision information if separate decisions were set for each list match in the alert. This element is required if the alert is configured to disposition each list match separately.
NewStatus Note
String String
This element contains the new alert status. This element contains a user-defined note. This element is required if a note requirement was configured in the XG application and the action that required a note was performed.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 136
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
Record
ResultRecord
The ResultRecord class contains information about the alert. This element is required if the ResultID element is not provided.
XG ignores information that is not relevant to list searching. For example, due diligence results are not added to the list record.
ResultID
Long
This element contains a system-generated number that identifies the alert, to be added to the list, in the XG database. This element is required if the Record element is not provided. If the Record element is included, then this element is ignored.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 137
CONFIDENTIAL
Chapter 7
EFT Par se d Input Cl asses
With the Search method in the Lists interface, input payment transaction data is searched as a text string that is provided in the InputEFT class. The REST API for LexisNexis® Bridger Insight® XG (XG) returns the input data as structured information when results are returned.
ACH Parsed Input Classes
Search requests for ACH (Automated Clearing House) records include various input classes. These classes are returned in the list screening results of the Lists interface.
ParsedACH Class
The ParsedACH class contains the input information.
For information on record content and format, see http://www.nacha.org.
Class Elements
Name
Type
Description
BatchNumber CardExpirationDate CardTransactionType Code CompanyEntry Description CompanyEntry DescriptiveDate EffectiveEntryDate FileCreationDate FileCreationTime FileIdentification ForeignExchange Indicator ForeignExchange Reference ForeignExchange ReferenceIndicator
String String String
This element contains the batch number. This element contains the card expiration date. This element contains the card transaction type code.
String
This element contains the company description.
String
This element contains the company descriptive date.
String String String String String
This element contains the effective entry date. This element contains the file creation date. This element contains the file creation time. This element contains the file identification. This element contains the foreign exchange indicator.
String
This element contains the foreign exchange reference.
String
This element contains the foreign exchange reference indicator.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 138
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
GatewayOperatorOFAC ScreeningIndicator IATIndicator
String
This element contains the gateway operator OFAC (Office of Foreign Assets Control) screening indicator. This element contains the IAT (International Automated Clearing House Transaction) indicator. This element contains the ISO (International Organization for Standardization) destination country code. This element contains the ISO destination currency code. This element contains the ISO originating currency code. This element contains the item type indicator. This element contains the Julian date on which the advice was created. The ParsedACHNote class contains the input note information. The ParsedACHParty class contains the input party information. This element contains the payment type code. This element contains the process control field. This element contains the reference code. This element contains the refused acknowledgement code. This element contains the secondary OFAC screening indicator. This element contains the service class code. This element contains the settlement date. This element contains the standard entry class code. This element contains the total amount of the transaction. This element contains the trace number. This element contains the transaction code.
String
ISODestinationCountry Code
String
ISODestinationCurrency Code ISOOriginatingCurrency Code ItemTypeIndicator JulianDateOnWhichThis AdviceIsCreated Notes
String
String
String String
List
Parties
List
PaymentTypeCode ProcessControlField ReferenceCode RefusedAcknowledgment Code SecondaryOFACScreening Indicator ServiceClassCode SettlementDate StandardEntryClassCode TotalAmount
String String String String
String
String String String String
TraceNumber TransactionCode
String String
ParsedACHAdditionalInfo Class
The ParsedACHAdditionalInfo class contains the additional information for the input party.
Class Elements
Name
Type
Description
Field
Integer
This element contains the field number. This element is required.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 139
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
Info RecordTypeCode
String Integer
This element contains the additional information. This element contains the record type code. This element is required.
ParsedACHAddress Class
The ParsedACHAddress class contains the address information for the input party.
Class Elements
Name
Type
Description
City CityStateProvince
String String
This element contains the city. This element contains the city, the state, or the province. This element contains the country. This element contains the country postal code. This element contains the postal code. This element contains the state or the province. This element contains the street address. This element contains the address type. Possible values: • None • Current • Mailing • Previous • Unknown None is not valid in a request.
Country CountryPostalCode PostalCode StateProvince StreetAddress Type
String String String String String AddressType
ParsedACHField Class
The ParsedACHField class contains the field information.
Class Elements
Name
Type
Description
AddendaTypeCode Contested Dishonored Field
String Boolean Boolean Integer
This element contains the addenda type code. True indicates contested. True indicates dishonored. This element contains the field number.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 140
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
RecordTypeCode Refused Value
Integer Boolean String
This element contains the record type code. True indicates refused. This element contains the field value.
ParsedACHID Class
The ParsedACHID class contains the ID information for the input party.
Class Elements
Name
Type
Description
Number Type
String IDType
This element contains the ID number. This element contains the ID type.
ParsedACHNote Class
The ParsedACHNote class contains the input note information.
Class Elements
Name
Type
Description
AuthorizationCodeOr CardExpirationDate ChangeCode ContestedDishonored ReturnReasonCode CORTraceSequence Number DateOfDeath DateOriginalEntry Returned DishonoredReturnReason Code DishonoredReturn SettlementDate DishonoredReturnTrace Number EDITRNDataSegment Identifier ForeignPaymentAmount
String
This element contains the authorization code or card expiration date. This element contains the change code. This element contains the contested dishonored return reason code. This element contains the change order request trace sequence number. This element contains the DOD (date of death). This element contains the original entry date.
String String
String
String String
String
This element contains the dishonored return reason code. This element contains the dishonored return settlement date. This element contains the dishonored return trace number. This element contains the edit RN data segment identifier. This element contains the foreign payment amount.
String
String
String
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 141
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
ForeignTraceNumber NetworkIdentification Code Note OriginalEntryTrace Number OriginalForwardEntry PaymentAmount OriginalReceivingDFI Identification OriginalSettlementDate OriginatingCompanyID ReceiverIdentification Number ReferenceID1 ReferenceID2 ReferenceInformation1
String String
This element contains the foreign trace number. This element contains the network identification code.
String String
This element contains the note text. This element contains the original entry trace number.
String
This element contains the original forward entry payment amount. This element contains the original receiving depository financial institution identification. This element contains the original settlement date. This element contains the originating company ID. This element contains the receiver identification number. This element contains the reference ID field 1. This element contains the reference ID field 2. This element contains the reference information field 1. This element contains the reference information field 2. This element contains the refused change order request code. This element contains the return reason code. This element contains the return settlement date. This element contains the return trace number. This element contains the sequence number. This element contains the terminal identification code. This element contains the trace number. This element contains the trace type code. This element contains the transaction date. This element contains the transaction description. This element contains the transaction serial number. This element contains the transaction time. This element contains the transaction type code. This element contains the type code.
String
String String String
String String String
ReferenceInformation2
String
RefusedCORCode
String
ReturnReasonCode ReturnSettlementDate ReturnTraceNumber SequenceNumber TerminalIdentification Code TraceNumber TraceTypeCode TransactionDate TransactionDescription TransactionSerialNumber TransactionTime TransactionTypeCode TypeCode
String String String String String
String String String String String String String String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 142
CONFIDENTIAL
ParsedACHParty Class
The ParsedACHParty class contains the input party information.
Class Elements
Name
Type
Description
AdditionalInfo
List
This element contains user-defined additional information. The ParsedACHAddress class contains the address information for the input party. The ParsedACHID class contains the ID information for the input party. This element contains the party name. This element contains the EFT (electronic funds transfer) party type for payment transaction records.
Addresses
List
IDs
List
Name Type
String EFTPartyType
Fedwire Parsed Input Classes
Search requests for Fedwire records include various input classes. These classes are returned in the list screening results of the Lists interface.
ParsedFedwire Class
The ParsedFedwire class contains the Fedwire input information.
For information on data content and record format, see http://www.frbservices.org.
Class Elements
Type
Description
Name
ActualAmounts
List
The ParsedFedwireAmount class contains the input transaction amount information. This element contains the effective date of the adjustment. This element contains the reason code for the adjustment. The ParsedFedwireAdjustment class contains the input adjustment information. This element contains the business function code. The ParsedFedwireAmount class contains the input transaction amount information.
AdjustmentEffectiveDate
AdjustmentReasonCode
String
Adjustments
List
BusinessFunctionCode Charges
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 143
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
CurrencyInstructed Amount DetailsOfCharges DocumentDates
ParsedFedwireAmount
The ParsedFedwireAmount class contains the input transaction amount information. This element contains the details of the charges. This element contains the dates of the input documents. The ParsedFedwireDocument class contains the input document information. This element contains the dollar amount of the transactions. This element contains the currency exchange rate. The ParsedFedwireAmount class contains the input transaction amount information. The ParsedFedwireAmount class contains the input transaction amount information. This element contains the local instrument code. This element contains the proprietary local instrument code. The ParsedFedwireAmount class contains the input transaction amount information. The ParsedFedwireNote class contains the input note information. The ParsedFedwireParty class contains the input party information. This element contains the payment notification indicator. This element contains the beneficiary reference. This element contains the remittance location method code. This element contains the sender reference number. This element contains the additional sender-provided information. This element contains the Fedwire type code.
String List
Documents
List
DollarAmount
ExchangeRate GrossAmounts
String List
InstructedAmount
LocalInstrumentCode LocalInstrument ProprietaryCode NegotiatedDiscounts
String String
List
Notes
Parties
List
PaymentNotification Indicator ReferenceForBeneficiary RemittanceLocation Method SenderReferenceNumber SenderSupplied Information TypeCode
String String
String String
String
ParsedFedwireAdditionalInfo Class
The ParsedFedwireAdditionalInfo class contains the additional information for the input party.
Class Elements
Name
Type
Description
Country Info
String String
This element contains the country. This element contains additional input information.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 144
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
ParsedInfo
String
This element contains additional structured input information. This element contains the information type.
Type
AdditionalInfoType
ParsedFedwireAddress Class
The ParsedFedwireAddress class contains the address information for the input party.
Class Elements
Name
Type
Description
AddressLine1 AddressLine1Element AddressLine2 AddressLine2Element AddressLine3 AddressLine3Element AddressLine4 AddressLine4Element AddressLine5 AddressLine5Element AddressLine6 AddressLine6Element AddressLine7 AddressLine7Element BuildingNumber BuildingNumberElement City CityElement Country CountryElement Department DepartmentElement PostalCode PostalCodeElement StateProvince StateProvinceElement
String Integer String Integer String Integer String Integer String Integer String Integer String Integer String Integer String Integer String Integer String Integer String Integer String Integer
This element contains the line 1 of the address. The element for line 1 of the address. This element contains the line 2 of the address. The element for line 2 of the address. This element contains the line 3 of the address. The element for line 3 of the address. This element contains the line 4 of the address. The element for line 4 of the address. This element contains the line 5 of the address. The element for line 5 of the address. This element contains the line 6 of the address. The element for line 6 of the address. This element contains the line 7 of the address. The element for line 7 of the address. This element contains the building number. This element contains the building number element. This element contains the city. This element contains the city element. This element contains the country. This element contains the country element. This element contains the department. This element contains the department element. This element contains the postal code. This element contains the postal code element. This element contains the state or the province. This element contains the state or the province element. This element contains the street name. This element contains the street name element.
StreetName StreetNameElement
String Integer
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 145
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
SubDepartment SubDepartmentElement Tag Type
String Integer String AddressType
This element contains the sub-department. This element contains the sub-department element. This element contains the field tag. This element contains the address type. Possible values: • None • Current • Mailing • Previous • Unknown None is not valid in a request. This element is required.
ParsedFedwireAmount Class
The ParsedFedwireAmount class contains the input transaction amount information.
Class Elements
Name
Type
Description
Amount CurrencyCode
String String
This element contains the transaction amount. This element contains the currency code.
ParsedFedwireField Class
The ParsedFedwireField class contains the Fedwire field information.
Class Elements
Name
Type
Description
Amount
ParsedFedwireAmount
The ParsedFedwireAmount class contains the input transaction amount information. This element contains the element number. This element contains the field tag. This element contains the field value.
Element Tag Value
Integer String String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 146
CONFIDENTIAL
ParsedFedwireID Class
The ParsedFedwireID class contains the input party ID information.
Class Elements
Name
Type
Description
CountryCode Issuer Number Type
String String String IDType
This element contains the country code. This element contains the issuer of the ID. This element contains the ID number. This element contains the ID type. This element is required.
ParsedFedwireNote Class
The ParsedFedwireNote class contains the input note information.
Class Elements
Name
Type
Description
AdditionalTextSearch
Boolean
True indicates that XG was set to search all fields for one or more of the following data types: BIC (Business Identifier Code) values, country codes, country names, or names. This element contains the remittance note. This element contains the remittance note tag.
Note Tag
String String
ParsedFedwireParty Class
The ParsedFedwireParty class contains the input party information.
Class Elements
Name
Type
Description
AdditionalInfo
List
The ParsedFedwireAdditionalInfo class contains the additional information for the input party. The ParsedFedwireAddress class contains the address information for the input party.
Addresses
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 147
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
EntityType
ResultEntityType
This element contains the entity type. Possible values: • Business • Individual • Text • Unknown • Unstructured
Fields
List
The ParsedFedwireNote class contains the input note information. The ParsedFedwireID class contains the input party ID information. This element contains the Fedwire party name. The ParsedFedwirePhone class contains the phone information for the input party. This element contains the EFT party type for payment transaction records.
IDs
List
Name Phones
String List
Type
ParsedFedwirePhone Class
The ParsedFedwirePhone class contains the phone information for the input party.
Class Elements
Name
Type
Description
Number Type
String PhoneType
This element contains the phone number. This element contains the phone type. Possible values: • Business • Cell • Fax • Home • Work • Unknown • None None is not valid in a request. This element is required.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 148
CONFIDENTIAL
ISO 20022 Parsed Input Classes
Search requests for ISO 20022 records include various input classes. These classes are returned in the list screening results of the Lists interface.
ParsedISO20022 Class
The ParsedISO20022 class contains the ISO 20022 input information. The class contains some SWIFT (Society for Worldwide Interbank Financial Telecommunication) ISO 20022 information that is available only for searches that use the SWIFT EFT input type.
For information about record content and format, see http://www.iso20022.org.
Class Elements
Name
Type
Description
ChequeMaturityDate ChequeNumber ContractIdentification CreationDateTime CurrencyOfTransfer DateOfSignature EndToEndIdentification EquivalentAmount EquivalentAmount Currency ExchangeRate ExchangeRateType FinalCollectionDate FirstCollectionDate InstructedAmount InstructedAmount Currency InstructionIdentification MandateIdentification MessageIdentification Notes
String String String String String String String String String
This element contains the check maturity date. This element contains the check number. This element contains the contract identification. This element contains the creation date and time. This element contains the transfer currency. This element contains the signature date. This element contains the end-to-end identification. This element contains the equivalent amount. This element contains the equivalent amount currency. This element contains the exchange rate. This element contains the exchange rate type. This element contains the final collection date. This element contains the first collection date. This element contains the instructed amount. This element contains the instructed amount currency. This element contains the instruction identification. This element contains the mandate identification. This element contains the message identification. The ParsedISO20022Note class contains the input note information. This element contains the original final collection date. This element contains the original mandate identification.
String String String String String String
String String String List
OriginalFinalCollection Date OriginalMandate Identification
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 149
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
Parties
List
The ParsedISO20022Party class contains the input party information. This element contains the payment information identification. This element contains the payment method. This element contains the pooling adjustment date. This element contains the pre-notification date. This element contains the pre-notification identification. This element contains the requested collection date. This element contains the requested execution date.
PaymentInformation Identification PaymentMethod PoolingAdjustmentDate PreNotificationDate PreNotification Identification RequestedCollectionDate RequestedExecutionDate
String String String String
String String
ParsedISO20022AdditionalInfo Class
The ParsedISO20022AdditionalInfo class contains the additional information for the input party.
Class Elements
Name
Type
Description
CountryOfBirth Info ParsedInfo
String String String
This element contains the country of birth. This element contains additional input information. This element contains additional structured input information. This element contains the province of birth. This element contains the information type.
ProvinceOfBirth Type
String AdditionalInfoType
ParsedISO20022Address Class
The ParsedISO20022Address class contains the address information for the input party.
The following elements are available only for searches that use the SWIFT EFT input type:
• Floor • FloorXPath • PostBox • PostBoxXpath
• Room • RoomXPath • TownLocationName • TownLocationNameXpath
• BuildingName • BuildingNameXpath • DistrictName • DistrictNameXpath
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 150
CONFIDENTIAL
Class Elements
Name
Type
Description
BuildingName BuildingNameXpath BuildingNumber City Country Department DistrictName DistrictNameXpath Floor FloorXPath Lines PostalCode PostBox PostBoxXpath
String String String String String String String String String String List
This element contains the building name. This element contains the building name XPath value. This element contains the building number. This element contains the city. This element contains the country. This element contains the department. This element contains the district name. This element contains the district name XPath value. This element contains the floor number. This element contains the floor number XPath value. This element contains the address lines. This element contains the postal code. This element contains the post office box number. This element contains the post office box number XPath value. This element contains the room number. This element contains the room number XPath value. This element contains the state or the province. This element contains the street name. This element contains the sub-department. This element contains the town or location name. This element contains the town or location name XPath value. This element contains the address type. Possible values: • None • Current • Mailing • Previous • Unknown None is not valid in a request. This element is required.
Room RoomXPath StateProvince StreetName SubDepartment TownLocationName TownLocationName Xpath Type
String String String String String String String
AddressType
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 151
CONFIDENTIAL
ParsedISO20022Field Class
The ParsedISO20022Field class contains the ISO 20022 field information.
Class Elements
Name
Type
Description
CurrencyCode
Boolean
This element contains the currency code. This element is required.
Value XPath
String String
This element contains the field value. This element contains the XPath value.
ParsedISO20022ID Class
The ParsedISO20022ID class contains the ID information for the input party.
Class Elements
Name
Type
Description
Issuer Label Number Type
String String String IDType
This element contains the issuer of the ID. This element contains the ID label. This element contains the ID number. This element contains the ID type.
ParsedISO20022Note Class
The ParsedISO20022Note class contains the input note information.
Class Elements
Name
Type
Description
AdditionalTextSearch
Boolean
True indicates that XG was set to search all fields for one or more of the following data types: BIC values, country codes, country names, or names. This element contains the note text. This element contains the note tag.
Note Tag
String String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 152
CONFIDENTIAL
ParsedISO20022Party Class
The ParsedISO20022Party class contains the input party information.
Class Elements
Name
Type
Description
AdditionalInfo
List
The ParsedISO20022AdditionalInfo class contains the additional information for the input party. The ParsedISO20022Address class contains the address information for the input party. This element contains the entity type. Possible values: • Business • Individual • Text • Unknown • Unstructured
Addresses
EntityType
IDs
List
The ParsedISO20022ID class contains the ID information for the input party. This element contains the party name. The ParsedISO20022Note class contains the input note information. The ParsedISO20022Phone class contains phone information for the input party. This element contains the EFT party type.
Name Notes
String List
Phones
List
Type
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 153
CONFIDENTIAL
ParsedISO20022Phone Class
The ParsedISO20022Phone class contains phone information for the input party.
Class Elements
Name
Type
Description
Number Type
String PhoneType
This element contains the phone number. This element contains the phone type. Possible values: • Business • Cell • Fax • Home • Work • Unknown • None None is not valid in a request. This element is required.
SWIFT Parsed Input Classes
Search requests for SWIFT records include various input classes. These classes are returned in the list screening results of the Lists interface.
ParsedSWIFT Class
The ParsedSWIFT class contains the SWIFT input information. For information on record content and format, see http://www.swift.com.
SWIFT formats that were supported prior to the XG web services 4.4.5 release return input values in both the Fields array and fields such as Amount. SWIFT formats that were released after the XG web services 4.4.5 release return input values in only the Fields array.
Class Elements
Name
Type
Description
AdditionalAmount
ParsedSWIFTAmount
The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the advice type A field.
AdjustmentAmount
ParsedSWIFTAmount
AdviceTypeA
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 154
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
AdviceTypeB AllocationIndicator Amount
String String ParsedSWIFTAmount
This element contains the advice type B field. This element contains the allocation indicator. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the applicable rules. This element contains the available by field. The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the bank operation code. This element contains the block trade indicator. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTChequeDetails class contains input check details. This element contains the check number. This element contains the claiming bank reference. This element contains the cleared product ID. This element contains the clearing threshold indicator.
AmountBought
ParsedSWIFTAmount
AmountOfCharges
ParsedSWIFTAmount
AmountOutstanding
ParsedSWIFTAmount
AmountSold
ParsedSWIFTAmount
AmountToBeSettled
ParsedSWIFTAmount
ApplicableRules AvailableBy BalanceAmount
String String ParsedSWIFTAmount
BankOperationCode BlockTradeIndicator BookBalance
String String ParsedSWIFTAmount
BrokersCommission
ParsedSWIFTAmount
ChequeDetails
List
ChequeNumber ClaimingBanksReference ClearedProductID ClearingThreshold Indicator ClosingAvailableBalance
ParsedSWIFTAmount
The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the code common reference. This element contains the collateralisation indicator. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTCommodityContractInfo class contains the input commodity contract information. This element contains the common reference. This element contains the confirmation instructions.
ClosingBalance
ParsedSWIFTAmount
CodeCommonReference CollateralisationIndicator CommodityAmount
String String ParsedSWIFTAmount
CommodityContracts
List
CommonReference ConfirmationInstructions
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 155
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
ConsiderationPaid
ParsedSWIFTAmount
The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the contract number party A field. This element contains the counter-party's reference. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTCurrencySequence class contains the input currency sequence information. This element contains the customer-specified reference. This element contains the date field. This element contains the date the contract was agreed or amended. This element contains the date destroyed or cancelled. This element contains the date the message was acknowledged. This element contains the date of advice. This element contains the date of amendment. This element contains the date of cash letter. This element contains the date of collection order. This element contains the expiration date. This element contains the issue date. This element contains the date of the original authorization. This element contains the date of the reduction or release. This element contains the preparation date. This element contains the date/time indication. This element contains the day count. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the details of the charges. This element contains the details of the charges. This element contains the direct debit reference.
ConsiderationReceived
ParsedSWIFTAmount
ContractNumPartyA
String
CounterpartysReference CreditFloorLimitIndicator
String ParsedSWIFTAmount
CurrencySequences
List
CustomerSpecified Reference Date DateContractAgreed Amended DateDestroyedCancelled
String String
String
DateMessage Acknowledged DateOfAdvice DateOfAmendment DateOfCashLetter DateOfCollectionOrder DateOfExpiry DateOfIssue DateOfOriginal Authorization DateOfReductionOr Release DatePrepared DateTimeIndication DayCountFraction DebitAndCreditFloorLimit Indicator DebitFloorLimitIndicator
String
String String String String String String String
String
String String String ParsedSWIFTAmount
ParsedSWIFTAmount
DecreaseAmount
ParsedSWIFTAmount
DetailsOfCharges DetailsOfCharges2 DirectDebitReference
String String String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 156
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
DocumentaryCredit Number DrawingID EarliestExerciseDate EffectiveDateOfNewRate
String
This element contains the documentary credit number. This element contains the drawing ID. This element contains the earliest exercise date. This element contains the effective date of the new rate. This element contains the exchange rate. This element contains the exchange rate. This element contains the execution timestamp. The ParsedSWIFTDrawingInfo class contains the input drawing information. This element contains the expiry details. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTField class contains the SWIFT field information. This element contains the file reference. The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the final settlement date. This element contains the form of documentary credit. The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the message function. This element contains the further identification field. This element contains the FX deal reference. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTDrawingInfo class contains the input drawing information. This element contains the interest due date. This element contains the interest rate. This element contains the issuing banks reference.
String String String
ExchangeRate ExchangeRate2 ExecutionTimestamp ExistingDrawings
String String String List
ExpiryDetails FacilityAmount
Fields
List
FileReference FinalClosingBalance
String ParsedSWIFTAmount
FinalSettlementDate FormOfDocumentary Credit ForwardAvailable Balances FunctionOfMessage FurtherIdentification FXDealReference GrossInterestAmount
String String
List
IncreaseAmount
ParsedSWIFTAmount
InstructedAmount
ParsedSWIFTAmount
InterbankSettledAmount
ParsedSWIFTAmount
InterestAmount
ParsedSWIFTAmount
InterestCalcs
List
InterestDueDate InterestRate IssuingBanksReference
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 157
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
LastDayOfFirstInterest Period LastDayOfNextInterest Period LatestDateOfShipment Linkages
String
This element contains the last day of the first interest period. This element contains the last day of the next interest period. This element contains the latest date of shipment. The ParsedSWIFTLinkage class contains the input linkage information. This element contains the mandate reference. This element contains the maturity date. This element contains the maximum credit amount. This element contains the message index and total. This element contains the requested message. This element contains the message type. The ParsedSWIFT4XXData class contains the SWIFT MT 400 series input information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the new expiration date. The ParsedSWIFTDrawingInfo class contains the input drawing information. This element contains the new interest rates. This element contains the next interest due date. This element contains the non-standard flag. The ParsedSWIFTNote class contains the input note information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the number of settlements. This element contains the number of days. This element contains the number of repetitions. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the original message date.
String
String List
MandateReference MaturityDate MaximumCreditAmount MessageIndexAndTotal MessageRequested MessageType MT4XXData
NetAmount
NetInterestAmount
ParsedSWIFTAmount
NewAmount
ParsedSWIFTAmount
NewDateOfExpiry NewDrawings
String List
NewInterestRates NextInterestDueDate NonStandardFlag Notes
NumberAndSumOfCredit Entries NumberAndSumOfDebit Entries NumberOfSettlements NumDays NumRepetitions OpeningBalance
ParsedSWIFTAmount
ParsedSWIFTAmount
String String String ParsedSWIFTAmount
OriginalAmount
ParsedSWIFTAmount
OriginalFacilityAmount
ParsedSWIFTAmount
OriginalMessageDate
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 158
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
OriginalMessageNumber OriginalMessageType OriginalOrderedAmount
String String ParsedSWIFTAmount
This element contains the original message number. This element contains the original message type. The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the original value date. This element contains the partial shipments field. The ParsedSWIFTParty class contains the input party information. This element contains the party-as-role field. This element contains the payment method indicator.
OriginalValueDate PartialShipments Parties
String String List
PartyAsRole PaymentMethod Indicator Payments
String String
List
The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the percentage credit amount tolerance. This element contains the notice period. This element contains the place of expiration. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the presenting bank's reference. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the principal's reference. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTPurchaseAgreementDetails class contains the input purchase agreement details.
PercentageCreditAmount Tolerance PeriodOfNotice PlaceOfExpiry PremiumPayment
String String ParsedSWIFTAmount
PremiumPrice
ParsedSWIFTAmount
PresentingBanks Reference PricePerUnit
String
ParsedSWIFTAmount
PrincipalAmount
ParsedSWIFTAmount
PrincipalAmountToBe Settled PrincipalsReference ProceedsRemitted
ParsedSWIFTAmount
String ParsedSWIFTAmount
PurchaseAgreement Details
List
Quantity
The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the receiver's reference.
QuantityBought
ParsedSWIFTAmount
QuantitySold
ParsedSWIFTAmount
ReceiversCharges
ParsedSWIFTAmount
ReceiversReference
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 159
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
ReferenceToPreAdvice
String
This element contains the reference to pre-advice field. This element contains the registration reference. This element contains the registration reference. This element contains the reimbursing bank's charges.
RegistrationReference RegistrationReference2 ReimbursingBanks Charges ReimbursingBanks Reference RelatedMessage Reference RelatedReference RelatedSequence Reference ReportingParties
String String String
String
This element contains the reimbursing bank's reference. This element contains the related message reference.
String
String String
This element contains the related reference. This element contains the related sequence reference.
List
The ParsedSWIFTReportingPartyInfo class contains the input reporting party information. This element contains the requested execution date. This element contains the scope of operation. The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the selling agent's number of PAs. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the sender's reference. This element contains the sequence of total. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTSettlementDetails class contains the input settlement details. This element contains the settlement number's page number. This element contains the settlement type. This element contains the specified reference. This element contains the split settlement indicator. This element contains the standing settlement instructions recipient indicator. This element contains the standing settlement instructions update type.
RequestExecutionDate ScopeOfOperation SellingAgentAmount
SellingAgentsNumberOf PAs SendersCharges
String
List
SendersChargesA
SendersChargesB
ParsedSWIFTAmount
SendersReference SequenceOfTotal SettlementAmount
String String ParsedSWIFTAmount
SettlementDetails
List
SettlementNumberPage Number SettlementType SpecifiedReference SplitSettlementIndicator SSIRecipientIndicator
String String String String
SSIUpdateType
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 160
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
StandingSettlement Instructions
List
The ParsedSWIFTStandingSettlementInstruction class contains the input standing settlement instructions.
StatementDate StatementLines StatementNumber SequenceNumber StrikePrice
This element contains the statement date. This element contains the statement lines. This element contains the statement number sequence number. The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the sub-message type. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the tax rate. This element contains the time indications. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTAmount class contains the input transaction amount information. This element contains the trade date. This element contains the transaction reference. This element contains the transaction reference 2. This element contains the transaction type code. This element contains the transaction type code 2. This element contains the transferring bank's reference. This element contains the trans-shipment field. This element contains the type, the date, and the version of agreement.
ParsedSWIFTAmount
SubMessageType SumOfAmounts
String ParsedSWIFTAmount
SumOfInterestCharges
ParsedSWIFTAmount
SumOfIssuersFICharges
ParsedSWIFTAmount
SumOfReceiversCharges
ParsedSWIFTAmount
SumOfSendersCharges
ParsedSWIFTAmount
TaxAmount
ParsedSWIFTAmount
TaxRate TimeIndications TotalAmount
String String ParsedSWIFTAmount
TotalAmountClaimed
ParsedSWIFTAmount
TotalAmountTransferred
ParsedSWIFTAmount
TotalChequeAmount
ParsedSWIFTAmount
TotalPrincipalAmount
ParsedSWIFTAmount
TradeDate TransactionReference TransactionReference2 TransactionTypeCode TransactionTypeCode2 TransferringBanks Reference Transshipment TypeDateVersionOf Agreement
String String String String String String
String String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 161
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
TypeOfEvent TypeOfOperation UnderlyingProductID ValueDate YearOfDefinitions
String String String String String
This element contains the type of event. This element contains the type of operation. This element contains the underlying product ID. This element contains the value date. This element contains the year of definitions.
ParsedSWIFTAdditionalInfo Class
The ParsedSWIFTAdditionalInfo class contains the additional information for the input party.
Class Elements
Name
Type
Description
Country Info ParsedInfo
String String String
This element contains the country. This element contains the additional information. This element contains the structured additional information. This element contains the additional information type.
Type
AdditionalInfoType
ParsedSWIFTAddress Class
The ParsedSWIFTAddress class contains the address information for the input party.
Class Elements
Name
Type
Description
AddressLine1 AddressLine2 AddressLine3 AddressLine4 City
String String String String String
This element contains the line 1 of the address. This element contains the line 2 of the address. This element contains the line 3 of the address. This element contains the line 4 of the address. This element contains the city.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 162
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
Country Type
String AddressType
This element contains the country. This element contains the address type. Possible values: • None • Current • Mailing • Previous • Unknown None is not valid in a request. This element is required.
ParsedSWIFTAmount Class
The ParsedSWIFTAmount class contains the input transaction amount information.
Class Elements
Name
Type
Description
AdditionalInformation Amount Code CurrencyCode Date DebitCreditMark MaturityPeriodType Number NumberOfDaysOrMonths Type Type2 Units
String String String String String String String String String String String String
This element contains additional input information. This element contains the transaction amount. This element contains the transaction code. This element contains the currency code. This element contains the transaction date. This element contains the debit or the credit mark. This element contains the maturity period type. This element contains the transaction number. This element contains the number of days or months. This element contains the transaction type. This element contains the transaction type. This element contains the units.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 163
CONFIDENTIAL
ParsedSWIFTField Class
The ParsedSWIFTField class contains the SWIFT field information.
Class Elements
Name
Type
Description
Amount
ParsedSWIFTAmount
The ParsedSWIFTAmount class contains the input transaction amount information. The ParsedSWIFTOriginalMessage class contains the input original message details. This element contains the qualifier. This element contains the sequence. This element contains the sub-sequence. This element contains the tag value. This element contains the value field.
OriginalMessage
ParsedSWIFTOriginal Message String String String String String
Qualifier Sequence SubSequence Tag Value
ParsedSWIFTID Class
The ParsedSWIFTID class contains the ID information for the input party.
Class Elements
Name
Type
Description
CountryCode Issuer Number Tag Type
String String String String IDType
This element contains the ID country code. This element contains the issuer of the ID. This element contains the ID number. This element contains the ID tag. This element contains the ID type. This element is required.
ParsedSWIFTNote Class
The ParsedSWIFTNote class contains the input note information.
Class Elements
Name
Type
Description
AdditionalTextSearch
Boolean
True indicates that XG was set to search all fields for one or more of the following data types: BIC values, country codes, country names, or names. This element contains the note text. This element contains the note tag.
Note Tag
String String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 164
CONFIDENTIAL
ParsedSWIFTOriginalMessage Class
The ParsedSWIFTOriginalMessage class contains the input original message details.
Class Elements
Name
Type
Description
Date MessageType SessionNumberAndISN
String String String
This element contains the date. This element contains the message type. This element contains the session number and the ISN (input sequence number).
ParsedSWIFTParty Class
The ParsedSWIFTParty class contains the input party information.
Class Elements
Name
Type
Description
AdditionalInfo
List
The ParsedSWIFTAdditionalInfo class contains the additional information for the input party. The ParsedSWIFTAddress class contains the address information for the input party. The ParsedSWIFTID class contains the ID information for the input party. This element contains the party name. This element contains the party tag. This element contains the EFT party type for payment transaction records.
Addresses
IDs
Name Tag Type
String String String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 165
CONFIDENTIAL
EFT Party Types
Payment transaction data can include EFT party types.
The following EFT party types are available:
• AccountCredited • AccountDebited • AccountIdentification • AccountServicingFI • AccountWithInstitution • AdviseThroughFI • Applicant • ApplicantFI • ApplicationHeaderBlockParty • AvailableWithFI • BasicHeaderBlockParty • Beneficiary • BeneficiaryFI • BeneficiaryOfCommodity • Borrower • Broker • CalculationAgent • CentralCounterpartyClearingHouse • ChangedApplicant • ChargesAccount • ChargesAccountAgent • ChequeDeliverTo • ChequeFrom • ClearingBroker • ClearingExceptionParty • Contact • CorrespondentFI • Counterparty • CountryofDomicile • CountryOfIncomeSource • CountryOfNonDomicile • CreditMandateSigner • Creditor
• CreditorAccount • CreditorAgent • CreditorAgentAccount • CreditorsFI • DealingBranchPartyA • DealingBranchPartyB • DebitInstitution • Debtor • DebtorAccount • DebtorAgent • DebtorAgentAccount • DebtorsFI • DelivererOfCommodity • DeliveryAgent • DepositoryofCSD • DocumentIssuer • Drawee • DrawerFI • EnquiredParty • ExecutingBroker • ExecutionVenue • ExercisingParty • ForwardingAgent • Fund • FundManager • FundOrBeneficiaryCustomer • FundOrInstructingParty • FXCounterparty • HaircutSource • InformationAgent • InitiatingInstitution • InitiatingParty • InstructingFI
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 166
CONFIDENTIAL
• PayingAgent • PhysicalSecuritiesAgent • Pledgee • PrimaryDocumentIssuer • Principal • Receiver • ReceiverOfCommodity • ReceiversCorrespondent • ReceivingAgent • ReceivingFI • Registrar • ReimbursingFI • RelatedParty • Remittance • RemittingAgent • ReportingParty • RequestedConfirmation • ResellingAgent • SafekeepingAccount • SecondaryDocumentIssuer • SellingAgent • SenderOfCashLetter • SendersCorrespondent • SendingFI • SolicitationAgent • SSIRecipient • SubmittingParty • SubPayingAgent • ThirdReimbursementFI • TradeParty • TransferAgent • UltimateCreditor • UltimateDebtor
• InstructingParty • IntermediaryAgent • IntermediaryAgentAccount • IntermediaryFI • Investor • Invoicee • Invoicer • Issuer • IssuerAgent • IssuingFI • LoanDepositCounterparty • MarketClaimCounterpart • MessageOriginator • NegotiatingFI • None • NonExercisingParty • Offeror • OrderingCustomer • OrderingFI • OriginalCreditMandateSigner • OriginalCreditorAgent • OriginalCreditorAgentAccount • OriginalDebtor • OriginalDebtorAccount • OriginalDebtorAgent • OriginalDebtorAgentAccount • OriginalReceivingFI • OriginationFI • Originator • PartyA • PartyB • PartyBClient • Payee • Payer
The following EFT party types are available only for the SWIFT 2021 standard or later:
• AdvisingBank (SWIFT 2021) • AvailableWith (SWIFT 2021)
• BlockchainAccount (SWIFT 2022) • DeliveryToCollectionBy (SWIFT 2021)
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 167
CONFIDENTIAL
• ObligorInstructingParty (SWIFT 2021)
The following EFT party types are available only for the SWIFT ISO 20022 standard:
• Agent • Creator • Garnishee • GarnishmentAdministrator • InstructedAgent • InstructedReimbursementAgent • InstructedReimbursementAgentAccount • InstructingAgent • InstructingReimbursementAgent
• InstructingReimbursementAgentAccount • PrepaidAccount • PreviousInstructingAgent • PreviousInstructingAgentAccount • ProprietaryAgent • RelatedAccount • SettlementAccount • ThirdReimbursementAgent • ThirdReimbursementAgentAccount
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 168
CONFIDENTIAL
Chapter 8
Enti t y I n formatio n
The REST API for LexisNexis® Bridger Insight® XG (XG) includes entity information in the request and in the response.
Input Entity Classes
With the Search method in the Lists interface, the input entity classes can be provided in the request or in the response.
Date Class
The Date class contains date information.
When possible, you should use the parsed elements instead of the Unparsed element for optimal results.
Class Elements
Name
Type
Description
Day
Integer
This element contains the day value in a structured date. This element contains the month value in a structured date. This element contains the unstructured date value. If your client instance is configured to use the ISO (International Organization for Standardization) date format in web services, then input dates are required to be in a YYYY-MM-DD format. If your client instance is configured to use U.S. or U.K. formats in web services, then no format requirements exist for input dates.
Month
Integer
Unparsed
String
Year
Integer
This element contains the year value in a structured date.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 169
CONFIDENTIAL
InputAccount Class
The InputAccount class contains the account information that helps identify the input entity.
An account number can be provided in the InputID class. The following account information can also be provided in the InputID class: account type, member ID, and provider ID. If this information is provided in both classes, then only the data in the InputAccount class is added to the record.
Class Elements
Name
Type
Description
Amount Date GroupID OtherData
String String String String
This element contains the amount. This element contains the date. This element contains the group ID. This element contains other information about the account. This element contains the member ID. This element contains the provider ID. This element contains the type of account.
MemberID ProviderID Type
String String String
InputAdditionalInfo Class
The InputAdditionalInfo class contains the additional information that helps identify the input entity.
Class Elements
Name
Type
Description
Date Label Type
Date String AdditionalInfoType
The Date class contains date information. This element contains a user-defined label. This element contains the additional information type. This element is required.
Value
String
This element contains the user-defined input value.
InputAddress Class
The InputAddress class contains the input address information.
Class Elements
Name
Type
Description
BuildingName BuildingOrStreetNumber
String String
This element contains the building name. This element contains the building number or the street number.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 170
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
City Country County District FloorNumber FullAddress
String String String String String String
This element contains the city or the town. This element contains the country. This element contains the county. This element contains the district. This element contains the floor number. This element contains the full address. XG ignores information that is provided in this element if enough information is provided in the structured address elements.
HouseNumber IntlStreetType PostalCode StateProvinceDistrict
String String String String
This element contains the house number. This element contains the international street type. This element contains the postal code or the area. This element contains the state, the province, or the district. This element contains the line 1 of the address. This element may contain unstructured address information.
Street1
String
Street2
String
This element contains the line 2 of the address. This element may contain unstructured address information.
StreetName StreetPostDirection
String String
This element contains the street name. This element contains the street direction after the street name. For example, this element would contain W if the address is 123 Main St W.
StreetPreDirection
String
This element contains the street direction before the street name. For example, this element would contain N if the address is 123 N Main St.
StreetSuffixOrType
String
This element contains the street type. For example: Avenue, Drive, Street, Boulevard.
Suburb Type
String AddressType
This element contains the suburb. This element contains the address type. Possible values: • None • Current • Mailing • Previous • Unknown None is not valid in a request. This element is required.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 171
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
UnitDesignation
String
This element contains the unit designation. Examples of unit designation include: unit, suite, apartment, or flat number.
UnitNumber
String
This element contains the unit number.
InputID Class
The InputID class contains the input ID information. The input ID may be included in either an InputEntity element search, an InputText element search, or an InputBasicID element search.
The following account information can also be provided in the InputAccount class: account type, member ID, and provider ID. If this information is provided in both classes, then only the data in the InputAccount class is added to the record.
Class Elements
Name
Type
Description
AccountType CityOfIssue
String String
This element contains the account type. This element contains the city where the ID was issued. This element contains the country where the person was born. This element contains the county where the ID was issued. This element contains the date the ID expires. The Date class contains date information.
CountryOfBirth
String
CountyOfIssue
String
DateExpires
Date
DateIssued
Date
This element contains the date that the ID was issued. The Date class contains date information.
DistrictOfIssue
String
This element contains the district where the ID was issued. This element contains the driver license version number. This element contains the family name of the person at birth. This element contains the family name of the person at the time of citizenship. This element contains the state or the country that issued the ID. This element contains a user-defined ID label. You can view this label in the XG application only if the ID Type equals Other.
DriverLicenceVersion Number FamilyNameAtBirth
String
String
FamilyNameAtCitizenship
String
Issuer
String
Label
String
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 172
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
MachineReadableLine1
String
This element contains a machine-readable line typically used for passports or visas. This element contains a machine-readable line typically used for passports or visas. This element contains the ID number. This element contains the place where the person was born. This element contains the province where the ID was issued. This element contains the state where the person was born. This element contains the ID type. This element is required.
MachineReadableLine2
String
Number PlaceOfBirth
String String
ProvinceOfIssue
String
StateOfBirth
String
Type
IDType
InputName Class
The InputName class contains the input name information. This class is required for Search requests that use the InputEntity element to search structured information.
For individual entities, the First element and the Last element are required or the Full element is required. For business entities or unknown entities, the Full element is required.
Records that contain the Full element can only be searched against screening lists.
All records within a request must contain the same elements.
Class Elements
Name
Type
Description
First
String
This element contains the first name. You use this element only for individual entities.
Full Generation
String String
This element contains the full name. This element contains the generation. Examples of generation information include Junior or III. You use this element only for individual entities.
Last
String
This element contains the last name. You use this element only for individual entities.
MaidenName
String
This element contains the maiden name. You use this element only for individual entities.
Middle
String
This element contains the middle name. You use this element only for individual entities.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 173
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
SecondSurname
String
This element contains the second surname. You use this element only for individual entities.
Title
String
This element contains the title. You use this element only for individual entities.
InputPhone Class
The InputPhone class contains the input phone number information.
Class Elements
Name
Type
Description
Number Type
String PhoneType
This element contains the phone number. This element contains the phone type. Possible values: • Business • Cell • Fax • Home • Work • Unknown • None None is not valid in a request. This element is required.
Entity Record Classes
With the Search method in the Lists interface, the entity record classes can be returned in the list screening results.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 174
CONFIDENTIAL
EntityAdditionalInfo Class
The EntityAdditionalInfo class contains the additional information that helps identify the list entity.
Class Elements
Name
Type
Description
Comments
String
This element contains additional user-defined comments. This element contains a system-generated number that identifies the entry in the record. This element contains the additional information type. This element is required.
ID
Long
Type
AdditionalInfoType
Value
String
This element contains the additional information.
EntityAddress Class
The EntityAddress class contains the address information.
Class Elements
Name
Type
Description
City Comments
String String
This element contains the city. This element contains any additional comments. For example, this element may include a date for when the address was current.
Country ID
String Long
This element contains the country. This element contains a system-generated number that identifies the entry in the record. This element contains the postal code. This element contains the state, the province, or the district. This element contains the line 1 of the address. This element contains the line 2 of the address. This element contains the address type. Possible values: • None • Current • Mailing • Previous • Unknown None is not valid in a request. This element is required.
PostalCode StateProvinceDistrict
String String
Street1 Street2 Type
String String AddressType
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 175
CONFIDENTIAL
EntityAKA Class
The EntityAKA class contains the alternative name information.
Class Elements
Name
Type
Description
Category
AKACategoryType
This element contains the AKA (also known as) category type. This type indicates the level that the alternative name is associated with the entity. Possible values: • None • Strong • Weak
Comments
String
This element contains additional AKA information. For example, this element may include the DOB (date of birth) information or the POB (place of birth) information for the AKA entity. This element contains a system-generated number that identifies the entry in the record. The EntityName class contains the name information. This element contains the alternative name type. Possible values: • None • Acronym • AKA (also known as) • CallSign • CCC (Chinese commercial code) • DBA (doing business as) • FKA (formerly known as) • Nickname • NKA (now known as)
ID
Long
Name Type
EntityName AKAType
EntityID Class
The EntityID class contains the entity ID information.
Class Elements
Name
Type
Description
Comments
String
This element contains user-defined comments about the ID. The Date class contains date information. The Date class contains date information.
DateExpires DateIssued
Date Date
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 176
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
Issuer
String
This element contains the state or the country that issued the ID. This element contains a system-generated number that identifies the entry in the record. This element contains the ID label. This element contains the ID number. This element contains the ID type. This element is required.
ID
Long
Label Number Type
String String IDType
EntityName Class
The EntityName class contains the name information.
Class Elements
Name
Type
Description
First Full Generation
String String String
This element contains the first name. This element contains the full name. This element contains the generation. Examples of generation information include Junior or III.
Last Middle Title
String String String
This element contains the last name. This element contains the middle name. This element contains the title.
EntityPhone Class
The EntityPhone class contains the phone number information.
Class Elements
Name
Type
Description
Comments
String
This element contains any additional comments about the phone information. This element contains a system-generated number that identifies the entry in the record.
ID
Long
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 177
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
Number Type
String PhoneType
This element contains the phone number. This element contains the phone type. Possible values: • Business • Cell • Fax • Home • Work • Unknown • None None is not valid in a request. This element is required.
Entity Criteria Classes
The entity criteria classes can be provided in the result queries that are performed in the Results interface.
EntityCriteriaAdditionalInfo Class
The EntityCriteriaAdditionalInfo class contains the additional information that the record must meet to be returned.
If only one of the Value1 or Value2 elements is provided, then the record information must meet that value. For example, you set the Type to Citizenship and provide United States in the Value1 element. Only records that contain a Citizenship of United States are returned.
If both elements are provided, then the record information must meet a value within the provided range. For example, you set the Type to DOB and provide 01/01/1955 in the Value1 element and 01/01/1965 for the Value2 element. Only records that contain a DOB within the range of 01/01/1955-01/01/1965 are returned.
Class Elements
Name
Type
Description
Type
AdditionalInfoType
This element contains the additional information type. This element is required.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 178
CONFIDENTIAL
Class Elements (Continued)
Name
Type
Description
Value1
String
This element contains additional information that is contained in the record, or the start of the range that includes the additional information. This element contains additional information that is contained in the record, or the end of the range that includes the additional information.
Value2
String
EntityCriteriaAddress Class
The EntityCriteriaAddress class contains the address information and the phone information that the record must meet to be returned.
Class Elements
Name
Type
Description
BuildingName City Country District FloorNumber Phone PostalCode StateProvinceDistrict
String String String String String Long String String
This element contains the building name. This element contains the city. This element contains the country. This element contains the district. This element contains the floor number. This element contains the phone number. This element contains the postal code. This element contains the state, the province, or the district. This element contains the line 1 of the address. This element contains the line 2 of the address. This element contains the suburb.
Street1 Street2 Suburb
String String String
EntityCriteriaID Class
The EntityCriteriaID class contains the ID information that the record must meet to be returned.
Class Elements
Name
Type
Description
Label Number Type
String String IDType
This element contains the ID label. This element contains the ID number. This element contains the ID type. This element is required.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 179
CONFIDENTIAL
Possible Type Values
A number of classes contain additional information or IDs for entities in the Lists interface. These classes include a Type property that indicates the kind of information the class provides.
Possible Additional Information Types
Entity information can include various additional information types.
The following additional information type values are available:
• Incident • IPAddress • MothersName • Nationality • Occupation • Other • PlaceOfBirth • Position
• Race • VesselCallSign • VesselFlag • VesselGRT • VesselOwner • VesselTonnage • VesselType • Weight
• None (not valid in a request) • Citizenship • Complexion • DistinguishingMarks • DOB • EyeColor • HairColor • Height
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 180
CONFIDENTIAL
Possible ID Types
Entity information can include various ID types.
The following ID type values are available:
• ABARouting (American Bankers Association
• LexID • MedicareID • MedicareReference • Member • Military • MMSI (maritime mobile service identity) • MSB (money services business ID) • National • NIT (número de identificación tributaria) • None (not valid in a request or in a custom screening list for an entity unique ID) • OFAC (Office of Foreign Assets Control ID) • Other • Passport • ProprietaryUID • ProviderID • RTACardNumber • SEC • SocialServicesNumber • SSN (Social Security number) • SwiftBEI (Society for Worldwide Interbank Financial Telecommunication business entity identifier)
routing number)
• Account • AircraftConstructionNumber • AircraftManufacturerSerialNumber • AlienRegistration • BankIdentifierCode • BankPartyID • BusinessRegistrationNumber • Cedula • ChipsUID (Clearing House Interbank Payments
System universal identifier)
• CRD (Central Registration Depository ID) • CustomerNumber • DriversLicense • DUNS (data universal numbering system) • EFTCode (electronic funds transfer code) • EIN (employer identification number) • EuropeanHealthInsuranceCard • ExpeditedEntryCard • FishingNumber • GIIN (global intermediary identification
number)
• GLN (global location number) • IBAN (international bank account number) • IBEI (international business entity identifier) • IMO (International Maritime Organization ID) • ISIN (international securities identification
• SwiftBIC (Society for Worldwide Interbank Financial Telecommunication business identifier code)
• TaxID • UnitedNations • VISA • Voter
number) • LegalEntity
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 181
CONFIDENTIAL
Chapter 9
Error s
The REST API for LexisNexis® Bridger Insight® XG (XG) can return errors that were generated by the system or method or errors that were generated by the search.
Error Class
The Error class returns REST API errors that were generated by the system or the method.
Class Elements
Name
Type
Description
Message
String
This element contains the error message.
ResultError Class
The ResultError class returns any errors that were generated during a search.
Class Elements
Name
Type
Description
Code
Unsigned Integer
This element contains the error code. Not all errors contain an error code.
Message
String
This element contains the error message.
BIS298-EN_US — 28 December 2023
REST API for XG 5 Web Services Page 182