Introduction
Welcome
Welcome to the WorldWatch Plus®
API suite! You can use our APIs to access all WorldWatch Plus products and services.
We can provide results in either XML or JSON. Examples are shown in the dark area to the right, and you can switch the data types of the examples with the tabs in the top right.
WorldWatch Plus® Solutions
A solution for acquiring customers via mobile devices without the frustration (and abandonment) often caused while entering identity information on a smartphone. As consumers increasingly rely on their devices, WorldWatch Plus® KYC Screening makes the account opening process easier.
| Identity Screening |
|---|
|
| ID Document Validation |
|---|
|
Execute your compliance screening quickly and in a single step with the highly configurable PEP, sanctions, and adverse media search tools in WorldWatch Plus® Risk Screening. Integrated to the KYC process or any other workflow, screen the validated entity against the industry's most comprehensive menu of curated sanctions, PEP, and watch lists, or against adverse media for reputational risk.
| Sanctions and Watch Lists |
|---|
|
| PEP Profiles |
|---|
|
| Adverse Media |
|---|
|
WorldWatch Plus® Platforms
Test Environment/Sandbox
WorldWatch Plus® has a Test Environment (Sandbox) for developers to perform their coding against the WorldWatch Plus Web Services. Initial testing in this environment allows you to develop a fully functional integration with the safety net of test data and the knowledge that your code has been tested before generating live chargeable transactions.
Production Environments
WorldWatch Plus® has multiple Production environments available depending on your intended use. The same searchable data sources (products) are available in all production environments. Client transactional data is maintained only in the specific environment being accessed. Client accounts must be established and credentials assigned for each environment before they are accessible via API.
- Due Diligence (DD) – for most clients
- Credit Reporting Agencies (CRA) – for background screening companies
- European Union (EU) – for clients operating within the EU who wish to limit personal data processing to the territory of the Union
Data Security and Assurance
WorldWatch Plus places security of customer data as our top priority and we are committed to ensuring the safety of our customer’s data from unauthorized use, access, disclosure, theft, manipulation, reproduction or possible security breach. We implement commercially accepted technologies and apply appropriate methods of security to ensure that the integrity and privacy of our customer’s data is protected. Information Security efforts are led by our Chief Technology Officer who is also responsible for the management of the program. This program includes policies and procedures around Information Security Standards, Compliance, and Assurance.
WorldWatch Plus maintains data centers in both the U.S. and in the E.U. to support E.U. Privacy Directives. WorldWatch Plus production servers are located in facilities with access restricted by biometric authentication and 24x7x365 surveillance. Production environments are configured to provide redundancy to prevent a single point of failure. Databases are located on a separate, private sub network, which is not connected to the Internet, with addresses that are not Internet routable. Databases transfer all transactional data real time using replication to ensure a secondary server is always up to date and available for failover. Dedicated firewalls allow only data requests which originate from set private IP addresses.
Any connection to the web applications or through the interfaces requires 256-bit TLS (Transport Layer Security) encryption. As an additional layer of security, any sensitive data is encrypted while at rest in the database using strong AES encryption techniques. Data is also secured to prevent one customer from accessing another customer’s data during each request to the database.
KYC Screening
Overview
WorldWatch Plus® APIs were designed to simplify the functionality and workflow associated with identity verification and risk screening of subjects (clients/applicants) in support of the KYC Onboarding process. These APIs have evolved to support a variety of client workflows and data requirements. Clients are offered many customization and configuration options either via account setup or available APIs.
- WorldWatch Plus® APIs are called via a simple RESTful HTTP methods using JSON or XML over HTTPS.
- All API requests will contain the necessary account credentials along with the associated XML or JSON payload. Account credentials will by assigned by WorldWatch Plus and will be unique to each WorldWatch Plus® platform/environment.
- WorldWatch Plus® fully supports the UTF-8 standard and API Methods can accept any non-Latin character sets.
- Error Status response codes are provided for each API Method.
KYC Screening Products
| Identity Verification (US and Canada) |
|---|
| WorldWatch Plus® Identity Verification uses a multi-layered process to access thousands of data sources containing billions of public records to instantly validate an identity while also providing predictive, intelligent information around that identity. This enables you to make quicker and smarter decisions on what to do next: approve, deny, or escalate. This identity proofing process is fast and seamless so that it can happen without interruption to the transaction and without customer interaction. An identity can be validated using as little input as a customer's name and address. |
| Risk Screening (Global) |
|---|
| WorldWatch Plus® Risk Screening delivers up-to-date access to the most extensive, inclusive, and continually updated library of watch lists available around the world. We ensure our customers utilize only the most current and accurate data to assess if an individual or business has been sanctioned, barred, or subjected to enforcement action by any financial, criminal and/or regulatory authority globally. Screening is also available for Politically Exposed Persons & Associates and Global Adverse Media. |
| Identity Document and Face Verification (Global) |
|---|
| WorldWatch Plus® Identity Document Verification provides you with the ability to capture
images of a customer’s photo-ID for the purpose of validating the individual’s identity. When
the customer submits the images, a programmatic document review is performed to determine if the
document template and attributes are valid. These data attributes are also stripped from the
images for additional identity verification. This process automates the manual review process
for account creation and high-risk transactions by programmatically verifying driver’s licenses,
ID cards, and passports. Identity Document Verification can perform a "forensic" level of authentication for photo-IDs in which approximately 20-40 tests are performed to authenticate the document based on image resolution and specific indicators found on the front and back. The results of these individual tests are combined into a single overall result, which can then provide an indicator that the document may be fraudulent. Currently, over 1,700 different types of photo-IDs can be verified from around the globe. Face Compare features prevent fraud by programmatically comparing a selfie against the identity document. This face analysis looks at over 50 specific points of the face in the evaluation and a score is assessed. A threshold score can be configured to decide the pass/fail decisioning after the face comparison is completed. |
Process Flow
The following is a high-level view of the KYC Screening proces flow. All KYC Screening products may not be enabled for your specific use case, and some can be enabled conditionally.
These illustrations show WorldWatch Plus optionally handling the customer/applicant notifications for you. This is not a requirement. A URL for the customer/applicant onboarding experience is returned with the initial API call if you prefer to send via email or SMS to them directly.
Sample Use Cases:
| "I would like for WorldWatch Plus KYC Screening to handle the full customer experience for me" | |
|---|---|
| 1. | Call GetIdentityReport API |
| 2. | Immediately: Review Identity and Risk results |
| 3. | On Callback: Review KBA, Document, Face Verification results |
| "I would like to deliver the customer notification myself, perhaps even conditionally" | |
|---|---|
| 1. | Call GetIdentityReport API |
| 2. | Immediately: Review Identity and Risk results |
| 3. | Conditionally: Send URL to customer via email or SMS |
| 4. | On Callback: Review KBA, Document, Face Verification results |
Mobile Customer Experience
The customer's Mobile Experience consists of the following steps:
| 1. | Subject of the verification receives a notice via email or SMS that "Further
Verification is Required". The content of this message and the instructions provided are customizable. |
| 2. | Subject follows the secure URL provided in the notice which takes them to a
browser-based user interface. The secure URL will be formatted as https://[yourcompanyname].onboarding.link?sid=[string150]
and contain a Session ID parameter that is unique to the subject being verified. |
| 3. | Subject navigates through basic application prompts for document and face
verification. Button color scheme, company name, logo, and introductory message are all customizable.     
|
| 4. | Subject confirms subission of document and face verification and is presented with next
steps. Confirmation message is customizable and can include redirect to a location of your choosing. |
API Authentication
WorldWatch Plus APIs support the use of HTTP Basic Authentication as well as Hash-based Message Authentication Code (HMAC) security. Utilize HMAC if you want to ensure that requests are both authentic and have not been tampered with. It is important to note that the use of HMAC signs the entire request, and therefore guarantees the authenticity of the action.
Basic Authentication
In basic HTTP authentication, the request must contain header fields with user name and password provided.
Using HMAC
HMAC is a mechanism for calculating a message authentication code involving a hash function in combination with a secret key. This can be used to verify the integrity and authenticity of a message. With HMAC, the server and the client share a secret access key. The access key lives in the respective data bases and is never transmitted across a line. Instead, the key is used to generate a hash for signing the message contents.
The general process for authentication via HMAC consists of these steps:
The client
1. Constructs an API request
2. Calculates a hash for the entire request using their Secret Key
3. Transmits the request including the Access Key ID and the hash using Basic Authentication
The server then
4. Looks up the Access Key in the data base
5. Calculates the hash for the received request using the Secret Key
6. Compares the received hash value with the one that was locally computed. Authorization was successful
if
the hashes match.
To keep this authentication process simple and secure, we have combined the use of HMAC with Basic Authentication, allowing the use of standard header variables for passing an access key identifier along with a message hash that has been encoded based upon a secret key.
| Username: | WorldWatch Plus assigned identifier for the Access Key |
| Password: | HMAC (hash function applied to the body of a message along with a Secret Key) |
GetIdentityReport Method
| PURPOSE: | Initiate KYC Screening Product Suite. This can include Identity Screening, Risk Screening, Document and Face Verification. Returns summary and detailed results for each screening product. |
The GetIdentityReport method assumes that customer/applicant data has already been collected and will initiate the identity validation and risk screening process. Initial Identity and Risk results will be returned immediately. A follow-up (callback) response will be returned when the customer/applicant verification has been completed.
Request Summary
Request parameters must be submitted as properly formed JSON or XML as specified in the API call and passed as the payload to this method. Results will be returned in the same format.
The request parameters for this method can be summarized as follows:
| 1. | Sender | Your Partner ID and Account identification | Required |
| 2. | Country Code | The target country for this screening | Required |
| 3. | Subject Identifiers | Details of the entity being screened | Required |
| 4. | Risk Options | Risk Screening specific parameters | Optional |
| 5. | Notification Options | How the client/applicant will be notified with URL | Optional |
| 6. | Callback URL | The specific location to receive follow-up responses to this request | Optional |
API Endpoint
Test:
https://test.worldwatchplus.com/api/getidentityreport?format={xml|json}
Production: https://dd.worldwatchplus.com/api/getidentityreport?format={xml|json}
Simple Request: (initiates all products based upon account settings)
{
"GetIdentityReport": {
"Sender": {
"PartnerID": "bc8934d999993de97b594ceb7436716c",
"AccountID": "999902",
"ReferenceID": "2392389"
},
"Request": {
"CountryCode": "US",
"SubjectIdentifiers": {
"GivenName": "John",
"FamilyName": "Smith",
"Address": "222333 PEACHTREE PLACE",
"CityLocale": "ATLANTA",
"StateRegion": "GA",
"PostalCode": "30318",
"DOB": "1948-02-28",
"Email": "john.smith@yahoo.com",
"Phone": "4048939999",
}
}
}
}
<GetIdentityReport>
<Sender>
<PartnerID>bc8934d999993de97b594ceb7436716c</PartnerID>
<AccountID>999902</AccountID>
<ReferenceID>2392389</ReferenceID>
</Sender>
<Request>
<CountryCode>US</CountryCode>
<SubjectIdentifiers>
<FamilyName>Smith</FamilyName>
<GivenName>John</GivenName>
<Address>222333 PEACHTREE PLACE</Address>
<CityLocale>ATLANTA</CityLocale>
<StateRegion>GA</StateRegion>
<PostalCode>30318</PostalCode>
<DOB>1948-02-28</DOB>
<Email>john.smith@yahoo.com</Email>
<Phone>4048939999</Phone>
</SubjectIdentifiers>
</Request>
</GetIdentityReport>
Request with Additional Parameters:
{
"GetIdentityReport": {
"Sender": {
"PartnerID": "bc8934d999993de97b594ceb7436716c",
"AccountID": "999902",
"ReferenceID": "2392389"
},
"Request": {
"CountryCode": "US",
"SubjectIdentifiers": {
"GivenName": "John",
"FamilyName": "Smith",
"Address": "222333 PEACHTREE PLACE",
"CityLocale": "ATLANTA",
"StateRegion": "GA",
"PostalCode": "30318",
"DOB": "1948-02-28",
"Email": "john.smith@yahoo.com",
"Phone": "4048939999",
},
"RiskOptions": {
"SmartMatch": "true",
"WatchLists": {
"List_ID": "SANCTIONS",
"List_ID": "FINANCE",
"List_ID": "TERRORISM",
"List_ID": "CRIME",
"List_ID": "OFAC",
},
"PoliticallyExposedLists": {
"List_ID": "PEPD"
},
"MediaTypes": {
"Type_ID": "NMEDIA"
},
"MediaLimit": "12",
"ExcerptSize": "1000",
"ExpediteResults": "false"
},
"NotificationOptions": {
"NotificationMethod": "sms"
},
"CallbackUrl": "https://mydomain.com/onboarding/accept_response.svc"
}
}
}
<GetIdentityReport>
<Sender>
<PartnerID>bc8934d999993de97b594ceb7436716c</PartnerID>
<AccountID>999902</AccountID>
<ReferenceID>2392389</ReferenceID>
</Sender>
<Request>
<CountryCode>US</CountryCode>
<SubjectIdentifiers>
<FamilyName>Smith</FamilyName>
<GivenName>John</GivenName>
<Address>222333 PEACHTREE PLACE</Address>
<CityLocale>ATLANTA</CityLocale>
<StateRegion>GA</StateRegion>
<PostalCode>30318</PostalCode>
<DOB>1948-02-28</DOB>
<Email>john.smith@yahoo.com</Email>
<Phone>4048939999</Phone>
</SubjectIdentifiers>
<RiskOptions>
<SmartMatch>true</SmartMatch>
<WatchLists>
<List_ID>SANCTIONS</List_ID>
<List_ID>FINANCE</List_ID>
<List_ID>TERRORISM</List_ID>
<List_ID>CRIME</List_ID>
<List_ID>OFAC</List_ID>
</WatchLists>
<PoliticallyExposedLists>
<List_ID>PEPD</List_ID>
</PoliticallyExposedLists>
<MediaTypes>
<Type_ID>NMEDIA</Type_ID>
</MediaTypes>
<ExcerptSize>1000</ExcerptSize>
<MediaLimit>12</MediaLimit>
<ExpediteResults>false</ExpediteResults>
</RiskOptions>
<NotificationOptions>
<NotificationMethod>sms</NotificationMethod>
</NotificationOptions>
<CallbackUrl>
https://mydomain.com/onboarding/accept_response.svc
</CallbackUrl>
</Request>
</GetIdentityReport>
Specific Request Parameters
| Parameter | Description |
|---|---|
| Sender | |
| Sender.PartnerID | RequiredYour Partner ID assigned by WorldWatch Plus (35) |
| Sender.AccountID | RequiredYour Account Code that must be assigned and enabled by WorldWatch Plus (6) |
| Sender.ReferenceID | OptionalYour Internal Transaction Reference ID for this specific request (50). Use this to be able to cross reference cases/transactions between platforms. |
| Request | |
| Request.CountryCode | RequiredBase ISO country code for Identity Verification (2) |
| Request.SubjectIdentifiers | |
| Request.SubjectIdentifiers.GivenName | RequiredGiven name of subject (40). |
| Request.SubjectIdentifiers.MiddleName | OptionalMiddle name of subject (40). |
| Request.SubjectIdentifiers.FamilyName | RequiredFamily name of subject (40). |
| Request.SubjectIdentifiers.Address | RequiredStreet address of subject (40). |
| Request.SubjectIdentifiers.CityLocale | US:ConditionalCity/Locale (40). If US, City and State required if enabled. |
| Request.SubjectIdentifiers.StateRegion | US:ConditionalState/Region. If US, City and State (2) required if enabled. |
| Request.SubjectIdentifiers.PostalCode | US:ConditionalPostal Code. If US, 5-digit zip code (5). Zip Code required if enabled |
| Request.SubjectIdentifiers.DOBMonth | OptionalMonth of Birth (2). Results improve with the addition of this field. |
| Request.SubjectIdentifiers.DOBDay | OptionalDay of Birth (2). Results improve with the addition of this field. |
| Request.SubjectIdentifiers.DOBYear | OptionalYear of Birth (4). Results improve with the addition of this field. YOB is the minimum DOB information accepted. |
| Request.SubjectIdentifiers.SSNlast4 | OptionalLast 4 digits of SSN (4). Results improve with the addition of this field. |
| Request.SubjectIdentifiers.SSN | OptionalFull SSN (9). |
| Request.SubjectIdentifiers.IPAddress | OptionalIP Address (15). Include periods in the address, for example - 11.111.111.11. |
| Request.SubjectIdentifiers.Email | OptionalEmail address (40). |
| Request.SubjectIdentifiers.Phone | OptionalPhone number (10). Include numbers only, no dashes. |
| Request.SubjectIdentifiers.altAddress | OptionalAlternate street address (40). Submit a secondary address for verification, such as a business address. |
| Request.SubjectIdentifiers.altCityLocale | OptionalAlternate city or locale (40). |
| Request.SubjectIdentifiers.altStateRegion | OptionalAlternate state. US State in abbreviated format, i.e. If US, for Georgia send "GA." |
| Request.SubjectIdentifiers.altPostalCode | OptionalAlternate postal code. If US, 5-digit zip code (5). |
| Request.RiskOptions | |
| Request.RiskOptions.FullNameScript | OptionalFull search name in native script (50). To be used if wanting to search a script version of the name in addition to the English version for risk evaluation. |
| Request.RiskOptions.Aliases | Specify any additional alias names to search. |
| Request.RiskOptions.Aliases.AliasName | OptionalFull alias name of subject (50). Multiple alias elements accepted. |
| Request.RiskOptions.SmartMatch | OptionalUse SmartMatch Plus® to search for similar spelling variations of names (True or False). |
| Request.RiskOptions.WatchLists | OptionalSpecify
Watchlist & Sanctions products to search: See "Risk Screening Products" |
| Request.RiskOptions.WatchLists.List_ID | ALL = All Watch Lists and Sanctions SANCTIONS, FINANCE, TERRORISM, CRIME, OFAC, SAMGOV, MEDICAL |
| Request.RiskOptions.PoliticallyExposedLists | OptionalSpecify
Political Exposure products to search: See "Risk Screening Products" |
| Request.RiskOptions.PoliticallyExposedLists.List_ID | ALL = All Politically Exposed Lists GOV = Government Officials SOE = State Owned Enterprises PEPD = Politically Exposed Persons & Associates |
| Request.RiskOptions.MediaTypes | OptionalSpecify
Media products to search: See "Risk Screening Products" |
| Request.RiskOptions.MediaTypes.Type_ID | NMEDIA = Adverse (Negative) Media |
| Request.RiskOptions.CustomLists | OptionalSpecify Custom lists to search: |
| Request.RiskOptions.CustomLists.List_ID | ID value of Custom List. Configured in account settings. |
| Request.RiskOptions.BlackLists | OptionalSpecify Black Lists to search: (coming soon) |
| Request.RiskOptions.BlackLists.List_ID | ID of customer-defined Black List |
| Request.RiskOptions.MediaLimit | OptionalLimit Media results to the previous X months where X=a numeric value. Default value is all available months or account default setting. |
| Request.RiskOptions.ExcerptSize | OptionalNumber of characters to show in results excerpts for unstructured data sources. (Numeric value typically between 250 and 5000) If not specified, defaults to account setting. |
| Request.RiskOptions.ExpediteResults | OptionalAn
external URL for viewing of risk results will always be returned by this API. However, if
inclusion of all detailed results, structured and unstructured, is desired in the API response,
then
specify and Case Match value representing the level of detail to return: 1 = Only Results with Exact DOB Match Found 2 = Only Results with Exact or Partial DOB Match Found 3 = Only Results with Exact or Partial DOB Matches or Subject Identifier Matches Found 4 = All Results, including Name Only Matches. Note: All structured fields values for results will be returned and will vary with product. |
| Request.NotificationOptions | |
| Request.NotificationOptions.NotificationMethod | ConditionalRequested
method of notifying the subject for Challenge Questions and/or Document and Facial
Verification. email = send notification via email sms = send notification via SMS message This is only required if WorldWatch Plus will be sending the notification on your behalf. Message details can be customized upon request. For emails to come from your domain, we will also need mail server name, port, username, and password configured in your account settings. |
| Request.CallbackUrl | ConditionalYour live
URL that will be notified with document verification results when subject (applicant)
transaction is complete. This is only required if Knowledge-based Authentication (Challenge Questions) and/or Document and Facial Verification is enabled. It is recommended that the specified URL is an active https:// service that accepts POSTs of text/xml content and returns HTTP 200 when the callback is received. |
Initial Response Summary
The initial response will be returned in the same data format (JSON or XML) specified when the API call was made. It is organized as follows:
| 1. | Error Status | Input Error Feedback |
| 2. | Identity Results | Summary and Detail Identity Verification Results |
| 3. | Risk Results | Summary and Detail Risk Screening Results |
| 4. | KBA | Knowledge-Based Authentication Questions for Client |
| 5. | Notification URL | Link to Document and Facial Verification for Client |
Example Initial Response:
{
"IdentityReport": {
"ErrorStatus": {
"Code": "0",
"Message": "Processed Normally"
},
"RequestDateTime": "2018-12-05 03:25:17Z",
"Identity": {
"IDNumber": "2182759247",
"SummaryResult": {
"Key": "id.success",
"Message": "PASS"
},
"Results": {
"Key": "result.match",
"Message": "ID Located"
},
"Qualifiers": {
"Qualifier": {
"Key": "resultcode.yob.does.not.match",
"Message": "YOB Does Not Match"
}
},
"VelocityResults": {
"VelocityResult": {
"Key": "",
"Message": ""
}
},
"IDScore": ""
},
"Risk": {
"SummaryResult": {
"QueriesWithResults": "2",
"CaseURL": "https://test.worldwatchplus.com/results?cid=2018112999990176194b9662876673eed",
"CaseID": "2018112999990176194b9662876673eed",
"CaseMatch": "4",
"CaseMatchDescription": "Name Only Matches Found",
"DOBExactMatch": "false",
"DOBMatch": "false",
"SubjectIdMatch": "false"
},
"Results": {
"Search": [
{
"SearchID": "1",
"SearchString": "John Smith",
"SearchType": "GOV",
"NameSource": "Provided",
"ResultsCount": "31",
"DOBExactMatch": "false",
"DOBMatch": "false",
"SubjectIdMatch": "false"
},
{
"SearchID": "2",
"SearchString": "John Smith",
"SearchType": "SOE",
"NameSource": "Provided",
"ResultsCount": "0",
"DOBExactMatch": "false",
"DOBMatch": "false",
"SubjectIdMatch": "false"
},
{
"SearchID": "3",
"SearchString": "John Smith",
"SearchType": "PEPD",
"NameSource": "Provided",
"ResultsCount": "25",
"DOBExactMatch": "false",
"DOBMatch": "false",
"SubjectIdMatch": "false"
}
]
}
},
"KBA": "",
"NotificationUrl": "https://test.worldwatchplus.com/identity/?referenceId=951d19e22f8d5a85b519d10c42ca31ef73d4100356a9f9999999999dc090db3b8aecc605b1d0755cffb1c8cf7ad0c82f189b527bd8a0fb39ff1ce6f22d4fcba58f330d78ba41e61044ebd1"
}
}
<IdentityReport>
<ErrorStatus>
<Code>0</Code>
<Message>Processed Normally</Message>
</ErrorStatus>
<RequestDateTime>2018-12-05 03:25:17Z</RequestDateTime>
<Identity>
<IDNumber>2182759247</IDNumber>
<SummaryResult>
<Key>id.success</Key>
<Message>PASS</Message>
</SummaryResult>
<Results>
<Key>result.match</Key>
<Message>ID Located</Message>
</Results>
<Qualifiers>
<Qualifier>
<Key>resultcode.yob.does.not.match</Key>
<Message>YOB Does Not Match</Message>
</Qualifier>
</Qualifiers>
<VelocityResults>
<VelocityResult>
<Key />
<Message />
</VelocityResult>
</VelocityResults>
<IDScore />
</Identity>
<Risk>
<SummaryResult>
<QueriesWithResults>2</QueriesWithResults>
<CaseURL>
https://test.worldwatchplus.com/results?cid=20181129999990176194b9662876673eed
</CaseURL>
<CaseID>20181129999990176194b9662876673eed</CaseID>
<CaseMatch>4</CaseMatch>
<CaseMatchDescription>
Name Only Matches Found
</CaseMatchDescription>
<DOBExactMatch>false</DOBExactMatch>
<DOBMatch>false</DOBMatch>
<SubjectIdMatch>false</SubjectIdMatch>
</SummaryResult>
<Results>
<Search>
<SearchID>1</SearchID>
<SearchString>John Smith</SearchString>
<SearchType>GOV</SearchType>
<NameSource>Provided</NameSource>
<ResultsCount>31</ResultsCount>
<DOBExactMatch>false</DOBExactMatch>
<DOBMatch>false</DOBMatch>
<SubjectIdMatch>false</SubjectIdMatch>
</Search >
<Search>
<SearchID>2</SearchID>
<SearchString>John Smith</SearchString>
<SearchType>SOE</SearchType>
<NameSource>Provided</NameSource>
<ResultsCount>0</ResultsCount>
<DOBExactMatch>false</DOBExactMatch>
<DOBMatch>false</DOBMatch>
<SubjectIdMatch>false</SubjectIdMatch>
</Search >
<Search>
<SearchID>3</SearchID>
<SearchString>John Smith</SearchString>
<SearchType>PEPD</SearchType>
<NameSource>Provided</NameSource>
<ResultsCount>25</ResultsCount>
<DOBExactMatch>false</DOBExactMatch>
<DOBMatch>false</DOBMatch>
<SubjectIdMatch>false</SubjectIdMatch>
</element>
</Search>
</Results>
</Risk>
<KBA />
<NotificationUrl>
https://test.worldwatchplus.com/identity/?referenceId=951d19e22f8d5a85b519d1999999999973d4100356a9f5e665b6a10dc090db3b8aecc605b1d0755cffb1c8cf7ad0c82f189b527bd8a0fb39ff1ce6f22d4fcba58f330d78ba41e61044ebd1
</NotificationUrl>
</IdentityReport>
Initial Response Elements
| Element | Description |
|---|---|
| ErrorStatus | |
| ErrorStatus.Code | 0 = Normal Processing See "Error Status Response Codes" |
| ErrorStatus.Message | Descriptive message associated with Code (100) |
| RequestDateTime | Date/Time Stamp of Request (UTC) (ISO 8601 format) |
| Identity | |
| Identity.IDNumber | Unique ID number user for reference, accounting or troubleshooting purposes. |
| Identity.SummaryResult | Provides information on the success or failure to locate the record. Contains following key and message. |
| Identity.SummaryResult.Key | Message identifier for summary-result.
|
| Identity.SummaryResult.Message | Displays the message for summary-result: PASS or FAIL. |
| Identity.Results | Returns the Identity Verification result. This value indicates if the information submitted matched the information located, subject to default tolerances and error-correcting logic (if enabled) on common typos in addresses or names. Contains following key and message. |
| Identity.Results.Key | Message identifier for results. The result will be one of the following:
|
| Identity.Results.Message | Message for results: PASS or FAIL. |
| Identity.Qualifiers | Specific warnings or informative messages. |
| Identity.Qualifiers.Qualifier | |
| Identity.Qualifiers.Qualifier.Key | See "Identity Qualifier Codes for Initial API Response" |
| Identity.Qualifiers.Qualifier.Message | See "Identity Qualifier Codes for Initial API Response" |
| Identity.VelocityResults | Velocity Monitoring system is a powerful anti-fraud feature that can monitor either incoming or located identity attributes for recurrence, either for a single enterprise or across the Network. Monitors can be configured to detect recurring over a set time period and range within each day (e.g. midnight to 5am over a 90 day period). There is no limit to the number of velocity monitors allowed per enterprise. |
| Identity.VelocityResults.VelocityResult | Specific warning or informative messages. See "Velocity Reference" |
| Identity.VelocityResults.VelocityResult.Key | |
| Identity.VelocityResults.VelocityResult.Message | |
| Identity.IDScore | |
| Risk | |
| Risk.SummaryResult | |
| Risk.SummaryResult.CaseID | WorldWatch Plus Assigned Case ID for Entity Risk Search |
| Risk.SummaryResult.CaseURL | URL (link) to specific Case ID showing detailed results. This is a one-click results dashboard view. Requires PIN. |
| Risk.SummaryResult.CaseMatch | Case level Match Result Code 0 = No Results Found 1 = Results with Exact DOB Match Found 2 = Results with Partial DOB Match Found 3 = Results with Subject IDs Found 4 = Results with None of the Above Found |
| Risk.SummaryResult.CaseMatchDescription | Description of code as shown above |
| Risk.SummaryResult.DOBExactMatch | If DOB was provided in request and an EXACT Match is found in the results, then returns: TRUE. Otherwise, FALSE |
| Risk.SummaryResult.DOBMatch | If DOB was provided in request, returns: TRUE = At least one of the searches performed contained a match on DOB based upon (day, month and year) OR (year) OR (day and month). FALSE = No searches contained a match on DOB per the above criteria. Note: This element returns TRUE for both Exact and Partial DOB Matches. |
| Risk.SummaryResult.SubjectIdMatch | TRUE or if at least one of the searches performed contained a match on at least one of the subject identifiers other than name. Otherwise, returns FALSE. |
| Risk.SummaryResult.QueriesWithResults | Number of queries that had results > 0 |
| Risk.Results | Number of queries that had results > 0 |
| Risk.Results.Search | Multiple Search IDs may get recorded for a single Case. Each Search ID represents a Name and Product variation that was searched under any particular Case. |
| Risk.Results.Search.SearchID | Search sequence number uniquely assigned per Case. |
| Risk.Results.Search.SearchString | Text of Name variation searched. |
| Risk.Results.Search.NameSource | Examples not limited to "Provided", "Alternate Given Name", "Similar Spelling", "Japanese Transliteration", etc. |
| Risk.Results.Search.SearchType | Type Source Data searched ("WLS", "PEP", or "NMEDIA") |
| Risk.Results.Search.DOBExactMatch | If DOB was provided in request and an EXACT Match is found in the results, then returns: TRUE. Otherwise, FALSE |
| Risk.Results.Search.DOBMatch | If DOB was provided in request, returns: TRUE = At least one of the result sources contained a match on DOB based upon (day, month and year) OR (year) OR (day and month). FALSE = No result sources contained a match on DOB per the above criteria. Note: The data sources searched may also not have had DOB available to search. |
| Risk.Results.Search.SubjectIdMatch | TRUE if at least one of the searches performed contained a match on at least one of the subject identifiers other than name. Otherwise, returns FALSE. |
| Risk.Results.Search.ResultsCount | Number of results from search. These represent actual source hits/results. A ResultsCount of 5 means the name appeared on 5 sources. |
| KBA | Knowledge-Based Authentication (KBA) questions are part of an account configuration. They can be
generated for each transaction or they can be triggered by specific rules (e.g., a triggered
Velocity warning, or the detection of a restricted ZIP code). When any of those configuration rules are triggered and questions are generated, the questions are presented in this section of the response. |
| KBA.Question | |
| KBA.Question.Prompt | Question to be provided to subject. |
| KBA.Question.Type | Type of question code. |
| KBA.Question.Answer | Up to 6 answers may be provided as separate elements. |
| NotificationUrl | URL to send to customer/applicant for onboarding verification. |
Error Status Response Codes
GetIdentityReport Error Status Response Codes:
| Code | Message |
|---|---|
| 0 | Normal Processing |
| 100 | Invalid Partner Id specified |
| 101 | Invalid Account Id specified |
| 102 | Invalid Country Code specified |
| 103 | Given Name can not be blank |
| 104 | Family Name can not be blank |
| 105 | Address can not be blank |
| 106 | City / Locale can not be blank |
| 107 | State / Region can not be blank |
| 108 | Notification Method must be set |
| 109 | Notification email method set but email is blank |
| 110 | Notification sms method set but phone is blank |
Callback Response Summary
A follow-up response is returned to the Callback URL following client/applicant document and facial verification. This response will be returned in the same data format (JSON or XML) specified when the initial API call was made. It is organized as follows:
| 1. | KBA Results | Results from any Knowledge-Based Authentication questions |
| 2. | Document Verification Results | Summary and detailed results from document verification |
| 3. | Scanned Document Data | Data from and about the document verified |
| 4. | Document Retrieval URL | A URL link to verified document images |
Example Callback Response:
{
"IdentityVerificationReport": {
"KBA": {
"SummaryResult": ""
},
"DocumentVerification": {
"IdNumber": "2182934951",
"IdScanResult": {
"Key": "result.id.scan.approved",
"message": "Approved"
},
"IdScanVerificationResult": {
"Key": "result.document.verified",
"message": "Document Verified"
},
"IdScanSummaryResult": {
"Key": "expectid.scan.id.success",
"Message": "PASS"
},
"Qualifiers": {
"Qualifier": {
"Key": "resultcode.scan.yob.does.not.match",
"Message": "YOB Does Not Match"
}
},
"IdScanRecord": {
"FirstName": "JOHN",
"MiddleName": "A",
"LastName": "SMITH",
"StreetNumber": "222333",
"StreetName": "PEACHTREE STREET",
"City": "ATLANTA",
"State": "US-GA",
"Zip": "30318-1234",
"DateOfBirth": {
"Year": "1975",
"Month": "02"
},
"Country": "US",
"WorldWatch PlusuanceState": {
"Year": "",
"Month": ""
},
"DateOfWorldWatch Plusuance": {
"Year": "2015",
"Month": "02"
},
"ExpirationDate": {
"Year": "2025",
"Month": "02"
},
"DocumentNumber": "123456789",
"DocumentType": "driverLicense",
"TemplateType": "DL",
"ConfidenceScore": "100"
},
"DocumentRetrievalUrl": "https://test.worldwatchplus.com/onboarding/documentRetrieval.php?retrievalId=2190489999"
}
}
}
<IdentityVerificationReport>
<KBA>
<SummaryResult />
</KBA>
<DocumentVerification>
<IdNumber>2182934951</IdNumber>
<IdScanResult>
<Key>result.id.scan.approved</Key>
<message>Approved</message>
</IdScanResult>
<IdScanVerificationResult>
<Key>result.document.verified</Key>
<message>Document Verified</message>
</IdScanVerificationResult>
<IdScanSummaryResult>
<Key>expectid.scan.id.success</Key>
<Message>PASS</Message>
</IdScanSummaryResult>
<Qualifiers>
<Qualifier>
<Key>resultcode.scan.yob.does.not.match</Key>
<Message>YOB Does Not Match</Message>
</Qualifier>
</Qualifiers>
<IdScanRecord>
<FirstName>JOHN</FirstName>
<MiddleName>A</MiddleName>
<LastName>SMITH</LastName>
<StreetNumber>222333</StreetNumber>
<StreetName>PEACHTREE STREET</StreetName>
<City>ATLANTA</City>
<State>US-GA</State>
<Zip>30318-1234</Zip>
<DateOfBirth>
<Month>02</Month>
<Year>1975</Year>
</DateOfBirth>
<Country>US</Country>
<WorldWatch PlusuanceState>
<Month />
<Year />
</WorldWatch PlusuanceState>
<DateOfWorldWatch Plusuance>
<Month>02</Month>
<Year>2015</Year>
</DateOfWorldWatch Plusuance>
<ExpirationDate>
<Month>02</Month>
<Year>2025</Year>
</ExpirationDate>
<DocumentNumber>123456789</DocumentNumber>
<DocumentType>driverLicense</DocumentType>
<TemplateType>DL</TemplateType>
<ConfidenceScore>100</ConfidenceScore>
</IdScanRecord>
<DocumentRetrievalUrl>
https://test.worldwatchplus.com/onboarding/documentRetrieval.php?retrievalId=2190499999
</DocumentRetrievalUrl>
</DocumentVerification>
</IdentityVerificationReport>
Callback Response Elements
| Element | Description |
|---|---|
| KBA | Knowledge-Based Authentication Results |
| KBA.SummaryResult | |
| KBA.SummaryResult.Key | Message identifier for summary-result.
|
| KBA.SummaryResult.Message | Displays the message for summary-result: PASS or FAIL. |
| DocumentVerification | |
| DocumentVerification.IDNumber | |
| DocumentVerification.IdScanResult | |
| DocumentVerification.IdScanResult.Key | |
| DocumentVerification.IdScanResult.Message | |
| DocumentVerification.IdScanVerificationResult | |
| DocumentVerification.IdScanVerificationResult.Key | |
| DocumentVerification.IdScanVerificationResult.Message | |
| DocumentVerification.IdScanSummaryResult | |
| DocumentVerification.IdScanSummaryResult.Key | |
| DocumentVerification.IdScanSummaryResult.Message | |
| DocumentVerification.IdScanManualReview | |
| DocumentVerification.IdScanManualReview.Key | |
| DocumentVerification.IdScanManualReview.Message | |
| DocumentVerification.Qualifiers | Specific warnings or informative messages |
| DocumentVerification.Qualifiers.Qualifier | |
| DocumentVerification.Qualifiers.Qualifier.Key | See "Identity Qualifier Codes for Follow-up API Response" |
| DocumentVerification.Qualifiers.Qualifier.Message | See "Identity Qualifier Codes for Follow-up API Response" |
| DocumentVerification.IdScanRecord | Customer data scraped from the document through the service. |
| DocumentVerification.IdScanRecord.FirstName | |
| DocumentVerification.IdScanRecord.MiddleName | |
| DocumentVerification.IdScanRecord.LastName | |
| DocumentVerification.IdScanRecord.StreetNumber | |
| DocumentVerification.IdScanRecord.StreetName | |
| DocumentVerification.IdScanRecord.City | |
| DocumentVerification.IdScanRecord.State | |
| DocumentVerification.IdScanRecord.DateOfBirth | |
| DocumentVerification.IdScanRecord.DateOfBirth.Year | |
| DocumentVerification.IdScanRecord.DateOfBirth.Month | |
| DocumentVerification.IdScanRecord.Country | |
| DocumentVerification.IdScanRecord.WorldWatch PlusuanceState | |
| DocumentVerification.IdScanRecord.DateOfWorldWatch Plusuance | |
| DocumentVerification.IdScanRecord.DateOfWorldWatch Plusuance.Year | |
| DocumentVerification.IdScanRecord.DateOfWorldWatch Plusuance.Month | |
| DocumentVerification.IdScanRecord.ExpirationDate | |
| DocumentVerification.IdScanRecord.ExpirationDate.Year | |
| DocumentVerification.IdScanRecord.ExpirationDate.Month | |
| DocumentVerification.IdScanRecord.DocumentNumber | |
| DocumentVerification.IdScanRecord.DocumentType | Indicates the document type that was provided. Will be one of the following values:
|
| DocumentVerification.IdScanRecord.TemplateType | See "Document Template Types" |
| DocumentVerification.IdScanRecord.ConfidenceScore | A confidence score that indicates the "confidence level" in the authenticity of the document based on how closely the document matches the template of the State and/or Country in which it was WorldWatch Plusued. |
| DocumentVerification.DocumentRetrievalUrl | The URL provided will link and display front and back of document as well as selfie image collected. These images will only be available for retrieval for 14 days. |
ScanIdentityReport Method
| PURPOSE: | Initiate KYC Screening Product Suite by first prompting client for ID. This is also referred to as Scan Onboarding. Returns the same level of detail as GetIdentityReport, except that the client information is extracted from their uploaded ID docuemtn rather than being provided in initial request. Returns summary and detailed results for each screening product. |
The ScanIdentityReport method does not require any predetermined client data other than contact information if we are sending the onboarding URL to your client directly. Confirmation of request initiation and Notification URL will be returned immediately. A follow-up (callback) response will be returned when the customer/applicant verification has been completed.
Request Summary
Request parameters must be submitted as properly formed JSON or XML as specified in the API call and passed as the payload to this method. Results will be returned in the same format.
The request parameters for this method can be summarized as follows:
| 1. | Sender | Your Partner ID and Account identification | Required |
| 2. | Country Code | The target country for this screening | Required |
| 3. | Risk Options | Risk Screening specific parameters | Optional |
| 4. | Notification Options | How the client/applicant will be notified with URL | Optional |
| 5. | Callback URL | The specific location to receive follow-up responses to this request | Optional |
API Endpoint
Test:
https://test.worldwatchplus.com/api/scanidentityreport?format={xml|json}
Production: https://dd.worldwatchplus.com/api/scanidentityreport?format={xml|json}
Simple Request: (initiates all products based upon account settings)
{
"ScanIdentityReport": {
"Sender": {
"PartnerID": "bc8934d999993de97b594ceb7436716c",
"AccountID": "999902",
"ReferenceID": "2392389"
},
"Request": {
"CountryCode": "US",
}
}
}
<ScanIdentityReport>
<Sender>
<PartnerID>bc8934d999993de97b594ceb7436716c</PartnerID>
<AccountID>999902</AccountID>
<ReferenceID>2392389</ReferenceID>
</Sender>
<Request>
<CountryCode>US</CountryCode>
</Request>
</ScanIdentityReport>
Request with Additional Parameters:
{
"ScanIdentityReport": {
"Sender": {
"PartnerID": "bc8934d999993de97b594ceb7436716c",
"AccountID": "999902",
"ReferenceID": "2392389"
},
"Request": {
"CountryCode": "US",
"RiskOptions": {
"SmartMatch": "true",
"WatchLists": {
"List_ID": "SANCTIONS",
"List_ID": "FINANCE",
"List_ID": "TERRORISM",
"List_ID": "CRIME",
"List_ID": "OFAC",
},
"PoliticallyExposedLists": {
"List_ID": "PEPD"
},
"MediaTypes": {
"Type_ID": "NMEDIA"
},
"MediaLimit": "12",
"ExcerptSize": "1000",
"ExpediteResults": "false"
},
"NotificationOptions": {
"NotificationMethod": "sms"
},
"CallbackUrl": "https://mydomain.com/onboarding/accept_response.svc"
}
}
}
<ScanIdentityReport>
<Sender>
<PartnerID>bc8934d999993de97b594ceb7436716c</PartnerID>
<AccountID>999902</AccountID>
<ReferenceID>2392389</ReferenceID>
</Sender>
<Request>
<CountryCode>US</CountryCode>
<RiskOptions>
<SmartMatch>true</SmartMatch>
<WatchLists>
<List_ID>SANCTIONS</List_ID>
<List_ID>FINANCE</List_ID>
<List_ID>TERRORISM</List_ID>
<List_ID>CRIME</List_ID>
<List_ID>OFAC</List_ID>
</WatchLists>
<PoliticallyExposedLists>
<List_ID>PEPD</List_ID>
</PoliticallyExposedLists>
<MediaTypes>
<Type_ID>NMEDIA</Type_ID>
</MediaTypes>
<ExcerptSize>1000</ExcerptSize>
<MediaLimit>12</MediaLimit>
<ExpediteResults>false</ExpediteResults>
</RiskOptions>
<NotificationOptions>
<NotificationMethod>sms</NotificationMethod>
</NotificationOptions>
<CallbackUrl>
https://mydomain.com/onboarding/accept_response.svc
</CallbackUrl>
</Request>
</ScanIdentityReport>
Specific Request Parameters
| Parameter | Description |
|---|---|
| Sender | |
| Sender.PartnerID | RequiredYour Partner ID assigned by WorldWatch Plus (35) |
| Sender.AccountID | RequiredYour Account Code that must be assigned and enabled by WorldWatch Plus (6) |
| Sender.ReferenceID | OptionalYour Internal Transaction Reference ID for this specific request (50). Use this to be able to cross reference cases/transactions between platforms. |
| Request | |
| Request.CountryCode | RequiredBase ISO country code for Identity Verification (2) |
| Request.SubjectIdentifiers | |
| Request.RiskOptions | |
| Request.RiskOptions.FullNameScript | OptionalFull search name in native script (50). To be used if wanting to search a script version of the name in addition to the English version for risk evaluation. |
| Request.RiskOptions.Aliases | Specify any additional alias names to search. |
| Request.RiskOptions.Aliases.AliasName | OptionalFull alias name of subject (50). Multiple alias elements accepted. |
| Request.RiskOptions.SmartMatch | OptionalUse SmartMatch Plus® to search for similar spelling variations of names (True or False). |
| Request.RiskOptions.WatchLists | OptionalSpecify
Watchlist & Sanctions products to search: See "Risk Screening Products" |
| Request.RiskOptions.WatchLists.List_ID | ALL = All Watch Lists and Sanctions SANCTIONS, FINANCE, TERRORISM, CRIME, OFAC, SAMGOV, MEDICAL |
| Request.RiskOptions.PoliticallyExposedLists | OptionalSpecify
Political Exposure products to search: See "Risk Screening Products" |
| Request.RiskOptions.PoliticallyExposedLists.List_ID | ALL = All Politically Exposed Lists GOV = Government Officials SOE = State Owned Enterprises PEPD = Politically Exposed Persons & Associates |
| Request.RiskOptions.MediaTypes | OptionalSpecify
Media products to search: See "Risk Screening Products" |
| Request.RiskOptions.MediaTypes.Type_ID | NMEDIA = Adverse (Negative) Media |
| Request.RiskOptions.CustomLists | OptionalSpecify Custom lists to search: |
| Request.RiskOptions.CustomLists.List_ID | ID value of Custom List. Configured in account settings. |
| Request.RiskOptions.BlackLists | OptionalSpecify Black Lists to search: (coming soon) |
| Request.RiskOptions.BlackLists.List_ID | ID of customer-defined Black List |
| Request.RiskOptions.MediaLimit | OptionalLimit Media results to the previous X months where X=a numeric value. Default value is all available months or account default setting. |
| Request.RiskOptions.ExcerptSize | OptionalNumber of characters to show in results excerpts for unstructured data sources. (Numeric value typically between 250 and 5000) If not specified, defaults to account setting. |
| Request.RiskOptions.ExpediteResults | OptionalAn
external URL for viewing of risk results will always be returned by this API. However, if
inclusion of all detailed results, structured and unstructured, is desired in the API response,
then
specify and Case Match value representing the level of detail to return: 1 = Only Results with Exact DOB Match Found 2 = Only Results with Exact or Partial DOB Match Found 3 = Only Results with Exact or Partial DOB Matches or Subject Identifier Matches Found 4 = All Results, including Name Only Matches. Note: All structured fields values for results will be returned and will vary with product. |
| Request.NotificationOptions | |
| Request.NotificationOptions.NotificationMethod | ConditionalRequested
method of notifying the subject for Challenge Questions and/or Document and Facial
Verification. none = don't send notification email = send notification via email sms = send notification via SMS message This is only required if WorldWatch Plus will be sending the notification on your behalf. Message details can be customized upon request. For emails to come from your domain, we will also need mail server name, port, username, and password configured in your account settings. |
| Request.CallbackUrl | ConditionalYour live
URL that will be notified with document verification results when subject (applicant)
transaction is complete. This is only required if Knowledge-based Authentication (Challenge Questions) and/or Document and Facial Verification is enabled. It is recommended that the specified URL is an active https:// service that accepts POSTs of text/xml content and returns HTTP 200 when the callback is received. |
Initial Response Summary
The initial response will be returned in the same data format (JSON or XML) specified when the API call was made. It is organized as follows:
| 1. | Error Status | Input Error Feedback |
| 2. | Unique Session ID | Unique session identifer for this transaction |
| 3. | Notification URL | Link to Document and Facial Verification for Client |
Example Initial Response:
{
"IdentityReport": {
"ErrorStatus": {
"Code": "0",
"Message": "Processed Normally"
},
"RequestDateTime": "2018-12-05 03:25:17Z",
"UniqueSessionID": "230k30dk03kd3md939jd9j03jdd9939813947018",
"NotificationUrl": "https://test.worldwatchplus.com/identity/?referenceId=951d19e22f8d5a85b519d10c42ca31ef73d4100356a9f9999999999dc090db3b8aecc605b1d0755cffb1c8cf7ad0c82f189b527bd8a0fb39ff1ce6f22d4fcba58f330d78ba41e61044ebd1"
}
}
<IdentityReport>
<ErrorStatus>
<Code>0</Code>
<Message>Processed Normally</Message>
</ErrorStatus>
<RequestDateTime>2018-12-05 03:25:17Z</RequestDateTime>
<UniqueSessionID>230k30dk03kd3md939jd9j03jdd9939813947018</RequestDateTime>
<NotificationUrl>
https://test.worldwatchplus.com/identity/?referenceId=951d19e22f8d5a85b519d1999999999973d4100356a9f5e665b6a10dc090db3b8aecc605b1d0755cffb1c8cf7ad0c82f189b527bd8a0fb39ff1ce6f22d4fcba58f330d78ba41e61044ebd1
</NotificationUrl>
</IdentityReport>
Initial Response Elements
| Element | Description |
|---|---|
| ErrorStatus | |
| ErrorStatus.Code | 0 = Normal Processing See "Error Status Response Codes" |
| ErrorStatus.Message | Descriptive message associated with Code (100) |
| RequestDateTime | Date/Time Stamp of Request (UTC) (ISO 8601 format) |
| UniqueSessionID | Unique Session ID for transaction inititated by this request. Use this to reference in callback response. |
| NotificationUrl | URL to send to customer/applicant for onboarding verification. |
Error Status Response Codes
ScanIdentityReport Error Status Response Codes:
| Code | Message |
|---|---|
| 0 | Normal Processing |
| 100 | Invalid Partner Id specified |
| 101 | Invalid Account Id specified |
| 102 | Invalid Country Code specified |
| 108 | Notification Method must be set |
| 109 | Notification email method set but email is blank |
| 110 | Notification sms method set but phone is blank |
Callback Response Summary
A follow-up response is returned to the Callback URL following client/applicant document and facial verification. This response will be returned in the same data format (JSON or XML) specified when the initial API call was made. It is organized as follows:
| 1. | Identity Results | Summary and Detail Identity Verification Results |
| 2. | Risk Results | Summary and Detail Risk Screening Results |
| 3. | KBA Results | Results from any Knowledge-Based Authentication questions |
| 4. | Document Verification Results | Summary and detailed results from document verification |
| 5. | Scanned Document Data | Data from and about the document verified |
| 6. | Document Retrieval URL | A URL link to verified document images |
Example Callback Response:
{
"IdentityVerificationReport": {
"Identity": {
"IDNumber": "2182759247",
"SummaryResult": {
"Key": "id.success",
"Message": "PASS"
},
"Results": {
"Key": "result.match",
"Message": "ID Located"
},
"Qualifiers": {
"Qualifier": {
"Key": "resultcode.yob.does.not.match",
"Message": "YOB Does Not Match"
}
},
"VelocityResults": {
"VelocityResult": {
"Key": "",
"Message": ""
}
},
"IDScore": ""
},
"Risk": {
"SummaryResult": {
"QueriesWithResults": "2",
"CaseURL": "https://test.worldwatchplus.com/results?cid=2018112999990176194b9662876673eed",
"CaseID": "2018112999990176194b9662876673eed",
"CaseMatch": "4",
"CaseMatchDescription": "Name Only Matches Found",
"DOBExactMatch": "false",
"DOBMatch": "false",
"SubjectIdMatch": "false"
},
"Results": {
"Search": [
{
"SearchID": "1",
"SearchString": "John Smith",
"SearchType": "GOV",
"NameSource": "Provided",
"ResultsCount": "31",
"DOBExactMatch": "false",
"DOBMatch": "false",
"SubjectIdMatch": "false"
},
{
"SearchID": "2",
"SearchString": "John Smith",
"SearchType": "SOE",
"NameSource": "Provided",
"ResultsCount": "0",
"DOBExactMatch": "false",
"DOBMatch": "false",
"SubjectIdMatch": "false"
},
{
"SearchID": "3",
"SearchString": "John Smith",
"SearchType": "PEPD",
"NameSource": "Provided",
"ResultsCount": "25",
"DOBExactMatch": "false",
"DOBMatch": "false",
"SubjectIdMatch": "false"
}
]
}
},
"KBA": {
"SummaryResult": ""
},
"DocumentVerification": {
"IdNumber": "2182934951",
"IdScanResult": {
"Key": "result.id.scan.approved",
"message": "Approved"
},
"IdScanVerificationResult": {
"Key": "result.document.verified",
"message": "Document Verified"
},
"IdScanSummaryResult": {
"Key": "expectid.scan.id.success",
"Message": "PASS"
},
"Qualifiers": {
"Qualifier": {
"Key": "resultcode.scan.yob.does.not.match",
"Message": "YOB Does Not Match"
}
},
"IdScanRecord": {
"FirstName": "JOHN",
"MiddleName": "A",
"LastName": "SMITH",
"StreetNumber": "222333",
"StreetName": "PEACHTREE STREET",
"City": "ATLANTA",
"State": "US-GA",
"Zip": "30318-1234",
"DateOfBirth": {
"Year": "1975",
"Month": "02"
},
"Country": "US",
"WorldWatch PlusuanceState": {
"Year": "",
"Month": ""
},
"DateOfWorldWatch Plusuance": {
"Year": "2015",
"Month": "02"
},
"ExpirationDate": {
"Year": "2025",
"Month": "02"
},
"DocumentNumber": "123456789",
"DocumentType": "driverLicense",
"TemplateType": "DL",
"ConfidenceScore": "100"
},
"DocumentRetrievalUrl": "https://test.worldwatchplus.com/onboarding/documentRetrieval.php?retrievalId=2190489999"
}
}
}
<IdentityVerificationReport>
<Identity>
<IDNumber>2182759247</IDNumber>
<SummaryResult>
<Key>id.success</Key>
<Message>PASS</Message>
</SummaryResult>
<Results>
<Key>result.match</Key>
<Message>ID Located</Message>
</Results>
<Qualifiers>
<Qualifier>
<Key>resultcode.yob.does.not.match</Key>
<Message>YOB Does Not Match</Message>
</Qualifier>
</Qualifiers>
<VelocityResults>
<VelocityResult>
<Key />
<Message />
</VelocityResult>
</VelocityResults>
<IDScore />
</Identity>
<Risk>
<SummaryResult>
<QueriesWithResults>2</QueriesWithResults>
<CaseURL>
https://test.worldwatchplus.com/results?cid=20181129999990176194b9662876673eed
</CaseURL>
<CaseID>20181129999990176194b9662876673eed</CaseID>
<CaseMatch>4</CaseMatch>
<CaseMatchDescription>
Name Only Matches Found
</CaseMatchDescription>
<DOBExactMatch>false</DOBExactMatch>
<DOBMatch>false</DOBMatch>
<SubjectIdMatch>false</SubjectIdMatch>
</SummaryResult>
<Results>
<Search>
<SearchID>1</SearchID>
<SearchString>John Smith</SearchString>
<SearchType>GOV</SearchType>
<NameSource>Provided</NameSource>
<ResultsCount>31</ResultsCount>
<DOBExactMatch>false</DOBExactMatch>
<DOBMatch>false</DOBMatch>
<SubjectIdMatch>false</SubjectIdMatch>
</Search >
<Search>
<SearchID>2</SearchID>
<SearchString>John Smith</SearchString>
<SearchType>SOE</SearchType>
<NameSource>Provided</NameSource>
<ResultsCount>0</ResultsCount>
<DOBExactMatch>false</DOBExactMatch>
<DOBMatch>false</DOBMatch>
<SubjectIdMatch>false</SubjectIdMatch>
</Search >
<Search>
<SearchID>3</SearchID>
<SearchString>John Smith</SearchString>
<SearchType>PEPD</SearchType>
<NameSource>Provided</NameSource>
<ResultsCount>25</ResultsCount>
<DOBExactMatch>false</DOBExactMatch>
<DOBMatch>false</DOBMatch>
<SubjectIdMatch>false</SubjectIdMatch>
</element>
</Search>
</Results>
</Risk>
<KBA>
<SummaryResult />
</KBA>
<DocumentVerification>
<IdNumber>2182934951</IdNumber>
<IdScanResult>
<Key>result.id.scan.approved</Key>
<message>Approved</message>
</IdScanResult>
<IdScanVerificationResult>
<Key>result.document.verified</Key>
<message>Document Verified</message>
</IdScanVerificationResult>
<IdScanSummaryResult>
<Key>expectid.scan.id.success</Key>
<Message>PASS</Message>
</IdScanSummaryResult>
<Qualifiers>
<Qualifier>
<Key>resultcode.scan.yob.does.not.match</Key>
<Message>YOB Does Not Match</Message>
</Qualifier>
</Qualifiers>
<IdScanRecord>
<FirstName>JOHN</FirstName>
<MiddleName>A</MiddleName>
<LastName>SMITH</LastName>
<StreetNumber>222333</StreetNumber>
<StreetName>PEACHTREE STREET</StreetName>
<City>ATLANTA</City>
<State>US-GA</State>
<Zip>30318-1234</Zip>
<DateOfBirth>
<Month>02</Month>
<Year>1975</Year>
</DateOfBirth>
<Country>US</Country>
<WorldWatch PlusuanceState>
<Month />
<Year />
</WorldWatch PlusuanceState>
<DateOfWorldWatch Plusuance>
<Month>02</Month>
<Year>2015</Year>
</DateOfWorldWatch Plusuance>
<ExpirationDate>
<Month>02</Month>
<Year>2025</Year>
</ExpirationDate>
<DocumentNumber>123456789</DocumentNumber>
<DocumentType>driverLicense</DocumentType>
<TemplateType>DL</TemplateType>
<ConfidenceScore>100</ConfidenceScore>
</IdScanRecord>
<DocumentRetrievalUrl>
https://test.worldwatchplus.com/onboarding/documentRetrieval.php?retrievalId=2190499999
</DocumentRetrievalUrl>
</DocumentVerification>
</IdentityVerificationReport>
Callback Response Elements
| Element | Description |
|---|---|
| Identity | |
| Identity.IDNumber | Unique ID number user for reference, accounting or troubleshooting purposes. |
| Identity.SummaryResult | Provides information on the success or failure to locate the record. Contains following key and message. |
| Identity.SummaryResult.Key | Message identifier for summary-result.
|
| Identity.SummaryResult.Message | Displays the message for summary-result: PASS or FAIL. |
| Identity.Results | Returns the Identity Verification result. This value indicates if the information submitted matched the information located, subject to default tolerances and error-correcting logic (if enabled) on common typos in addresses or names. Contains following key and message. |
| Identity.Results.Key | Message identifier for results. The result will be one of the following:
|
| Identity.Results.Message | Message for results: PASS or FAIL. |
| Identity.Qualifiers | Specific warnings or informative messages. |
| Identity.Qualifiers.Qualifier | |
| Identity.Qualifiers.Qualifier.Key | See "Identity Qualifier Codes for Initial API Response" |
| Identity.Qualifiers.Qualifier.Message | See "Identity Qualifier Codes for Initial API Response" |
| Identity.VelocityResults | Velocity Monitoring system is a powerful anti-fraud feature that can monitor either incoming or located identity attributes for recurrence, either for a single enterprise or across the Network. Monitors can be configured to detect recurring over a set time period and range within each day (e.g. midnight to 5am over a 90 day period). There is no limit to the number of velocity monitors allowed per enterprise. |
| Identity.VelocityResults.VelocityResult | Specific warning or informative messages. See "Velocity Reference" |
| Identity.VelocityResults.VelocityResult.Key | |
| Identity.VelocityResults.VelocityResult.Message | |
| Identity.IDScore | |
| Risk | |
| Risk.SummaryResult | |
| Risk.SummaryResult.CaseID | WorldWatch Plus Assigned Case ID for Entity Risk Search |
| Risk.SummaryResult.CaseURL | URL (link) to specific Case ID showing detailed results |
| Risk.SummaryResult.CaseMatch | Case level Match Result Code 0 = No Results Found 1 = Results with Exact DOB Match Found 2 = Results with Partial DOB Match Found 3 = Results with Subject IDs Found 4 = Results with None of the Above Found |
| Risk.SummaryResult.CaseMatchDescription | Description of code as shown above |
| Risk.SummaryResult.DOBExactMatch | If DOB was provided in request and an EXACT Match is found in the results, then returns: TRUE. Otherwise, FALSE |
| Risk.SummaryResult.DOBMatch | If DOB was provided in request, returns: TRUE = At least one of the searches performed contained a match on DOB based upon (day, month and year) OR (year) OR (day and month). FALSE = No searches contained a match on DOB per the above criteria. Note: This element returns TRUE for both Exact and Partial DOB Matches. |
| Risk.SummaryResult.SubjectIdMatch | TRUE or if at least one of the searches performed contained a match on at least one of the subject identifiers other than name. Otherwise, returns FALSE. |
| Risk.SummaryResult.QueriesWithResults | Number of queries that had results > 0 |
| Risk.Results | Number of queries that had results > 0 |
| Risk.Results.Search | Multiple Search IDs may get recorded for a single Case. Each Search ID represents a Name and Product variation that was searched under any particular Case. |
| Risk.Results.Search.SearchID | Search sequence number uniquely assigned per Case. |
| Risk.Results.Search.SearchString | Text of Name variation searched. |
| Risk.Results.Search.NameSource | Examples not limited to "Provided", "Alternate Given Name", "Similar Spelling", "Japanese Transliteration", etc. |
| Risk.Results.Search.SearchType | Type Source Data searched ("WLS", "PEP", or "NMEDIA") |
| Risk.Results.Search.DOBExactMatch | If DOB was provided in request and an EXACT Match is found in the results, then returns: TRUE. Otherwise, FALSE |
| Risk.Results.Search.DOBMatch | If DOB was provided in request, returns: TRUE = At least one of the result sources contained a match on DOB based upon (day, month and year) OR (year) OR (day and month). FALSE = No result sources contained a match on DOB per the above criteria. Note: The data sources searched may also not have had DOB available to search. |
| Risk.Results.Search.SubjectIdMatch | TRUE if at least one of the searches performed contained a match on at least one of the subject identifiers other than name. Otherwise, returns FALSE. |
| Risk.Results.Search.ResultsCount | Number of results from search. These represent actual source hits/results. A ResultsCount of 5 means the name appeared on 5 sources. |
| KBA | Knowledge-Based Authentication Results |
| KBA.SummaryResult | |
| KBA.SummaryResult.Key | Message identifier for summary-result.
|
| KBA.SummaryResult.Message | Displays the message for summary-result: PASS or FAIL. |
| DocumentVerification | |
| DocumentVerification.IDNumber | |
| DocumentVerification.IdScanResult | |
| DocumentVerification.IdScanResult.Key | |
| DocumentVerification.IdScanResult.Message | |
| DocumentVerification.IdScanVerificationResult | |
| DocumentVerification.IdScanVerificationResult.Key | |
| DocumentVerification.IdScanVerificationResult.Message | |
| DocumentVerification.IdScanSummaryResult | |
| DocumentVerification.IdScanSummaryResult.Key | |
| DocumentVerification.IdScanSummaryResult.Message | |
| DocumentVerification.IdScanManualReview | |
| DocumentVerification.IdScanManualReview.Key | |
| DocumentVerification.IdScanManualReview.Message | |
| DocumentVerification.Qualifiers | Specific warnings or informative messages |
| DocumentVerification.Qualifiers.Qualifier | |
| DocumentVerification.Qualifiers.Qualifier.Key | See "Identity Qualifier Codes for Follow-up API Response" |
| DocumentVerification.Qualifiers.Qualifier.Message | See "Identity Qualifier Codes for Follow-up API Response" |
| DocumentVerification.IdScanRecord | Customer data scraped from the document through the service. |
| DocumentVerification.IdScanRecord.FirstName | |
| DocumentVerification.IdScanRecord.MiddleName | |
| DocumentVerification.IdScanRecord.LastName | |
| DocumentVerification.IdScanRecord.StreetNumber | |
| DocumentVerification.IdScanRecord.StreetName | |
| DocumentVerification.IdScanRecord.City | |
| DocumentVerification.IdScanRecord.State | |
| DocumentVerification.IdScanRecord.DateOfBirth | |
| DocumentVerification.IdScanRecord.DateOfBirth.Year | |
| DocumentVerification.IdScanRecord.DateOfBirth.Month | |
| DocumentVerification.IdScanRecord.Country | |
| DocumentVerification.IdScanRecord.WorldWatch PlusuanceState | |
| DocumentVerification.IdScanRecord.DateOfWorldWatch Plusuance | |
| DocumentVerification.IdScanRecord.DateOfWorldWatch Plusuance.Year | |
| DocumentVerification.IdScanRecord.DateOfWorldWatch Plusuance.Month | |
| DocumentVerification.IdScanRecord.ExpirationDate | |
| DocumentVerification.IdScanRecord.ExpirationDate.Year | |
| DocumentVerification.IdScanRecord.ExpirationDate.Month | |
| DocumentVerification.IdScanRecord.DocumentNumber | |
| DocumentVerification.IdScanRecord.DocumentType | Indicates the document type that was provided. Will be one of the following values:
|
| DocumentVerification.IdScanRecord.TemplateType | See "Document Template Types" |
| DocumentVerification.IdScanRecord.ConfidenceScore | A confidence score that indicates the "confidence level" in the authenticity of the document based on how closely the document matches the template of the State and/or Country in which it was WorldWatch Plusued. |
| DocumentVerification.DocumentRetrievalUrl | The URL provided will link and display front and back of document as well as selfie image collected. These images will only be available for retrieval for 14 days. |
Identity Qualifier Code Reference
Qualifiers Returned in Initial API Response
| Qualifier | What it means |
|---|---|
| resultcode.coppa.alert | Customer is 13 or under. COPPA laws forbid conducting e-commerce with people under 14 years of age. When this result is encountered, the input information and located data will not be available in any record of the transaction due to the WorldWatch Plusues around storing data on children. |
| resultcode.address.does.not.match | Address found does not match address submitted. This can be due to a typo in the input information, typos or errors in the address located, or the address is actually incorrect, but the subject’s credentials are located in or near the target ZIP code, city, or metropolitan area. |
| resultcode.street.name.does.not.match | The submitted street name does not match the located data. This can be due to a typo in the input or the located data. This note will always be accompanied by the resultcode.address.does.not.match ID Note. |
| resultcode.street.number.does.not.match | The submitted street number does not match the located data. This can be due to a typo in the input or the located data. This note will always be accompanied by the resultcode.address.does.not.match ID Note. |
| resultcode.input.address.is.po.box | The input address is a PO Box. |
| resultcode.located.address.is.po.box | The located address is a PO Box. |
| resultcode.warm.address.alert | This indicates that the located address is a warm address. Warm addresses will be clarified further as to which type with the value of the value. Those are: • mail drop • hospital • hotel • prison • campground • college • university • USPO |
| resultcode.zip.does.not.match | ZIP code located does not match the ZIP code submitted. |
| resultcode.yob.does.not.match | The year of birth located does not match. If neither the month-of-birth nor the year-of-birth match, this ID Note is presented. |
| resultcode.yob.within.one.year | This indicates a discrepancy of one year between the YOB submitted and the YOB located. If the YOB submitted is 1970 and the YOB located is 1971, this ID Note is presented. |
| resultcode.mob.does.not.match | This indicates a discrepancy between the month of birth submitted and the month of birth located. This ID Note is only presented when the year-of-birth matches. |
| resultcode.no.mob.available | This indicates that no month-of-birth was included in the records that were located. |
| resultcode.multiple.records.found | Several valid records exist containing conflicting identifying information. |
| resultcode.newer.record.found | The subject of the search was found at the address submitted, but a more recent record shows a different address for the individual. If a customer intentionally provides an old address and a new one is located, this result will occur, but it also results from a customer providing a current "home" address and the Identity search locating newer real estate, like a second/vacation home or an investment property. |
| resultcode.high.risk.address.alert | Identifies addresses with a known history of fraud activity. |
| resultcode.address.velocity.alert | Warns of the number of addresses someone has had within a defined time period. |
| resultcode.address.stability.alert | Indicates how often someone moves based on specific timeframe triggers |
| resultcode.address.longevity.alert | Specifies how long someone has lived at their current address. |
| resultcode.address.location.alert | A location-based alert that advises when the located ZIP Code exceeds the Enterprise’s Permitted Distance Radius rule. |
| resultcode.alternate.address.alert | Indicates that the Alternate Address could not be verified for the customer. The Alert will be clarified further as to which type with the value of the value. Those are: • Street Number • Street Name • State • ZIP Code |
| resultcode.no.dob.available | The individual was identified, but DOB information was not available in the records located. This does not mean the search failed. Numerous public-record data sources do not include DOB information in their records. |
| resultcode.ssn.not.available | The individual was identified, but SSN information was not available. This does not mean the search failed. Numerous public-record data sources do not include SSN information in their records. |
| resultcode.ssn.does.not.match | SSN found does not match SSN submitted. This does not necessarily mean the ID Located is invalid, especially when the MOB+YOB or YOB was provided as well. There can be errors in the located SSN data. |
| resultcode.ssn.within.one.digit | This indicates a discrepancy of one digit between the SSN submitted and the SSN located. If the SSN submitted is off by one digit from the located SSN, the ID Note is presented. |
| resultcode.input.ssn.is.itin | Indicates that the Input SSN is an ITIN (Individual Taxpayer Identification Number). |
| resultcode.located.itin | Indicates that the Located SSN is an ITIN (Individual Taxpayer Identification Number). |
| resultcode.ssn.tied.to.multiple.names | The SSN provided is tied to two or more individuals. |
| resultcode.subject.deceased | Records indicate that the subject in question is deceased. |
| resultcode.state.does.not.match | This indicates that the State located does not match the state input as part of the address. This ID Note is a very specialized response and is only available if configured by WorldWatch Plus. |
| resultcode.ssn.WorldWatch Plusued.prior.to.dob | This indicates that the SSN number was WorldWatch Plusued before the individual’s DOB, a serious fraud flag. |
| resultcode.ssn.not.valid | The located SSN does not match the structure of a valid SSN. |
| resultcode.single.address.in.file | This indicates that only a single address record was located for the individual. |
| resultcode.data.strength.alert | Examines how long someone has been in the public record system and how much data is available. |
| resultcode.activation.date.alert | This indicates that the provided Purchase Date of the card is a particular set of days after the Activation Date. |
| resultcode.last.name.does.not.match | This indicates that the located last name does not match the input last name. |
| resultcode.thin.file | This indicates that the record located had very little information, specifically only name + address (Personal Info or “PI” only), and lacks any information that can be used to link to other records. |
| resultcode.bankruptcy | This indicates that the subject of the search has a chapter 7 or 13 bankruptcy in their public record. |
| resultcode.age.below.minimum | Indicates that the subject is below the minimum age specified in the enterprise configuration. |
| resultcode.age.above.maximum | Indicates that the subject is above the maximum age specified in the enterprise configuration. |
| resultcode.multiple.records.found | Indicates that more than one record was found containing the same located address for the person, but one of the records contains a different SSN than the others. |
| resultcode.network.alert.ssn | Indicates that the input SSN9 was found on the Network Alert List. |
| resultcode.network.alert.address | Indicates that the input Address was found on the Network Alert List. |
| resultcode.network.alert.ip | Indicates that the input IP Address was found on the Network Alert List. |
| resultcode.network.alert.email | Indicates that the input email address was found on the Network Alert List. |
| resultcode.network.alert.phone | Indicates that the input phone number was found on the Network Alert List. |
| resultcode.network.alert.domain | Indicates that the input email domain was found on the Network Alert List. |
| resultcode.ip.state.does.not.match | Indicates that the located IP State does not match the located State for the customer. |
| resultcode.ip.invalid | Indicates that the IP address submitted does not fit the proper structure of an IP address and/or is found to be an unassigned IP address. This might also indicate that the IP address is a private or multicast address. |
| resultcode.ip.not.located | Indicates that the IP address could not be located within available data sources. |
| resultcode.high.risk.ip.bot | Indicates that the IP address is part of a network of computers infected with malware. |
| resultcode.high.risk.ip.spam | Indicates that the IP address is associated with a device infected with malware. |
| resultcode.high.risk.ip.tor | Indicates that the IP address is associated with a TOR network. |
| resultcode.ip.location.not.available | Indicates that the location of the IP address cannot be determined. |
| resultcode.low.risk | Triggered when the total ID Score is less than or equal to the value entered for the Low Risk threshold. |
| resultcode.medium.risk | Triggered when the total ID Score is between the values entered for the Low and High Risk threshold. |
| resultcode.high.risk | Triggered when the total ID Score is greater than or equal to the value entered for the High Risk threshold. |
| resultcode.email.domain.does.not.exist | The email address or domain does not exist. |
| resultcode.high.risk.email.recently.verified | The email address is high risk because it was only recently verified in our databases. |
| resultcode.high.risk.email.country | The email address is found to be from a country that is set as restricted within the Enterprise configuration. |
| resultcode.high.risk.email.fraud | The email address has been reported as fraud or is potentially fraudulent. |
| resultcode.high.risk.email.domain | The domain has been reported as fraud or is potentially fraudulent. |
| resultcode.invalid.email.address | The email address is invalid or does not have the proper syntax of an email address. |
Qualifiers Returned in Follow-up (Callback) API Response
| Qualifier | What it means |
|---|---|
| resultcode.scan.coppa.alert | Consumer is 13 or under. COPPA laws forbid conducting e-commerce with people under 14 years of age. |
| resultcode.scan.address.does.not.match | Address found does not match address submitted. |
| resultcode.scan.street.name.does.not.match | The submitted street name does not match the located data. This can be due to a typo in the input or the located data. |
| resultcode.scan.street.number.does.not.match | The submitted street number does not match the located data. This can be due to a typo in the input or the located data. |
| resultcode.scan.input.address.is.po.box | The input address is a PO box. This does not indicate any discrepancy between the input address and the located address. |
| resultcode.scan.warm.address.alert | This indicates that the located address is a warm address. Warm addresses are further clarified with the following values: • mail drop • hospital • hotel • prison |
| resultcode.scan.zip.does.not.match | ZIP code located does not match the ZIP code submitted. |
| resultcode.scan.country.does.not.match | The WorldWatch Plusuing country of the ID presented does not match the country submitted. |
| resultcode.scan.yob.does.not.match | The year of birth located does not match. If neither the month of birth nor the year of birth match, this ID Note is presented. |
| resultcode.scan.yob.within.one.year | Indicates a discrepancy between the YOB submitted and the YOB located of 1 year. |
| resultcode.scan.mob.does.not.match | Indicates a discrepancy between the month of birth submitted and the month of birth located. Only presented when the year of birth matches. |
| resultcode.scan.age.above.maximum | Indicates that the individual's DOB from their document exceeds the Maximum Age limit. |
| resultcode.scan.high.risk.address.alert | Identifies if the document address has a known history of fraud activity. |
| resultcode.scan.address.location.alert | A location-based alert that advices when the located ZIP code exceeds your enterprise's Permitted Distance Radius rule. |
| resultcode.scan.first.name.does.not.match | Indicates that the individual's first name on their ID does not match the first name provided in the input data. |
| resultcode.scan.last.name.does.not.match | Indicates that the individual's last name on their ID does not match the last name provided in the input data. |
| resultcode.scan.id.expired | Indicates the ID provided is expired. |
| resultcode.scan.id.number.does.not.match | Indicates the ID Number from the ID does not match the ID Number provided by the customer in the input data. |
| resultcode.scan.input.ssn.is.itin | Indicates the Input SSN is an ITIN (Individual Taxpayer Identification Number). |
| resultcode.scan.subject.deceased | Records indicate that the consumer in question is deceased. |
| resultcode.scan.state.does.not.match | This indicates the state located does not match the state input as part of the address. This is a specialized response that is only available if configured by WorldWatch Plus for your enterprise. |
| resultcode.scan.ssn.WorldWatch Plusued.prior.to.dob | This indicates the SSN number was WorldWatch Plusued before the individual's DOB, a serious fraud flag. |
| resultcode.scan.ssn.not.valid | The located SSN does not match the structure of a valid SSN. |
| resultcode.scan.age.below.minimum | Indicates that the consumer is below the minimum age specified in the enterprise configuration. |
| resultcode.scan.restricted.ip.proxy | Indicates an active anonymous proxy which the person may be using to deliberately hide their true location. |
| resultcode.scan.restricted.ip.country | The IP address is found to be from a country that is set as restricted within the enterprise configuration. |
| resultcode.scan.ip.location.alert | Indicates the IP address is not in the same state nor is it within proximity to the located address for the person. |
| resultcode.scan.ip.state.does.not.match | Indicates the located IP state does not match the located state for the customer. |
| resultcode.scan.ip.invalid | Indicates the IP address submitted does not fit the proper structure of an IP address and/or is found to be an unassigned IP address. |
| resultcode.scan.ip.not.located | Indicates the IP address could not be located within our data sources. |
| resultcode.scan.ip.location.not.available | Indicates the location of the IP address cannot be determined. |
| resultcode.scan.high.risk.ip.bot | Indicates that the IP address of a scan has a Very High Risk Score (ip-risk-score = >80,
ip-bot-score = >4) and may be associated with a bot. Note: GeoTrace must be enabled to enable this ID Note. |
| resultcode.scan.high.risk.ip.tor | Indicates that the IP address of a scan is associated with a TOR network. Note: GeoTrace must be enabled to enable this ID Note. |
| resultcode.scan.high.risk.ip.spam | Indicates that the IP address of a scan is associated with spam. Spam types include General
Spam,
Honeypot Spam, and Honeypot Dictionary Attack. Note: GeoTrace must be enabled to enable this ID Note. Sub notes will only appear if also enabled. |
| resultcode.scan.capture.face.compare.alert | Indicates that the customer's Face Compare Score is beneath the Facial Match Score allowed by the enterprise. |
| resultcode.scan.located.address.does.not.match | The address on the document is not a match to the address located for the consumer in public record. |
| resultcode.scan.located.street.number.does.not.match | The street number on the document is not a match to the street number located for the consumer in public record. |
| resultcode.scan.located.street.name.does.not.match | The street name on the document is not a match to the street name located for the consumer in public record. |
| resultcode.scan.located.state.does.not.match | The state on the document is not a match to the state located for the consumer in public record. |
| resultcode.scan.located.zip.does.not.match | The ZIP code on the document is not a match to the ZIP code located for the consumer in public record. |
| resultcode.scan.restricted.document.country | The document provided has originated from a country that is indicated as restricted in the Enterprise settings. |
| resultcode.scan.restricted.template.type | Indicates that the template type identified for the document provided is restricted in the Enterprise settings. |
Velocity Reference
Velocity Monitoring for KYC Screening is a powerful anti-fraud feature that can monitor either incoming or located identity attributes for recurrence, either for a single enterprise or across the Network. Monitors can be configured to detect recurring over a set time period and range within each day (e.g. midnight to 5am over a 90 day period). There is no limit to the number of velocity monitors allowed per enterprise.
Possible Results for Velocity
Example Initial Response with 2 Velocity Events:
{
"IdentityReport": {
"ErrorStatus": {
"Code": "0",
"Message": "Processed Normally"
},
"RequestDateTime": "2018-12-05 03:25:17Z",
"Identity": {
"IDNumber": "2182759247",
"SummaryResult": {
"Key": "id.success",
"Message": "PASS"
},
"Results": {
"Key": "result.match",
"Message": "ID Located"
},
"Qualifiers": {
"Qualifier": {
"Key": "resultcode.yob.does.not.match",
"Message": "YOB Does Not Match"
}
},
"VelocityResults": {
"VelocityResult": {
"Key": "ADDR",
"Message": "Velocity Warning - Address Only, 12 hours"
},
"VelocityResult": {
"Key": "NAME",
"Message": "Velocity Warning - Name and Address, 12 hours"
}
},
"IDScore": ""
},
"Risk": {
"SummaryResult": {
"QueriesWithResults": "2",
"CaseURL": "https://test.worldwatchplus.com/results?cid=2018112999990176194b9662876673eed",
"CaseID": "2018112999990176194b9662876673eed",
"CaseMatch": "4",
"CaseMatchDescription": "Name Only Matches Found",
"DOBExactMatch": "false",
"DOBMatch": "false",
"SubjectIdMatch": "false"
},
"Results": {
"Search": [
{
"SearchID": "1",
"SearchString": "John Smith",
"SearchType": "GOV",
"NameSource": "Provided",
"ResultsCount": "31",
"DOBExactMatch": "false",
"DOBMatch": "false",
"SubjectIdMatch": "false"
},
{
"SearchID": "2",
"SearchString": "John Smith",
"SearchType": "SOE",
"NameSource": "Provided",
"ResultsCount": "0",
"DOBExactMatch": "false",
"DOBMatch": "false",
"SubjectIdMatch": "false"
},
{
"SearchID": "3",
"SearchString": "John Smith",
"SearchType": "PEPD",
"NameSource": "Provided",
"ResultsCount": "25",
"DOBExactMatch": "false",
"DOBMatch": "false",
"SubjectIdMatch": "false"
}
]
}
},
"KBA": "",
"NotificationUrl": "https://test.worldwatchplus.com/identity/?referenceId=951d19e22f8d5a85b519d10c42ca31ef73d4100356a9f9999999999dc090db3b8aecc605b1d0755cffb1c8cf7ad0c82f189b527bd8a0fb39ff1ce6f22d4fcba58f330d78ba41e61044ebd1"
}
}
<IdentityReport>
<ErrorStatus>
<Code>0</Code>
<Message>Processed Normally</Message>
</ErrorStatus>
<RequestDateTime>2018-12-05 03:25:17Z</RequestDateTime>
<Identity>
<IDNumber>2182759247</IDNumber>
<SummaryResult>
<Key>id.success</Key>
<Message>PASS</Message>
</SummaryResult>
<Results>
<Key>result.match</Key>
<Message>ID Located</Message>
</Results>
<Qualifiers>
<Qualifier>
<Key>resultcode.yob.does.not.match</Key>
<Message>YOB Does Not Match</Message>
</Qualifier>
</Qualifiers>
<VelocityResults>
<VelocityResult>
<Key>ADDR</Key>
<Message>Velocity Warning - Address Only, 12 hours</Message>
</VelocityResult>
<VelocityResult>
<Key>NAME</Key>
<Message>Velocity Warning - Name and Address, 12 hours</Message>
</VelocityResult>
</VelocityResults>
<IDScore />
</Identity>
<Risk>
<SummaryResult>
<QueriesWithResults>2</QueriesWithResults>
<CaseURL>
https://test.worldwatchplus.com/results?cid=20181129999990176194b9662876673eed
</CaseURL>
<CaseID>20181129999990176194b9662876673eed</CaseID>
<CaseMatch>4</CaseMatch>
<CaseMatchDescription>
Name Only Matches Found
</CaseMatchDescription>
<DOBExactMatch>false</DOBExactMatch>
<DOBMatch>false</DOBMatch>
<SubjectIdMatch>false</SubjectIdMatch>
</SummaryResult>
<Results>
<Search>
<SearchID>1</SearchID>
<SearchString>John Smith</SearchString>
<SearchType>GOV</SearchType>
<NameSource>Provided</NameSource>
<ResultsCount>31</ResultsCount>
<DOBExactMatch>false</DOBExactMatch>
<DOBMatch>false</DOBMatch>
<SubjectIdMatch>false</SubjectIdMatch>
</Search >
<Search>
<SearchID>2</SearchID>
<SearchString>John Smith</SearchString>
<SearchType>SOE</SearchType>
<NameSource>Provided</NameSource>
<ResultsCount>0</ResultsCount>
<DOBExactMatch>false</DOBExactMatch>
<DOBMatch>false</DOBMatch>
<SubjectIdMatch>false</SubjectIdMatch>
</Search >
<Search>
<SearchID>3</SearchID>
<SearchString>John Smith</SearchString>
<SearchType>PEPD</SearchType>
<NameSource>Provided</NameSource>
<ResultsCount>25</ResultsCount>
<DOBExactMatch>false</DOBExactMatch>
<DOBMatch>false</DOBMatch>
<SubjectIdMatch>false</SubjectIdMatch>
</element>
</Search>
</Results>
</Risk>
<KBA />
<NotificationUrl>
https://test.worldwatchplus.com/identity/?referenceId=951d19e22f8d5a85b519d1999999999973d4100356a9f5e665b6a10dc090db3b8aecc605b1d0755cffb1c8cf7ad0c82f189b527bd8a0fb39ff1ce6f22d4fcba58f330d78ba41e61044ebd1
</NotificationUrl>
</IdentityReport>
| Result | What it means |
|---|---|
| NAME2 | A Velocity alert was triggered on Located First Name and Last Name per the Enterprise configuration. |
| LNAME4 | A Velocity alert was triggered on Located Last Name and SSN4 per the Enterprise configuration. |
| NAME | A Velocity alert was triggered on Located Last Name and Street Address per the Enterprise configuration. |
| NAME4 | A Velocity alert was triggered on Located Last Name and Street Address w/ SSN4 per the Enterprise configuration. |
| ADDR | A Velocity alert was triggered on Located Street Address per the Enterprise configuration. |
| STRNZIP | A Velocity alert was triggered on Located Street Name and ZIP Code per the Enterprise configuration. |
| ADDR4 | A Velocity alert was triggered on Located Street Address w/SSN4 per the Enterprise configuration. |
| PHONE | A Velocity alert was triggered on Located Phone Number per the Enterprise configuration. |
| SSN9 | A Velocity alert was triggered on Located SSN9 per the Enterprise configuration. |
| INAME2 | A Velocity alert was triggered on Input First Name and Last Name per the Enterprise configuration. |
| ILNAME4 | A Velocity alert was triggered on Input Last Name and SSN4 per the Enterprise configuration. |
| INAME | A Velocity alert was triggered on Input Last Name and Street Address per the Enterprise configuration. |
| INAME4 | A Velocity alert was triggered on Input Last Name and Street Address w/ SSN4 per the Enterprise configuration. |
| IADDR | A Velocity alert was triggered on Input Street Address per the Enterprise configuration. |
| IALTADDR | A Velocity alert was triggered on the Alternate Street Address per the Enterprise configuration. |
| ISTRNZIP | A Velocity alert was triggered on Input Street Name and ZIP Code per the Enterprise configuration. |
| IADDR4 | A Velocity alert was triggered on Input street address w/ SSN4 per the Enterprise configuration. |
| A Velocity alert was triggered on Input Email Address per the Enterprise configuration. | |
| IPHONE | A Velocity alert was triggered on Input Phone Number per the Enterprise configuration. |
| WorldWatch PlusN9 | A Velocity alert was triggered on Input SSN9 per the Enterprise configuration. |
| IIPADDR | A Velocity alert was triggered in Input IP Address per the Enterprise configuration. |
Document Template Types
If the document provided by the customer could be read by the service, then we will also return the document type and template type within the "TemplateType" response tag. The following template types may be returned in the response:
| Template Type | Definition |
|---|---|
| DL | (Driver’s License) Document permitting a person to drive a motor vehicle. |
| ID | (Identity Document) Document for individual that does not specify driving perissions to establish a person’s identity. These may be WorldWatch Plusued to individuals of any age, dependent on the requirements of the state the document is being WorldWatch Plusued in. |
| Passport | Document WorldWatch Plusued by a government, certifying the holder’s identity and citizenship and entitling them to travel under its protection to and from foreign countries. |
| Member | Document identifying holder as a member of a government entity, e.g. member of Queensland parliament. |
| Resident Permit | Document allowing a foreign national to reside in a country for a fixed or indefinite amount of time. |
| Visa | An endorsement on a passport that grants the holder official perission to enter, leave, or stay in a country for a specified time period. |
| DVLA | WorldWatch Plusuing authority of UK driver’s licenses – Driver and Vehicle Licensing Agency. |
| Not Set | The document could be read but the template type could not be specified. |
| Club | Document identifying holder as a member of an official organization. |
| Military | Document identification WorldWatch Plusued by the federal armed services indicating that the holder has served in the Military or Armed Forces. |
| Social Security | Document identifying an individual’s Social Security number. |
| Gun License | A permit from an authority to own a gun or carry one under specified conditions or purposes. |
| ID/DL | Document provided is a REAL ID, or Enhanced Driver’s License. |
| Travel Document | Identity document WorldWatch Plusued by a government to facilitate the movement of individuals or small groups of persons across international boundaries following international agreements. |
| Biometric Passport | Biometric Passport Passport with embedded chip containing biometric information that can be used to authenticate the identity of the passport holder. |
| Biometric ID | ID with embedded chip containing biometric information that can be used to authenticate the identity of the ID holder. |
| Photo Card | Identification card that includes a photograph of the holder. |
| Unified Multi-Purpose ID | Philippine identity card developed as a single card for the relations between several government agencies. |
| Professional Regulation Comission | Philippine identity document used to identify a PRC-registered professional or representative. |
| Sex Offender | Document identifying holder on the sex offender registry for the WorldWatch Plusuing government. |
VerifyDocumentReport Method
| PURPOSE: | Perform "forensic" level of authentication for photo-IDs in which approximately 20-40 tests are performed to authenticate the document based on image resolution and specific indicators found on the front and back. The results of these individual tests are combined into a single overall result, which can then provide an indicator that the document may be fraudulent. Currently, over 3,400 different types of photo-IDs can be verified from around the globe. |
Request Summary
Request parameters must be submitted as properly formed JSON or XML as specified in the API call and passed as the payload to this method. Results will be returned in the same format.
The request parameters for this method can be summarized as follows:
| 1. | Sender | Your Partner ID and Account identification | Required |
| 2. | Request | Details and Document data for verification | Required |
API Endpoint
Test Environment:
https://test.worldwatchplus.com/api/verifydocumentreport?format={xml|json}
Production - Due Diligence (DD) – for most clients: https://dd.worldwatchplus.com/api/verifydocumentreport?format={xml|json}
Production - Credit Reporting Agencies (CRA) – for background screening companies:
https://cra.worldwatchplus.com/api/verifydocumentreport?format={xml|json}
Production - European Union (EU) – for clients servicing EU member countries: https://eu.worldwatchplus.com/api/verifydocumentreport?format={xml|json}
Example VerifyDocumentReport Request:
{
"VerifyDocumentReport": {
"Sender": {
"PartnerID": "bc8934d999993de97b594ceb7436716c",
"AccountID": "999902",
"ReferenceID": "2392389"
},
"Request": {
"DocumentFrontImage": "Base64 encoded byte stream",
"DocumentBackImage": "Base64 encoded byte stream",
"Sensitivity": "normal",
}
}
}
<VerifyDocumentReport>
<Sender>
<PartnerID>bc8934d999993de97b594ceb7436716c</PartnerID>
<AccountID>999902</AccountID>
<ReferenceID>2392389</ReferenceID>
</Sender>
<Request>
<DocumentFrontImage>Base64 encoded byte stream</DocumentFrontImage>
<DocumentBackImage>Base64 encoded byte stream</DocumentBackImage>
<Sensitivity>normal</Sensitivity>
</Request>
</VerifyDocumentReport>
Specific Request Parameters
| Parameter | Description |
|---|---|
| Sender | |
| Sender.PartnerID | RequiredYour Partner ID assigned by WorldWatch Plus (35) |
| Sender.AccountID | RequiredYour Account Code that must be assigned and enabled by WorldWatch Plus (6) |
| Sender.ReferenceID | OptionalYour Internal Transaction Reference ID for this specific request (50). Use this to be able to cross reference cases/transactions between platforms. |
| Request | |
| Request.DocumentFrontImage | RequiredFront image of document to be verified (as Base64 encoded byte stream) |
| Request.DocumentBackImage | RequiredBack image of document to be verified (as Base64 encoded byte stream) |
| Request.Sensitivity | RequiredYou can set the authentication sensitivity to low, normal (default), or high depending on your business rules. Using a Low sensitivity may result in a lower false reject rate where authentic documents are flagged as suspect, but it can also increase the false acceptance rate (the number of fraudulent documents that passed authentication). The High sensitivity level will result in a higher false reject rate, but will have a lower false acceptance rate. In general, we recommend using the Normal setting. |
Response Summary
The initial response will be returned in the same data format (JSON or XML) specified when the API call was made. It is organized as follows:
| 1. | Error Status | Input Error Feedback |
| 2. | Unique Session ID | Unique session identifer for this transaction |
| 3. | Notification URL | Link to Document and Facial Verification for Client |
Example Response:
{
"VerificationReport": {
"RequestDateTime": "2020-08-14 05:46:57",
"ReviewRequired": true,
"Alerts": {
"VisiblePattern": {
"Actions": "Check the visible (white) document image to verify the presence of the security feature. Possible reasons this test may fail for a valid document may be that the document was moving during the capture, or the document may be excessively worn or damaged.",
"DataFieldReferences": [],
"Description": "Verified the presence of a pattern on the visible image.",
"Disposition": "A visible pattern was found",
"FieldReferences": [],
"Id": "2d536487-b3f1-42df-9cc0-b1eb1a4ec84e",
"ImageReferences": [],
"Information": "Verified that a security feature in the visible spectrum is present and in an expected location on the document.",
"Key": "Visible Pattern",
"Name": "Visible Pattern",
"RegionReferences": {
"Zero": "89cec905-dab9-4c9d-b601-9bcd2e89c768"
},
"Result": 1
},
"ImageTamperingCheck": {
"Actions": "Examine the data regions of the document for any visible indications that the data has been digitally manipulated. Request a new image, if possible, to repeat the test.",
"DataFieldReferences": [],
"Description": "Examines a document image for evidence of tampering or digital manipulation.",
"Disposition": "Evidence suggests the image has been tampered with or digitally manipulated.",
"FieldReferences": [],
"Id": "7a65c1d8-1ff7-469a-894b-e77c8ee7529a",
"ImageReferences": [],
"Information": "Tested the document image for evidence of tampering or digital manipulation.",
"Key": "Image Tampering Check",
"Name": "Image Tampering Check",
"RegionReferences": [],
"Result": 2
},
"BirthDateCrosscheck": {
"Actions": "The birth date field on the document may have been misread due to dirt or wear. Confirm that the data from all visible sources match and are free of obstruction.",
"DataFieldReferences": {
"Zero": "aa05129e-f5da-4eb0-81ab-e9691266d2ce",
"One": "a459a169-7cc5-4c62-8986-bbb36acdd3ea"
},
"Description": "Compare the machine-readable birth date field to the human-readable birth date field.",
"Disposition": "The birth dates do not match",
"FieldReferences": [],
"Id": "bd098bc4-0b30-4988-9e75-7dd356f45ded",
"ImageReferences": [],
"Information": "The birth date is present in multiple locations on this document (e.g., visual, 2D barcode, magnetic stripe, contactless smart card). This test compares this field between two or more of these sources to verify that they match.",
"Key": "Birth Date Crosscheck",
"Name": "Birth Date Crosscheck",
"RegionReferences": [],
"Result": 4
},
"BirthDateCheckDigit": {
"Actions": "The birth date check digit or birth date elements within the machine readable zone on the document may have been misread due to dirt or wear. Confirm that the machine readable zone is legible, and if applicable, update it to the actual value in your application if it was not correctly read.",
"DataFieldReferences": {
"Zero": "ed6f398a-4642-4824-9c79-2e2546c40e76"
},
"Description": "Verified that the birth date check digit is correct.",
"Disposition": "The birth date check digit is correct",
"FieldReferences": [],
"Id": "003cb1f8-c8d4-47d5-8a27-4dbc2e824e64",
"ImageReferences": [],
"Information": "Check digits are used in the machine readable zone (MRZ) to provide verification that the data is correctly interpreted. This test validates the visible birth date check digit by comparing it with a calculated check digit from the visible birth date element.",
"Key": "Birth Date Check Digit",
"Name": "Birth Date Check Digit",
"RegionReferences": [],
"Result": 1
},
"BirthDateValid": {
"Actions": "The birth date on the document may have been misread. Confirm that it is legible.",
"DataFieldReferences": [],
"Description": "Verified that the birth date is valid.",
"Disposition": "The birth date is valid",
"FieldReferences": {
"Zero": "73610bba-3626-4c99-992d-85c2b5b70557"
},
"Id": "13f9e735-a798-4c4d-8a57-6360e29e6c83",
"ImageReferences": [],
"Information": "Verified that the birth date is valid, in the expected format, and occurs on or before the current date and not outside a reasonable range.",
"Key": "Birth Date Valid",
"Name": "Birth Date Valid",
"RegionReferences": [],
"Result": 1
},
"CompositeCheckDigit": {
"Actions": "The composite check digit, document number, birth date or expiration date elements within the machine readable zone on the document may have been misread due to dirt or wear. Confirm that the machine readable zone is legible, and if applicable, update it to the actual value in your application if it was not correctly read.",
"DataFieldReferences": {
"Zero": "ed6f398a-4642-4824-9c79-2e2546c40e76"
},
"Description": "Verified that the composite check digit is correct.",
"Disposition": "The composite check digit is correct",
"FieldReferences": [],
"Id": "29848d29-b62e-46f5-b7e1-cbea6c727f21",
"ImageReferences": [],
"Information": "Check digits are used in the machine readable zone (MRZ) to provide verification that the data is correctly interpreted. This test validates the visible composite check digit by comparing it with a calculated check digit from the document number, birth date and expiration date elements.",
"Key": "Composite Check Digit",
"Name": "Composite Check Digit",
"RegionReferences": [],
"Result": 1
},
"DocumentClassification": {
"Actions": "This test may fail if a document cannot be successfully classified as a supported document type. This may occur if the document is fraudulent as some fraudulent documents differ so much from authentic documents that they will not be recognized as that type of document. This may also occur if a valid document is significantly worn or damaged or if the document is of a new or different type that is not yet supported by the library. The document should be examined manually.",
"DataFieldReferences": [],
"Description": "Verified that the type of document is supported and is able to be fully authenticated.",
"Disposition": "The document type is supported",
"FieldReferences": [],
"Id": "72ed6389-e191-437e-afd6-27769c17ba7d",
"ImageReferences": [],
"Information": "Verified that the document is recognized as a supported document type and that the type of document can be fully authenticated.",
"Key": "Document Classification",
"Name": "Document Classification",
"RegionReferences": [],
"Result": 1
},
"DocumentCrosscheckAggregation": {
"Actions": "Several crosschecks are failing. Confirm that the data from all visible sources match and are free of obstruction.",
"DataFieldReferences": {
"Zero": "a459a169-7cc5-4c62-8986-bbb36acdd3ea"
},
"Description": "Compared the machine-readable fields to the human-readable fields.",
"Disposition": "There are not a large number of differences between electronic and human-readable data sources",
"FieldReferences": [],
"Id": "dc84a78f-fef1-42b1-bf1c-c644cced5321",
"ImageReferences": [],
"Information": "There are multiple sources of data on the document. This test verifies that there are not widespread differences in data between data sources, which can indicate a fake or tampered document.",
"Key": "Document Crosscheck Aggregation",
"Name": "Document Crosscheck Aggregation",
"RegionReferences": [],
"Result": 1
},
"DocumentExpired": {
"Actions": "The expiration date on the document may have been misread. Confirm that it is legible and occurs on or after the current date. Also confirm that the current date and time of the host computer is correctly set.",
"DataFieldReferences": [],
"Description": "Checked if the document is expired.",
"Disposition": "The document has not expired",
"FieldReferences": {
"Zero": "d8352a2c-70e5-4458-be8c-d5b87ba3fbea"
},
"Id": "4c67bc77-ab3a-4897-827b-138b2d64524e",
"ImageReferences": [],
"Information": "Verified that the document expiration date does not occur before the current date.",
"Key": "Document Expired",
"Name": "Document Expired",
"RegionReferences": [],
"Result": 1
},
"DocumentNumberCheckDigit": {
"Actions": "The document number check digit or document number elements within the machine readable zone on the document may have been misread due to dirt or wear. Confirm that the machine readable zone is legible, and if applicable, update it to the actual value in your application if it was not correctly read.",
"DataFieldReferences": {
"Zero": "ed6f398a-4642-4824-9c79-2e2546c40e76"
},
"Description": "Verified that the document number check digit is correct.",
"Disposition": "The document number check digit is correct",
"FieldReferences": [],
"Id": "833b4bed-d21d-4008-902d-ddaab63cbfc9",
"ImageReferences": [],
"Information": "Check digits are used in the machine readable zone (MRZ) to provide verification that the data is correctly interpreted. This test validates the visible document number check digit by comparing it with a calculated check digit from the visible document number element.",
"Key": "Document Number Check Digit",
"Name": "Document Number Check Digit",
"RegionReferences": [],
"Result": 1
},
"DocumentNumberCrosscheck": {
"Actions": "The document number field on the document may have been misread due to dirt or wear. Confirm that the data from all visible sources match and are free of obstructions.",
"DataFieldReferences": {
"Zero": "b304abd8-2c29-43bc-b075-83b8de90f587",
"One": "6ba152a0-5cfb-48d4-be58-727c597fd4d2"
},
"Description": "Compare the machine-readable document number field to the human-readable document number field.",
"Disposition": "The document numbers match",
"FieldReferences": [],
"Id": "a7db4940-0642-439d-ae6e-3d27d2c83618",
"ImageReferences": [],
"Information": "The document number is present in multiple locations on this document (e.g., visual, 2D barcode, magnetic stripe, contactless smart card). This test compares this field between two or more of these sources to verify that they match.",
"Key": "Document Number Crosscheck",
"Name": "Document Number Crosscheck",
"RegionReferences": [],
"Result": 1
},
"ExpirationDateCheckDigit": {
"Actions": "The expiration date check digit or expiration date elements within the machine readable zone on the document may have been misread due to dirt or wear. Confirm that the machine readable zone is legible, and if applicable, update it to the actual value in your application if it was not correctly read.",
"DataFieldReferences": {
"Zero": "ed6f398a-4642-4824-9c79-2e2546c40e76"
},
"Description": "Verified that the expiration date check digit is correct.",
"Disposition": "The expiration date check digit is correct",
"FieldReferences": [],
"Id": "790c8e10-2a60-4c58-8641-f1862bc8abf3",
"ImageReferences": [],
"Information": "Check digits are used in the machine readable zone (MRZ) to provide verification that the data is correctly interpreted. This test validates the visible expiration date check digit by comparing it with a calculated check digit from the visible expiration date element.",
"Key": "Expiration Date Check Digit",
"Name": "Expiration Date Check Digit",
"RegionReferences": [],
"Result": 1
},
"ExpirationDateCrosscheck": {
"Actions": "The expiration date field on the document may have been misread due to dirt or wear. Confirm that the data from all visible sources match and are free of obstruction.",
"DataFieldReferences": {
"Zero": "63eb00ad-79af-4417-8282-51a51558ea36",
"One": "ae6d7043-2dda-4af2-b434-b9428dee2603"
},
"Description": "Compare the machine-readable expiration date field to the human-readable expiration date field.",
"Disposition": "The expiration dates match",
"FieldReferences": [],
"Id": "82761d7b-f2fc-44ab-806f-13f68c260450",
"ImageReferences": [],
"Information": "The expiration date is present in multiple locations on this document (e.g., visual, 2D barcode, magnetic stripe, contactless smart card). This test compares this field between two or more of these sources to verify that they match.",
"Key": "Expiration Date Crosscheck",
"Name": "Expiration Date Crosscheck",
"RegionReferences": [],
"Result": 1
},
"ExpirationDateValid": {
"Actions": "The expiration date on the document may have been misread. Confirm that it is legible and occurs after the issue and birth dates.",
"DataFieldReferences": [],
"Description": "Verified that the expiration date is valid.",
"Disposition": "The expiration date is valid",
"FieldReferences": {
"Zero": "d8352a2c-70e5-4458-be8c-d5b87ba3fbea"
},
"Id": "0a779c60-6515-46d6-b82b-4c170d177a72",
"ImageReferences": [],
"Information": "Verified that the document expiration date is valid, in the expected format, and occurs after the issue and birth dates.",
"Key": "Expiration Date Valid",
"Name": "Expiration Date Valid",
"RegionReferences": [],
"Result": 1
},
"FullNameCrosscheck": {
"Actions": "The given name and\/or surname fields on the document may have been misread due to dirt or wear. Confirm that the data from all visible sources match and are free of obstructions.",
"DataFieldReferences": {
"Zero": "5bfa7473-6ac3-4712-aaf0-bb07eefd4a06",
"One": "5ee466d5-d1f7-4d18-92d6-80b9a2f36a0a"
},
"Description": "Compare the machine-readable full name field to the human-readable full name field.",
"Disposition": "The full names match",
"FieldReferences": [],
"Id": "2b28f2dd-3a9a-4a57-abf9-d7bf24a49adf",
"ImageReferences": [],
"Information": "The full name is composed of the given name and the surname. These items are present in multiple locations on this document (e.g., visual, 2D barcode, magnetic stripe, contactless smart card). This test compares this field between two or more of these sources to verify that they match.",
"Key": "Full Name Crosscheck",
"Name": "Full Name Crosscheck",
"RegionReferences": [],
"Result": 1
},
"IssuingStateValid": {
"Actions": "The issuing state code on the document may have been misread. Confirm that it is legible and is from a valid country or state.",
"DataFieldReferences": {
"Zero": "0d993baa-603f-4924-9729-c9c7b140cccd"
},
"Description": "Verified that the issuing state is valid.",
"Disposition": "The issuing state is valid",
"FieldReferences": [],
"Id": "58b53000-1d42-48f5-82e6-241e75451550",
"ImageReferences": [],
"Information": "Verified that the issuing state code is valid by ensuring it appears in the list of standard state codes.",
"Key": "Issuing State Valid",
"Name": "Issuing State Valid",
"RegionReferences": [],
"Result": 1
},
"PersonalNumberCheckDigit": {
"Actions": "The personal number check digit or personal number elements within the machine readable zone on the document may have been misread due to dirt or wear. Confirm that the machine readable zone is legible, and if applicable, update it to the actual value in your application if it was not correctly read.",
"DataFieldReferences": {
"Zero": "ed6f398a-4642-4824-9c79-2e2546c40e76"
},
"Description": "Verified that the personal number check digit is correct.",
"Disposition": "The personal number check digit is correct",
"FieldReferences": [],
"Id": "2bdeb17a-128e-40e7-b783-de78bea58d4f",
"ImageReferences": [],
"Information": "Check digits are used in the machine readable zone (MRZ) to provide verification that the data is correctly interpreted. This test validates the visible personal number check digit by comparing it with a calculated check digit from the visible personal number element.",
"Key": "Personal Number Check Digit",
"Name": "Personal Number Check Digit",
"RegionReferences": [],
"Result": 1
},
"SexCrosscheck": {
"Actions": "The sex field on the document may have been misread due to dirt or wear. Confirm that the data from all visible sources match and are free of obstruction.",
"DataFieldReferences": {
"Zero": "f65e6984-2004-4de1-8ddc-1cd267d68a0c",
"One": "22e3d6b3-c67d-4e11-97cf-327447bb9c17"
},
"Description": "Compare the machine-readable sex field to the human-readable sex field.",
"Disposition": "The sexes match",
"FieldReferences": [],
"Id": "bbd02b17-af28-4343-9690-d4f26cd3f11d",
"ImageReferences": [],
"Information": "The sex field is present in multiple locations on this document (e.g., visual, 2D barcode, magnetic stripe, contactless smart card). This test compares this field between two or more of these sources to verify that they match.",
"Key": "Sex Crosscheck",
"Name": "Sex Crosscheck",
"RegionReferences": [],
"Result": 1
},
"VisiblePhotoCharacteristics": {
"Actions": "If the test fails, check to make sure that the photo area is not obscured and that the photo has not been altered or replaced.",
"DataFieldReferences": [],
"Description": "Verifies the visible characteristics of the Photo",
"Disposition": "The photo has the expected appearance",
"FieldReferences": [],
"Id": "3b902c55-920a-4cc3-acb4-51b189551f4b",
"ImageReferences": [],
"Information": "Verifies that the general appearance of photo on the document is as expected. This test may be used to verify that the photo has not been obscured or replaced in any way. ",
"Key": "Visible Photo Characteristics",
"Name": "Visible Photo Characteristics",
"RegionReferences": {
"Zero": "33a8ff0d-b4ce-4bae-b610-617655ef8b1a"
},
"Result": 1
}
},
"Classification": {
"Type": {
"Class": 1,
"ClassCode": "P",
"ClassName": "Passport",
"CountryCode": "USA",
"Id": "7b4266f2-df17-45e9-a0e3-ba8d6880850c",
"IsGeneric": false,
"Issue": "2006",
"IssueType": "ePassport",
"IssuerCode": "USA",
"IssuerName": "United States",
"IssuerType": 1,
"KeesingCode": "USA_P8",
"Name": "United States (USA) ePassport",
"Size": 3
}
},
"Identity": {
"BirthDate": {
"DataFieldReferences": {
"Zero": "aa05129e-f5da-4eb0-81ab-e9691266d2ce",
"One": "a459a169-7cc5-4c62-8986-bbb36acdd3ea"
},
"DataSource": 4,
"Description": "The person's date of birth",
"Id": "73610bba-3626-4c99-992d-85c2b5b70557",
"IsImage": false,
"Key": "Birth Date",
"Name": "Birth Date",
"RegionReference": "00000000-0000-0000-0000-000000000000",
"Type": "datetime",
"Value": "\/Date(-128736000000)\/"
},
"BirthPlace": {
"DataFieldReferences": {
"Zero": "6b081a0d-fd69-4f1c-ba4c-425b560e0610"
},
"DataSource": 6,
"Description": "The person's place of birth",
"Id": "1f1322ea-ab71-45b6-ab76-b09427d2fdf4",
"IsImage": false,
"Key": "Birth Place",
"Name": "Birth Place",
"RegionReference": "00000000-0000-0000-0000-000000000000",
"Type": "string",
"Value": "NEW YORK, U.S.A."
},
"DocumentClassCode": {
"DataFieldReferences": {
"Zero": "306f9c08-38f0-4bde-a3e6-369fda50b44e"
},
"DataSource": 7,
"Description": "Class code extracted from the MRZ on the document that indicates the document type",
"Id": "06d07a18-8b15-489c-8a58-639af019ea85",
"IsImage": false,
"Key": "Document Class Code",
"Name": "Document Class Code",
"RegionReference": "00000000-0000-0000-0000-000000000000",
"Type": "string",
"Value": "P"
},
"DocumentClassName": {
"DataFieldReferences": [],
"DataSource": 7,
"Description": "The localized version of the document class of the document type",
"Id": "f945878d-0d86-419f-bc15-b39968cd0584",
"IsImage": false,
"Key": "Document Class Name",
"Name": "Document Class Name",
"RegionReference": "00000000-0000-0000-0000-000000000000",
"Type": "string",
"Value": "Passport"
},
"DocumentNumber": {
"DataFieldReferences": {
"Zero": "b304abd8-2c29-43bc-b075-83b8de90f587",
"One": "6ba152a0-5cfb-48d4-be58-727c597fd4d2"
},
"DataSource": 4,
"Description": "A number that identifies a document",
"Id": "ee1acc2a-5ba4-4e7e-ac1e-20d36d3b53cf",
"IsImage": false,
"Key": "Document Number",
"Name": "Document Number",
"RegionReference": "00000000-0000-0000-0000-000000000000",
"Type": "string",
"Value": "511715007"
},
"DocumentSeries": {
"DataFieldReferences": {
"Zero": "ed6f398a-4642-4824-9c79-2e2546c40e76"
},
"DataSource": 4,
"Description": "",
"Id": "0469df3a-b2d7-4b8c-add4-7e84dff784a5",
"IsImage": false,
"Key": "Document Series",
"Name": "Document Series",
"RegionReference": "00000000-0000-0000-0000-000000000000",
"Type": "string",
"Value": "51"
},
"ExpirationDate": {
"DataFieldReferences": {
"Zero": "63eb00ad-79af-4417-8282-51a51558ea36",
"One": "ae6d7043-2dda-4af2-b434-b9428dee2603"
},
"DataSource": 4,
"Description": "Date that the document will expire",
"Id": "d8352a2c-70e5-4458-be8c-d5b87ba3fbea",
"IsImage": false,
"Key": "Expiration Date",
"Name": "Expiration Date",
"RegionReference": "00000000-0000-0000-0000-000000000000",
"Type": "datetime",
"Value": "2023-08-15"
},
"FirstName": {
"DataFieldReferences": {
"Zero": "5bfa7473-6ac3-4712-aaf0-bb07eefd4a06"
},
"DataSource": 4,
"Description": "The person's first name",
"Id": "fac70e7d-aeb6-40a5-bb8d-2f98262e7dec",
"IsImage": false,
"Key": "First Name",
"Name": "First Name",
"RegionReference": "00000000-0000-0000-0000-000000000000",
"Type": "string",
"Value": "JAMES"
},
"FullName": {
"DataFieldReferences": {
"Zero": "5bfa7473-6ac3-4712-aaf0-bb07eefd4a06",
"One": "5ee466d5-d1f7-4d18-92d6-80b9a2f36a0a"
},
"DataSource": 4,
"Description": "The person's full name (given name plus surname)",
"Id": "28c8446e-80a8-469d-9f2e-5556dc12b5c8",
"IsImage": false,
"Key": "Full Name",
"Name": "Full Name",
"RegionReference": "00000000-0000-0000-0000-000000000000",
"Type": "string",
"Value": "JOHN AMOS DOE"
},
"GivenName": {
"DataFieldReferences": {
"Zero": "d64bc29f-a391-412b-bfe4-7a61f3408c4a",
"One": "fbe8dee9-fd72-490f-8983-e13ef96708ba"
},
"DataSource": 4,
"Description": "The person's given name",
"Id": "c9b5de27-afc8-48d1-acda-59e9a6303296",
"IsImage": false,
"Key": "Given Name",
"Name": "Given Name",
"RegionReference": "00000000-0000-0000-0000-000000000000",
"Type": "string",
"Value": "JOHN AMOS"
},
"IssueDate": {
"DataFieldReferences": {
"Zero": "372fcaaa-25ca-4d6a-a593-36c31fd76934"
},
"DataSource": 6,
"Description": "Date that the document was issued",
"Id": "5876f0ba-288d-4c0e-8a26-adc96f78c43f",
"IsImage": false,
"Key": "Issue Date",
"Name": "Issue Date",
"RegionReference": "00000000-0000-0000-0000-000000000000",
"Type": "datetime",
"Value": "16Auq20l3"
},
"IssuingAuthority": {
"DataFieldReferences": {
"Zero": "f0293842-d003-48c8-a696-1de3cb28e09a"
},
"DataSource": 6,
"Description": "Authority that issued the document",
"Id": "75e44884-8798-4db1-8695-383b5d644763",
"IsImage": false,
"Key": "Issuing Authority",
"Name": "Issuing Authority",
"RegionReference": "00000000-0000-0000-0000-000000000000",
"Type": "string",
"Value": "United States Department of State"
},
"IssuingStateCode": {
"DataFieldReferences": {
"Zero": "7f8d7c05-193e-4be1-b472-e21275e72804"
},
"DataSource": 7,
"Description": "Abbreviated ID code of the state or country that issued the document",
"Id": "b4d387d0-cca1-407c-b889-6b84bedadf57",
"IsImage": false,
"Key": "Issuing State Code",
"Name": "Issuing State Code",
"RegionReference": "00000000-0000-0000-0000-000000000000",
"Type": "string",
"Value": "USA"
},
"IssuingStateName": {
"DataFieldReferences": {
"Zero": "583e223e-35bb-4000-9f58-baa31d8bbb58"
},
"DataSource": 7,
"Description": "Full name of the state or country that issued the document",
"Id": "2ca1f0bd-faf0-485a-99d8-35ec136badf6",
"IsImage": false,
"Key": "Issuing State Name",
"Name": "Issuing State Name",
"RegionReference": "00000000-0000-0000-0000-000000000000",
"Type": "string",
"Value": "United States"
},
"MiddleName": {
"DataFieldReferences": {
"Zero": "5bfa7473-6ac3-4712-aaf0-bb07eefd4a06"
},
"DataSource": 4,
"Description": "The person's middle name",
"Id": "81de1fc7-9f0c-4b8c-b62f-96d5f6110e20",
"IsImage": false,
"Key": "Middle Name",
"Name": "Middle Name",
"RegionReference": "00000000-0000-0000-0000-000000000000",
"Type": "string",
"Value": "AMOS"
},
"MRZ": {
"DataFieldReferences": {
"Zero": "2faf63f7-70da-4ccd-aac9-a97253460be1"
},
"DataSource": 4,
"Description": "Text extracted from the machine-readable zone (MRZ) of the document",
"Id": "13931919-6940-41c0-ab2a-963322920fec",
"IsImage": false,
"Key": "MRZ",
"Name": "MRZ",
"RegionReference": "00000000-0000-0000-0000-000000000000",
"Type": "string",
"Value": "P
See JSON
Response Elements
| Element | Description |
|---|---|
| ErrorStatus | |
| ErrorStatus.Code | 0 = Normal Processing See "Error Status Response Codes" |
| ErrorStatus.Message | Descriptive message associated with Code (100) |
| MORE COMING SOON | |
Error Status Response Codes
VerifyDocumentReport Error Status Response Codes:
| Code | Message |
|---|---|
| 0 | Normal Processing |
GetMRZValidation Method
| PURPOSE: | Validates a specified Passport or Visa MRZ code via WorldWatch Plus and returns the summary and detailed results. This is an MRZ code validation only which includes checksum verification and data extraction as well as checking document expiration date. |
Request Summary
Request parameters must be submitted as properly formed XML as specified in the API call and passed as the payload to this method. Results will be returned in the same format.
The request parameters for this method can be summarized as follows:
| 1. | Sender | Your Partner ID and Account identification | Required |
| 2. | Request | Details and MRZ data for validation | Required |
API Endpoint
Test Environment:
https://test.worldwatchplus.com/api/getmrzvalidation.php
Production - Due Diligence (DD) – for most clients: https://dd.worldwatchplus.com/api/getmrzvalidation.php
Production - Credit Reporting Agencies (CRA) – for background screening companies:
https://cra.worldwatchplus.com/api/getmrzvalidation.php
Production - European Union (EU) – for clients servicing EU member countries: https://eu.worldwatchplus.com/api/getmrzvalidation.php
Example GetMRZVerification:
See XML
<GetMRZValidation>
<Receiver>
<ReceiverID>INTLSOL</ReceiverID>
<VersionID>1.50</VersionID>
<EnvironmentCode>Test</EnvironmentCode>
</Receiver>
<Sender/>
<PartnerID>bc893eidhc873de979xcjhrhb743der6c</PartnerID>
<AccountID>123456</AccountID>
<AccountingCode />
<ReferenceID />
<FCRA>0</FCRA>
</Sender>
<Request>
<ValidationType>P</ValidationType>
<MRZLine1><![CDATA[P<SWESPECIMEN<<SVEN<<<<<<<<<<<<<<<<<<<<<<<<<]]></MRZLine1>
<MRZLine2><![CDATA[59000001<5SWE8703145M1701027198703142391<<46]]></MRZLine2>
</Request>
</GetMRZValidation>
Specific Request Parameters
| Parameter | Description |
|---|---|
| Sender | |
| Sender.PartnerID | RequiredYour Partner ID assigned by WorldWatch Plus (35) |
| Sender.AccountID | RequiredYour Account Code that must be assigned and enabled by WorldWatch Plus (6) |
| Sender.AccountingCode | OptionalYour Accounting, Reporting, or Organizational Unit Code for Internal tracking (100) |
| Sender.ReferenceID | OptionalYour Internal Transaction Reference ID for this specific request (50). Use this to be able to cross reference cases/transactions between platforms. |
| Sender.FCRA | RequiredIdentifies if purpose of this transaction is governed by FCRA guidelines (True or False) Must be correctly identified for the specific platform. |
| Request | |
| Request.ValidationType | Required
0 = Passport 1 = Visa |
| Request.MRZLine1 | OptionalLine 1 of MRZ Code |
| Request.MRZLine2 | RequiredLine 2 of MRZ Code |
Response Summary
The initial response will be returned in XML format and organized as follows:
| 1. | Error Status | Input Error Feedback |
| 2. | Summary | Summary MRZ Validation Results |
| 3. | Results | Detailed MRZ Validation Results |
Example Response:
See XML
<MRZValidation>
<ErrorStatus>
<Code>0</Code>
<Message>Processed Normally</Message>
</ErrorStatus>
<Summary>
<RequestDateTime>2020-08-13 22:21:03Z</RequestDateTime>
<ProcessingTime>0.002680</ProcessingTime>
</Summary>
<Results>
<FullMRZ>
<![CDATA[P<SWESPECIMEN<<SVEN<<<<<<<<<<<<<<<<<<<<<<<<< 59000001<5SWE8703145M1701027198703142391<<46]]>
</FullMRZ>
<MRZType>Passport</MRZType>
<ResultCode>80</ResultCode>
<ResultText>Invalid - Expired</ResultText>
<ResultDetails>
<![CDATA[<table class="mrzdata"><tr><td>Document Type: </td><td><strong>PASSPORT</strong> </td></tr><tr><td>Issuing State/Organization: </td><td><strong>SWE SWEDEN</strong> </td></tr><tr><td>Name: </td><td><strong>SPECIMEN SVEN</strong> </td></tr><tr><td>Passport Number: </td><td><strong>59000001</strong> </td></tr><tr><td>Nationality: </td><td><strong>SWE</strong> </td></tr><tr><td>Date of Birth: </td><td><strong>03/14/87</strong> </td></tr><tr><td>Gender: </td><td><strong>M</strong> </td></tr><tr><td>Expiration Date: </td><td><strong>01/02/17</strong> </td></tr><tr><td>Passport Expiration Check: </td><td><font color="red"><strong>EXPIRED</strong></font> </td></tr><tr><td>Personal Number: </td><td><strong>198703142391 </strong> </td></tr></table>]]>
</ResultDetails>
<ResultDetailsXML>
<MRZData>
<MRZ1LengthCheck>PASS</MRZ1LengthCheck>
<DocumentType>PASSPORT</DocumentType>
<IssuingStateOrg>SWE</IssuingStateOrg>
<IssuingStateOrgName>SWEDEN</IssuingStateOrgName>
<Name>SPECIMEN SVEN</Name>
<MRZ2LengthCheck>PASS</MRZ2LengthCheck>
<PassportNumber>59000001</PassportNumber>
<ControlDigit1Check>PASS</ControlDigit1Check>
<Nationality>SWE</Nationality>
<DOB>870314</DOB>
<ControlDigit2Check>PASS</ControlDigit2Check>
<Gender>M</Gender>
<ExpirationDate>170102</ExpirationDate>
<ExpirationCheck>FAIL</ExpirationCheck>
<ControlDigit3Check>PASS</ControlDigit3Check>
<PersonalNumber>198703142391</PersonalNumber>
<ControlDigit4Check>PASS</ControlDigit4Check>
<ControlDigit5Check>PASS</ControlDigit5Check>
<ResultText>Invalid - Expired</ResultText>
</MRZData>
</ResultDetailsXML>
</Results>
</MRZValidation>
Response Elements
| Element | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ErrorStatus | |||||||||||||||||||||
| ErrorStatus.Code | 0 = Normal Processing 99 = Invalid Credentials |
||||||||||||||||||||
| ErrorStatus.Message | Descriptive message associated with Code (100) | ||||||||||||||||||||
| Summary | |||||||||||||||||||||
| Summary.RequestDateTime | Date/Time Stamp of Request (UTC) (ISO 8601 format) | ||||||||||||||||||||
| Summary.ProcessingTime | Time required for request to process | ||||||||||||||||||||
| Results | |||||||||||||||||||||
| Results.FullMRZ | The full MRZ code that was processed |
||||||||||||||||||||
| Results.MRZType | Passport or Visa | ||||||||||||||||||||
| Results.ResultCode | 0 = Valid 80 = Invalid - Expired 81 = Invalid - MRZ Sequence |
||||||||||||||||||||
| Results.ResultText | Valid Invalid - Expired Invalid - MRZ Sequence |
||||||||||||||||||||
| Results.ResultDetails | Results details provided in an HTML table format for quick display use. Example:
|
||||||||||||||||||||
| Results.ResultDetailsXML | |||||||||||||||||||||
| Results.ResultDetailsXML.MRZData | |||||||||||||||||||||
| Results.ResultDetailsXML.MRZData.MRZ1LengthCheck | PASS or FAIL | ||||||||||||||||||||
| Results.ResultDetailsXML.MRZData.DocumentType | PASSPORT or VISA | ||||||||||||||||||||
| Results.ResultDetailsXML.MRZData.IssuingStateOrg | 3 character issuing country code | ||||||||||||||||||||
| Results.ResultDetailsXML.MRZData.IssuingStateOrgName | ISsuing Country name | ||||||||||||||||||||
| Results.ResultDetailsXML.MRZData.Name | Name extracted from MRZ | ||||||||||||||||||||
| Results.ResultDetailsXML.MRZData.MRZ2LengthCheck | PASS or FAIL | ||||||||||||||||||||
| Results.ResultDetailsXML.MRZData.ControlDigit1Check | PASS or FAIL | ||||||||||||||||||||
| Results.ResultDetailsXML.MRZData.Nationality | Country code for Nationality extracted from MRZ |
||||||||||||||||||||
| Results.ResultDetailsXML.MRZData.DOB | DOB extracted from MRZ (YYMMDD) | ||||||||||||||||||||
| Results.ResultDetailsXML.MRZData.ControlDigit2Check | PASS or FAIL | ||||||||||||||||||||
| Results.ResultDetailsXML.MRZData.Gender | M or F | ||||||||||||||||||||
| Results.ResultDetailsXML.MRZData.ExpirationDate | Expiration date from MRZ (YYMMDD) |
||||||||||||||||||||
| Results.ResultDetailsXML.MRZData.ExpirationCheck | PASS or FAIL | ||||||||||||||||||||
| Results.ResultDetailsXML.MRZData.ControlDigit3Check | PASS or FAIL | ||||||||||||||||||||
| Results.ResultDetailsXML.MRZData.PersonalNumber | Personal Number extracted from MRZ | ||||||||||||||||||||
| Results.ResultDetailsXML.MRZData.ControlDigit4Check | PASS or FAIL | ||||||||||||||||||||
| Results.ResultDetailsXML.MRZData.ControlDigit5Check | PASS or FAIL | ||||||||||||||||||||
| Results.ResultDetailsXML.MRZData.ResultText | Valid Invalid - Expired Invalid - MRZ Sequence |
||||||||||||||||||||
Error Status Response Codes
GetMRZValidation Error Status Response Codes:
| Code | Message |
|---|---|
| 0 | Normal Processing |
| 99 | Invalid Credentials |
Risk Screening
Overview
WorldWatch Plus® Risk Screening APIs were designed to mimic the functionality and workflow available via the client portal. These APIs have also evolved to support a variety of client workflows and data requirements. Clients may fully integrate, which means fully absorb all results into your own platform and manage adjudication on your own, or clients may partially integrate (a hybrid approach), where initial searches are performed via API, and the WorldWatch Plus portal is used to view results and/or adjudicate. Either approach can also leverage APIs to check adjudication status or check for monitoring events that may have occurred following the initial search.
- WorldWatch Plus® Risk Screening APIs are called via a simple HTTP POST using XML over HTTPS. XML String needs to be stored in a form field called “xml” and should be sent to our servers via HTTP POST method.
- All API requests will contain the necessary account credentials along with the associated XML payload. Account credentials will by assigned by WorldWatch Plus and will be unique to each WorldWatch Plus® platform/environment.
- WorldWatch Plus® fully supports the UTF-8 standard and API Methods can accept any non-Latin character sets. That said, we recommend use of [CDATA] wrappers for any text fields that could contain characters that would interfere with the XML structure.
- Error Status response codes are provided for each API Method.
- If required, SOAP requests options are also available. We can place a SOAP wrapper around these same XML requests along with additional basic authentication.
Intent and Design
WorldWatch Plus® was designed and built to be a search engine for publicly-available global risk data, to help organizations avoid and combat financial crimes. Two key and critical elements of the WorldWatch Plus® system are the search and filtering engine, and the underlying data being examined.
Search and Filtering engine
WorldWatch Plus® was architected to be used by clients either as a SaaS portal or an integrated solution making web service calls to an API. The intent of the design options was to facilitate in-stream use of the system to maximize utilization and deployment. Filtering algorithms return search results most pertinent to the name and other criteria being searched. Results and search criteria are logged, as a case, for audit purposes, and monitoring options alert users when risk data changes on a case previously searched.
Global Risk Data
Global risk data searched by WorldWatch Plus® customers includes political, medical and financial sanctions, enforcement actions, terrorism and most wanted lists, and other information outlining illicit activity. All data is publicly-available. The number of global data sources and volume of risk data continues to grow, as more countries and more agencies contribute information to combat money laundering, funding of terrorism, human trafficking and other socially-impactful crimes. WorldWatch Plus® refreshes the available data every 24 hours so that clients search the most up-to-date information available from more than 2,000 (as of 31-Dec-2018) watch lists and sanctions sources.
Screening Products
WorldWatch Plus® Risk sources are grouped into predefined Product groups, and in some cases sub-categories of products. Searches may be performed against these predefined Products assuming they have been authorized and enabled for the client on the requested platform. In some cases, searches may be performed against custom source lists. These WorldWatch Plus® search results are returned immediately upon initiation of Risk-based API services.
| Product ID | Description |
|---|---|
| WLS | Watch Lists & Sanctions
|
| GOV | Current Government Officials
|
| SOE | State Owned Enterprises
|
| PEPD | PEP Desk® Politically Exposed Persons
|
| NMEDIA | Adverse (Negative) Media
|
Workflow Integration
USE CASE #1 - Initial searches are performed via API, and the WorldWatch Plus portal is then used to view results and/or adjudicate.
- Call Search API (GetRiskReport)
- Read and evaluate summary results that are returned
Hint: Use "CaseMatch" return codes to quickly make a red or green light decision. - Create your own results summary to insert into your existing workflow
(sample)
Global Watch Lists & Sanctions Search Results...
Subject Identifiers Applied: 123 Main Street,Austin,TX
DOB for Matching: 1948-12-10
1. Abu Abbas [WLS] (Given Family) >> 25 Results DOB MATCH (url link to details)
2. John Quincy Jones [WLS] (Alias) >> No Results
3. Abu Williams [WLS] (Alias) >> No Results
Queries with Results = 1
- URL links returned in results summary to allow users to "punch out" to WorldWatch Plus and view all detailed results (does not require login)
USE CASE #2 - Full Integration with Detailed Results Ingestion
- Call Search API (GetRiskReport)
- Read and evaluate summary results that are returned
Hint: Use "CaseMatch" return codes to quickly make a red or green light decision. - If there are results, and it is determined necessary to review the results details further, then call GetMatchDetails for each name and product variation returned with results. Another option is to use "ExpediteResults" in the search API and have all detailed results returned in the intial request.
- Read through Details in response and map all structured and unstructured results to your local database.
- Modify existing application UI to display appropriate data to users.
- Call additional web services as desired
Platform/Account Hierarchy
WorldWatch Plus® clients are assigned a Partner ID for each platform in which they are subscribed. Multiple client Accounts can be created to represent different client business units, organizational function or types of business. One of the Accounts can be designated as the “Parent Account” with administrative privileges and oversight. Multiple accounts are not required.
All transactions can occur within a single account, as long as there is no need to for the business to operate using multiple WorldWatch Plus platforms. Within an Account, each entity search that gets performed creates a Case ID recording the transaction. Multiple Search IDs may get recorded for a single Case. Each Search ID represents a Name and Product variation that was searched under any particular Case.
Query Processing
Queries represent searched name and product variations. When a search request is submitted using the GetRiskReport API, a unique Case ID is assigned in WorldWatch Plus. This Case ID applies to all queries performed by and results returned from the GetRiskReport API. This Case ID is necessary for any subsequent API calls regarding the original request. Each name and product search (Query) generated by a single case gets assigned a sequential Search ID for the given case. Therefore, specific result queries are referenced by Case ID and Search ID.
As shown in following screen capture, rows 1-2 are results of the name search in the WorldWatch Plus portal. Since SmartMatch™ is turned on, the system recognized a potential similar spelling and provided those search results in addition to the original searched text (query). A Case ID gets generated for the request and each name variation searched will be returned as a “query” in the GetRiskReport API with a Search ID (1-2) assigned.
To further clarify, there will be a separate query for each data set (product) searched. So, a search for “Abu Abbas” against WLS, GOV, SOE, PEPD, and Media would result in at least 5 queries, each with their own set of results and with the product searched specified in the returned “SearchType” element. This is illustrated in the following snippet from WorldWatch Plus Case Management portal.
GetMatchDetails is called to return the detailed results from a Query. In the specification for GetMatchDetails, you will find that every structured or unstructured data field we have captured for a data source will be returned. Some of these details may vary based upon product searched. However, common to all GetMatchDetails results are the Source related information such as the Source Name, Agency, Entity (country), and any predefined source categories. The Source URL is also included for each individual result allowing for further investigation.
NOTE: When sources are identified in search results, they can be associated with multiple categories within the Watch Lists & Sanctions (WLS) product. If a source is identified as being CRIME, FINANCE, and SANCTIONS, that simply means a search of one of the categories with our WLS product, would include that source. If you only searched the OFAC category of WLS, you may be alerted that a source returned also belongs to other categories.
Search Matching Features
WorldWatch Plus® contains a combination of both structured and unstructured data sources from all over the world. For structured data sources, search terms are queried against appropriate corresponding structured data fields (e.g.. Name related fields, DOB fields, etc). For unstructured data sources (ie. pdfs and html), the entire full text is queried for search terms.
SEARCH ENTITIES
A name search in WorldWatch Plus® can be either a Person or a Business. For both types of searches, the search name can be submitted as a single text string we refer to as either the “Freeform Name” or “Full Name”. This freeform name field supports any UTF-8 compatible characters and therefore allows for native script versions of names to be submitted as well English. Also available is a dedicated parameter for the script version of a name for cases where both are to be submitted in the same request.
For person type entity searches there are also parameters available for Given, Middle, and Family names. These parameters are optional and there is no difference in search results from the Freeform parameter. Freeform works better for names that do not conform to first-middle-last convention, or for the script versions of names.
PROXIMITY MATCHING
The WorldWatch Plus® matching algorithm is, by default, a “proximity” based search. This means that each term of the search value must exist within a specified distance of each other within the source data. Distance is the number of intermediate words or characters. For example, searching for “Abu Abbas” would find results where “Abu” and “Abbas” exist within a few words of each other in any sequence (e.g. “Abu Abbas”, “Abbas, Abu”, “Abu M. Abbas”, “Abu Mohamed Abbas”). The number of intermediate words that are allowed is proprietary, but varies, and is dependent upon the number of terms in the name being searched. The matching algorithm is optimized for both performance and reliability of results.
SMARTMATCH PLUS™
WorldWatch Plus® also incorporates a combination of proprietary matching algorithms and business rules to facilitate “fuzzy” name variation matches. These optional features (known in the system as SmartMatch Plus™) allow WorldWatch Plus to identify possible name matches even when search input includes:
|
|
Results generation strikes a balance between returning enough data to avoid missing a result (false negative) and too much data that may include irrelevant results (false positive). SmartMatch Plus accounts for name variations and keystroke entry errors, using fuzzy logic algorithms to provide highly-confident alternatives to the name provided in the original search.
To eliminate false positive results – and reduce time reviewing results – SmartMatch Plus only queries and presents name variations with the strongest matches to the name entered. Other alternate names discovered that have a matching confidence above 87% but below 92% are returned without search results as “Additional Name Considerations”. These names may be searched separately as a new transaction if desired.
ALIASES
Specific Aliases may be requested to be searched and are treated as unique search terms queried in addition to and using the same methods as the original search terms. There are no alias tables. Aliases are manually specified and requested by the user.
SUBJECT IDENTIFIERS
Subject Identifiers (filters) can be optionally specified in the search request. Subject Identifiers are used as additional search strings or filters to be further identified within the previous name search results. Results are NOT further limited as a result of providing Subject Identifiers. All name matches are returned with a code indicating if a match was found in the result set. In the WorldWatch Plus portal, anything specified as a subject identifier will be highlighted in the search results and used to prioritize the display of the search results.
DATE OF BIRTH
DOB can be optionally specified in the search request and works similar to subject identifiers, except that it stands on its own. Not all Data Sources contain a DOB. But if they do, we normalize/standardize the DOB and make it searchable. Response codes are available for both Exact and Partial DOB matches. DOBMatch indicates there was some type of DOB match, either exact or partial. DOBExactMatch is true only in the case of an exact match.
Partial DOB match is based upon the following logic; A DOB Match will be returned if At Least one of the result sources for that search contained a match or partial match on DOB based upon (day, month and year) OR (year) OR (day and month). In the WorldWatch Plus portal, the results/sources containing the DOB Match will be noted with the green “DOB Match” or a yellow “Partial DOB Match” when viewing the search result details.
ORDER OF RESULTS
There is currently no scoring of the results. This is because query results for a particular name variation are always a match for that name. We do recommend, however, that when results are presented to users, they are prioritized/sorted so that those containing Subject Identifier matches appear before those without matches, and DOB matches always appear first. This is what we do in the WorldWatch Plus portal.
TRANSACTION HISTORY/RETENTION
All search request and result transaction history is currently maintained indefinitely or until obfuscated following a mutually agreed upon time frame. Therefore, detailed search results as captured at the time of the initial search are available for API request at any time. Please note that this detail is required and maintained for ongoing monitoring services. We now have a “Zero Footprint” option available in GetRiskReport that records the transaction, but does not retain any personally identifiable information.
Matching Indicators
WorldWatch Plus® results provide match indicators/elements at the overall Case level and for each individual Search ID (name variation). These indicators and their descriptions are as follows:
| Match Element | Description | Case Level? | Search Level? |
|---|---|---|---|
| CaseMatch | Case level Match Result Code 0 = No Results Found (Green light) 1 = Results with Exact DOB Match Found 2 = Results with Partial DOB Match Found 3 = Results with Subject IDs Found 4 = Results with None of the Above Found |
YES | NO |
| DOBMatch | If DOB was provided in request, returns: TRUE if searches performed contained a match on DOB based upon (day, month and year) OR (year) OR (day and month). FALSE = No searches contained a match on DOB per the above criteria. Note: This element returns TRUE for both Exact and Partial DOB Matches. |
YES | YES |
| DOBExactMatch | If DOB was provided in request and an EXACT Match is found in the results, then returns: TRUE. Otherwise, FALSE | YES | YES |
| FilterMatch | If Filters (Subject Identifiers) were provided in request, returns: TRUE or if searches performed contained a match on at least one of the filters. Otherwise, returns FALSE. | YES | YES |
| LEIMatch | If an LEI was provided in request and an EXACT Match is found in the results, then returns: TRUE. Otherwise, FALSE | YES | YES |
| LEIOnlyMatch | If an LEI was provided in request and an EXACT Match is found in the results, BUT the LEI number does not match the name searched, then returns: TRUE. Otherwise, FALSE | YES | YES |
GetRiskReport Method
| PURPOSE: | Initiates a series of global risk queries via targeted WorldWatch Plus platform and returns name
variations, indicators, and links associated with results identified. These are summary level
results with response codes to identify the types of matches found. A URL link is provided to
view results for those who are doing only partial integrations. To obtain specifics of search
results and actual sources, use GetMatchDetails or utilize the ExpediteResults parameter.
|
GetRiskReport is the primary method for Risk Screening an entity (person or organization). Risk results will be returned immediately.
Request Summary
Request parameters must be submitted as properly formed XML as specified in the API call and passed as the payload to this method. Results will be returned in the same format.
The request parameters for this method can be summarized as follows:
| 1. | Receiver | API Version and Target Environment identification | Required |
| 2. | Sender | Your Partner ID, Account identification, and accounting references | Required |
| 3. | Request | Details and screening parameters of the entity being screened | Required |
API Endpoint
Test Environment:https://test.worldwatchplus.com/api/getriskreport.php
Production - Due Diligence (DD) – for most clients:https://dd.worldwatchplus.com/api/getriskreport.php
Production - Credit Reporting Agencies (CRA) – for background screening companies:https://cra.worldwatchplus.com/api/getriskreport.php
Production - European Union (EU) – for clients servicing EU member countries:https://eu.worldwatchplus.com/api/getriskreport.php
All of the above require a Post Variable where: xml="xmlrequest"
Example GetRiskReport Request:
See XML
<GetRiskReport>
<Receiver>
<ReceiverID>INTLSOL</ReceiverID>
<VersionID>1.50</VersionID>
<EnvironmentCode>Test</EnvironmentCode>
</Receiver>
<Sender>
<PartnerID>bc893eidhc873de979xcjhrhb743der6c</PartnerID>
<AccountID>123456</AccountID>
<ReferenceID>MYREFERENCEID123</ReferenceID>
<AccountingCode>MyOrganizationalUnit</AccountingCode>
<FCRA>false</FCRA>
</Sender>
<Request>
<SubjectType>P</SubjectType>
<FullName><![CDATA[Abu Abbas]]></FullName>
<DOB>1948-12-10</DOB>
<SmartMatch>false</SmartMatch>
<Filters>
<FilterString><![CDATA[Palestine Liberation Front]]></FilterString>
<FilterString><![CDATA[Corée du Nord]]></FilterString>
</Filters>
<WatchLists>
<List_ID>OFAC</List_ID>
<List_ID>SANCTIONS</List_ID>
<List_ID>TERRORISM</List_ID>
<List_ID>CRIME</List_ID>
<List_ID>FINANCE</List_ID>
<List_ID>MEDICAL</List_ID>
</WatchLists>
<PoliticallyExposedLists>
<List_ID>PEPD</List_ID>
<List_ID>GOV</List_ID>
</PoliticallyExposedLists>
<MediaTypes>
<Type_ID>NMEDIA</Type_ID>
</MediaTypes>
<MediaLimit>12</MediaLimit>
<ExcerptSize>250</ExcerptSize>
<Monitoring>false</Monitoring>
</Request>
</GetRiskReport>
Specific Request Parameters
| Parameter | Description |
|---|---|
| Receiver | |
| Receiver.ReceiverID | RequiredWorldWatch Plus Assigned Identification as Receiver (30) |
| Receiver.VersionID | RequiredWorldWatch Plus Version ID of API (5) |
| Receiver.EnvironmentCode | RequiredWorldWatch Plus Target Operating Environment (Test or Production) (10). |
| Sender | |
| Sender.PartnerID | RequiredYour Partner ID assigned by WorldWatch Plus (35) |
| Sender.AccountID | RequiredYour Account Code that must be assigned and enabled by WorldWatch Plus (6) |
| Sender.FCRA | RequiredIdentifies if purpose of this transaction is governed by FCRA guidelines (True or False) Must be correctly identified for the specific platform. |
| Sender.BatchID | OptionalYour Internal Batch ID (optional) (50) |
| Sender.AccountingCode | OptionalYour Accounting, Reporting, or Organizational Unit Code for Internal tracking (100) |
| Sender.ReferenceID | OptionalYour Internal Transaction Reference ID for this specific request (50). Use this to be able to cross reference cases/transactions between platforms. |
| Sender.UserName | OptionalUser Name of individual running search. Shown in Case Mgmt for audit trail. (30) |
| Request | |
| Request.SubjectType | RequiredP = Person (Individual), B = Business |
| Request.FullName | Required-NFull Search Name – Free Form (100) FullName is a free form text field that can be used for any type of search, person or business, including script versions of names. |
| Request.FullNameScript | Required-NFull Search Name – Native Script (100) To be used if wanting to search a script version of the name in addition to the English version, in the same search. Otherwise, the native script can be placed into the FullName element and WorldWatch Plus will auto detect and translate or transliterate. |
| Request.GivenName | Required-NIf Person: Given Name (50) Simply a structured alternative to a free form name search |
| Request.MiddleName | Required-NIf Person: Middle Name (50) Simply a structured alternative to a free form name search |
| Request.FamilyName | Required-NIf Person: Family Name (50) Simply a structured alternative to a free form name search |
| Request.Aliases (multiple) | Specify any additional alias names to search. |
| Request.Aliases.AliasName | OptionalFull Alias Name of Person or Business (Free Form) (50) Multiple alias elements accepted. |
| Request.SmartMatch | OptionalUse SmartMatch Plus® for Similar Spelling Variations (True or False) |
| Request.DOB | OptionalIndividual Date of Birth in ISO 8601 format (YYYY-MM-DD) |
| Request.LEI | OptionalLegal Entity Identifier for additional business identifier verification and lookup. Matches will be identified in products searched. |
| Request.LEILookup | OptionalIn addition to other products searched, perform a name and LEI number lookup against LEI registered organizations (True or False). gleif.org |
| Request.Filters (multiple) | OptionalSupplementary text/subject identifiers for prioritizing search results. |
| Request.Filters.FilterString | Subject Identifier as Text string (ie. date, country, id number, etc) (50) |
| Request.WatchLists (multiple) | Required-PSpecify
Watchlist & Sanctions products to search: See "Risk Screening Products" |
| Request.WatchLists.List_ID | ALL = All Watch Lists and Sanctions SANCTIONS, FINANCE, TERRORISM, CRIME, OFAC, SAMGOV, MEDICAL |
| Request.PoliticallyExposedLists (multiple) | Required-PSpecify
Political Exposure products to search: See "Risk Screening Products" |
| Request.PoliticallyExposedLists.List_ID | ALL = All Politically Exposed Lists GOV = Government Officials SOE = State Owned Enterprises PEPD = Politically Exposed Persons & Associates |
| Request.CustomLists (multiple) | Required-PSpecify Custom lists to search: |
| Request.CustomLists.List_ID | Custom List Identifier of custom list created and defined in WorldWatch Plus |
| Request.SpecificSources (multiple) | Required-PSpecify Black Lists to search: (coming soon) |
| Request.SpecificSources.Source_ID | Individual Data Source Identifier as defined in WorldWatch Plus– For searching specific sources. |
| Request.MediaTypes (multiple) | Required-PSpecify
Media products to search: See "Risk Screening Products" |
| Request.MediaTypes.Type_ID | NMEDIA = Adverse (Negative) Media |
| Request.MediaLimit | OptionalLimit Media results to the previous X months where X=a numeric value. Default value is all available months or account default setting. |
| Request.ExcerptSize | OptionalNumber of characters to show in results excerpts for unstructured data sources. (Numeric value typically between 250 and 5000) If not specified, defaults to account setting. |
| Request.ExpediteResults | OptionalAn
external URL for viewing of risk results will always be returned by this API. However, if
inclusion of all detailed results, structured and unstructured, is desired in this API response,
then specify a Case Match value representing the level of detail to return: 1 = Only Results with Exact DOB Match Found 2 = Only Results with Exact or Partial DOB Match Found 3 = Only Results with Exact or Partial DOB Matches or Subject Identifier Matches Found 4 = All Results, including Name Only Matches. Note: All structured fields values for results will be returned and will vary with product. |
| Request.ZeroFootprint | OptionalIf True, leaves no trace of entity being searched or any associated PII such as DOB or subject identifiers. Transaction is still recorded in WWP platform. However, search criteria and results are not recorded in these transactions. The default value is False. |
| Request.Monitoring | OptionalSpecifies whether Monitoring should be enabled for this request (True or False) |
Response Summary
The response will be returned in the same data format specified when the API call was made. It is organized as follows:
| 1. | Error Status | Input Error Feedback |
| 2. | Summary | Summary Risk Screening Results |
| 3. | Details | Detailed Risk Screening Results |
Example GetRiskReport Response:
<RiskReport>
<ErrorStatus>
<Code>0</Code>
<Message>Processed Normally</Message>
</ErrorStatus>
<Summary>
<RequestDateTime>2018-06-01 01:57:53Z</RequestDateTime>
<QueriesProcessed>4</QueriesProcessed>
<QueriesReturned>4</QueriesReturned>
<QueriesWithResults>2</QueriesWithResults>
<CaseID>201862215752dd0d889d249129bbdac2</CaseID>
<Domain>
<![CDATA[https://test.worldwatchplus.com]]>
</Domain>
<CaseURL> <![CDATA[/searches?searchstring=201811115752dd0d889d2491291111c2&orderby=requested&sortorder=asc]]>
</CaseURL>
<CaseMatch>1</CaseMatch>
<DOBMatch>true</DOBMatch>
<DOBExactMatch>true</DOBExactMatch>
<FilterMatch>true</FilterMatch>
<LEIMatch>false</LEIMatch>
<LEIOnlyMatch>false</LEIOnlyMatch>
</Summary>
<Results>
<InputScan>
<Advisory>
<ScannedField>Subject Identifiers</ScannedField>
<PhraseID>63</PhraseID>
<PhraseFound>Corée du Nord</PhraseFound>
<PhraseFoundEnglish>North Korea </PhraseFoundEnglish>
<PhraseList>
<![CDATA[U.S. Sanctioned Country]]>
</PhraseList>
</Advisory>
</InputScan>
<Query>
<SearchID>1</SearchID>
<SearchString>
<![CDATA[Abu Abbas]]>
</SearchString>
<SearchType>WLS</SearchType>
<NameFormat>Free Form</NameFormat>
<NameSource>Provided</NameSource>
<ResultsCount>22</ResultsCount>
<ResultsURL>
<![CDATA[/listresults?cid=201811115752dd0d889d2491291111c2&sid=1]]>
</ResultsURL>
<DOBMatch>true</DOBMatch>
<DOBExactMatch>true</DOBExactMatch>
<FilterMatch>true</FilterMatch>
<LEIMatch>false</LEIMatch>
<LEIOnlyMatch>false</LEIOnlyMatch>
<ResultSources>
<Source>
<SID>1009</SID>
<DOBMatch>NA</DOBMatch>
</Source>
<Source>
<SID>2039</SID>
<DOBMatch>NA</DOBMatch>
</Source>
<Source>
<SID>3504</SID>
<DOBMatch>NA</DOBMatch>
</Source>
<Source>
<SID>1055</SID>
<DOBMatch>true</DOBMatch>
</Source>
<Source>
<SID>2081</SID>
<DOBMatch>true</DOBMatch>
</Source>
<Source>
<SID>2787</SID>
<DOBMatch>NA</DOBMatch>
</Source>
<Source>
<SID>2912</SID>
<DOBMatch>NA</DOBMatch>
</Source>
<Source>
<SID>1080</SID>
<DOBMatch>NA</DOBMatch>
</Source>
</ResultSources>
</Query>
<Query>
<SearchID>2</SearchID>
<SearchString>
<![CDATA[Abu Abbas]]>
</SearchString>
<SearchType>PEPD</SearchType>
<NameFormat>Free Form</NameFormat>
<NameSource>Provided</NameSource>
<ResultsCount>12</ResultsCount>
<ResultsURL>
<![CDATA[/pepresults?cid=201811115752dd0d889d2491291111c2&sid=2]]>
</ResultsURL>
<DOBMatch>false</DOBMatch>
<DOBExactMatch>false</DOBExactMatch>
<FilterMatch>false</FilterMatch>
<LEIMatch>false</LEIMatch>
<LEIOnlyMatch>false</LEIOnlyMatch>
<ResultSources></ResultSources>
</Query>
<Query>
<SearchID>3</SearchID>
<SearchString>
<![CDATA[Abu Abbas]]>
</SearchString>
<SearchType>GOV</SearchType>
<NameFormat>Free Form</NameFormat>
<NameSource>Provided</NameSource>
<ResultsCount>0</ResultsCount>
<ResultsURL></ResultsURL>
<ResultSources></ResultSources>
</Query>
<Query>
<SearchID>4</SearchID>
<SearchString>
<![CDATA[Abu Abbas]]>
</SearchString>
<SearchType>NMEDIA</SearchType>
<NameFormat>Free Form</NameFormat>
<NameSource>Provided</NameSource>
<ResultsCount>0</ResultsCount>
<ResultsURL></ResultsURL>
<ResultSources></ResultSources>
</Query>
</Results>
</RiskReport>
Initial Response Elements
| Element | Description |
|---|---|
| ErrorStatus | |
| ErrorStatus.Code | 0 = Normal Processing See "Error Status Response Codes" |
| ErrorStatus.Message | Descriptive message associated with Code (100) |
| Summary | |
| Summary.RequestDateTime | Date/Time Stamp of Request (UTC) (ISO 8601 format) |
| Summary.QueriesProcessed | Number of queries processed by this service (int) |
| Summary.QueriesReturned | Number of queries actually returned in XML (int) |
| Summary.QueriesWithResults | Number of queries that had results > 0 (int) |
| Summary.Domain | Domain to Use for Links Provided (str 50) |
| Summary.CaseID | WorldWatch Plus Assigned Case ID for Entity Risk Search |
| Summary.CaseURL | URL (link) to specific Case ID in Case Management portal. Requires Portal User ID and Password. |
| Summary.CaseResultsURL | URL (link) to specific Case ID showing detailed results. This is a one-click results dashboard view. Requires PIN. |
| Summary.CaseMatch | Case level Match Result Code 0 = No Results Found 1 = Results with Exact DOB Match Found 2 = Results with Partial DOB Match Found 3 = Results with Subject IDs Found 4 = Results with None of the Above Found |
| Summary.DOBExactMatch | If DOB was provided in request and an EXACT Match is found in the results, then returns: TRUE. Otherwise, FALSE |
| Summary.DOBMatch | If DOB was provided in request, returns: TRUE = At least one of the searches performed contained a match on DOB based upon (day, month and year) OR (year) OR (day and month). FALSE = No searches contained a match on DOB per the above criteria. Note: This element returns TRUE for both Exact and Partial DOB Matches. |
| Summary.FilterMatch | TRUE or if at least one of the searches performed contained a match on at least one of the subject identifiers other than name. Otherwise, returns FALSE. |
| Summary.LEIMatch | If an LEI was provided in request and an EXACT Match is found in the results, then returns: TRUE. Otherwise, FALSE |
| Summary.LEIOnlyMatch | If an LEI was provided in request and an EXACT Match is found in the results, BUT the LEI number does not match the name searched, then returns: TRUE. Otherwise, FALSE |
| Results | |
| Results.Query | Multiple Search IDs may get recorded for a single Case. Each Search ID represents a Name and Product variation that was searched under any particular Case. |
| Results.Query.SearchID | Search sequence number uniquely assigned per Case. |
| Results.Query.SearchString | Text of Name variation searched. |
| Results.Query.NameSource | Examples not limited to "Provided", "Alternate Given Name", "Similar Spelling", "Japanese Transliteration", etc. |
| Results.Query.SearchType | Type Source Data searched ("WLS", "PEP", or "NMEDIA") |
| Results.Query.DOBExactMatch | If DOB was provided in request and an EXACT Match is found in the results, then returns: TRUE. Otherwise, FALSE |
| Results.Query.DOBMatch | If DOB was provided in request, returns: TRUE = At least one of the result sources contained a match on DOB based upon (day, month and year) OR (year) OR (day and month). FALSE = No result sources contained a match on DOB per the above criteria. Note: The data sources searched may also not have had DOB available to search. |
| Results.Query.FilterMatch | TRUE if at least one of the searches performed contained a match on at least one of the subject identifiers other than name. Otherwise, returns FALSE. |
| Results.Query.LEIMatch | If an LEI was provided in request and an EXACT Match is found in the results, then returns: TRUE. Otherwise, FALSE |
| Results.Query.LEIOnlyMatch | If an LEI was provided in request and an EXACT Match is found in the results, BUT the LEI number does not match the name searched, then returns: TRUE. Otherwise, FALSE |
| Results.Query.ResultSources | Data Source(s) that contained Results. |
| Results.Query.ResultSources.Source | This element will be repeated for each source identified. |
| Results.Query.ResultSources.Source.SID | Individual Data Source Identifier |
| Results.Query.ResultSources.Source.DOBMatch | If DOB was provided in request, returns: TRUE = DOB was available on source and either matched (day, month and year) OR (year) OR (day and month) FALSE = DOB was available but did not match NA = DOB was not available on source |
| Results.AdditionalSearchConsiderations | Additional Names that were identified by SmartMatch Plus as having a high similarity (greater than or equal to 87% and less than 92%) to the name requested. These names were not searched automatically and returned in this request. Note: Name variations of 92% and above as identified by SmartMatch Plus are searched and already included in search results for this request. |
| Results.AdditionalSearchConsiderations.NameVariation | Multiple elements may be returned |
| Results.AdditionalSearchConsiderations.NameVariation.Name | Full name of individual or business. (100) |
| Results.AdditionalSearchConsiderations.NameVariation.Similarity | Similarity score to name in search request (typically greater than or equal to 87% and less than 92%). |
Error Status Response Codes
GetIdentityReport Error Status Response Codes:
| Code | Message |
|---|---|
| 0 | Normal Processing |
| 100 | Invalid Partner Id specified |
| 101 | Invalid Account Id specified |
| 102 | Invalid Country Code specified |
| 103 | Given Name can not be blank |
| 104 | Family Name can not be blank |
| 105 | Address can not be blank |
| 106 | City / Locale can not be blank |
| 107 | State / Region can not be blank |
| 108 | Notification Method must be set |
| 109 | Notification email method set but email is blank |
| 110 | Notification sms method set but phone is blank |
GetMatchDetails Method
| PURPOSE: | Requests result details for previous queries initiated by the GetRiskReport web service. Each combination of name variation and product searched will have associated match details available for retrieval if results were found (greater than zero). There is no need to call GetMatchDetails if there were no results, and in some cases, you may just choose not to make this API call because the query did not indicate a DOB match or any other type of match, or perhaps the name variation searched was just not relevant. |
GetMatchDetails is the method used to return search result details that were generated from the GetRiskReport web service method.
Request Summary
Request parameters must be submitted as properly formed XML as specified in the API call and passed as the payload to this method. Results will be returned in the same format.
The request parameters for this method can be summarized as follows:
| 1. | Receiver | API Version and Target Environment identification | Required |
| 2. | Sender | Your Partner ID, Account identification, and accounting references | Required |
| 3. | Request | Case and Search identifiers to retrieve search results from | Required |
API Endpoint
Test Environment:https://test.worldwatchplus.com/api/getmatchdetails.php
Production - Due Diligence (DD) – for most clients:https://dd.worldwatchplus.com/api/getmatchdetails.php
Production - Credit Reporting Agencies (CRA) – for background screening companies:https://cra.worldwatchplus.com/api/getmatchdetails.php
Production - European Union (EU) – for clients servicing EU member countries:https://eu.worldwatchplus.com/api/getmatchdetails.php
All of the above require a Post Variable where: xml="xmlrequest"
Example GetMatchDetails Request:
See XML
<GetMatchDetails>
<Receiver>
<ReceiverID>INTLSOL</ReceiverID>
<VersionID>1.50</VersionID>
<EnvironmentCode>Test</EnvironmentCode>
</Receiver>
<Sender>
<PartnerID>bc8s9fjf9ej99de97b594ceb7436716c</PartnerID>
<AccountID>201699</AccountID>
</Sender>
<Request>
<CaseID>201111175234798e4ec97c8e58ff1111</CaseID>
<SearchID>1</SearchID>
<AlertsOnly>false</AlertsOnly>
</Request>
</GetMatchDetails>
Specific Request Parameters
| Parameter | Description |
|---|---|
| Receiver | |
| Sender.ReceiverID | RequiredISS Assigned Identification as Receiver (30) |
| Sender.VersionID | RequiredISS Version ID of API (5) |
| Sender.EnvironmentCode | RequiredISS Target Operating Environment (Test or Production) (10). |
| Sender | |
| Sender.PartnerID | RequiredYour Partner ID assigned by ISS (35) |
| Sender.AccountID | RequiredYour Account Code that must be assigned and enabled by ISS (6) |
| Request | |
| Request.CaseID | RequiredCase ID returned by GetRiskReport |
| Request.SearchID | RequiredSearch ID returned by GetRiskReport |
| Request.AlertsOnly | OptionalFull
TRUE = Only return sources identified as new or changed as a result of monitoring FALSE = Return all source matches |
Response Summary
The response will be returned in the same data format specified when the API call was made. It is organized as follows:
| 1. | Error Status | Input Error Feedback |
| 2. | Summary | Summary Risk Screening Results |
| 3. | Details | Detailed Matches including all structured and unstructured data content |
Example GetMatchDetails Response for Watchlists & Sanctions (WLS):
<MatchDetails>
<ErrorStatus>
<Code>0</Code>
<Message>Processed Normally</Message>
</ErrorStatus>
<Summary>
<RequestDateTime>2018-06-03 21:56:00Z</RequestDateTime>
<ResultsCount>9</ResultsCount>
<CaseID>201111175234798e4ec97c8e58ff1111</CaseID>
<SearchID>1</SearchID>
<SearchType>WLS</SearchType>
<SearchString>
<![CDATA[Abu Abbas]]>
</SearchString>
</Summary>
<Details>
<Match>
<SourceID>1055</SourceID>
<SourceName>
<![CDATA[Specially Designated Nationals/Sanctions]]>
</SourceName>
<SourceAgency>
<![CDATA[Department of the Treasury]]>
</SourceAgency>
<SourceEntity>United States</SourceEntity>
<SourceCategory>
<Name>SANCTIONS</Name>
<Name>TERRORISM</Name>
<Name>CRIME</Name>
<Name>OFAC</Name>
</SourceCategory>
<FilterMatch>false</FilterMatch>
<SourceType>structured</SourceType>
<DOBMatch>true</DOBMatch>
<DOBExactMatch>true</DOBExactMatch>
<SignificantEvents>true</SignificantEvents>
<LocationMatch>false</LocationMatch>
<ResultsURL>
<![CDATA[http://www.treasury.gov/resource-center/sanctions/SDN-List/Pages/default.aspx]]>
</ResultsURL>
<FullName>
<![CDATA[Abu ABBAS]]>
</FullName>
<Aliases>
<![CDATA[Muhammad ZAYDAN]]>
</Aliases>
<DateofBirth>
<![CDATA[10 Dec 1948]]>
</DateofBirth>
</Match>
<Match>
<SourceID>1080</SourceID>
<SourceName>
<![CDATA[Foreign Terrorist Organizations (FTO) list]]>
</SourceName>
<SourceAgency>
<![CDATA[Department of State]]>
</SourceAgency>
<SourceEntity>United States</SourceEntity>
<SourceCategory>
<Name>TERRORISM</Name>
<Name>CRIME</Name>
</SourceCategory>
<KeywordsIdentified>
<![CDATA[Palestine Liberation Front]]>
</KeywordsIdentified>
<FilterMatch>true</FilterMatch>
<SourceType>unstructured</SourceType>
<DOBMatch>na</DOBMatch>
<DOBExactMatch>false</DOBExactMatch>
<ResultsID>1415595757</ResultsID>
<ResultsURL>
<![CDATA[http://www.state.gov/j/ct/rls/crt/2012/209989.htm]]>
</ResultsURL>
<Excerpts>
<![CDATA[ ... . The PLF was suspected of supporting terrorism against Israel by other Palestinian groups into the 1990s. In April 2004, <b>Abu</b><b>Abbas</b> died of natural causes while in U.S. custody in Iraq. The PLF took part in the 2006 Palestinian parliamentarian ... ]]>
</Excerpts>
</Match>
<Match>
<SourceID>2081</SourceID>
<SourceName>
<![CDATA[Consolidated Screening List]]>
</SourceName>
<SourceAgency>
<![CDATA[President’s Export Control Reform]]>
</SourceAgency>
<SourceEntity>United States</SourceEntity>
<SourceCategory>
<Name>SANCTIONS</Name>
</SourceCategory>
<KeywordsIdentified>
<![CDATA[Palestine Liberation Front]]>
</KeywordsIdentified>
<FilterMatch>true</FilterMatch>
<SourceType>structured</SourceType>
<DOBMatch>na</DOBMatch>
<DOBExactMatch>false</DOBExactMatch>
<ResultsURL>
<![CDATA[http://www.export.gov/ecr/eg_main_023148.asp]]>
</ResultsURL>
<FullName>
<![CDATA[PALESTINE LIBERATION FRONT - ABU ABBAS FACTION PALESTINE LIBERATION FRONT; PLF; PLF-ABU ABBAS]]>
</FullName>
<Remarks>
<![CDATA[SDT; FTO; SDGT]]>
</Remarks>
</Match>
<Match>
<SourceID>1055</SourceID>
<SourceName>
<![CDATA[Specially Designated Nationals/Sanctions]]>
</SourceName>
<SourceAgency>
<![CDATA[Department of the Treasury]]>
</SourceAgency>
<SourceEntity>United States</SourceEntity>
<SourceCategory>
<Name>SANCTIONS</Name>
<Name>TERRORISM</Name>
<Name>CRIME</Name>
<Name>OFAC</Name>
</SourceCategory>
<KeywordsIdentified>
<![CDATA[Palestine Liberation Front]]>
</KeywordsIdentified>
<FilterMatch>true</FilterMatch>
<SourceType>structured</SourceType>
<DOBMatch>na</DOBMatch>
<DOBExactMatch>false</DOBExactMatch>
<ResultsURL>
<![CDATA[http://www.treasury.gov/resource-center/sanctions/SDN-List/Pages/default.aspx]]>
</ResultsURL>
<FullName>
<![CDATA[PALESTINE LIBERATION FRONT - ABU ABBAS FACTION]]>
</FullName>
<Aliases>
<![CDATA[ PALESTINE LIBERATION FRONT PLF PLF-ABU ABBAS]]>
</Aliases>
</Match>
</Details>
</MatchDetails>
Example GetMatchDetails Response for Political Exposure (PEPD):
<MatchDetails>
<ErrorStatus>
<Code>0</Code>
<Message>Processed Normally</Message>
</ErrorStatus>
<Summary>
<RequestDateTime>2018-06-03 22:12:19Z</RequestDateTime>
<ResultsCount>4</ResultsCount>
<CaseID>201111175234798e4ec97c8e58ff1111</CaseID>
<SearchID>2</SearchID>
<SearchType>PEPD</SearchType>
<SearchString>
<![CDATA[Abu Abbas]]>
</SearchString>
</Summary>
<Details>
<Match>
<SourceID>PEPDESK_GLO_001</SourceID>
<SourceName>
<![CDATA[PEP Desk™]]>
</SourceName>
<SourceAgency>Info4c</SourceAgency>
<SourceEntity>Global</SourceEntity>
<FilterMatch>false</FilterMatch>
<SourceType>structured</SourceType>
<DOBMatch>na</DOBMatch>
<DOBExactMatch>false</DOBExactMatch>
<ResultsID>214038</ResultsID>
<ResultsTitle>
<![CDATA[PEP Desk™ by Info4c]]>
</ResultsTitle>
<PEPID>10101185043</PEPID>
<Title>
<![CDATA[Haji; Mr.]]>
</Title>
<FullName>
<![CDATA[Abu Abbas]]>
</FullName>
<OtherNames>
<![CDATA[Md Abu Abbas]]>
</OtherNames>
<Gender>Male</Gender>
<PEPStatus>PEP</PEPStatus>
<Country>
<![CDATA[Bangladesh]]>
</Country>
<PoliticalExposure>
<Item>
<Function>
<![CDATA[Ex Member - Parliament, Jatiya Sangsad]]>
</Function>
<Category>
<![CDATA[Legislative Functions, Parliaments]]>
</Category>
</Item>
</PoliticalExposure>
</Match>
<Match>
<SourceID>PEPDESK_GLO_001</SourceID>
<SourceName>
<![CDATA[PEP Desk™]]>
</SourceName>
<SourceAgency>Info4c</SourceAgency>
<SourceEntity>Global</SourceEntity>
<FilterMatch>false</FilterMatch>
<SourceType>structured</SourceType>
<DOBMatch>false</DOBMatch>
<DOBExactMatch>false</DOBExactMatch>
<ResultsID>106391</ResultsID>
<ResultsTitle>
<![CDATA[PEP Desk™ by Info4c]]>
</ResultsTitle>
<PEPID>10101081923</PEPID>
<Title>
<![CDATA[Mr.]]>
</Title>
<FullName>
<![CDATA[Mahmoud Reda Abbas]]>
</FullName>
<OtherNames>
<![CDATA[Mahmoud Abbas Abu Mazen; Abu Mazen; Abbas, Mahmoud; Abbas, Mahmud]]>
</OtherNames>
<ScriptName>
<![CDATA[محمود رضا عباس]]>
</ScriptName>
<Gender>Male</Gender>
<DateofBirth>26.03.1935</DateofBirth>
<PlaceofBirth>
<![CDATA[Safad, Palestine]]>
</PlaceofBirth>
<PEPStatus>PEP</PEPStatus>
<Country>
<![CDATA[Palestine]]>
</Country>
<PoliticalExposure>
<Item>
<Function>
<![CDATA[President - Office of the President]]>
</Function>
<Category>
<![CDATA[Heads of State, Major Government Offices and Support]]>
</Category>
</Item>
<Item>
<Function>
<![CDATA[Party Leader - Fatah]]>
</Function>
<Category>
<![CDATA[Political Leaders]]>
</Category>
</Item>
<Item>
<Function>
<![CDATA[Chairperson, Executive Committee - Palestine Liberation Organization (PLO)]]>
</Function>
<Category>
<![CDATA[Political Leaders]]>
</Category>
</Item>
<Item>
<Function>
<![CDATA[Ex Prime Minister - Office of the Prime Minister]]>
</Function>
<Category>
<![CDATA[Heads of State, Major Government Offices and Support]]>
</Category>
</Item>
<Item>
<Function>
<![CDATA[Commander-in-chief - Palestinian National Security Forces]]>
</Function>
<Category>
<![CDATA[Military]]>
</Category>
</Item>
</PoliticalExposure>
<Associations>
<Item>
<PEPID>10101081931</PEPID>
<Title>
<![CDATA[Mr.]]>
</Title>
<FullName>
<![CDATA[Mazen Abbas]]>
</FullName>
<Function>
<![CDATA[Ex PEP, Deceased Son of Mahmoud Abbas - Relatives of High Officials]]>
</Function>
</Item>
<Item>
<PEPID>10101081932</PEPID>
<Title>
<![CDATA[Mr.]]>
</Title>
<FullName>
<![CDATA[Tareq Abbas]]>
</FullName>
<Function>
<![CDATA[Son of Mahmoud Abbas - Relatives of High Officials]]>
</Function>
</Item>
<Item>
<PEPID>10101081933</PEPID>
<Title>
<![CDATA[Mr.]]>
</Title>
<FullName>
<![CDATA[Yaser Abbas]]>
</FullName>
<OtherNames>
<![CDATA[Abbas, Yasser]]>
</OtherNames>
<Function>
<![CDATA[Son of Mahmoud Abbas - Relatives of High Officials]]>
</Function>
</Item>
<Item>
<PEPID>10101280461</PEPID>
<Title>
<![CDATA[Mrs.]]>
</Title>
<FullName>
<![CDATA[Amina Abbas]]>
</FullName>
<Function>
<![CDATA[Wife of Mahmoud Reda Abbas - Relatives of High Officials]]>
</Function>
</Item>
</Associations>
</Match>
</Details>
</MatchDetails>
Example GetMatchDetails Response for Adverse Media (NMEDIA):
<MatchDetails>
<ErrorStatus>
<Code>0</Code>
<Message>Processed Normally</Message>
</ErrorStatus>
<Summary>
<RequestDateTime>2018-06-03 23:22:15Z</RequestDateTime>
<ResultsCount>7</ResultsCount>
<CaseID>202222263134b72905c71a9900001844</CaseID>
<SearchID>4</SearchID>
<SearchType>NMEDIA</SearchType>
<SearchString>
<![CDATA[Abu Abbas]]>
</SearchString>
</Summary>
<Details>
<Match>
<SourceID>4210</SourceID>
<SourceName>
<![CDATA[MEDIA_IQ_5319]]>
</SourceName>
<SourceAgency>
<![CDATA[MEMRI - Lates Special Dispatches]]>
</SourceAgency>
<SourceEntity>Middle East</SourceEntity>
<FilterMatch>false</FilterMatch>
<SignificantEvents>true</SignificantEvents>
<LocationMatch>false</LocationMatch>
<SourceType>unstructured</SourceType>
<ResultsID>21104568</ResultsID>
<ResultsTitle>
<![CDATA[Palestinian Reactions to the Death of Abu Al-Abbas – 'The Great National Leader' | MEMRI - The Middle East Media Research Institute]]>
</ResultsTitle>
<ResultsURL>
<![CDATA[https://www.memri.org/reports/palestinian-reactions-death-abu-al-abbas-%E2%80%93-great-national-leader]]>
</ResultsURL>
<Excerpts>
<![CDATA[ ... inhumane conditions that directly harmed his life… "[Our] commitment remains unchanged, and [our] vow remains in force. We continue marching on the path of revolution and of just national struggle until victory is realized and an independent Palestinian state with Jerusalem as its capital is established. To eternal Paradise, our hero Shahid – <b>Abu</b> Al-Abbas!" [5] Death notices were published by several top Palestinian officials, among them Rashid<b>Abu</b> Shbak who heads the Preventive Security Apparatus in Gaza. Shbak expressed his deep sorrow "on the death of the great national fighter." [6] PA Information Ministry Director-General Sa'ad Tawfiq Bsisso demanded that an international committee be established to investigate the circumstances of<b>Abu</b> Al-Abbas's death. [7] Other Palestinian Organizations The National and Islamic Forces also published a communiqué, promising to follow in the path of<b>Abu</b> Al-Abbas: "The martyrdom of<b>Abu</b> Al-Abbas will only add to our people and to its national and Islamic determination to continue the struggle in the same path [as he], and to cling to the same goals for which the great commander was martyred." [8]<b>Abbas</b>'s organization, the Palestine Liberation Front, had a similar demand, calling for the establishment of a medical committee "to expose the circumstances of the martyrdom" of its secretary general, adding: "We bid farewell today to our commander and secretary general, the Shahid<b>Abu</b> Al-Abbas, who played a prominent role in the history of the Palestinian struggle for 40 years, from his youth to his martyrdom. He took part in the various stations [along the way] of the national struggle, by establishing the fighting front and heading it… "<b>Abu</b> Al-Abbas defended the right of the struggle of our people and [the right] to demand its rights and sovereignty on its land and homeland. We promise the Shahid commander to continue in his path, and we promise to remain faithful to his [acts of] sacrifice. Our positions, which will remain living in ... ]]>
</Excerpts>
</Match>
<Match>
<SourceID>4228</SourceID>
<SourceName>
<![CDATA[MEDIA_SY_5341]]>
</SourceName>
<SourceAgency>
<![CDATA[Syrian Arab News Agency - Syria and the World]]>
</SourceAgency>
<SourceEntity>Middle East</SourceEntity>
<FilterMatch>false</FilterMatch>
<SourceType>unstructured</SourceType>
<ResultsID>24053371</ResultsID>
<ResultsTitle>
<![CDATA[Russian Aerospace Forces kill 37 al-Nusra terrorists, including 5 of their leaders – Syrian Arab News Agency]]>
</ResultsTitle>
<ResultsURL>
<![CDATA[https://sana.sy/en/?p=114671]]>
</ResultsURL>
<Excerpts>
<![CDATA[ ... Russian Defense Ministry affirmed the killing of 37 Jabhat al-Nusra terrorists, among them 5 of their leaders, in airstrikes against one of their command center in the southern countryside of Idleb province. Russian Defense Ministry spokesman Major-General Igor Konashenkov said that based on precise information, the Russian Aerospace Forces carried out an airstrike on one of al-Nusra’s command center in Idleb province, eliminating 37 terrorists including five field commanders who were holding a meeting. He said that a precise missile airstrike was carried out only after information about the meeting was collected from various channels, adding that a nearby ammunition and explosives depot as well as 6 SUVs with large-caliber weapons were also eliminated. The terrorist leaders that were killed were known as <b>Abu</b> Salman al-Saudi,<b>Abu</b><b>Abbas</b> Alaeddin,<b>Abu</b> al-Hassan,<b>Abu</b> Mohammad al-Joulani, Walid al-Mustafa, and Abdullah al-Mhaisni and<b>Abu</b> Mujahed. H. Zain/ Hazem Sabbagh including 5 of their leaders Russian Aerospace Forces kill 37 al-Nusra terrorists 2017-09-27 hala Share tweet Previous Wednesday weather forecast: Temperatures around average, weather relatively cold at coastal mountains Next Artistic exhibition at<b>Abu</b> Rummaneh Cultural Center in Damascus Check Also 3,000 displaced persons return to their towns in Deir Ezzor countryside Deir Ezzor, SANA- Hundreds of families returned to their homes and towns in Deir Ezzor … Video SANA Army regains control over all villages and towns to northeast of Khanser-Tal al-Daman road, southern Aleppo 15 January، 2018 Army establishes control over 400 square kilometers in Aleppo countryside 15 January، 2018 Realtiy of Events 3,000 displaced persons return to their towns in Deir Ezzor countryside 16 January، 2018 Syrian Army establishes control over al-Shaheed hill and 3 villages in Aleppo countryside 16 January، 2018 Two civilians including child killed, six injured in terrorist attacks in Aleppo, Damascus and Hama 16 January، 2018 ... ]]>
</Excerpts>
</Match>
<Match>
<SourceID>4310</SourceID>
<SourceName>
<![CDATA[MEDIA_IL_5462]]>
</SourceName>
<SourceAgency>
<![CDATA[The Times of Israel - Israel Inside]]>
</SourceAgency>
<SourceEntity>Middle East</SourceEntity>
<FilterMatch>false</FilterMatch>
<SourceType>unstructured</SourceType>
<ResultsID>20631844</ResultsID>
<ResultsTitle>
<![CDATA[The World Should Know What He Did to My Family - The Washington Post]]>
</ResultsTitle>
<ResultsURL>
<![CDATA[https://www.washingtonpost.com/archive/opinions/2003/05/18/the-world-should-know-what-he-did-to-my-family/0da7cca5-fd96-4412-82a6-957df703ca3d/]]>
</ResultsURL>
<Excerpts>
<![CDATA[ ... her mouth, hoping she could breathe. As I lay there, I remembered my mother telling me how she had hidden from the Nazis during the Holocaust. "This is just like what happened to my mother," I thought. As police began to arrive, the terrorists took Danny and Einat down to the beach. There, according to eyewitnesses, one of them shot Danny in front of Einat so that his death would be the last sight she would ever see. Then he smashed my little girl's skull in against a rock with his rifle butt. That terrorist was Samir Kuntar. By the time we were rescued from the crawl space, hours later, Yael, too, was dead. In trying to save all our lives, I had smothered her. The next day, <b>Abu</b><b>Abbas</b> announced from Beirut that the terrorist attack in Nahariya had been carried out "to protest the signing of the Egyptian-Israeli peace treaty" at Camp David the previous year.<b>Abbas</b> seems to have a gift for charming journalists, but imagine the character of a man who protests an act of peace by committing an act of slaughter. Two of<b>Abbas</b>'s terrorists had been killed by police on the beach. The other two were captured, convicted and sentenced to life in prison. Despite my protests, one was released in a prisoner exchange for Israeli POWs several months before the Achille Lauro hijacking.<b>Abu</b><b>Abbas</b> was determined to find a way to free Kuntar as well. So he engineered the hijacking of the Achille Lauro off the coast of Egypt and demanded the release of 50 Arab terrorists from Israeli jails. The only one of those prisoners actually named was Samir Kuntar. The plight of hundreds held hostage on a cruise ship for two days at sea lent itself to massive international media coverage. The attack on Nahariya, by contrast, had taken less than an hour in the middle of the night. So what happened then was hardly noticed outside of Israel. One hears the terrorists and their excusers say that they are driven to kill out of desperation. But there is always a choice. Even when you have suffered, you ... ]]>
</Excerpts>
</Match>
<Match>
<SourceID>4242</SourceID>
<SourceName>
<![CDATA[MEDIA_LB_5362]]>
</SourceName>
<SourceAgency>
<![CDATA[Nahar Net - Lebanon]]>
</SourceAgency>
<SourceEntity>Middle East</SourceEntity>
<FilterMatch>false</FilterMatch>
<SourceType>unstructured</SourceType>
<ResultsID>18981450</ResultsID>
<ResultsTitle>
<![CDATA[Report: Detained Abdullah Azzam Militant was Involved in Shatah's Assassination — Naharnet]]>
</ResultsTitle>
<ResultsURL>
<![CDATA[http://www.naharnet.com/stories/en/159640-report-detained-abdullah-azzam-militant-was-involved-in-shatah-s-assassination]]>
</ResultsURL>
<Excerpts>
<![CDATA[ ... ,” al-Mayadeen television reported. It said he was involved in the 2013 assassination of Minister Mohammed Shatah in a central Beirut car bombing. Military sources informed on the investigations told al-Mayadeen that “the car used in Shatah's assassination came from the Ain el-Hilweh camp,” noting that Abdullah Azzam Brigades leader “Majed al-Majed was arrested four days after the assassination.” Majed was reportedly the mastermind of the deadly twin suicide bombing that targeted the Iranian embassy in Beirut in November 2013. The Lebanese army announced in January that Majed, a Saudi militant, had died of illness at the central military hospital in Beirut after being arrested on December 26, 2013. On Thursday evening, al-Manar television announced that the detainee <b>Abu</b><b>Abbas</b> had transported “more than one booby-trapped car” from the outskirts of the Bekaa border town of Arsal to areas inside Lebanon. He was also behind sending the bomb-laden car that exploded prematurely at the Dahr al-Baydar checkpoint before reaching its supposed destination in Beirut's southern suburbs, al-Manar said.<b>Abu</b><b>Abbas</b> also confirmed that the<b>Abu</b> Assaf Cafe in Tayyouneh -- where dozens of football fans were watching a World Cup match in June -- was the target of the car bomb that exploded several meters away from the popular coffee shop. Earlier on Thursday, al-Akhbar newspaper said the Army Intelligence captured<b>Abu</b><b>Abbas</b> in an “ambush” around a week ago, describing him as a “hefty catch.” It said the prominent militant leader hails from the eastern Bekaa town of Majdal Anjar. The newspaper said that the detainee confessed that he transported the suicide bomber of Dahr al-Baydar and Beirut's Tayyouneh roundabout in June. Sources said that the suspect is the right hand of Sirajeddine Zureiqat, a so-called spokesman of the Qaida-linked Abdullah Azzam Brigades. The detainee also provided a residence for Iraqi woman Saja al-Dulaimi, who was identified as a divorcee of Islamic State leader ... ]]>
</Excerpts>
</Match>
</Details>
</MatchDetails>
Example GetMatchDetails Response for Legal Entity Identifiers (LEI):
<MatchDetails>
<ErrorStatus>
<Code>0</Code>
<Message>Processed Normally</Message>
</ErrorStatus>
<Summary>
<RequestDateTime>2018-06-03 23:40:53Z</RequestDateTime>
<ResultsCount>4</ResultsCount>
<CaseID>20555551331448a222bf48a666663bebb</CaseID>
<SearchID>1</SearchID>
<SearchType>LEI</SearchType>
<SearchString>
<![CDATA[hutchin hill]]>
</SearchString>
</Summary>
<Details>
<Match>
<SourceID>LEI_GLO_001</SourceID>
<SourceName>Global Legal Entity Identifier Foundation</SourceName>
<SourceAgency>GLEIF</SourceAgency>
<SourceEntity>Global</SourceEntity>
<FilterMatch>false</FilterMatch>
<SourceType>structured</SourceType>
<leiMatch>false</leiMatch>
<ResultsTitle>Global Legal Entity Identifier Foundation</ResultsTitle>
<ResultsURL>
<![CDATA[https://www.gleif.org]]>
</ResultsURL>
<LEINumber>549300FRJX2VJYUTRD71</LEINumber>
<LegalName>
<![CDATA[Hutchin Hill UK LLP]]>
</LegalName>
<OtherNames>
<![CDATA[Etablissements Guy Dauphin et Cie SA - ]]>
</OtherNames>
<ScriptName>
<![CDATA[Henrik Iwerdal Affarsutveckling Aktiebolag ]]>
</ScriptName>
<Addresses>
<LegalAddress>
<AddressLine>29 Farm Street</AddressLine>
<AddressCity>London</AddressCity>
<AddressRegion>GB-ENG</AddressRegion>
<AddressCountry>GB</AddressCountry>
<AddressPostalCode>W1J 5RL</AddressPostalCode>
</LegalAddress>
<HeadquartersAddress>
<AddressLine>29 Farm Street</AddressLine>
<AddressCity>London</AddressCity>
<AddressRegion>GB-ENG</AddressRegion>
<AddressCountry>GB</AddressCountry>
<AddressPostalCode>W1J 5RL</AddressPostalCode>
</HeadquartersAddress>
<OtherAddress>
<AddressLine>65, Bld.1, Sushchevskiy Val Street</AddressLine>
<AddressCity>Moscow</AddressCity>
<AddressRegion>RU-MOW</AddressRegion>
<AddressCountry>RU</AddressCountry>
<AddressPostalCode>129594</AddressPostalCode>
</OtherAddress>
</Addresses>
<LegalJurisdiction>GB</LegalJurisdiction>
<EntityCategory>FUND</EntityCategory>
<EntityLegalForm>Limited Liability Partnership</EntityLegalForm>
<EntityOtherLegalForm>LIMITED LIABILITY PARTNERSHIP</EntityOtherLegalForm>
<EntityStatus>ACTIVE</EntityStatus>
<InitialRegistrationDate>2017-07-13T01:50:00.000Z</InitialRegistrationDate>
<LastUpdatedDate>2017-07-13T01:50:00.000Z</LastUpdatedDate>
<ManagingLOU>EVK05KS7XY1DEII3R011</ManagingLOU>
<RegistrationAuthorityID>RA000585</RegistrationAuthorityID>
<RegistrationStatus>ISSUED</RegistrationStatus>
<RenewalDate>2018-07-11T15:00:00.000Z</RenewalDate>
<DirectlyConsolidatedBy>
<Entity>
<LEINumber>549300IGJ3BMOH7P3S23</LEINumber>
<LegalName>
<![CDATA[Hutchin Hill (UK) Services Limited]]>
</LegalName>
<OtherNames>
<![CDATA[ThyssenKrupp Automotive Erste Beteiligungsgesellschaft mbH - ThyssenKrupp Engineering GmbH - ]]>
</OtherNames>
<AddressLine>29 Farm Street</AddressLine>
<AddressAdditionalLine></AddressAdditionalLine>
<AddressCity>London</AddressCity>
<AddressRegion>GB-ENG</AddressRegion>
<AddressCountry>GB</AddressCountry>
<AddressPostalCode>W1J 5RL</AddressPostalCode>
<MeasurementMethod>ACCOUNTING_CONSOLIDATION</MeasurementMethod>
<QuantifierUnits>PERCENTAGE</QuantifierUnits>
<QuantifierAmount>68.00</QuantifierAmount>
</Entity>
</DirectlyConsolidatedBy>
<UltimatelyConsolidatedBy>
<Entity>
<LEINumber>004L5FPTUREIWK9T2N63</LEINumber>
<LegalName>
<![CDATA[Hutchin Hill Capital, LP]]>
</LegalName>
<OtherNames>
<![CDATA[]]>
</OtherNames>
<AddressLine>C/O Corporation Service Company</AddressLine>
<AddressAdditionalLine>2711 Centerville Road</AddressAdditionalLine>
<AddressCity>Wilmington</AddressCity>
<AddressRegion>US-DE</AddressRegion>
<AddressCountry>US</AddressCountry>
<AddressPostalCode>19808</AddressPostalCode>
<MeasurementMethod>ACCOUNTING_CONSOLIDATION</MeasurementMethod>
<QuantifierUnits>PERCENTAGE</QuantifierUnits>
<QuantifierAmount>68.00</QuantifierAmount>
</Entity>
</UltimatelyConsolidatedBy>
</Match>
<Match>
<SourceID>LEI_GLO_001</SourceID>
<SourceName>Global Legal Entity Identifier Foundation</SourceName>
<SourceAgency>GLEIF</SourceAgency>
<SourceEntity>Global</SourceEntity>
<FilterMatch>false</FilterMatch>
<SourceType>structured</SourceType>
<leiMatch>false</leiMatch>
<ResultsTitle>Global Legal Entity Identifier Foundation</ResultsTitle>
<ResultsURL>
<![CDATA[https://www.gleif.org]]>
</ResultsURL>
<LEINumber>549300IGJ3BMOH7P3S23</LEINumber>
<LegalName>
<![CDATA[Hutchin Hill (UK) Services Limited]]>
</LegalName>
<OtherNames>
<![CDATA[ThyssenKrupp Automotive Erste Beteiligungsgesellschaft mbH - ThyssenKrupp Engineering GmbH - ]]>
</OtherNames>
<ScriptName>
<![CDATA[Citernes Bedard Inc. ]]>
</ScriptName>
<Addresses>
<LegalAddress>
<AddressLine>29 Farm Street</AddressLine>
<AddressCity>London</AddressCity>
<AddressRegion>GB-ENG</AddressRegion>
<AddressCountry>GB</AddressCountry>
<AddressPostalCode>W1J 5RL</AddressPostalCode>
</LegalAddress>
<HeadquartersAddress>
<AddressLine>29 Farm Street</AddressLine>
<AddressCity>London</AddressCity>
<AddressRegion>GB-ENG</AddressRegion>
<AddressCountry>GB</AddressCountry>
<AddressPostalCode>W1J 5RL</AddressPostalCode>
</HeadquartersAddress>
<OtherAddress>
<AddressLine>東堀前通七番町1071-1</AddressLine>
<AddressCity>新潟県 新潟市中央区</AddressCity>
<AddressCountry>JP</AddressCountry>
<AddressPostalCode>951-8066</AddressPostalCode>
</OtherAddress>
</Addresses>
<LegalJurisdiction>GB</LegalJurisdiction>
<EntityCategory>FUND</EntityCategory>
<EntityOtherLegalForm>LIMITED</EntityOtherLegalForm>
<EntityStatus>ACTIVE</EntityStatus>
<InitialRegistrationDate>2017-07-11T02:02:00.000Z</InitialRegistrationDate>
<LastUpdatedDate>2017-07-11T02:02:00.000Z</LastUpdatedDate>
<ManagingLOU>EVK05KS7XY1DEII3R011</ManagingLOU>
<RegistrationAuthorityID>RA000585</RegistrationAuthorityID>
<RegistrationStatus>ISSUED</RegistrationStatus>
<RenewalDate>2018-07-07T15:25:00.000Z</RenewalDate>
<DirectlyConsolidatedBy>
<Entity>
<LEINumber>004L5FPTUREIWK9T2N63</LEINumber>
<LegalName>
<![CDATA[Hutchin Hill Capital, LP]]>
</LegalName>
<OtherNames>
<![CDATA[]]>
</OtherNames>
<AddressLine>C/O Corporation Service Company</AddressLine>
<AddressAdditionalLine>2711 Centerville Road</AddressAdditionalLine>
<AddressCity>Wilmington</AddressCity>
<AddressRegion>US-DE</AddressRegion>
<AddressCountry>US</AddressCountry>
<AddressPostalCode>19808</AddressPostalCode>
<MeasurementMethod>ACCOUNTING_CONSOLIDATION</MeasurementMethod>
<QuantifierUnits>PERCENTAGE</QuantifierUnits>
<QuantifierAmount>100.00</QuantifierAmount>
</Entity>
</DirectlyConsolidatedBy>
<DirectlyConsolidatedCompanies>
<Entity>
<LEINumber>549300FRJX2VJYUTRD71</LEINumber>
<LegalName>
<![CDATA[Hutchin Hill UK LLP]]>
</LegalName>
<OtherNames>
<![CDATA[Etablissements Guy Dauphin et Cie SA - ]]>
</OtherNames>
<AddressLine>29 Farm Street</AddressLine>
<AddressAdditionalLine></AddressAdditionalLine>
<AddressCity>London</AddressCity>
<AddressRegion>GB-ENG</AddressRegion>
<AddressCountry>GB</AddressCountry>
<AddressPostalCode>W1J 5RL</AddressPostalCode>
<MeasurementMethod>ACCOUNTING_CONSOLIDATION</MeasurementMethod>
<QuantifierUnits>PERCENTAGE</QuantifierUnits>
<QuantifierAmount>68.00</QuantifierAmount>
</Entity>
</DirectlyConsolidatedCompanies>
</Match>
</Details>
</MatchDetails>
Response Elements
| Element | Description |
|---|---|
| ErrorStatus | |
| ErrorStatus.Code | 0 = Normal Processing See "Error Status Response Codes" |
| ErrorStatus.Message | Descriptive message associated with Code (100) |
| Summary | |
| Summary.RequestDateTime | Date/Time Stamp of Request (UTC) (ISO 8601 format) |
| Summary.Results Count | Number of results returned by this service (int) |
| Summary.CaseID | Case ID Requested (35) |
| Summary.SearchID | Search ID Requested (int) |
| Summary.SearchType | Type of Source Data searched (“WLS”, “PEP”, “GOV”, “PEPD” or “MEDIA”) (10) |
| Details | |
| Details.Match | |
| Details.Match.SourceID | WWP Source ID (20) |
| Details.Match.SourceName | WWP Source Name (100) |
| Details.Match.SourceAgency | WWP Source Agency Name (100) |
| Details.Match.SourceEntity | WWP Source Entity Entity (country/region) (100) |
| Details.Match.SourceCategory | |
| Details.Match.SourceCategory.Name | Name of Source Category Assigned (20) |
| Details.Match.KeywordsIdentified | Filter/Subject ID matches (100) |
| Details.Match.FilterMatch | Returns TRUE if this result source contained a match on at least one of the filters (keywords) provided. Otherwise, returns FALSE. |
| Details.Match.SignificantEvents | AIVAa FeatureReturns TRUE if a significant event directly attributed to the entity being searched. Otherwise, returns FALSE. |
| Details.Match.LocationMatch | AIVAa FeatureReturns TRUE if this result source contained a match on the geography subject identifiers specified in the search. Otherwise, returns FALSE. |
| Details.Match.SourceType | “structured” or “unstructured” |
| Details.Match.Alert | TRUE = New or changed source identified via monitoring FALSE = Original source (no monitoring alerts) |
| NMEDIA Search Type Specific Results | Match Details Provided (only applicable data elements returned). The following elements are returned for NMEDIA. |
| Details.Match.ResultsID | Unique Results ID (int) |
| Details.Match.ResultsTitle | (100) |
| Details.Match.ResultsURL | HTTP URL of data source (100) |
| Details.Match.Excerpts | Excerpts are used as a method to provide something back for unstructured sources when there is no structured data available. We either provide all structured data available or an excerpt. The excerpts could contain HTML. For example, bolding/highlighting of the name found in the string. (str size of excerpt setting per request 250-5000) |
| Details.Match.SignificantEvents | AIVAa Feature |
| Details.Match.SignificantEvents.Item | |
| Details.Match.SignificantEvents.Item.ID | The id (ontology) assigned to this event. |
| Details.Match.SignificantEvents.Item.Name | The descriptive name of the event. |
| Details.Match.SignificantEvents.Item.Association | direct = The searched entity was identified as directly associated with this event.
indirect = This event was identified through association. An entity involved in this signficant event was directly associated with the searched entity. |
| Details.Match.EntityDescriptors | AIVAa FeatureDescriptors used within the search result to describe the entity. |
| Details.Match.EntityDescriptors.Value | Examples: "the Pilot", "ex-President", "the leader of the Abu Sayyaf Group". |
| Details.Match.EntityAssociations | AIVAa FeaturePeople, places, or things identified in this result that have been directly associated to the searched entity. |
| Details.Match.EntityAssociations.Item | |
| Details.Match.EntityAssociations.Item.Label | Examples: "organization", "country", "title", "person", "spouse", "sibling" |
| Details.Match.EntityAssociations.Item.Value | Value identified by label. |
| WLS, GOV, SOE Search Type Specific Results | Match Details Provided (only applicable data elements returned). The following elements are returned for WLS, GOV, SOE search types. |
| Details.Match.ResultsID | Unique Results ID (int) |
| Details.Match.DOBExactMatch | If DOB was provided in request and an EXACT Match is found in the results, then returns: TRUE. Otherwise, FALSE |
| Details.Match.DOBMatch | If DOB was provided in request, returns: TRUE = At least one of the result sources contained a match on DOB based upon (day, month and year) OR (year) OR (day and month). FALSE = No result sources contained a match on DOB per the above criteria. Note: The data sources searched may also not have had DOB available to search. |
| Details.Match.ResultsID | Unique Results ID (int) |
| Details.Match.ResultsTitle | (100) |
| Details.Match.ResultsURL | HTTP URL of data source (100) |
| Details.Match.Excerpts | Excerpts are used as a method to provide something back for unstructured sources when there is no structured data available. We either provide all structured data available or an excerpt. The excerpts could contain HTML. For example, bolding/highlighting of the name found in the string. (str size of excerpt setting per request 250-5000) |
| Details.Match.SignificantEvents | AIVAa Feature |
| Details.Match.SignificantEvents.Item | |
| Details.Match.SignificantEvents.Item.AssociatedEvent | TRUE = This event was identified through association. An entity involved in this signficant event was directly associated with the searched entity. FALSE = The searched entity was identified as directly associated with this event. |
| Details.Match.SignificantEvents.Item.EventID | The id (ontology) assigned to this event. |
| Details.Match.SignificantEvents.Item.EventName | The descriptive name of the event. |
| Details.Match.EntityDescriptors | AIVAa FeatureDescriptors used within the search result to describe the entity. |
| Details.Match.EntityDescriptors.Value | Examples: "the Pilot", "ex-President", "the leader of the Abu Sayyaf Group". |
| Details.Match.EntityAssociations | AIVAa FeaturePeople, places, or things identified in this result that have been directly associated to the searched entity. |
| Details.Match.EntityAssociations.Item | |
| Details.Match.EntityAssociations.Item.Label | Examples: "organization", "country", "title", "person", "spouse", "sibling" |
| Details.Match.EntityAssociations.Item.Value | Value identified by label. |
| Details.Match.FullName | (512) |
| Details.Match.Aliases | (2048) |
| Details.Match.DateofBirth | (64) |
| Details.Match.PlaceofBirth | (64) |
| Details.Match.Nationality | (64) |
| Details.Match.Address | (64) |
| Details.Match.IdentityDocuments | (256) |
| Details.Match.EyeColor | (10) |
| Details.Match.HairColor | (10) |
| Details.Match.Height | (20) |
| Details.Match.Weight | (20) |
| Details.Match.Entity | (100) |
| Details.Match.Remarks | (1024) |
| Details.Match.MailingAddressName | (50) |
| Details.Match.MailingAddress | (50) |
| Details.Match.PreviousAddress | (50) |
| Details.Match.RecordType | (50) |
| Details.Match.CorporateName | (75) |
| Details.Match.AvgNumberofEmployees | (10) |
| Details.Match.AnnualReceipts | (50) |
| Details.Match.CorporateURL | (50) |
| Details.Match.CompanyDivision | (50) |
| Details.Match.DivisionNumber | (50) |
| Details.Match.CorporatePhone1 | (50) |
| Details.Match.CorporatePhone2 | (50) |
| Details.Match.CorporateFax | (50) |
| Details.Match.CorporateEmail | (50) |
| Details.Match.RegistrationDate | (50) |
| Details.Match.RenewalDate | (50) |
| Details.Match.BusinessStartDate | (50) |
| Details.Match.FiscalYearEndClose | (50) |
| Details.Match.OrganizationalType | (50) |
| Details.Match.CountryofIncorporation | (50) |
| Details.Match.StateofIncorporation | (50) |
| Details.Match.OwnerName | (50) |
| Details.Match.OwnerEmail | (50) |
| Details.Match.OwnerPhone1 | (50) |
| Details.Match.OwnerPhone2 | (50) |
| Details.Match.OwnerFax | (50) |
| Details.Match.GovtAdddressName | (50) |
| Details.Match.GovtAddress | (50) |
| Details.Match.GovtPhone1 | (50) |
| Details.Match.GovtPhone2 | (50) |
| Details.Match.GovtEmail | (50) |
| Details.Match.GovtFax | (50) |
| Details.Match.AltGovtAddressName | (50) |
| Details.Match.AltGovtAddress | (50) |
| Details.Match.AltGovtPhone1 | (50) |
| Details.Match.AltGovtPhone2 | (50) |
| Details.Match.AltGovtFax | (50) |
| Details.Match.AltGovtEmail | (50) |
| PEPD Search Type Specific Results | Match Details Provided (only applicable data elements returned). The following elements are returned for the PEPD search type. |
| Details.Match.DOBExactMatch | If DOB was provided in request and an EXACT Match is found in the results, then returns: TRUE. Otherwise, FALSE |
| Details.Match.DOBMatch | If DOB was provided in request, returns: TRUE = At least one of the result sources contained a match on DOB based upon (day, month and year) OR (year) OR (day and month). FALSE = No result sources contained a match on DOB per the above criteria. Note: The data sources searched may also not have had DOB available to search. |
| Details.Match.ResultsID | Unique Results ID (int) |
| Details.Match.ResultsTitle | (100) |
| Details.Match.ResultsURL | HTTP URL of data source (100) |
| Details.Match.PEPID | (int) |
| Details.Match.Country | (50) |
| Details.Match.CountryOfOrigin | (50) |
| Details.Match.CountryOfActivity | (50) |
| Details.Match.AdditionalInformation | (512) |
| Details.Match.PoliticalExposure | Each Function or Position Held |
| Details.Match.PoliticalExposure.Item | |
| Details.Match.PoliticalExposure.Item.Function | (100) |
| Details.Match.PoliticalExposure.Item.Category | (100) |
| Details.Match.Associations | Each associated entity identified |
| Details.Match.Associations.Item | |
| Details.Match.Associations.Item.PEPDID | (int) |
| Details.Match.Associations.Item.Title | (50) |
| Details.Match.Associations.Item.FullName | (100) |
| Details.Match.Associations.Item.OtherNames | (100) |
| Details.Match.Associations.Item.ScriptName | (100) |
| Details.Match.Associations.Item.Function | (100) |
| LEI Search Type Specific Results | Match Details Provided (only applicable data elements returned). The following elements are returned for the LEI search type. |
| Details.Match.LEIMatch | If an LEI was provided in request and an EXACT Match is found in the results, then returns: TRUE. Otherwise, FALSE |
| RDetails.Match.LEIOnlyMatch | If an LEI was provided in request and an EXACT Match is found in the results, BUT the LEI number does not match the name searched, then returns: TRUE. Otherwise, FALSE |
| Details.Match.ResultsTitle | (100) |
| Details.Match.ResultsURL | (100) |
| Details.Match.LEINumber | (20) |
| Details.Match.LegalName | (512) |
| Details.Match.OtherNames | (512) |
| Details.Match.ScriptName | (512) |
| Details.Match.Addresses | |
| Details.Match.Addresses.LegalAddress | |
| Details.Match.Addresses.LegalAddress.AddressLine | (100) |
| Details.Match.Addresses.LegalAddress.AddressAdditionalLine | (100) |
| Details.Match.Addresses.LegalAddress.AddressCity | (100) |
| Details.Match.Addresses.LegalAddress.AddressRegion | (100) |
| Details.Match.Addresses.LegalAddress.AddressCountry | (100) |
| Details.Match.Addresses.LegalAddress.AddressPostalCode | (100) |
| Details.Match.Addresses.HeadquartersAddress | |
| Details.Match.Addresses.HeadquartersAddress.AddressLine | (100) |
| Details.Match.Addresses.HeadquartersAddress.AddressAdditionalLine | (100) |
| Details.Match.Addresses.HeadquartersAddress.AddressCity | (100) |
| Details.Match.Addresses.HeadquartersAddress.AddressRegion | (100) |
| Details.Match.Addresses.HeadquartersAddress.AddressCountry | (100) |
| Details.Match.Addresses.HeadquartersAddress.AddressPostalCode | (100) |
| Details.Match.Addresses.OtherAddress | |
| Details.Match.Addresses.OtherAddress.AddressLine | (100) |
| Details.Match.Addresses.OtherAddress.AddressAdditionalLine | (100) |
| Details.Match.Addresses.OtherAddress.AddressCity | (100) |
| Details.Match.Addresses.OtherAddress.AddressRegion | (100) |
| Details.Match.Addresses.OtherAddress.AddressCountry | (100) |
| Details.Match.Addresses.OtherAddress.AddressPostalCode | (100) |
| Details.Match.LegalJurisdiction | (100) |
| Details.Match.EntityCategory | (100) |
| Details.Match.EntityLegalForm | (100) |
| Details.Match.EntityOtherLegalForm | (100) |
| Details.Match.EntityStatus | (100) |
| Details.Match.InitialRegistrationDate | (100) |
| Details.Match.LastUpdatedDate | (100) |
| Details.Match.ManagingLOU | (100) |
| Details.Match.RegistrationAuthorityID | (100) |
| Details.Match.RegistrationStatus | (100) |
| Details.Match.RenewalDate | (100) |
| Details.Match.DirectlyConsolidatedBy | |
| Details.Match.DirectlyConsolidatedBy | |
| Details.Match.DirectlyConsolidatedBy.Entity | |
| Details.Match.DirectlyConsolidatedBy.Entity.LEINumber | (100) |
| Details.Match.DirectlyConsolidatedBy.Entity.LegalName | (100) |
| Details.Match.DirectlyConsolidatedBy.Entity.OtherNames | (100) |
| Details.Match.DirectlyConsolidatedBy.Entity.AddressLine | (100) |
| Details.Match.DirectlyConsolidatedBy.Entity.AddressAdditionalLine | (100) |
| Details.Match.DirectlyConsolidatedBy.Entity.AddressCity | (100) |
| Details.Match.DirectlyConsolidatedBy.Entity.AddressRegion | (100) |
| Details.Match.DirectlyConsolidatedBy.Entity.AddressCountry | (100) |
| Details.Match.DirectlyConsolidatedBy.Entity.AddressPostalCode | (100) |
| Details.Match.DirectlyConsolidatedBy.Entity.MeasurementMethod | (100) |
| Details.Match.DirectlyConsolidatedBy.Entity.QuantifierUnits | (100) |
| Details.Match.DirectlyConsolidatedBy.Entity.QuantifierAmount | (100) |
| Details.Match.UltimatelyConsolidatedBy | |
| Details.Match.UltimatelyConsolidatedBy.Entity | |
| Details.Match.UltimatelyConsolidatedBy.Entity.LEINumber | (100) |
| Details.Match.UltimatelyConsolidatedBy.Entity.LegalName | (100) |
| Details.Match.UltimatelyConsolidatedBy.Entity.OtherNames | (100) |
| Details.Match.UltimatelyConsolidatedBy.Entity.AddressLine | (100) |
| Details.Match.UltimatelyConsolidatedBy.Entity.AddressAdditionalLine | (100) |
| Details.Match.UltimatelyConsolidatedBy.Entity.AddressCity | (100) |
| Details.Match.UltimatelyConsolidatedBy.Entity.AddressRegion | (100) |
| Details.Match.UltimatelyConsolidatedBy.Entity.AddressCountry | (100) |
| Details.Match.UltimatelyConsolidatedBy.Entity.AddressPostalCode | (100) |
| Details.Match.UltimatelyConsolidatedBy.Entity.MeasurementMethod | (100) |
| Details.Match.UltimatelyConsolidatedBy.Entity.QuantifierUnits | (100) |
| Details.Match.UltimatelyConsolidatedBy.Entity.QuantifierAmount | (100) |
| Details.Match.DirectlyConsolidatedCompanies | |
| Details.Match.DirectlyConsolidatedCompanies.Entity | |
| Details.Match.DirectlyConsolidatedCompanies.Entity.LEINumber | (100) |
| Details.Match.DirectlyConsolidatedCompanies.Entity.LegalName | (100) |
| Details.Match.DirectlyConsolidatedCompanies.Entity.OtherNames | (100) |
| Details.Match.DirectlyConsolidatedCompanies.Entity.AddressLine | (100) |
| Details.Match.DirectlyConsolidatedCompanies.Entity.AddressAdditionalLine | (100) |
| Details.Match.DirectlyConsolidatedCompanies.Entity.AddressCity | (100) |
| Details.Match.DirectlyConsolidatedCompanies.Entity.AddressRegion | (100) |
| Details.Match.DirectlyConsolidatedCompanies.Entity.AddressCountry | (100) |
| Details.Match.DirectlyConsolidatedCompanies.Entity.AddressPostalCode | (100) |
| Details.Match.DirectlyConsolidatedCompanies.Entity.MeasurementMethod | (100) |
| Details.Match.DirectlyConsolidatedCompanies.Entity.QuantifierUnits | (100) |
| Details.Match.DirectlyConsolidatedCompanies.Entity.QuantifierAmount | (100) |
Error Status Response Codes
GetMatchDetails Error Status Response Codes:
| Code | Message |
|---|---|
| 0 | Normal Processing |
| 10 | No Queries Processed |
| 50 | Service Not Currently Available (ie. System down for maintenance) |
| 90 | Invalid Receiver ID Specified |
| 91 | Invalid Version ID Specified |
| 95 | Invalid Search Identification (Requested search does not exist) |
| 98 | Improperly Formatted XML |
| 99 | Invalid Credentials |
GetMonitoringAlerts Method
| PURPOSE: | Requests alerts that have been identified as a result of ongoing monitoring activity. Monitoring services must be enabled for your account on each platform of intended use. Monitoring services “re-process” entity searches using original search criteria on a predetermined schedule (daily, weekly, monthly, annually), compare current results to previous results, identify changes, and create alerts if changes are identified. |
Request Summary
Request parameters must be submitted as properly formed XML as specified in the API call and passed as the payload to this method. Results will be returned in the same format.
The request parameters for this method can be summarized as follows:
| 1. | Receiver | API Version and Target Environment identification | Required |
| 2. | Sender | Your Partner ID and Account identification | Required |
| 3. | Request | Details request parameters | Required |
API Endpoint
Test Environment:https://test.worldwatchplus.com/api/getmonitoringalerts.php
Production - Due Diligence (DD) – for most clients:https://dd.worldwatchplus.com/api/getmonitoringalerts.php
Production - Credit Reporting Agencies (CRA) – for background screening companies:https://cra.worldwatchplus.com/api/getmonitoringalerts.php
Production - European Union (EU) – for clients servicing EU member countries:https://eu.worldwatchplus.com/api/getmonitoringalerts.php
All of the above require a Post Variable where: xml="xmlrequest"
Example GetMonitoringAlerts Request:
See XML
<GetMonitoringAlerts>
<Receiver>
<ReceiverID>INTLSOL</ReceiverID>
<VersionID>1.20</VersionID>
<EnvironmentCode>Test</EnvironmentCode>
</Receiver>
<Sender>
<PartnerID>bc89311111b73de97b594ceb74311111</PartnerID>
<AccountID>201888</AccountID>
<FCRA>false</FCRA>
</Sender>
<Request>
<StartDate>2018-07-01</StartDate>
</Request>
</GetMonitoringAlerts>
Specific Request Parameters
| Parameter | Description |
|---|---|
| Receiver | |
| Receiver.ReceiverID | RequiredWorldWatch Plus Assigned Identification as Receiver (30) |
| Receiver.VersionID | RequiredWorldWatch Plus Version ID of API (5) |
| Receiver.EnvironmentCode | RequiredWorldWatch Plus Target Operating Environment (Test or Production) (10). |
| Sender | |
| Sender.PartnerID | RequiredYour Partner ID assigned by WorldWatch Plus (35) |
| Sender.AccountID | RequiredYour Account Code that must be assigned and enabled by WorldWatch Plus (6) |
| Request | |
| Request.NewSinceLastRequest | Required-DRequests only new alerts that have not previously been requested (TRUE or FALSE). May or may not be used along with data range selection below. |
| Request.StartDate | Required-D Beginning Date of Alerts in ISO 8601 format (YYYY-MM-DD) |
| Request.EndDate | OptionalEnding Date of Alerts in ISO 8601 format (YYYY-MM-DD) – optional (default = current date) |
Response Summary
The response will be returned in the same data format specified when the API call was made. It is organized as follows:
| 1. | Error Status | Input Error Feedback |
| 2. | Summary | Summary of Response |
| 3. | Details | Monitoring Alert Details |
Example GetMonitoringAlerts Response:
<MonitoringAlerts>
<ErrorStatus>
<Code>0</Code>
<Message>Processed Normally</Message>
</ErrorStatus>
<Summary>
<RequestDateTime>2018-06-04 04:51:42Z</RequestDateTime>
<AlertCount>7</AlertCount>
</Summary>
<Details>
<Alert>
<CaseID>20167111142984a21160a773f71c601c</CaseID>
<ReferenceID>
<![CDATA[554760]]>
</ReferenceID>
<AlertDate>2017-07-03</AlertDate>
<Search>
<SearchID>1001</SearchID>
<SearchType>WLS</SearchType>
<SearchText>
<![CDATA[Mickey Mouse]]>
</SearchText>
<SearchResults>3</SearchResults>
<Deltas>1</Deltas>
</Search>
</Alert>
<Alert>
<CaseID>2016711114292b2779ecc9ee2720d921</CaseID>
<ReferenceID>
<![CDATA[540406]]>
</ReferenceID>
<AlertDate>2017-07-03</AlertDate>
<Search>
<SearchID>1001</SearchID>
<SearchType>WLS</SearchType>
<SearchText>
<![CDATA[Minnie Mouse]]>
</SearchText>
<SearchResults>3</SearchResults>
<Deltas>1</Deltas>
</Search>
</Alert>
<Alert>
<CaseID>201671111847d8981639505e393b26bd</CaseID>
<ReferenceID>
<![CDATA[554149]]>
</ReferenceID>
<AlertDate>2017-07-03</AlertDate>
<Search>
<SearchID>1001</SearchID>
<SearchType>WLS</SearchType>
<SearchText>
<![CDATA[Winnie the Pooh]]>
</SearchText>
<SearchResults>2</SearchResults>
<Deltas>1</Deltas>
</Search>
</Alert>
<Alert>
<CaseID>201671112313c391893a1f784bad3ce5</CaseID>
<ReferenceID>
<![CDATA[491623]]>
</ReferenceID>
<AlertDate>2017-07-03</AlertDate>
<Search>
<SearchID>1002</SearchID>
<SearchType>WLS</SearchType>
<SearchText>
<![CDATA[ABC Company]]>
</SearchText>
<SearchResults>2</SearchResults>
<Deltas>2</Deltas>
</Search>
</Alert>
<Alert>
<CaseID>20167115274b4e74fa2aab5f077086c</CaseID>
<ReferenceID />
<AlertDate>2017-07-29</AlertDate>
<Search>
<SearchID>1007</SearchID>
<SearchType>WLS</SearchType>
<SearchText>
<![CDATA[Widgets International]]>
</SearchText>
<SearchResults>2</SearchResults>
<Deltas>1</Deltas>
</Search>
</Alert>
<Alert>
<CaseID>20167115274b4e74fa2aab5f077086c</CaseID>
<ReferenceID />
<AlertDate>2017-07-29</AlertDate>
<Search>
<SearchID>1008</SearchID>
<SearchType>WLS</SearchType>
<SearchText>
<![CDATA[Captain Crunch]]>
</SearchText>
<SearchResults>2</SearchResults>
<Deltas>0</Deltas>
</Search>
</Alert>
<Alert>
<CaseID>201671152714231bcd547570eb5ff2e2</CaseID>
<ReferenceID />
<AlertDate>2017-07-29</AlertDate>
<Search>
<SearchID>1016</SearchID>
<SearchType>WLS</SearchType>
<SearchText>
<![CDATA[Marcos Gun Emporium]]>
</SearchText>
<SearchResults>3</SearchResults>
<Deltas>1</Deltas>
</Search>
</Alert>
</Details>
</MonitoringAlerts>
Response Elements
| Element | Description |
|---|---|
| ErrorStatus | |
| ErrorStatus.Code | 0 = Normal Processing See "Error Status Response Codes" |
| ErrorStatus.Message | Descriptive message associated with Code (100) |
| Summary | |
| Summary.RequestDateTime | Date/Time Stamp of Request (UTC) (ISO 8601 format) |
| Summary.AlertsCount | Number of results/events returned (int) |
| Details | |
| Details.Alert | Alert Details Provided |
| Details.Alert.CaseID | WWP Unique Case ID |
| Details.Alert.AlertDate | Date of Alert in ISO 8601 format (YYYY-MM-DD) |
| Details.Alert.Search | WWP Specific Search IDs |
| Details.Alert.Search.SearchID | WWP Search ID |
| Details.Alert.Search.SearchType | Examples: WLS, GOV, SOE, PEPD, NMEDIA |
| Details.Alert.Search.SearchText | Subject Name Searched |
| Details.Alert.Search.SearchResults | Number of Monitored Search Results |
| Details.Alert.Search.Deltas | Number of New or Changed Results |
Error Status Response Codes
GetMonitoringAlerts Error Status Response Codes:
| Code | Message |
|---|---|
| 0 | Normal Processing |
| 10 | No Alerts Found |
| 11 | Invalid Start Date |
| 12 | Invalid End Date |
| 50 | Service Not Currently Available (ie. System down for maintenance) |
| 90 | Invalid Receiver ID Specified |
| 91 | Invalid Version ID Specified |
| 98 | Improperly Formatted XML |
| 99 | Invalid Credentials |
GetAdjudicationStatus Method
| PURPOSE: | Requests the current status of adjudication for a specific search. Requires the WorldWatch Plus portal to be used for adjudication. Example adjudication statuses are “No Match Found”, “Possible Match Found”, and “Flagged”. Example use case for this web service could be a hybrid integration solution where the client’s Procurement application calls the GetRiskReport API to screen a vendor and receives results that need to be adjudicated. The Procurement or Compliance Team would adjudicate results using the WorldWatch Plus portal and the Procurement application would wait for the vendor to be “cleared” prior to taking next steps. |
Request Summary
Request parameters must be submitted as properly formed XML as specified in the API call and passed as the payload to this method. Results will be returned in the same format.
The request parameters for this method can be summarized as follows:
| 1. | Receiver | API Version and Target Environment identification | Required |
| 2. | Sender | Your Partner ID and Account identification | Required |
| 3. | Request | Details request parameters | Required |
API Endpoint
Test Environment:https://test.worldwatchplus.com/api/getadjudicationstatus.php
Production - Due Diligence (DD) – for most clients:https://dd.worldwatchplus.com/api/getadjudicationstatus.php
Production - Credit Reporting Agencies (CRA) – for background screening companies:https://cra.worldwatchplus.com/api/getadjudicationstatus.php
Production - European Union (EU) – for clients servicing EU member countries:https://eu.worldwatchplus.com/api/getadjudicationstatus.php
All of the above require a Post Variable where: xml="xmlrequest"
Example GetAdjudicationStatus Request:
See XML
<GetAdjudicationStatus>
<Receiver>
<ReceiverID>INTLSOL</ReceiverID>
<VersionID>1.20</VersionID>
<EnvironmentCode>Test</EnvironmentCode>
</Receiver>
<Sender>
<PartnerID>bc89311111b73de97b5941111136716c</PartnerID>
<AccountID>201855</AccountID>
<FCRA>false</FCRA>
</Sender>
<Request>
<CaseID>20164162254259dda30e3cf5083891dfb</CaseID>
</Request>
</GetAdjudicationStatus>
Specific Request Parameters
| Parameter | Description |
|---|---|
| Receiver | |
| Receiver.ReceiverID | RequiredWorldWatch Plus Assigned Identification as Receiver (30) |
| Receiver.VersionID | RequiredWorldWatch Plus Version ID of API (5) |
| Receiver.EnvironmentCode | RequiredWorldWatch Plus Target Operating Environment (Test or Production) (10). |
| Sender | |
| Sender.PartnerID | RequiredYour Partner ID assigned by WorldWatch Plus (35) |
| Sender.AccountID | RequiredYour Account Code that must be assigned and enabled by WorldWatch Plus (6) |
| Request | |
| Request.CaseID | Required-PCase ID returned by GetRiskReport (35) |
| Request.ReferenceID | Required-PCustomer Reference ID (50) |
Response Summary
The response will be returned in the same data format specified when the API call was made. It is organized as follows:
| 1. | Error Status | Input Error Feedback |
| 2. | Summary | Summary of Response |
| 3. | Details | Status Details |
Example GetAdjudicationStatus Response:
<AdjudicationStatus>
<ErrorStatus>
<Code>0</Code>
<Message>Processed Normally</Message>
</ErrorStatus>
<Summary>
<RequestDateTime>2018-06-04 05:06:18Z</RequestDateTime>
</Summary>
<Details>
<CaseID>20164162254259dda30e3cf5083891dfb</CaseID>
<ReferenceID></ReferenceID>
<StatusCode>3</StatusCode>
<StatusDescription>
<![CDATA[Adjudicated: Possible Match Found]]>
</StatusDescription>
</Details>
</AdjudicationStatus>
Response Elements
| Element | Description |
|---|---|
| ErrorStatus | |
| ErrorStatus.Code | 0 = Normal Processing See "Error Status Response Codes" |
| ErrorStatus.Message | Descriptive message associated with Code (100) |
| Summary | |
| Summary.RequestDateTime | Date/Time Stamp of Request (UTC) (ISO 8601 format) |
| Details | |
| Details.CaseID | Case ID (35) |
| Details.ReferenceID | Customer Reference ID (50) |
| Details.StatusCode | Adjudication Status Code 0 = Clear: No Results Found 1 = Not Adjudicated 2 = Adjudicated: No Match Found 3 = Adjudicated: Possible Match Found 4 = Adjudicated: Flagged |
| Details.StatusDescription | Adjudication Status Description (see above) (30) |
Error Status Response Codes
GetAdjudicationStatus Error Status Response Codes:
| Code | Message |
|---|---|
| 0 | Normal Processing |
| 10 | Case or Reference ID Not Found |
| 50 | Service Not Currently Available (ie. System down for maintenance) |
| 90 | Invalid Receiver ID Specified |
| 91 | Invalid Version ID Specified |
| 98 | Improperly Formatted XML |
| 99 | Invalid Credentials |
UpdateRiskReport Method
| PURPOSE: | Updates the original searches performed using GetRiskReport. This web service is used to turn monitoring Off or On. Records can also be cleansed/purged using this service. |
Request Summary
Request parameters must be submitted as properly formed XML as specified in the API call and passed as the payload to this method. Results will be returned in the same format.
The request parameters for this method can be summarized as follows:
| 1. | Receiver | API Version and Target Environment identification | Required |
| 2. | Sender | Your Partner ID and Account identification | Required |
| 3. | Request | Detailed request parameters | Required |
API Endpoint
Test Environment:https://test.worldwatchplus.com/api/updateriskreport.php
Production - Due Diligence (DD) – for most clients:https://dd.worldwatchplus.com/api/updateriskreport.php
Production - Credit Reporting Agencies (CRA) – for background screening companies:https://cra.worldwatchplus.com/api/updateriskreport.php
Production - European Union (EU) – for clients servicing EU member countries:https://eu.worldwatchplus.com/api/updateriskreport.php
All of the above require a Post Variable where: xml="xmlrequest"
Example UpdateRiskReport Requests:
See XML
<UpdateRiskReport>
<Receiver>
<ReceiverID>INTLSOL</ReceiverID>
<VersionID>1.20</VersionID>
<EnvironmentCode>Test</EnvironmentCode>
</Receiver>
<Sender>
<PartnerID>bc89341111173de97b594ceb7111116c</PartnerID>
<AccountID>201802</AccountID>
<FCRA>false</FCRA>
</Sender>
<Request>
<CaseID>20164162254259dda30e3cf5083891dfb</CaseID>
<Monitoring>true</Monitoring>
<Cleanse>false</Cleanse>
</Request>
</UpdateRiskReport>
Specific Request Parameters
| Parameter | Description |
|---|---|
| Receiver | |
| Receiver.ReceiverID | RequiredWorldWatch Plus Assigned Identification as Receiver (30) |
| Receiver.VersionID | RequiredWorldWatch Plus Version ID of API (5) |
| Receiver.EnvironmentCode | RequiredWorldWatch Plus Target Operating Environment (Test or Production) (10). |
| Sender | |
| Sender.PartnerID | RequiredYour Partner ID assigned by WorldWatch Plus (35) |
| Sender.AccountID | RequiredYour Account Code that must be assigned and enabled by WorldWatch Plus (6) |
| Request | |
| Request.CaseID | Required-PCase ID returned by GetRiskReport (35) |
| Request.ReferenceID | Required-PCustomer Reference ID (50) |
| Request.Monitoring | Enables (True) or Disables (False) Monitoring Acitivity for specified Case or Reference ID |
| Request.Cleanse | Wipe/clear any PII from this transaction in WorldWatch Plus. True or False |
Response Summary
The response will be returned in the same data format specified when the API call was made. It is organized as follows:
| 1. | Error Status | Input Error Feedback |
| 2. | Summary | Summary of Response |
| 3. | Details | Status Details |
Example UpdateRiskReport Response:
<RiskReport>
<ErrorStatus>
<Code>0</Code>
<Message>Processed Normally</Message>
</ErrorStatus>
<Summary>
<RequestDateTime>2018-06-04 05:14:23Z</RequestDateTime>
</Summary>
<Details>
<CaseID>20164162254259dda30e3cf5083891dfb</CaseID>
<ReferenceID></ReferenceID>
</Details>
</RiskReport>
Response Elements
| Element | Description |
|---|---|
| ErrorStatus | |
| ErrorStatus.Code | 0 = Normal Processing See "Error Status Response Codes" |
| ErrorStatus.Message | Descriptive message associated with Code (100) |
| Summary | |
| Summary.RequestDateTime | Date/Time Stamp of Request (UTC) (ISO 8601 format) |
| Details | |
| Details.CaseID | Case ID (35) |
| Details.ReferenceID | Customer Reference ID (50) |
Error Status Response Codes
UpdateRiskReport Error Status Response Codes:
| Code | Message |
|---|---|
| 0 | Normal Processing |
| 10 | Case or Reference ID Not Found |
| 50 | Service Not Currently Available (ie. System down for maintenance) |
| 90 | Invalid Receiver ID Specified |
| 91 | Invalid Version ID Specified |
| 98 | Improperly Formatted XML |
| 99 | Invalid Credentials |