NAV
REST SOAP

Getting Started

Some key concepts you should know…
The W2 API is built around a few simple concepts when brought together provide powerful and flexible solutions.

Services


W2 has a wide portfolio of products that we name Services, ranging from checking against datasources such as global Sanctions list, Identity checking using credit reference agencies, document verification and many more.

A full list of all services can be found here.

Services are accessed through the API via Bundles.

Bundles


A bundle is a collection of one or more services. Services can be ordered in a bundle in any way you choose.

When you call the W2 API you specify a bundle name. By collecting services in a Bundle, only one API call is then required to execute all services in that Bundle.

Bundles are configured by W2. This will be completed as part of the on-boarding process.

Typical bundle example

As an example, if you wanted to confirm an individual’s identity and check that they are not on any Sanctions lists, the bundle might look like this:

Bundle Name Services Service Description
KYC_ID_CHECK_EXAMPLE  IdCheckUKAlphaFull UK Identity Check
  SISCheckPlus Standard International Sanctions
  PEPDesk Politically Exposed Persons

This bundle example contains three services. The first one, IdCheckUkAlphaFull, checks various sources (Electoral Roll, credit lenders, etc.) to confirm an individual’s identity. The next two services check the given name against a Sanctions list and a Politically Exposed Persons list.

To execute this bundle you would call the KYCCheck method on the API with the bundle name (KYC_ID_CHECK_EXAMPLE) and the required identity information (name, date of birth, address, etc.). The API will run through each service in sequence and return the results in one response. In the above example if the identity was good but the individual turns up in a PEP list you might get something like this:

Bundle Name Services Service Description Service Result
KYC_ID_Check_Sanctions IdCheckUKAlphaFull UK Identity Check PASS
  SISCheckPlus Standard International Sanctions NO RESULTS
  PEPDesk Politically exposed persons 1 RESULT

The Response will also contain more detailed information about each result.

Bundle Workflows

Also known as ‘Interpret and Halt’ or ‘Staged Search Manager’. As part of setting up a bundle W2 can configure settings that can ‘Interpret’ service level and bundle level results as well as ’Halting’ the execution of a Bundle should a certain result be returned from an individual Service.

Bundle Result Interpretation

W2 can configure how the API will interpret the overall result for the whole bundle. For example, in the example bundle above, if the Alpha service returned a “Fail” result then the bundle’s overall result would also be “Fail”. The possible results for Bundle results are Pass, Fail or Inconclusive. 

Bundle Halting

We can also configure the bundle to Halt after each service based on the result of that service. So for example you might decide that if Alpha returns a Fail (i.e. this identity is not valid) then there is no point checking the sanctions lists, so the bundle will stop there and not call the rest of the services in the bundle.

So in our example above let us assume that we have configured the following rules:

  1. Fail if Alpha returns Fail or Inconclusive,
  2. Return Inconclusive if the Sanctions or Political Persons lists have any matches

If we get the same results based on these results the service would return inconclusive

Bundle Name Intepret Result Services Service Description Service Result
KYC_ID_Check_Sanctions INCONCLUSIVE IdCheckUKAlphaFull UK Identity Check PASS
    SISCheckPlus Standard International Sanctions NO RESULTS
    PEPDesk Politically Exposed Persons 1 RESULT

Sandbox Cases

Two Plus Two Check


Our identity check services attempt to do a Two Plus Two check.

All this means is that we will attempt to match the name and address from one data source and the name and date of birth from another independent data source.

For example, if we can find the name and address on the Electoral Roll and the name and date of birth on a credit lenders record then that would be a Two Plus Two check. If we only found the information on the Electoral Roll then that would not be a Two Plus Two check as this only use one data source.

REST

This section describes how to use the W2 restful Api

Location

Live: https://api.w2globaldata.com

UAT: https://api-uat.w2globaldata.com

Authentication

The W2 REST API uses basic authentication. You will need to add a basic authorization header with your api key base 64 encoded to all requests.

Header Key Header Pattern
Authorization Basic Base64EncodedW2ApiKey

API Versioning

To call a specific version of the API append the API version query option to the end of the URL like this: https://api.w2globaldata.com/kyc-check?api-version=1.1

We strongly recommend that you provide a version number with all of your requests. A request without a version number will default to the latest version of the API so you might experience changes you are not prepared for.

KYC Check


This section describes how the KYC check API endpoint functions

How to call the endpoint

To call the endpoint you will need to perform a HTTP POST request to the URL:

API Version Url
1.0 https://api.w2globaldata.com/kyccheck?api-version=1.0 (Deprecated)
1.1 https://api.w2globaldata.com/kyccheck?api-version=1.1 (Deprecated)
1.2 https://api.w2globaldata.com/kyc-check?api-version=1.2 Latest

Request & Response

Full Request example:

{
	"Bundle": "Bundle123",
	"ClientReference": "MyReference123",
	"Data": {
		"AgeVerificationPassIf": 0,
		"AgeVerificationThreshold": 0,
		"City": "Newport",
		"Country": "Wales",
		"County": "Gwent",
		"DateOfBirthMatchThreshold": 80,
		"DayOfBirth": 10,
		"DrivingLicenceNumber": "123",
		"Email": "[email protected]",
		"Flat": "12",
		"Forename": "Tyrion",
		"Gender": "Male",
		"HouseName": "Casterly Rock",
		"HouseNumber": "10",
		"HouseNameNumber": "10 Casterly Rock",
		"IP": "192.168.0.1",
		"IdCardNumber": "123",
		"MRZ": ">>123>>",
		"Maiden": "???",
		"MiddleNames": "James",
		"MobileNumber": "001",
		"MonthOfBirth": 10,
		"NameQuery": "Tyrion Lannister",
		"NameQueryMatchThreshold": 80,
		"NationalId": "123",
		"PassportNumber": "123",
		"PersonalId": "123",
		"PhoneNumber": "000123",
		"PlaceOfBirth": "Lannisport",
		"Postcode": "LANN1",
		"ProfileId": "123-123-123-123",
		"Region": "Westerlands",
		"Street": "Lannisport Street",
		"Surname": "Lannister",
		"TaxCode": "123",
		"Title": "Lord",
		"TravelVisaNumber": "123",
		"YearOfBirth": 273
	},
	"Files": [{
		"Id": "123",
		"Reference": "123-ref-321",
		"Group": "group1",
		"Index": 0,
		"Service": "W2_DATA_IDVCHECK_013"
		}
	],
	"Options": {
		"Sandbox": "False",
		"Key": "Value"
	}
}

KYC Check Response Example (SIS Plus service call):



{
  "clientReference": "123-456-789",
  "results": {
    "sisPlusCheckResult": {
      "matchResults": [
        {
          "matchType": "Person",
          "name": "Robert Gabriel MUGABE",
          "nameMatchScore": 85,
          "profileId": "SANC-d28cdbbd-5c0e-1a1b-4c1c-88a6b5790e84"
        },
        {
          "matchType": "Person",
          "name": "Robert Gabriel MUGABE",
          "nameMatchScore": 85,
          "profileId": "SANC-081d73e2-b1cd-baeb-176b-cf1607b75383"
        },
        {
          "matchType": "Unknown",
          "name": "Robert Gabriel Mugabe",
          "nameMatchScore": 85,
          "profileId": "SANC-dac80327-376e-6784-e793-3d39904726f4"
        },
        {
          "matchType": "Person",
          "name": "MUGABE Robert Gabriel",
          "nameMatchScore": 80,
          "profileId": "SANC-9763b970-f325-77bc-5c7e-46d7c18b3f01"
        }
      ]
    }
  },
  "transaction": {
    "interpretResult": "NotApplicable",
    "serviceCallReference": "8bb44731-9103-47b2-979e-f27c69f9d68b",
    "serviceTransactions": [
      {
        "haltTriggered": false,
        "service": "SISPlusCheck",
        "serviceInterpretResult": "MultipleResults",
        "serviceTransactionResult": "Success",
        "serviceTransactionResultMessage": "This call was generated using sandbox mode",
        "validationResult": "Pass"
      }
    ]
  }
}

Request Properties

Use this table to find the meaning of each of the fields in the request.

Property Description
Bundle The Bundle section states which bundle you are calling and is mandatory for every service call. A bundle is a collection of services which will be agreed with W2 Support.
ClientReference A reference identifying this call for your reference i.e. ‘My Company Testing’.
Data The Data object contains all the information about the individual or organisation you are querying. Which fields you need to include will be different for each service and many of them are only used for specific services. See the service page for each service you are calling.
Files This element is provided to supply the details of documents that are required for a service in the bundle to complete its work. For example, when using the IDDocumentCheck service, an image of the document must be associated with the call. This association is performed by adding the Unique ID of the document that was returned when it was uploaded to an item in this array.
Options These are optional parameters for some extra fields not covered in the Data object. The whole section is optional. The most common use is to set Sandbox mode, where you can call the service and get standard responses. For further information, each service has examples of how to structure a call to the sandbox.

Client Provided Data

This section simply reflects back information that was submitted in the API call.

Property Description
ClientReference This reflects back the client reference that was supplied in the request
ClientSubaccount An optional reference to identify which of your client accounts this call was made for.
ClientUser An optional reference to identify which individual user made this call. For future compatibility with W2 products we suggest this value should be the user’s email address.
RefersToServiceCallReference Links this call to a previous call by specifying the previous ServiceCallReference.

Transaction Information

This section contains the interpret result for the whole bundle, the service call reference and a section of meta data for each service.

Property Description
InterpretResult The validation result of the Interpret function.
1. Pass - The information supplied to the bundle passed validation.
2. Fail- The information supplied to the bundle failed validation.
3. Inconclusive- It was not possible to generate a clear validation result from the information supplied. It may be necessary to refer this query for further investigation.
4. NoInterpretPerformed - No interpret was performed in this case. Check the other information returned by the services to determine why.
5. NotApplicable - Interpret is not enabled for this bundle.
ServiceTransactions A collection of ServiceTransactionInformation objects. See below
ServiceCallReference A unique reference for this service call.

Service Transaction Information

Every service that is called will return one of these:

Property Description
Service The service that was invoked.
ServiceInterpretResult The validation result of the service interpret function.
1. Pass - The query data resulted in a pass.
2. Fail - The query data resulted in a failure.
3. Inconclusive - The query data resulted in an inconclusive outcome.
4. NoResults - The query data returned no results.
5. OneResult - The query data returned a single result.
6. MultipleResults - >The query data returned multiple results.
7. NotApplicable - Interpret is not applicable to the call or wasn’t enabled.
8. NotPerformed - An error prevented this result from being categorised.
ServiceTransactionResult The validation result for service transaction.
1. Success - The service executed successfully.
2. SuccessNoResults - The service executed successfully but no results were generated.
3. SuccessIncompleteResults - The service executed successfully but too many results were generated to return them all, so the results have been truncated.
4. MultipleChoices - The service could not continue as there are multiple choices available and one of them must be selected or the query must be submitted with more concise information in order to complete execution.
5. ClientErrorInsufficientInformation - There was insufficient information for the service to execute. Check that all of the required fields for the service were supplied.
6. NotExecutedDueToPreviousHalt - The service was not executed because a previous service in the bundle triggered a halt.
7. ServerErrorGeneralError - A general error occurred on the server trying to run the service.
ServiceTransactionResultMessage The message associated with the ServiceTransactionResult if applicable. The ServiceTransactionResultMessage is usually null, but in some cases may provide some insight into the ServiceTransactionResult. For example, if a service returns SuccessIncompleteResults the ServiceTransactionResultMessage may contain an explanation of why, such as there being a limit of 100 results per query. There is no standard across services for this field so it should not be relied upon, instead it is better to use it for debugging or additional information and rely on the ServiceTransactionResult which has consistent behaviour.
ValidationResult The validation result…
1. Pass - The information supplied to the service passed validation
2. Fail - The information supplied to the service failed validation.
3. Inconclusive - It was not possible to generate a clear validation result from the information supplied. It may be necessary to refer this query for further investigation.
4. NoValidationPerformed - No validation was performed in this case. Check the other information returned by the service to determine why.
5. NotApplicable - The service is not a service that performs validation and therefore validation is not applicable.
ServiceValidationDetails This field provides information about the pre-execution validation step and should be read in conjunction with the ValidationResult field.
HaltTriggered True if the service halted after this service

Upload Document

How to call the endpoint

To call the endpoint you will need to perform a HTTP POST request to the URL:

API Version URL
1.0 https://api.w2globaldata.com/documentupload?api-version=1.0 (Deprecated)
1.1 https://api.w2globaldata.com/document-upload?api-version=1.1 Latest

Content Type

The document upload endpoint expects the body of requests to be in the form-data format.

Request - Document Upload

Property Details
ServiceAuthorisation Contains authorisation information to identify the person using the service. See here
DocumentReference Contains a client-specified tracking reference. Maximum 100 Characters
DocumentType None - No type specified / known.
JPEG - A JPEG (Joint Picture Experts Group Image).
PNG - A PNG (Portable Network Graphics) image.
PDF - A PDF (Portable Document Format).
DocumentData Base64 Encoded representation of the document to upload.
DocumentExpiry Desired expiry date to apply to the document to upload.
If left blank, W2 will use the default value of 14 days to expire the document. This can be set anywhere up to a maximum of 6 months.
Once the expiration date has been reached, W2 will remove the image data from our system, however the footprint of the upload will be preserved.
QueryOptions Specify optional flags that alter the invocation of the service. See here

Response - Document Upload

Upload Document Response

{
    "bytesUploaded": 108920,
    "reference": "123",
    "documentTypeValidationSucceeded": true,
    "id": "0e397a02-4b7c-5494-abf0-14e2230be606",
    "resolvedDocumentType": "JPEG"
}

Response Properties

Property Name Description
BytesUploaded The number of bytes uploaded to check against expected number.
Reference An echo of the value that was used on submission - useful when operating asynchronously.
DocumentTypeValidationSucceeded Whether or not the resolved document type matched the type specified by the user (e.g if the user specified the document was a PNG, and the document resolved to a PNG, this value is true).
Id The system assigned unique Id applied to this document on upload. Used to refer to the document when associating documents with a service as a part of the Files element of a KYC Check request.
ResolvedDocumentType The document type as resolved by the service - this can be compared against the expected (submitted) type for validation purposes.
- None
- No type specified / known.
- JPEG - A JPEG (Joint Picture Experts Group Image).
- PNG - A PNG (Portable Network Graphics) image.
- PDF - A PDF (Portable Document Format)

Document Size Limit

Document Verification


This section describes how the Document Verification API endpoint functions

Endpoints

Endpoint Description
Crop This endpoint is used to remove the background from an image of a document. This is helpful when you wish to display the document back to your customer as part their journey.
Verify The Verify endpoint performs the document verification.

Important Definitions

Term Definition
Document Type When using W2’s document verification api’s you will be asked to supply the Document Type of the document you are verifying. This refers to the size standards for identification documents specified by ISO. You can read more about the standard here. W2 currently Supports ID1 or ID3 documents

Crop

This section describes how the Crop API endpoint functions.
The Crop endpoint is used to perform document verification.

How to call the endpoint
To call the endpoint you will need to perform a HTTP POST request to the URL:

Calling document verification crop endpoint using C#

    using System;
    using System.IO;
    using System.Net.Http;
    using System.Threading.Tasks;
    using Newtonsoft.Json;

    public class Program
    {
        public class CropResult
        {
            public string Image { get; set; }
        }

        static async Task Main(string[] args)
        {
            var client = new HttpClient();

            var content = new MultipartFormDataContent();

            content.Add(new ByteArrayContent(File.ReadAllBytes("/ID1-Page1.png")), "Image", "image.png");

            content.Add(new StringContent("Id1"), "DocumentType");

            content.Add(new StringContent("1"), "Page");

            var response = await client.SendAsync(new HttpRequestMessage
            {
                Method = HttpMethod.Post,
                Headers = { { "Authorization", "Basic YourApiKey" } },
                RequestUri = new Uri("https://api.w2globaldata.com/document-verification/crop?api=version=1.1"),
                Content = content
            });

            var cropResult = JsonConvert.DeserializeObject<CropResult>(
                await response.Content.ReadAsStringAsync());

            File.WriteAllBytes("id1-cropped.png", Convert.FromBase64String(cropResult.Image));

            Console.WriteLine("Cropped image saved");

            Console.ReadLine();
        }
    }
Api Version Url
1.1 and greater https://api.w2globaldata.com/document-verification/crop

Content Type
The crop endpoint expects the body of requests to be in the form-data format. Responses will be in application/json format

Crop Request Structure

Property Description
Page (int) Represents the page of the document you are cropping.
- Required
- Must be between 1 and 3
- 1 for the front page of the document
- 2 for the back page of the document
- 3 for additional page of the document
DocumentType (string) A string representing the type of the document you are cropping.
- Required
- Must be either ‘ID1’ or ‘ID3’
Image (file) Image data representing the image you wish to crop
- Required
- File must be either JPEG, PNG or BMP
ClientReference (string) A reference identifying this call for your reference.
- Optional

Crop Response Structure

Example of a full document verification crop response

{
    "image": "{Base 64 data removed for documentation}",
    "metadata": {
        "glare": 0,
        "sharpness": 62
    }
}
Property Name Description
Image(string) Base 64 string representing the cropped document image.
Meta Data (object) Represents extended data obtained from cropping the image. The values provided are not guaranteed to exist on each request.

Verify

This section describes how the Verify API endpoint functions.
The Verify endpoint is used to perform document verification.

How to call the endpoint
To call the endpoint you will need to perform a HTTP POST request to the URL:

Example of how to call the document verification verify endpoint using C#

    using System;
    using System.IO;
    using System.Net.Http;
    using System.Threading.Tasks;
    using Newtonsoft.Json;

    public class VerifyResult
    {
        public string Result { get; set; }

        // OTHER PROPERTIES LEFT OUT FOR DEMO
    }

    public class Program
    {
        static async Task Main(string[] args)
        {
            var client = new HttpClient();

            var content = new MultipartFormDataContent();

            content.Add(new ByteArrayContent(File.ReadAllBytes("/Id1Image-front.png")), "pages", "id1-front.png");

            content.Add(new ByteArrayContent(File.ReadAllBytes("/Id1Image-back.png")), "pages", "id1-back.png");

            content.Add(new StringContent("Id1"), "DocumentType");

            content.Add(new StringContent("123"), "ClientReference");

            var response = await client.SendAsync(new HttpRequestMessage
            {
                Method = HttpMethod.Post,
                Headers = { { "Authorization", "Basic YourApiKey" } },
                RequestUri = new Uri("https://api.w2globaldata.com/document-verification/verify?api-version=1.1"),
                Content = content
            });

            var verificationResult = JsonConvert.DeserializeObject<VerifyResult>(
                await response.Content.ReadAsStringAsync());

            Console.WriteLine($"Verification result: {verificationResult.Result}");

            Console.ReadLine();
        }
    }
Api Version URL
1.1 and greater https://api.w2globaldata.com/document-verification/verify

Content Type
The verify endpoint expects the body of requests to be in the form-data format. Responses will be in application/json format.

Verify Request Structure

Property Description
Pages (File) An array of image data files that represent the images of the document.
- At least one page required
- File must be either JPEG, PNG or BMP
DocumentType (string) A string representing the type of the document you are cropping.
- Required
- Must be either ‘ID1’ or ‘ID3’
ClientReference (string) A reference identifying this call for your reference.
- Optional

Example of a full document verification response

{
    "alerts": [
        {
            "name": "Document Expired",
            "description": "Checked if the document is expired.",
            "mitigation": "The document has expired",
            "result": "Refer"
        },
        {
            "name": "Visible Color Response",
            "description": "Verified the color response of an element on the visible image.",
            "mitigation": "The color response is incorrect",
            "result": "Failed"
        },
        {
            "name": "Visible Pattern",
            "description": "Verified the presence of a pattern on the visible image.",
            "mitigation": "A visible pattern was not found",
            "result": "Failed"
        },
        {
            "name": "Document Number Crosscheck",
            "description": "Compare the machine-readable document number field to the human-readable document number field.",
            "mitigation": "The document numbers do not match",
            "result": "Refer"
        },
        {
            "name": "Birth Date Check Digit",
            "description": "Verified that the birth date check digit is correct.",
            "mitigation": "The birth date check digit is correct",
            "result": "Refer"
        },
        {
            "name": "Birth Date Crosscheck",
            "description": "Compare the machine-readable birth date field to the human-readable birth date field.",
            "mitigation": "The birth dates match",
            "result": "Refer"
        },
        {
            "name": "Birth Date Valid",
            "description": "Verified that the birth date is valid.",
            "mitigation": "The birth date is valid",
            "result": "Refer"
        },
        {
            "name": "Composite Check Digit",
            "description": "Verified that the composite check digit is correct.",
            "mitigation": "The composite check digit is correct",
            "result": "Refer"
        },
        {
            "name": "Document Classification",
            "description": "Verified that the type of document is supported and is able to be fully authenticated.",
            "mitigation": "The document type is supported",
            "result": "Refer"
        },
        {
            "name": "Document Crosscheck Aggregation",
            "description": "Compared the machine-readable fields to the human-readable fields.",
            "mitigation": "There are not a large number of differences between electronic and human-readable data sources",
            "result": "Refer"
        },
        {
            "name": "Document Number Check Digit",
            "description": "Verified that the document number check digit is correct.",
            "mitigation": "The document number check digit is correct",
            "result": "Refer"
        },
        {
            "name": "Expiration Date Check Digit",
            "description": "Verified that the expiration date check digit is correct.",
            "mitigation": "The expiration date check digit is correct",
            "result": "Refer"
        },
        {
            "name": "Expiration Date Crosscheck",
            "description": "Compare the machine-readable expiration date field to the human-readable expiration date field.",
            "mitigation": "The expiration dates match",
            "result": "Refer"
        },
        {
            "name": "Expiration Date Valid",
            "description": "Verified that the expiration date is valid.",
            "mitigation": "The expiration date is valid",
            "result": "Refer"
        },
        {
            "name": "Full Name Crosscheck",
            "description": "Compare the machine-readable full name field to the human-readable full name field.",
            "mitigation": "The full names match",
            "result": "Refer"
        },
        {
            "name": "Issue Date Valid",
            "description": "Verified that the issue date is valid.",
            "mitigation": "The issue date is valid",
            "result": "Refer"
        },
        {
            "name": "Issuing State Valid",
            "description": "Verified that the issuing state is valid.",
            "mitigation": "The issuing state is valid",
            "result": "Refer"
        },
        {
            "name": "Sex Crosscheck",
            "description": "Compare the machine-readable sex field to the human-readable sex field.",
            "mitigation": "The sexes match",
            "result": "Refer"
        },
        {
            "name": "Visible Color Response",
            "description": "Verified the color response of an element on the visible image.",
            "mitigation": "The color response is correct",
            "result": "Refer"
        },
        {
            "name": "Visible Pattern",
            "description": "Verified the presence of a pattern on the visible image.",
            "mitigation": "A visible pattern was found",
            "result": "Refer"
        }
    ],
    "checkedRegions": [
        {
            "name": "Back Reg",
            "height": 55,
            "width": 69,
            "xAxis": 180,
            "yAxis": 124
        },
        {
            "name": "Background",
            "height": 52,
            "width": 359,
            "xAxis": 325,
            "yAxis": 138
        },
        {
            "name": "Background Blue Color",
            "height": 52,
            "width": 359,
            "xAxis": 325,
            "yAxis": 138
        },
        {
            "name": "Background EU",
            "height": 56,
            "width": 65,
            "xAxis": 471,
            "yAxis": 136
        },
        {
            "name": "Background Red Color",
            "height": 52,
            "width": 359,
            "xAxis": 325,
            "yAxis": 138
        },
        {
            "name": "Birth Date",
            "height": 37,
            "width": 153,
            "xAxis": 203,
            "yAxis": 69
        },
        {
            "name": "Birth Place",
            "height": 35,
            "width": 353,
            "xAxis": 203,
            "yAxis": 97
        },
        {
            "name": "Document Number",
            "height": 46,
            "width": 177,
            "xAxis": 544,
            "yAxis": 2
        },
        {
            "name": "Expiration Date",
            "height": 31,
            "width": 166,
            "xAxis": 243,
            "yAxis": 150
        },
        {
            "name": "Fixed Reg",
            "height": 65,
            "width": 83,
            "xAxis": 232,
            "yAxis": 48
        },
        {
            "name": "Full Name",
            "height": 51,
            "width": 472,
            "xAxis": 244,
            "yAxis": 81
        },
        {
            "name": "Issuing Information",
            "height": 33,
            "width": 168,
            "xAxis": 244,
            "yAxis": 194
        },
        {
            "name": "Locator",
            "height": 164,
            "width": 146,
            "xAxis": 589,
            "yAxis": 107
        },
        {
            "name": "MRZ Locate",
            "height": 189,
            "width": 155,
            "xAxis": 1,
            "yAxis": 281
        },
        {
            "name": "MRZ1 (Visible)",
            "height": 44,
            "width": 699,
            "xAxis": 24,
            "yAxis": 311
        },
        {
            "name": "MRZ2 (Visible)",
            "height": 46,
            "width": 699,
            "xAxis": 24,
            "yAxis": 348
        },
        {
            "name": "MRZ3 (Visible)",
            "height": 51,
            "width": 699,
            "xAxis": 24,
            "yAxis": 388
        },
        {
            "name": "MRZ3 Check",
            "height": 70,
            "width": 86,
            "xAxis": 31,
            "yAxis": 354
        },
        {
            "name": "Photo",
            "height": 261,
            "width": 211,
            "xAxis": 26,
            "yAxis": 165
        },
        {
            "name": "Remarks Photo Side",
            "height": 97,
            "width": 289,
            "xAxis": 248,
            "yAxis": 304
        },
        {
            "name": "Seal",
            "height": 65,
            "width": 120,
            "xAxis": 532,
            "yAxis": 247
        },
        {
            "name": "Sex",
            "height": 36,
            "width": 58,
            "xAxis": 204,
            "yAxis": 140
        },
        {
            "name": "Signature",
            "height": 81,
            "width": 226,
            "xAxis": 499,
            "yAxis": 307
        },
        {
            "name": "Signature Label Black",
            "height": 39,
            "width": 154,
            "xAxis": 555,
            "yAxis": 387
        },
        {
            "name": "Type Header",
            "height": 60,
            "width": 323,
            "xAxis": 220,
            "yAxis": 0
        },
        {
            "name": "Type of Permit",
            "height": 51,
            "width": 295,
            "xAxis": 241,
            "yAxis": 242
        },
        {
            "name": "Validator 1",
            "height": 66,
            "width": 117,
            "xAxis": 10,
            "yAxis": 1
        },
        {
            "name": "Verify <<",
            "height": 122,
            "width": 607,
            "xAxis": 90,
            "yAxis": 316
        }
    ],
    "metaData": {
        "name": "Tyrion Lannister",
        "dateOfBirth": "1990-08-01T00:00:00.0000000Z",
        "mrz": "IRGGRJF321822427<<<<<<<<<<<<1234010M1511114KEN<<<<<<<<<<<8ICTHREEMALE<<TECH<REFRESH<<<<<",
        "documentNumber": "123456789"
    },
    "result": "Refer",
    "photo": "<Base 64 encoded image removed for documentation>",
    "signature": "<Base 64 encoded image removed for documentation"
}

Response Properties
This table describes the properties of the response.

Property Name Description
Alerts (array of objects) Represents the alerts generated from verifying the document. See the table below for details.
Checked Regions (array of objects) Shows the checked regions of the verified document. See the table below for details.
Meta Data (dictionary) A dictionary of key value pairs representing data from the verified document. We cannot guarantee the existence of any values in this dictionary. For example, verifying one document may return the Name on the document where as verifying another may not.
Result Represents the result of the verification.
Possible values:
- Pass
- Fail
- Refer
Photo Represents a base 64 encoded image of the cut out photo on the verified document.
Signature Represents a base 64 encoded image of the cut out signature on the verified document.

Alert

Property Name Description
Name (string) The name of the alert.
Description (string) The description of the alert.
Mitigation (string) The action(s) that can manually be performed to mitigate the alert.
Result (string) The alert result:
Failed - The alert indicates a failure of a document verification metric.
Refer - The alert indicates the possible manual verification metric that could not confidently be guaranteed correct by automated checks.

Alert table
On a document verification, the number of security checks completed varies from document to document, based on the number of security features that the document contains. To achieve an overall Pass, not every check needs to pass, and this alert table will highlight the checks that were not passed.

Checks that do not pass, are broken down into 2 categories – ‘Refer’ and ‘Failed’.

A ‘Refer’ simply refers to a potential warning or information alert that normally indicates that the quality of the image did not allow the check to be completed. Users normally find and on human inspection of these, they are passed, and most clients will simply ignore these alerts if the overall result of the Document verification is a Pass.

The ‘Failed’ checks indicate that the check was completed, but there was an element of the check that failed the verification. This will normally be associated with referred or failed checks; however, the visual checks can also fail depending on document classification. These should normally result in some human inspection, but again, are normally only checked in circumstances where the overall document check has not passed.

Regions checked
This table gives co-ordinates of the areas of the document that have been assessed and automatically reviewed. W2 provides these regions so clients can extract the specific regions of the document that relate to the checks that have been completed and inspect/review if they see fit. If clients are storing the documents, these regions can also be used as marker for ‘blacking out’ Personal Identifiable Information (PII).

Meta Data
This is the region where extracted information from the document is reported on via optical data recognition (OCR). W2 currently only reports on the Name, Date of birth, Machine-Readable zone (MRZ) and Document Number of a document. We are looking to expand these offerings to include document classification, address etc soon.

Result
This is the overall result of the document verification. This is the final, overall recommendation from W2 regarding how the document verification should be treated.

Photo
This is the photo that is extracted by the document verification. It is this photo that is normally used by the facial comparison SDK to compare the selfie picture against.

Signature
If a signature is included on the document, this is the region that will extract the image of the signature.

Checked Regions

Property Name Description
Name (string) The name of the document region.
Height (int) The height of the document region.
Width(int) the width of the document region.
xAxis (int) The x-axis co-ordinate or the document region
yAxis (int) The y-axis co-ordinate of the document region

Facial Comparison


This section describes how the Facial Comparison API endpoint functions

Example of how to call facial comparison endpoint using C#

    using System;
    using System.IO;
    using System.Net.Http;
    using System.Threading.Tasks;
    using Newtonsoft.Json;

    public class ComparisonResult
    {
        public bool IsMatch { get; set; }

        public int Confidence { get; set; }
    }

    public class Program
    {
        static async Task Main(string[] args)
        {
            var client = new HttpClient();

            var content = new MultipartFormDataContent();

            content.Add(new ByteArrayContent(File.ReadAllBytes("/face1.png")), "Current", "current.png");

            content.Add(new ByteArrayContent(File.ReadAllBytes("/face2.png")), "Comparison", "comparison.png");

            content.Add(new StringContent("123"), "ClientReference");

            var response = await client.SendAsync(new HttpRequestMessage
            {
                Method = HttpMethod.Post,
                Headers = { { "Authorization", "Basic YourApiKey" } },
                RequestUri = new Uri("https://api.w2globaldata.com/facial-comparison/compare?api-version=1.1"),
                Content = content
            });

            var comparisonResult = JsonConvert.DeserializeObject<ComparisonResult>(
                await response.Content.ReadAsStringAsync());

            Console.WriteLine($"Comparison result: {comparisonResult.IsMatch}");

            Console.ReadLine();
        }
    }

Endpoints

Endpoint Description
Compare This endpoint is used to determine whether the face in two different images are the same or not.

Request Properties
This details the fields of a facial comparison compare request.

   
Current (file) The Current element is the image captured from the device camera. It has to be a file rather than a text. When using the facial comparison endpoint, the Current image can be uploaded from the device. This element is compulsory, it cannot be removed or left empty.
- Required
- File must be either JPEG, PNG or BMP

Please ensure that the image presented is smaller than 1.5Mb. If an image larger than this is presented, the endpoint will compress the image (ensuring that the solution works) however this will have a detrimental effect on the response time.
Comparison (file) The Comparison is the image to be compared against the Current image. It has to be a file rather than a text. When using the facial comparison endpoint, the Comparison image can be uploaded from the device. This element is compulsory, it cannot be removed or left empty.
- Required
- File must be either JPEG, PNG or BMP

Please ensure that the image presented is smaller than 1.5Mb. If an image larger than this is presented, the endpoint will compress the image (ensuring that the solution works) however this will have a detrimental effect on the response time.
ClientReference (string) The Client Reference identifies this call for your reference.
- Optional

Response Properties
This table describes the properties of the response.

Facial Comparison Full Response Example 1

{
  "isMatch": true,
  "confidence": 100
}

Facial Comparison Full Response Example 2

{
  "isMatch": false,
  "confidence": 12
}
Property Name Description
isMatch (Boolean) Represents whether the uploaded images match each other: true = match, false = not a match. This is based on the confidence score returned, >= 85 will return true, <85 will return false
confidence (int) A score of 0 - 100 percentage, 0 indicates no match and 100 indicates 100% match

SOAP

API V3 Documentation


An overview of the W2 Global Data API V3

API Version 3

LIVE: https://apiv3.w2globaldata.com/Service.svc?wsdl

UAT: https://apiv3-uat.w2globaldata.com/Service.svc?wsdl

The API exposes two methods: KYCCheck and DocumentUpload.

KYCCheck

This is the most common method for calling the API. The call to the KYCCheck method takes a bundle name and a set of query data as parameters and goes through each service in that bundle. It will return a response from each service that is called along with an interpret result.

DocumentUpload

Some services perform document verification by looking at images of important documents (passports and driving licenses etc.) and as such we need to upload a document to W2. This method is used to upload documents.

  1. Upload Document Request
  2. Upload Document Response

KYC Check Request


An explanation of the Request object for the KYCCheck method

Full Request

Here is a complete request for the API. Which fields are required will depend on which service(s) are being called.

A Note on Field Ordering example

<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <KYCCheck>
         <serviceRequest>
            <BundleData>
               <BundleName>?</BundleName>
            </BundleData>
            <QueryData>
               <AgeVerificationPassIf>?</neur:AgeVerificationPassIf>
               <AgeVerificationThreshold>?</neur:AgeVerificationThreshold>
               <City>?</City>
               <Country>?</Country>
               <County>?</County>
               <DateOfBirthMatchThreshold>?</DateOfBirthMatchThreshold>
               <DayOfBirth>?</DayOfBirth>
               <DrivingLicenceNumber>?</DrivingLicenceNumber>
               <Email>?</Email>
               <Flat>?</Flat>
               <Forename>?</Forename>
               <Gender>?</Gender>
               <HouseName>?</HouseName>
               <HouseNumber>?</HouseNumber>
               <HouseNameNumber>?</HouseNameNumber>
               <IP>?</IP>
               <IdCardNumber>?</IdCardNumber>
               <MRZ>?</MRZ>
               <Maiden>?</Maiden>
               <MiddleNames>?</MiddleNames>
               <MobileNumber>?</MobileNumber>
               <MonthOfBirth>?</MonthOfBirth>
               <NameQuery>?</NameQuery>
               <NameQueryMatchThreshold>?</NameQueryMatchThreshold>
               <NationalId>?</NationalId>
               <PassportNumber>?</PassportNumber>
               <PersonalId>?</PersonalId>
               <PhoneNumber>?</PhoneNumber>
               <PlaceOfBirth>?</PlaceOfBirth>
               <Postcode>?</Postcode>
               <ProfileId>?</ProfileId>
               <Region>?</Region>
               <Street>?</Street>
               <Surname>?</Surname>
               <TaxCode>?</TaxCode>
               <Title>?</Title>
               <TravelVisaNumber>?</TravelVisaNumber>
               <YearOfBirth>?</YearOfBirth>
            </QueryData>
            <!--Optional:-->
            <QueryOptions>
               <KeyValueOfstringstring>
                  <Key>?</Key>
                  <Value>?</Value>
               </KeyValueOfstringstring>
            </QueryOptions>
            <ServiceAuthorisation>
               <APIKey>?</APIKey>
               <ClientReference>?</ClientReference>
               <ClientSubaccount>?</ClientSubaccount>
               <ClientUser>?</ClientUser>
               <RefersToServiceCallReference>?</RefersToServiceCallReference>
            </ServiceAuthorisation>
            <!--Optional:-->
            <UploadedFiles>
               <!--Zero or more repetitions:-->
               <UploadedFile>
                  <DocumentReference>?</DocumentReference>
                  <DocumentUID>?</DocumentUID>
                  <Group>?</Group>
                  <Index>?</Index>
                  <Service>?</Service>
               </UploadedFile>
            </UploadedFiles>
         </serviceRequest>
      </KYCCheck>
   </soapenv:Body>
</soapenv:Envelope>

            (This only affects SOAP Requests)

If you’re using a development environment other than Microsoft Visual Studio, or are crafting your requests manually, then you must ensure that all fields are passed in Alphabetical Order - i.e. in the order shown in the example above. This is due to the way that the de-serialisation works on the server side, and is a mandatory requirement.

If you pass the fields in a different order, you will see a Null Reference exception thrown by the service.

Bundle Data

Bundle Data

<BundleData>
    <BundleName>{You bundle name here e.g. TEST_KYC_SIS}</BundleName>
</BundleData>

The bundle data tag indicates which bundle you are calling and is mandatory for every service call. A bundle is a collection of services which will be agreed with W2 Support.

Query Data

Query Data

<QueryData>
    <AgeVerificationPassIf>?</neur:AgeVerificationPassIf>
    <AgeVerificationThreshold>?</neur:AgeVerificationThreshold>
    <City>?</City>
    <Country>?</Country>
    <County>?</County>
    <DateOfBirthMatchThreshold>?</DateOfBirthMatchThreshold>
    <DayOfBirth>?</DayOfBirth>
    <DrivingLicenceNumber>?</DrivingLicenceNumber>
    <Email>?</Email>
    <Flat>?</Flat>
    <Forename>?</Forename>
    <Gender>?</Gender>
    <HouseName>?</HouseName>
    <HouseNumber>?</HouseNumber>
    <HouseNameNumber>?</HouseNameNumber>
    <IP>?</IP>
    <IdCardNumber>?</IdCardNumber>
    <MRZ>?</MRZ>
    <Maiden>?</Maiden>
    <MiddleNames>?</MiddleNames>
    <MobileNumber>?</MobileNumber>
    <MonthOfBirth>?</MonthOfBirth>
    <NameQuery>?</NameQuery>
    <NameQueryMatchThreshold>?</NameQueryMatchThreshold>
    <NationalId>?</NationalId>
    <PassportNumber>?</PassportNumber>
    <PersonalId>?</PersonalId>
    <PhoneNumber>?</PhoneNumber>
    <PlaceOfBirth>?</PlaceOfBirth>
    <Postcode>?</Postcode>
    <ProfileId>?</ProfileId>
    <Region>?</Region>
    <Street>?</Street>
    <Surname>?</Surname>
    <TaxCode>?</TaxCode>
    <Title>?</Title>
    <TravelVisaNumber>?</TravelVisaNumber>
    <YearOfBirth>?</YearOfBirth>
</QueryData>

SIS (Standard International Sanctions) example


<QueryData>
    <DayOfBirth>{e.g. 21}</DayOfBirth>
    <MonthOfBirth>{e.g. 02}</MonthOfBirth>
    <NameQuery>{e.g. Robert Mugabe}</NameQuery>
    <YearOfBirth>{e.g. 1924}</YearOfBirth>
</QueryData>

Query Options

Sandbox request example


<QueryOptions>
   <KeyValueOfstringstring>
   	<Key>Sandbox</Key>
        <Value>True</Value>
    </KeyValueOfstringstring>
</QueryOptions>

These are optional parameters for some extra fields not covered in the Query Data. The whole section is optional. The most common use is to set Sandbox mode, where you can call the service and get standard responses. For further information, each service has examples of how to structure a call to the sandbox.

Service Authorisation

Service Authorisation example

<ServiceAuthorisation>
   <APIKey>
   	Your API key provided by W2.
    </APIKey>
    <!--Optional:-->
    <ClientReference>
   	A reference identifying this call i.e. My Company Testing.
      </ClientReference>
    <!--Optional:-->
    <ClientSubaccount>
        An optional reference to identify which of your client accounts this call was made for.
    </ClientSubaccount>
    <!--Optional:-->
    <ClientUser>
    	An optional reference to identify which individual user made this call. If specified,
        this value must be the email address of a known user account assigned to your company 
        currently in the W2 Global Database. If a value is specified here that can't be validated 
        as an existing account, then the call will fail with an Invalid Client User error.
      </ClientUser>
    <!--Optional:-->
    <RefersToServiceCallReference>
        Links this call to a previous call by specifying the previous ServiceCallReference.
    </RefersToServiceCallReference>
</ServiceAuthorisation>

Uploaded Files

Uploaded Files example


<UploadedFiles>
  <!--Zero or more repetitions:-->
  <neur:UploadedFile>
    <DocumentReference>
        A client-provided reference to help identify the document.
    </DocumentReference>
    <DocumentUID>
        The Unique identifier returned from the Document Upload service when uploading this document.
    </DocumentUID>
    <Group>
        An optional identifier used to group documents.
    </Group>
    <Index>
        An optional value used to indicate the index of this document 
        within its group (if provided) or overall if no group is specified 
    </Index>
    <Service>
        Indicates which service in the specified bundle this document should be associated with
    </Service>
  </UploadedFile>
</UploadedFiles>

KYC Check Response


The response object contains the response from every service in your bundle as well as placeholders for any uncalled services. For every service that is called we also return a Service Transaction Information object that contains metadata about that service call. We also include an Interpret result which represents a combined response from all the services called.

Full Response

Full Response example

<Envelope>
   <Body>
      <KYCCheckResponse>
         <KYCCheckResult>
            <ClientProvidedData>
               <ClientReference>
                   Your client reference will be visible here.
               </ClientReference>
               <ClientSubaccount>
                   If supplied the client sub account will be visible here.
               </ClientSubaccount>
               <ClientUser>
                   If supplied the client user will be visible here.
               </ClientUser>
               <RefersToServiceCallReference>
                   If supplied the call reference will be visible here.
               </RefersToServiceCallReference>
            </ClientProvidedData>
            <ProcessRequestResult>
               <ServiceResult>
                  <!-- More information about each service's response 
                       can be found on relevant the service's page-->
                  <DirectorUKCheckResult />
                  <IDCheckATBravoResult />
                  <IDCheckAddressLookupResult />
                  <IDCheckCHBravoResult />
                  <IDCheckCZBravoResult />
                  <IDCheckDEAlphaResult />
                  <IDCheckDEBravoResult />
                  <IDCheckITBravoResult />
                  <IDCheckNLAlphaResult />
                  <IDCheckNameLookupResult />
                  <IDCheckPassportMRZResult />
                  <IDCheckRUBravoResult />
                  <IDCheckSKBravoResult />
                  <IDCheckUKAlphaResult />
                  <IDCheckUKDeltaResult />
                  <IDCheckUKDrivingLicenceNumberResult />
                  <IDCheckZAAlphaResult />
                  <IDDocumentCheckResult />
                  <PEPDeskCheckResult />
                  <ProfileDetailsResult />
                  <SISPlusCheckResult />
                  <SPFPlusCheckResult />
                  <W2DataAddressLookUp007Result />
                  <W2DataEkybUk009Result />
                  <W2DataEkycUk007Result />
                  <W2DataIdvcheck013Result />
                  <WatchlistCheckResult >
                  <W2DataEkycScandi025Result />
               </ServiceResult>
               <TransactionInformation>
                  <InterpretResult>
                    { NoInterpretPerformed | Pass | Inconclusive | Fail | NotApplicable }
                  </InterpretResult>
                  <ServiceCallReference>
                    { the unique identifier for this call }
                  </ServiceCallReference>
                  <ServiceTransactions>
                     <--Multiple values here -->
                     <ServiceTransactionInformation>
                        <FailedOverTo>
                            If a service "crashes" we can configure another to take it's place. 
                            the fail-over service name will be here
                        </FailedOverTo>
                        <HaltTriggered>
                       	    { true | false}
                        </HaltTriggered>
                        <Service>
                            The name of the service called
                        </Service>
                        <ServiceInterpretResult>
                            { Pass | Fail | Inconclusive | 
                              NoResults | OneResult | MultipleResults | 
                              NotApplicable | NotPerformed }
                        </ServiceInterpretResult>
                        <ServiceTransactionResult>
                            { None |  SuccessNoResults | SuccessIncompleteResults | 
                              MultipleChoices | ClientErrorInformationFormatInvalid | 
                              ClientErrorInsufficientInformation | NotExecutedDueToPreviousHalt | 
                              ServerErrorGeneralError | ServiceFailureError }
                        </ServiceTransactionResult>
                        <ServiceTransactionResultMessage>
                            Any messages from the service call
                        </ServiceTransactionResultMessage>
                        <ServiceValidationDetails>
                             This object provides the details of the validation step. 
                             If all validation succeeded, then the ValidationFailureReasons 
                             field will be set to null.                        
                        </ServiceValidationDetails>
                        <ValidationResult>
                            { Pass | Fail | Inconclusive | 
                              NoValidationPerformed | NotApplicable }
                        </ValidationResult>
                     </ServiceTransactionInformation>
                  </ServiceTransactions>
               </TransactionInformation>
            </ProcessRequestResult>
         </KYCCheckResult>
      </KYCCheckResponse>
   </Body>
</Envelope>

Client Provided Data

This section simply reflects back information that was submitted in the API call.

Property Description
ClientReference This reflects back the client reference that was supplied in the request.
ClientSubaccount An optional reference to identify which of your client accounts this call was made for.
ClientUser An optional reference to identify which individual user made this call. For future compatibility with W2 products we suggest this value should be the user’s email address.
RefersToServiceCallReference Links this call to a previous call by specifying the previous ServiceCallReference.

Transaction Information

This section contains the interpret result for the whole bundle, the service call reference and a section of meta data for each service.

Property Details
InterpretResult The validation result of the Interpret function.
1. Pass- The information supplied to the bundle passed validation.
2. Fail- The information supplied to the bundle failed validation.
3. Inconclusive- It was not possible to generate a clear validation result from the information supplied. It may be necessary to refer this query for further investigation.
4. NoInterpretPerformed - No interpret was performed in this case. Check the other information returned by the services to determine why.
5. NotApplicable - Interpret is not enabled for this bundle.
ServiceTransactions A collection of ServiceTransactionInformation objects. See below
ServiceCallReference A unique reference for this service call.

Service Transaction information

Every service that is called will return one of these:

Property Details
Service The service that was invoked.
ServiceInterpretResult 1. Pass- The query data resulted in a pass.
2. Fail - The query data resulted in a failure.
3. Inconclusive - The query data resulted in an inconclusive outcome.
4. NoResults - The query data returned no results.
5. OneResult - The query data returned a single result.
6. MultipleResults- >The query data returned multiple results.
7. NotApplicable- Interpret is not applicable to the call or wasn’t enabled.
8. NotPerformed - An error prevented this result from being categorised.
ServiceTransactionResult 1. Success- The service executed successfully.
2. SuccessNoResults- The service executed successfully but no results were generated.
3. SuccessIncompleteResults- The service executed successfully but too many results were generated to return them all, so the results have been truncated.
4. MultipleChoices - The service could not continue as there are multiple choices available and one of them must be selected or the query must be submitted with more concise information in order to complete execution.
5. ClientErrorInsufficientInformation- There was insufficient information for the service to execute. Check that all of the required fields for the service were supplied.
6. NotExecutedDueToPreviousHalt- The service was not executed because a previous service in the bundle triggered a halt.
7. ServerErrorGeneralError - A general error occurred on the server trying to run the service.
ServiceTransactionResultMessage The message associated with the ServiceTransactionResult if applicable. The ServiceTransactionResultMessage is usually null, but in some cases may provide some insight into the ServiceTransactionResult. For example, if a service returns SuccessIncompleteResults the ServiceTransactionResultMessage may contain an explanation of why, such as there being a limit of 100 results per query. There is no standard across services for this field so it should not be relied upon, instead it is better to use it for debugging or additional information and rely on the ServiceTransactionResult which has consistent behaviour.
ValidationResult 1. Pass - The information supplied to the service passed validation
2. Fail - The information supplied to the service failed validation.
3. Inconclusive - It was not possible to generate a clear validation result from the information supplied. It may be necessary to refer this query for further investigation.
4. NoValidationPerformed - No validation was performed in this case. Check the other information returned by the service to determine why.
5. NotApplicable - The service is not a service that performs validation and therefore validation is not applicable.
ServiceValidationDetails This field provides information about the pre-execution validation step and should be read in conjunction with the ValidationResult field.
HaltTriggered True if the service halted after this service

Upload Document

Upload Document Request

A full description of the upload document request

Sample Requests

This is the structure of a typical SOAP request to the service.

<Envelope>
  <Header>
    <Action>http://tempuri.org/IService/UploadDocument</Action>
  </Header>
  <Body>
    <UploadDocument>
      <DocumentUploadRequest>
        <DocumentData>
            /9j/4TmVRXhpZgAASUkqAAgAAAANAAABBAABAAAAwBQAAAEBBAABAAAArAsAAA8B//----- Data Truncated
        </DocumentData>
        <DocumentExpiry>2016-01-01T00:00:00</DocumentExpiry>
        <DocumentReference>MyDocumentReference</DocumentReference>
        <DocumentType>JPEG</DocumentType>
        <ServiceAuthorisation>
          <APIKey>APIKey</APIKey>
          <ClientReference />
          <ClientSubaccount />
          <ClientUser />
          <RefersToServiceCallReference />
        </ServiceAuthorisation>
      </documentUploadRequest>
    </UploadDocument>
  </Body>
</Envelope>
Property Details
ServiceAuthorisation Contains authorisation information to identify the person using the service. See here
DocumentReference Contains a client-specified tracking reference. Maximum 100 Characters
DocumentType None - No type specified / known.
JPEG - A JPEG (Joint Picture Experts Group Image).
PNG - A PNG (Portable Network Graphics) image.
PDF - A PDF (Portable Document Format)
DocumentData Base64 Encoded representation of the document to upload.
DocumentExpiry Desired expiry date to apply to the document to upload.
If left blank, W2 will use the default value of 14 days to expire the document. This can be set anywhere up to a maximum of 6 months.
Once the expiration date has been reached, W2 will remove the image data from our system, however the footprint of the upload will be preserved.
QueryOptions Specify optional flags that alter the invocation of the service. See here

Notes

The maximum file size that we accept for a document upload is 4MB, please ensure your documents are no larger than this before uploading.

The DocumentData field must contain a Base64 Encoded representation of the document to upload. The recommended method for creating this representation is to use OpenSSL and issuing the following command;

The DocumentData field example

openssl enc -Base64 -in {inputFilePath} -out {outputFilePath}

The output from the above will be a text string similar to;

/9j/4TmVRXhpZgAASUkqAAgAAAANAAABBAABAAAAwBQAAAEBBAABAAAArAsAAA8B
AgAIAAAAqgAAABABAgAJAAAAsgAAABIBAwABAAAAAQAAABoBBQABAAAAvAAAABsB
BQABAAAAxAAAACgBAwABAAAAAgAAADEBAgAOAAAAzAAAADIBAgAUAAAA2gAAABMC
AwABAAAAAQAAAGmHBAABAAAA7gAAACWIBAABAAAAVAwAAGYMAABzYW1zdW5nAFNN
LU45MTBGAABIAAAAAQAAAEgAAAABAAAATjkxMEZYWFUxQk9DMwAyMDE1OjA4OjAz
IDExOjIwOjM5AB8AmoIFAAEAAABoAgAAnYIFAAEAAABwAgAAIogDAAEAAAACAAAA
J4gDAAEAAAAoAAAAAJAHAAQAAAAwMjIwA5ACABQAAAB4AgAABJACABQAAACMAgAA
......(Output truncated)

Upload Document Response

A full description of the upload document request

Example Response

A Response example

<Envelope>
   <Body>
      <UploadDocumentResponse>
         <UploadDocumentResult>
            <BytesUploaded>9100</BytesUploaded>
            <DocumentReference>MyImage</DocumentReference>
            <DocumentTypeValidationSucceeded>true</DocumentTypeValidationSucceeded>
            <DocumentUID>756df058-6548-4535-a09d-6e47ffdbbd7d</DocumentUID>
            <ResolvedDocumentType>JPEG</ResolvedDocumentType>
         </UploadDocumentResult>
      </UploadDocumentResponse>
   </Body>
</Envelope>
Property Name Description
BytesUploaded The number of bytes uploaded to check against expected number.
ResolvedDocumentType The document type as resolved by the service - this can be compared against the expected (submitted) type for validation purposes.
None - No type specified / known.
JPEG - A JPEG (Joint Picture Experts Group Image).
PNG - A PNG (Portable Network Graphics) image.
PDF - A PDF (Portable Document Format)
DocumentTypeValidationSucceeded Whether or not the resolved document type matched the type specified by the user (e.g if the user specified the document was a PNG, and the document resolved to a PNG, this value is true).
DocumentUID The system assigned unique Id applied to this document on upload. Used to refer to the document when associating documents with a service as a part of the UploadedFiles element of a Service Request
DocumentReference An echo of the value that was used on submission - useful when operating asynchronously.

Services

Services Overview


All of our services are exposed through bundles and you will need a bundle name in order to call a service. W2 Support will configure bundles for you, please contact us if this hasn’t been done already.

Each of our service provides different functionality see below for each service.

Footprint Whether a service leaves a footprint or not
Sandbox Whether a service has a sandbox mode available
Beta Whether a service is currently available in Beta only

Sanctions List Checks

Service Footprint Sandbox Beta Only Description
SIS Plus No Yes No Checks if a specified person is under a standard international sanction
SPF Plus No Yes No Checks if a specified person is a senior political figure
PEPDesk No Yes No Checks if a specified person is a politically exposed person
Watchlist Check No Yes No DOW Jones Watchlist check
Profile Details No Yes No Profile Details is a profile retrieval service.
PEP and Sanction 006 No Yes No Checks if a specified person is on a PEP or Sanctions list
W2-DATA-W2-DATA-DISQUALIFIEDS-UK-008 No Yes Yes Perform searches against a list of Disqualified Directors

Identity Check Services UK

Service Footprint Sandbox Beta Only Description
Id Check Alpha Full Yes Yes No Id check service for the UK
W2 DATA EKYC UK 007 Yes Yes No A UK Identity check service
ID Check UK Delta Yes Yes No An Identity check service for the UK
ID Check Name Lookup No Yes No A name verification service.
Director Check UK No Yes No Searches the UK database of directors
W2 Data Ekyc UK 004 Yes Yes No Id check service for the UK
W2 Data Ekyc UK 005 Yes Yes Yes Id check service for the UK
W2DataEkycUk007B Yes Yes No UK Identity verification service
W2 Data Post Redirect 028 No Yes Yes Check for an NCOA record for an individual at an address
W2DataEkycUk015 Yes Yes No UK Identity verification service
W2 Data Bank Account Verification Uk 007 Service Yes Yes Yes  
W2 Data Mortality Uk 035 No Yes Yes Mortality verification service

Identity Check International

Service Footprint Sandbox Beta Only Description
Id Check NL Alpha Yes Yes No Identity check service for the Netherlands
ID Check ZA Alpha Yes Yes No Identity check service for South Africa
ID Check AT Bravo Yes Yes No Identity check service for Austria
ID Check CH Bravo Yes Yes No Identity check service for Switzerland
ID Check CZ Bravo Yes Yes No Identity Check service for Czech Republic
ID Check DE Bravo Yes Yes No Identity Check service for Germany
ID Check IT Bravo Yes Yes No An Identity Check service for Italy
ID Check SK Bravo Yes Yes No An Identity check service for the Slovak Republic
W2 Data Ekyc SCANDI 025 No No No An Identity Check service for Sweden, Norway and Denmark
W2 Data EKYC US 005 Yes Yes No Identity check for USA
W2 Data EKYC CA 005 Yes Yes No Identity check for Canada
W2 Data EKYC AU 029 Yes Yes Yes Identity check for Australia
W2 Data EKYC DK 029 Yes Yes Yes Identity check for Denmark
W2 Data EKYC ES 029 Yes Yes No Identity check for Spain
W2 Data EKYC FR 029 Yes Yes No Identity check for France
W2 Data EKYC Lite US 005 Service Yes Yes Yes  
W2 Data Ekyc Global Multisource 043 No Yes No Global Id check service
W2 Data Ekyc Singlesource 043 No Yes No Global Id check service

Address Lookup

Service Footprint Sandbox Beta Only Description
ID Check Address Lookup No Yes No An address lookup service
W2 Data Address Lookup 007 No Yes No An alternative address lookup service for the UK
W2 Data Address Lookup 024 No Yes No W2’s address lookup service for the UK and international addresses
W2 Data Email Validate 010 No No No  

Document Services

Service Footprint Sandbox Beta Only Description
ID Check UK Driving Licence Number No Yes No A driving licence verification service
ID Check Passport MRZ No Yes No A passport verification service
W2 Data IDV Check 013 No Yes No An identity verification service that uses physical documentation
W2 Data Document Check 026 No No No An international document verification service

Know Your Business Services

Service Footprint Sandbox Beta Only Description
W2 Data EKYB IDS No Yes No A know your business service
W2 Data EKYB DDS No Yes No A know your business service
W2 Data EKYB PDS No Yes No A know your business service
W2 Data EKYB UK 009 No Yes No A know your business service

Age Verification

Service Footprint Sandbox Beta Only Description
W2 Data Age Verification 007 Service No Yes Yes An age verification service for the UK

SIS Plus


Standard International Sanctions (SISPlus) service
SISPlus service checks if a specified person is under a standard international sanction. If there are multiple matches, it provides a list of them, up to a limit of 100.

Properties

The following properties pertain to this service.

Property Name Type Optional/Mandatory Notes
NameQuery String Mandatory The name of the person you are searching for.
NameQueryMatchThreshold Integer Optional The minimum name match score to match against. Default is 80 (all matches)
DateOfBirthMatchThreshold Integer Optional The minimum date of birth score to match against. Default is null (off). If supplied, at least one component of the date of birth must be supplied.
DayOfBirth Integer Optional Used with DateOfBirthMatchThreshold.
MonthOfBirth Integer Optional Used with DateOfBirthMatchThreshold.
YearOfBirth Integer Optional Used with DateOfBirthMatchThreshold.

Response
The following table gives some more details about the response.

Example Response

"SISPlusCheckResult": {
	"MatchResults": [
		{
			"MatchType": "Person",
			"Name": "Robert Gabriel MUGABE",
			"NameMatchScore": "85",
			"ProfileId": "SANC-cbe61692-1455-5cb6-879f-03864696e457"
		}
	]
}

<SISPlusCheckResult>
 <MatchResults>
	<!-- one or more of these -->
	<CheckMatch>
	   <BirthDay />
	   <BirthMonth />
	   <BirthYear />
	   <DateOfBirthMatchScore />
	   <MatchType>Person</MatchType>
	   <Name>Robert Gabriel MUGABE</Name>
	   <NameMatchScore>85</NameMatchScore>
	   <ProfileId>SANC-cbe61692-1455-5cb6-879f-03864696e457</ProfileId>
	</CheckMatch>	
 </MatchResults>
</SISPlusCheckResult>
Property Name Type Description
BirthDay String The birth day of the record matched against.
BirthMonth Integer The birth month of the record matched against.
BirthYear Integer The birth month of the record matched against.
DateOfBirthMatchScore Integer The score that this record’s date of birth matched the query date.
MatchType MatchTypeEnum The type of match where the data is available in the source. See below
Name String The name of the record matched against. Depending on the source data there may be multiple names here combined into one.
NameMatchScore Integer The score that this record’s name matched the query name.
ProfileId String A unique reference for a profile that can be subsequently retrieved in full using the Profile Details Service.

Notes
The date of birth parameters will be null if no date of birth matching threshold was specified, even if the record has a date of birth, as it reflects the matching that occurred.

MatchTypeEnum
Represents the type of match.

Enumeration Value Value Description
Person 1 The match is a Person.
Entity 2 The match is an Entity.
Unknown 3 The match is of unknown type. This may represent missing data and does not necessarily mean ‘other’.
Vessel 4 The match is a vessel (usually maritime).
Aircraft 5 The match is an aircraft.

Transaction Result

HaltTriggered False
ServiceTransactionResult Success
SuccessNoResults
SuccessIncompleteResults - Too many matches generated, results truncated
ClientErrorInsufficientInformation - Required field not supplied
ClientErrorInformationFormatInvalid - Invalid format in field
ServerErrorGeneralError - Error with third party service
ServiceInterpretResult OneResult
MultipleResults
NoResults
NotPerformed - An error occurred and the search was not performed
ServiceTransactionResultMessage Usually empty, can contain optional information such as too many matches etc.
ValidationResult NotApplicable - No search occurred to match against
Fail - MissingMandatoryField or PatternNotMatched

Alert Filters

Available Filters

Applying Filters:

    "Options": {
        "Sandbox": "false",
        "IncludeCountries":"GBR,UDF,SUP - Up to 20 comma delimited countries",
        "ExcludeEntities": "true | false",
        "ExcludeIndividuals": "true | false",
        "ExcludeExPeps": "true | false"
    }

<QueryOptions>
  <KeyValueOfstringstring>
    <Key>Sandbox</Key>
    <Value>false</Value>
  </KeyValueOfstringstring>
  <KeyValueOfstringstring>
    <Key>IncludeCountries</Key>
    <Value>GBR,UDF,SUP - Up to 20 comma delimited countries</Value>
  </KeyValueOfstringstring>
  <KeyValueOfstringstring>
    <Key>ExcludeIndividuals</Key>
    <Value>true | false</Value>
  </KeyValueOfstringstring>
  <KeyValueOfstringstring>
    <Key>ExcludeEntities</Key>
    <Value>true | false</Value>
  </KeyValueOfstringstring>
  <KeyValueOfstringstring>
    <Key>ExcludeExPeps</Key>
    <Value>true | false</Value>
  </KeyValueOfstringstring>
</QueryOptions>
Filter Type Description
Include Countries If included, this filter will only return alerts that are on profiles that indicate that the main country of residence/activity is in the included country. Please note that if this filter is used, we advise to also use the 2 additional filters for undefined and supra-Nationals. This will include alerts generated for subjects that cannot be readily assigned to a country.
Exclude Ex-PEPs If included, this filter exclude alerts that would have been generated on individuals that have left the office that attracted their ‘PEP status’ for a defined period of time. For a risk based approach, it is normally appropriate to consider ex-PEPs some time, however, this time will differ based on the risk profile of the business that your organisation conducts.
Exclude Individuals/Entities When applied, this filter will supress alerts that are generated on either individuals (if you are conducting a search on a known business/entity) OR supress entities (if conducting a search on an known individual)

Sandbox

If the Sandbox query option is set to “true” the following entry will be returned in the ServiceResult:

Example Response for “Robert Mugabe”:

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "Multiple Results",
	"ServiceTransactionResult": "Success",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "Pass"
}

<HaltTriggered> False </HaltTriggered>
<ServiceInterpretResult> Multiple Results </ServiceInterpretResult>
<ServiceTransactionResult> Success </ServiceTransactionResult>
<ServiceTransactionResultMessage> "This call was generated using sandbox mode" </ServiceTransactionResultMessage>
<ValidationResult> Pass </ValidationResult>

Example Response for all OTHER name queries:

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "NoResults",
	"ServiceTransactionResult": "SuccessNoResults",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "Pass"
}

<HaltTriggered> False </HaltTriggered>
<ServiceInterpretResult> NoResults </ServiceInterpretResult>
<ServiceTransactionResult> SuccessNoResults </ServiceTransactionResult>
<ServiceTransactionResultMessage> "This call was generated using sandbox mode" </ServiceTransactionResultMessage>
<ValidationResult> Pass </ValidationResult>

SPF Plus

Senior Political Figures (SPFPlus) service
SPFPlus service checks if a specified person is a senior political figure (cabinet level or equivalent). If there are multiple matches, it provides a list of them, up to a limit of 100.

Properties

The following properties pertain to this service.

Property Name Type Optional/Mandatory Notes
NameQuery String Mandatory The name of the person you are searching for.
NameQueryMatchThreshold Integer Optional The minimum name match score to match against. Default is 80 (all matches)
DateOfBirthMatchThreshold Integer Optional The minimum date of birth score to match against. Default is null (off). If supplied, at least one component of the date of birth must be supplied.
DayOfBirth Integer Optional Used with DateOfBirthMatchThreshold.
MonthOfBirth Integer Optional Used with DateOfBirthMatchThreshold.
YearOfBirth Integer Optional Used with DateOfBirthMatchThreshold.


Transaction Result

HaltTriggered False
ServiceTransactionResult Success
SuccessNoResults
SuccessIncompleteResults - Too many matches generated, results truncated
ClientErrorInsufficientInformation - Required field not supplied
ClientErrorInformationFormatInvalid - Invalid format in field
ServerErrorGeneralError - Error with third party service
ServiceInterpretResult OneResult
MultipleResults
NoResults
NotPerformed - An error occurred and the search was not performed
ServiceTransactionResultMessage Usually empty, can contain optional information such as too many matches etc.
ValidationResult NotApplicable - No search occurred to match against
Fail - MissingMandatoryField or PatternNotMatched

Response

The following table gives some more details about the response.

Example Response

  "SPFPlusCheckResult": {
  	"MatchResults": [{
  			"MatchType": "Unknown",
  			"Name": "Robert Gabriel MUGABE Robert Gabriel MUGABE",
  			"NameMatchScore": "85",
  			"ProfileId": "SANC-6b1a02d6-63b0-7f5d-4a5d-4fb2a0862082"
  		}
  	]
  }

<SPFPlusCheckResult>
  <MatchResults>
    <CheckMatch>
      <BirthDay />
      <BirthMonth />
      <BirthYear />
      <DateOfBirthMatchScore />
      <MatchType>Unknown</MatchType>
      <Name>Robert Gabriel MUGABE Robert Gabriel MUGABE</Name>
      <NameMatchScore>85</NameMatchScore>
      <ProfileId>SANC-6b1a02d6-63b0-7f5d-4a5d-4fb2a0862082</ProfileId>
    </CheckMatch>
  </MatchResults>
</SPFPlusCheckResult>
Property Name Type Description
BirthDay String The birth day of the record matched against.
BirthMonth Integer The birth month of the record matched against.
BirthYear Integer The birth month of the record matched against.
DateOfBirthMatchScore Integer The score that this record’s date of birth matched the query date.
MatchType MatchTypeEnum The type of match where the data is available in the source. See below
Name String The name of the record matched against. Depending on the source data there may be multiple names here combined into one.
NameMatchScore Integer The score that this record’s name matched the query name.
ProfileId String A unique reference for a profile that can be subsequently retrieved in full using the Profile Details Service.

Notes
The date of birth parameters will be null if no date of birth matching threshold was specified, even if the record has a date of birth, as it reflects the matching that occurred.

MatchTypeEnum
Represents the type of match.

Enumeration Value Value Description
Person 1 The match is a Person.
Entity 2 The match is an Entity.
Unknown 3 The match is of unknown type. This may represent missing data and does not necessarily mean ‘other’.
Vessel 4 The match is a vessel (usually maritime).
Aircraft 5 The match is an aircraft.

Alert Filters

Available Filters

Applying Filters:

    "Options": {
        "Sandbox": "false",
        "IncludeCountries":"GBR,UDF,SUP - Up to 20 comma delimited countries",
    }

<QueryOptions>
  <KeyValueOfstringstring>
    <Key>Sandbox</Key>
    <Value>false</Value>
  </KeyValueOfstringstring>
  <KeyValueOfstringstring>
    <Key>IncludeCountries</Key>
    <Value>GBR,UDF,SUP - Up to 20 comma delimited countries</Value>
  </KeyValueOfstringstring>
</QueryOptions>
Filter Type Description
Include Countries If included, this filter will only return alerts that are on profiles that indicate that the main country of residence/activity is in the included country. Please note that if this filter is used, we advise to also use the 2 additional filters for undefined and supra-Nationals. This will include alerts generated for subjects that cannot be readily assigned to a country.

Sandbox

If the Sandbox query option is set to “true” the following entry will be returned in the ServiceResult:

Example Response for “David Cameron”:

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "Multiple Results",
	"ServiceTransactionResult": "Success",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "Pass"
}

<HaltTriggered> False </HaltTriggered>
<ServiceInterpretResult> Multiple Results </ServiceInterpretResult>
<ServiceTransactionResult> Success </ServiceTransactionResult>
<ServiceTransactionResultMessage> "This call was generated using sandbox mode" </ServiceTransactionResultMessage>
<ValidationResult> Pass </ValidationResult>

Example Response for all OTHER name queries:

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "NoResults",
	"ServiceTransactionResult": "SuccessNoResults",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "Pass"
}

<HaltTriggered> False </HaltTriggered>
<ServiceInterpretResult> NoResults </ServiceInterpretResult>
<ServiceTransactionResult> SuccessNoResults </ServiceTransactionResult>
<ServiceTransactionResultMessage> "This call was generated using sandbox mode" </ServiceTransactionResultMessage>
<ValidationResult> Pass </ValidationResult>

PEPDesk

Politically Exposed Persons service

PEPDesk service checks if a specified person is a politically exposed person, i.e. they are in a prominent public position or a close relative of someone who is. If there are multiple matches, it provides a list of them, up to a limit of 100.

Properties

The following properties pertain to this service.

Property Name Type Optional/Mandatory Notes
NameQuery String Mandatory The name of the person you are searching for.
NameQueryMatchThreshold Integer Optional The minimum name match score to match against. Default is 80 (all matches)
DateOfBirthMatchThreshold Integer Optional The minimum date of birth score to match against. Default is null (off). If supplied, at least one component of the date of birth must be supplied.
DayOfBirth Integer Optional Used with DateOfBirthMatchThreshold.
MonthOfBirth Integer Optional Used with DateOfBirthMatchThreshold.
YearOfBirth Integer Optional Used with DateOfBirthMatchThreshold.

Response

PEP Desk Response

  "PEPDeskCheckResult": {
    "MatchResults": [
      {
        "MatchType": "Unknown",
        "Name": "Robert Gabriel Mugabe Mugabe, Robert G.; Mugabe, Robert",
        "NameMatchScore": "85",
        "ProfileId": "a34c862e-a0b9-28a4-49ca-f3cdd4ec7f54"
      }
    ]
  }

<PEPDeskCheckResult>
	 <!-- One or more of these --> 
	 <MatchResults>
		<CheckMatch>
		   <BirthDay />
		   <BirthMonth />
		   <BirthYear />
		   <DateOfBirthMatchScore />
		   <MatchType>Unknown</MatchType>
		   <Name>Robert Gabriel Mugabe Mugabe, Robert G.; Mugabe, Robert</Name>
		   <NameMatchScore>85</NameMatchScore>
		   <ProfileId>a34c862e-a0b9-28a4-49ca-f3cdd4ec7f54</ProfileId>
		</CheckMatch>
	 </MatchResults>
</PEPDeskCheckResult>

The following table gives some more details about the response.

Property Name Type Description
BirthDay String The birth day of the record matched against.
BirthMonth Integer The birth month of the record matched against.
BirthYear Integer The birth month of the record matched against.
DateOfBirthMatchScore Integer The score that this record’s date of birth matched the query date.
MatchType MatchTypeEnum The type of match where the data is available in the source. See below
Name String The name of the record matched against. Depending on the source data there may be multiple names here combined into one.
NameMatchScore Integer The score that this record’s name matched the query name.
ProfileId String A unique reference for a profile that can be subsequently retrieved in full using the Profile Details Service.

Notes
The date of birth parameters will be null if no date of birth matching threshold was specified, even if the record has a date of birth, as it reflects the matching that occurred.

MatchTypeEnum
Represents the type of match.

Enumeration Value Value Description
Person 1 The match is a Person.
Entity 2 The match is an Entity.
Unknown 3 The match is of unknown type. This may represent missing data and does not necessarily mean ‘other’.
Vessel 4 The match is a vessel (usually maritime).
Aircraft 5 The match is an aircraft.

Transaction Result

HaltTriggered False
ServiceTransactionResult Success
SuccessNoResults
SuccessIncompleteResults - Too many matches generated, results truncated
ClientErrorInsufficientInformation - Required field not supplied
ClientErrorInformationFormatInvalid - Invalid format in field
ServerErrorGeneralError - Error with third party service
ServiceInterpretResult OneResult
MultipleResults
NoResults
NotPerformed - An error occurred and the search was not performed
ServiceTransactionResultMessage Usually empty, can contain optional information such as too many matches etc.
ValidationResult NotApplicable - No search occurred to match against
Fail - MissingMandatoryField or PatternNotMatched

Alert Filters

Available Filters

Applying Filters:

    "Options": {
        "Sandbox": "false",
        "IncludeCountries":"GBR,UDF,SUP - Up to 20 comma delimited countries",
        "ExcludeExPeps": "true | false",
        "IncludeExPEPsFromDate": "1990-08-17 OR 1990-08-17T06:04:18Z - UTC Date Time"
    }

<QueryOptions>
  <KeyValueOfstringstring>
    <Key>Sandbox</Key>
    <Value>false</Value>
  </KeyValueOfstringstring>
  <KeyValueOfstringstring>
    <Key>IncludeCountries</Key>
    <Value>GBR,UDF,SUP - Up to 20 comma delimited countries</Value>
  </KeyValueOfstringstring>
  <KeyValueOfstringstring>
    <Key>ExcludeExPeps</Key>
    <Value>true | false</Value>
  </KeyValueOfstringstring>
  <KeyValueOfstringstring>
    <Key>IncludeExPEPsFromDate</Key>
    <Value>1990-08-17 OR 1990-08-17T06:04:18Z - UTC Date Time</Value>
  </KeyValueOfstringstring>
</QueryOptions>
Filter Type Description
Include Countries If included, this filter will only return alerts that are on profiles that indicate that the main country of residence/activity is in the included country. Please note that if this filter is used, we advise to also use the 2 additional filters for undefined and supra-Nationals. This will include alerts generated for subjects that cannot be readily assigned to a country.
Exclude Ex-PEP If included, this filter exclude alerts that would have been generated on individuals that have left the office that attracted their ‘PEP status’ for a defined period of time. For a risk based approach, it is normally appropriate to consider ex-PEPs some time, however, this time will differ based on the risk profile of the business that your organisation conducts.
IncludeExPEPsFromDate If included, this filter includes alerts that are generated on individuals who gained their ex-PEP status after the specified date.

Sandbox

Example Response for “David Cameron”:

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "Multiple Results",
	"ServiceTransactionResult": "Success",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "Pass"
}

<HaltTriggered>False</HaltTriggered>
<ServiceInterpretResult>OneResult</ServiceInterpretResult>
<ServiceTransactionResult>Success</ServiceTransactionResult>
<ServiceTransactionResultMessage>"This call was generated using sandbox mode"</ServiceTransactionResultMessage>
<ValidationResult>Pass</ValidationResult>

Example Response for all OTHER name queries:

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "NoResults",
	"ServiceTransactionResult": "SuccessNoResults",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "Pass"
}

<HaltTriggered> False </HaltTriggered>
<ServiceInterpretResult> NoResults </ServiceInterpretResult>
<ServiceTransactionResult> SuccessNoResults </ServiceTransactionResult>
<ServiceTransactionResultMessage> "This call was generated using sandbox mode" </ServiceTransactionResultMessage>
<ValidationResult> Pass </ValidationResult>

Watchlist Check


Watchlist service checks if a specified person or entity is held within a comprehensive dataset comprising PEP, Sanction, Adverse media content and enforcement watchlists from around the globe. If there are multiple matches, it provides a list of them, up to a limit of 100.

Response
The following shows a sample of the <WatchlistCheckResult> object that is returned in the <ServiceResult> Section of the <ProcessRequestResult> object

Properties

The following properties pertain to this service.

Property Name Type Optional/Mandatory Notes
NameQuery String Mandatory The name of the person you are searching for.
NameQueryMatchThreshold Integer Optional The minimum name match score to match against. Default is 80 (all matches)
DateOfBirthMatchThreshold Integer Optional The minimum date of birth score to match against. Default is null (off). If supplied, at least one component of the date of birth must be supplied.
DayOfBirth Integer Optional Used with DateOfBirthMatchThreshold.
MonthOfBirth Integer Optional Used with DateOfBirthMatchThreshold.
YearOfBirth Integer Optional Used with DateOfBirthMatchThreshold.

Response
The following table gives some more details about the response.

Sample Response - Watchlist Check

"WatchlistCheckResult": {
	"MatchResults": [{
			"MatchType": "Person",
			"Name": "JOHN SMITH",
			"NameMatchScore": "85",
			"ProfileId": "69e10264-4b90-64fe-b4b7-c9dddafd0241"
		}, {
			"MatchType": "Person",
			"Name": "JOHN JAMES SMITH",
			"NameMatchScore": "85",
			"ProfileId": "cb5f2851-64c0-6866-0ed1-da306e45efb2"
		}
	]
}

<WatchlistCheckResult>
	 <MatchResults>
		<CheckMatch>
		   <BirthDay />
		   <BirthMonth />
		   <BirthYear />
		   <DateOfBirthMatchScore />
		   <MatchType>Person</MatchType>
		   <Name>JOHN SMITH</Name>
		   <NameMatchScore>85</NameMatchScore>
		   <ProfileId>69e10264-4b90-64fe-b4b7-c9dddafd0241</ProfileId>
		</CheckMatch>
		<CheckMatch>
		   <BirthDay />
		   <BirthMonth />
		   <BirthYear />
		   <DateOfBirthMatchScore />
		   <MatchType>Person</MatchType>
		   <Name>JOHN JAMES SMITH</Name>
		   <NameMatchScore>85</NameMatchScore>
		   <ProfileId>cb5f2851-64c0-6866-0ed1-da306e45efb2</ProfileId>
		</CheckMatch>
	 </MatchResults>
</WatchlistCheckResult>
Property Name Type Description
BirthDay String The birth day of the record matched against.
BirthMonth Integer The birth month of the record matched against.
BirthYear Integer The birth month of the record matched against.
DateOfBirthMatchScore Integer The score that this record’s date of birth matched the query date.
MatchType MatchTypeEnum The type of match where the data is available in the source. See below
Name String The name of the record matched against. Depending on the source data there may be multiple names here combined into one.
NameMatchScore Integer The score that this record’s name matched the query name.
ProfileId String A unique reference for a profile that can be subsequently retrieved in full using the Profile Details Service.

Notes
The date of birth parameters will be null if no date of birth matching threshold was specified, even if the record has a date of birth, as it reflects the matching that occurred.

MatchTypeEnum
Represents the type of match.

Enumeration Value Value Description
Person 1 The match is a Person.
Entity 2 The match is an Entity.
Unknown 3 The match is of unknown type. This may represent missing data and does not necessarily mean ‘other’.
Vessel 4 The match is a vessel (usually maritime).
Aircraft 5 The match is an aircraft.

Transaction Result

HaltTriggered False
ServiceTransactionResult Success
SuccessNoResults
SuccessIncompleteResults - Too many matches generated, results truncated
ClientErrorInsufficientInformation - Required field not supplied
ClientErrorInformationFormatInvalid - Invalid format in field
ServerErrorGeneralError - Error with third party service
ServiceInterpretResult OneResult
MultipleResults
NoResults
NotPerformed - An error occurred and the search was not performed
ServiceTransactionResultMessage Usually empty, can contain optional information such as too many matches etc.
ValidationResult NotApplicable - No search occurred to match against
Fail - MissingMandatoryField or PatternNotMatched

Alert Filters

Available Filters

Applying Filters:

    "Options": {
        "Sandbox": "false",
        "IncludeCountries":"GBR,UDF,SUP - Up to 20 comma delimited countries",
        "ExcludeEntities": "true | false",
        "ExcludeIndividuals": "true | false",
        "ExcludeExPeps": "true | false"
    }

<QueryOptions>
  <KeyValueOfstringstring>
    <Key>Sandbox</Key>
    <Value>false</Value>
  </KeyValueOfstringstring>
  <KeyValueOfstringstring>
    <Key>IncludeCountries</Key>
    <Value>GBR,UDF,SUP - Up to 20 comma delimited countries</Value>
  </KeyValueOfstringstring>
  <KeyValueOfstringstring>
    <Key>ExcludeIndividuals</Key>
    <Value>true | false</Value>
  </KeyValueOfstringstring>
  <KeyValueOfstringstring>
    <Key>ExcludeEntities</Key>
    <Value>true | false</Value>
  </KeyValueOfstringstring>
  <KeyValueOfstringstring>
    <Key>ExcludeExPeps</Key>
    <Value>true | false</Value>
  </KeyValueOfstringstring>
</QueryOptions>
Filter Type Description
Include Countries If included, this filter will only return alerts that are on profiles that indicate that the main country of residence/activity is in the included country. Please note that if this filter is used, we advise to also use the 2 additional filters for undefined and supra-Nationals. This will include alerts generated for subjects that cannot be readily assigned to a country.
Exclude Ex-PEPs If included, this filter exclude alerts that would have been generated on individuals that have left the office that attracted their ‘PEP status’ for a defined period of time. For a risk based approach, it is normally appropriate to consider ex-PEPs some time, however, this time will differ based on the risk profile of the business that your organisation conducts.
Exclude Individuals/Entities When applied, this filter will supress alerts that are generated on either individuals (if you are conducting a search on a known business/entity) OR supress entities (if conducting a search on an known individual)

Sandbox

If the Sandbox query option is set to “true” the following entry will be returned in the ServiceResult:

Example Response for “Robert Mugabe”:

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "OneResult",
	"ServiceTransactionResult": "Success",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "Pass"
}

<HaltTriggered>False</HaltTriggered>
<ServiceInterpretResult>OneResult</ServiceInterpretResult>
<ServiceTransactionResult>Success</ServiceTransactionResult>
<ServiceTransactionResultMessage>"This call was generated using sandbox mode"</ServiceTransactionResultMessage>
<ValidationResult>Pass</ValidationResult>

Example Response for all OTHER name queries:

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "NoResults",
	"ServiceTransactionResult": "SuccessNoResults",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "Pass"
}

<HaltTriggered>False</HaltTriggered>
<ServiceInterpretResult>NoResults</ServiceInterpretResult>
<ServiceTransactionResult>SuccessNoResults</ServiceTransactionResult>
<ServiceTransactionResultMessage>"This call was generated using sandbox mode"</ServiceTransactionResultMessage>
<ValidationResult>Pass</ValidationResult>

Profile Details


ProfileDetails is a profile retrieval service. For any check that returns a profile ID this service will retrieve the full report on that ID.

Properties

The following properties pertain to this service.

Property Name Type Optional/Mandatory Notes
ProfileID String Mandatory A unique profile reference, as returned by one of the ‘Check’ services. NB: For UK Directors the ID returned by DirectorUKCheck the Companies House number must be prefixed with ‘DIR-‘, e.g. ‘DIR-99999999’.

Director UK Details Response

Example Response - Director UK Details

{
  "ProfileDetailsResult": {
    "DirectorUKDetailsResult": {
      "DirectorUKDetailsDirector": {
        "Address1": "221B Baker Street",
        "Address4": "London",
        "BirthDate": "01/01/1970",
        "DirectorNumber": "123456789",
        "Directorships": {
          "Directorship": {
            "AppointDate": "01/01/1980",
            "CompanyName": "DIRSE LLP",
            "CompanyNumber": "AB123456",
            "CompanyStatus": "Active - Accounts Filed",
            "CreditLimit": "10000",
            "CreditRating": "79",
            "Function": "LLP Member"
          }
        },
        "Name": "Jessica Black",
        "Nationality": "U.KINGDOM",
        "Postcode": "W1S 1AA",
        "Title": "Mrs"
      }
    }
  }
}

<ProfileDetailsResult>
	<DirectorUKDetailsResult >
		<DirectorUKDetailsDirector >
		<Address1>221B Baker Street</Address1>
		<Address2 />
		<Address3 />
		<Address4>London</Address4>
		<Address5 />
		<BirthDate>01/01/1970</BirthDate>
		<DirectorNumber>123456789</DirectorNumber>
		<Directorships>
			<Directorship>
				<AppointDate>01/01/1980</AppointDate>
				<CompanyName>DIRSE LLP</CompanyName>
				<CompanyNumber>AB123456</CompanyNumber>
				<CompanyStatus>Active - Accounts Filed</CompanyStatus>
				<CreditLimit>10000</CreditLimit>
				<CreditRating>79</CreditRating>
				<Function>LLP Member</Function>
			</Directorship>
		</Directorships>
		<Honours />
		<Name>Jessica Black</Name>
		<Nationality>U.KINGDOM</Nationality>
		<Postcode>W1S 1AA</Postcode>
		<Title>Mrs</Title>
		</DirectorUKDetailsDirector>
		<DirectorUKDetailsErrors  />
	</DirectorUKDetailsResult>
</ProfileDetailsResult>

Response Properties

Property Name Type Description
Address1 String First line of address.
Address2 String Second line of address.
Address3 String Third line of address.
Address4 String Fourth line of address.
Address5 String Fifth line of address.
BirthDate String Date of birth in a ‘dd/MM/yyyy’ format.
DirectorNumber String Director companie as listed on Companies House.
Directorships Directorships List of directorships held by director. See below.
Honours String Honours held by director.
Name String Name of director.
Nationality String Nationality of director.
Postcode String Postcode of director.
Title String Title of director.

Directorships
Directorships are a collection of one or more Directorship items, which are defined below.

Property Name Type Description
AppointDate String Date director was appointed.
CompanyName String Name of company.
CompanyNumber String Company number, as listed on Companies House.
CompanyStatus String How active the company still is.
CreditLimit String Credit limit of the company.
CreditRating String Credit rating of the company.
Function String Official function of director.

PEP Details Response

Example Response - PEP Details

"profileDetailsResult": {
	"pepDeskDetailsResult": {
		"additionalInformation": [],
		"country": [
			"European Union",
			"United Kingdrom"
		],
		"dateOfBirth": [
			"09.10.1966"
		],
		"functionDetails": [{
				"category": "State Executive Function, Government, Ministries",
				"dateNotInchargeSince": "",
				"exPEP": false,
				"function": "European Council",
				"specificFunction": "Member"
			}, {
				"category": "Heads of State, Major Government Offices and Support",
				"dateNotInchargeSince": "",
				"exPEP": false,
				"function": "Office of the Prime Minister, Cabinet Office",
				"specificFunction": "Minister for the Civil Service"
			}, {
				"category": "Political Leaders",
				"dateNotInchargeSince": "",
				"exPEP": false,
				"function": "Conservative Party",
				"specificFunction": "Leader"
			}
		],
		"gender": "Male",
		"nameDetails": [{
				"alternativeScript": "",
				"firstName": "David William Donald",
				"fullName": "",
				"lastName": "Cameron",
				"otherName": "Cameron, David",
				"title": "Mr."
			}, {
				"alternativeScript": "",
				"firstName": "David William Donald",
				"fullName": "",
				"lastName": "Cameron",
				"otherName": "Cameron, David",
				"title": "The Rt Hon Mr."
			}
		],
		"placeOfBirth": [
			"London, United Kingdom"
		]
	}
}

<PEPDeskDetailsResult >
	<AdditionalInformation/>
	<Country>
		<string>European Union</string>
		<string>United Kingdom</string>
	</Country>
	<DateOfBirth>
		<string>09.10.1966</string>
	</DateOfBirth>
	<FunctionDetails>
		<PEPDeskFunctionDetails>
			<Category>State Executive Function, Government, Ministries</Category>
			<DateNotInchargeSince/>
			<ExPEP>false</ExPEP>
			<Function>European Council</Function>
			<SpecificFunction>Member</SpecificFunction>
		</PEPDeskFunctionDetails>
		<PEPDeskFunctionDetails>
			<Category>Heads of State, Major Government Offices and Support</Category>
			<DateNotInchargeSince/>
			<ExPEP>false</ExPEP>
			<Function>Office of the Prime Minister, Cabinet Office</Function>
			<SpecificFunction>Minister for the Civil Service</SpecificFunction>
		</PEPDeskFunctionDetails>
		<PEPDeskFunctionDetails>
			<Category>Political Leaders</Category>
			<DateNotInchargeSince/>
			<ExPEP>false</ExPEP>
			<Function>Conservative Party</Function>
			<SpecificFunction>Leader</SpecificFunction>
		</PEPDeskFunctionDetails>
	</FunctionDetails>
	<Gender>Male</Gender>
	<NameDetails>
		<PEPDeskNameDetails>
			<AlternativeScript/>
			<FirstName>David William Donald</FirstName>
			<FullName/>
			<LastName>Cameron</LastName>
			<OtherName>Cameron, David</OtherName>
			<Title>Mr.</Title>
		</PEPDeskNameDetails>
		<PEPDeskNameDetails>
			<AlternativeScript/>
			<FirstName>David William Donald</FirstName>
			<FullName/>
			<LastName>Cameron</LastName>
			<OtherName>Cameron, David</OtherName>
			<Title>The Rt Hon Mr.</Title>
		</PEPDeskNameDetails>
	</NameDetails>
	<PlaceOfBirth>
		<string>London, United Kingdom</string>
	</PlaceOfBirth>
</PEPDeskDetailsResult>

Response Properties

Property Name Type Description
AdditionalInformation String  
Country String  
DateOfBirth String  
FunctionDetails PEPDeskFunctionDetails See below
Gender String  
NameDetails PEPDeskNameDetails See below
PlaceOfBirth String  

PEPDeskFunctionDetails

Property Name Type Description
Function String  
SpecificFunction String  
Category String  
DateNotInchargeSince String  
ExPEP Boolean  

PEPDeskNameDetails

Property Name Type Description
Title String  
FirstName String  
LastName String  
FullName String  
OtherName String  
AlternativeScript String  

SIS Plus / SPF Plus Details Response

Example Response - SIS Plus / SPF Plus Details

"sisPlusDetailsResult": {
	"active": true,
	"addressDetails": [],
	"aliasDetails": [],
	"callsign": [],
	"citizenShip": [],
	"constituancy": [],
	"dateOfBirth": [
		"1924/02/21 00:00:00.000"
	],
	"documents": [
		"AD001095"
	],
	"email": [],
	"eyes": [],
	"fax": [],
	"grt": [],
	"hair": [],
	"height": [],
	"imageUrl": [],
	"languages": [],
	"legalBasis": [],
	"listingDate": [
		"2002-02-21T00:00:00"
	],
	"marks": [],
	"nameDetails": [{
			"courtesyTitle": "",
			"firstName": "Robert",
			"fullName": "MUGABE",
			"lastName": "",
			"middleName": "Gabriel",
			"suffix": "",
			"title": "President"
		}
	],
	"offense": [],
	"pageUrl": [
		"http://www.hm-treasury.gov.uk/fin_sanctions_index.htm"
	],
	"phone": [],
	"placeOfBirth": [],
	"politicalParty": [],
	"program": [
		"Zimbabwe"
	],
	"remarks": [
		"Head of Government."
	],
	"riskCode": [
		"WL"
	],
	"sex": [],
	"source": [
		"HM-Treasury Consolidated list of financial sanctions targets"
	],
	"tin": [],
	"tonnage": [],
	"type": [
		"Individual"
	],
	"vesselFlag": [],
	"vesselOwner": [],
	"vesselType": [],
	"wantedBy": [],
	"website": [],
	"weight": []
}
"spfPlusDetailsResult": {
	"active": true,
	"addressDetails": [{
			"address": "",
			"addressRemarks": "",
			"city": "",
			"country": "United Kingdom",
			"postcode": "",
			"province": ""
		}
	],
	"aliasDetails": [],
	"callsign": [],
	"citizenShip": [],
	"constituancy": [],
	"dateOfBirth": [],
	"documents": [],
	"email": [],
	"eyes": [],
	"fax": [],
	"grt": [],
	"hair": [],
	"height": [],
	"imageUrl": [],
	"languages": [],
	"legalBasis": [],
	"listingDate": [],
	"marks": [],
	"nameDetails": [{
			"courtesyTitle": "",
			"firstName": "David",
			"fullName": "David William Donald CAMERON",
			"lastName": "",
			"middleName": "William Donald",
			"suffix": "",
			"title": "Prime Min., First Lord of the Treasury, & Min. for the Civil Service"
		}
	],
	"offense": [],
	"pageUrl": [
		"https://www.cia.gov/library/publications/world-leaders-1/UK.html"
	],
	"phone": [],
	"placeOfBirth": [],
	"politicalParty": [],
	"program": [
		"World Leaders"
	],
	"remarks": [],
	"riskCode": [
		"PEP"
	],
	"sex": [],
	"source": [
		"Chiefs of State and Cabinet Members of Foreign Governments"
	],
	"tin": [],
	"tonnage": [],
	"type": [
		"Indiv"
	],
	"vesselFlag": [],
	"vesselOwner": [],
	"vesselType": [],
	"wantedBy": [
		"Central Intelligence Agency"
	],
	"website": [],
	"weight": []
}

<SISPlusDetailsResult >
	<Active>true</Active>
	<AddressDetails/>
	<AliasDetails/>
	<Callsign />
	<CitizenShip />
	<Constituancy />
	<DateOfBirth >
	   <string>1924/02/21 00:00:00.000</string>
	</DateOfBirth>
	<Documents >
	   <string>AD001095</string>
	</Documents>
	<Email />
	<Eyes />
	<Fax />
	<GRT />
	<Hair />
	<Height />
	<ImageUrl />
	<Languages />
	<LegalBasis />
	<ListingDate>
	   <dateTime>2002-02-21T00:00:00</dateTime>
	</ListingDate>
	<Marks />
	<NameDetails>
		<SanctionsPlusNameDetails>
			<CourtesyTitle/>
			<FirstName>Robert</FirstName>
			<FullName>MUGABE</FullName>
			<LastName/>
			<MiddleName>Gabriel</MiddleName>
			<Suffix/>
			<Title>President</Title>
		</SanctionsPlusNameDetails>
	</NameDetails>
	<Offense />
	<PageUrl >
	   <string>http://www.hm-treasury.gov.uk/fin_sanctions_index.htm</string>
	</PageUrl>
	<Phone />
	<PlaceOfBirth />
	<PoliticalParty />
	<Program >
	   <string>Zimbabwe</string>
	</Program>
	<Remarks >
	   <string>Head of Government.</string>
	</Remarks>
	<RiskCode >
	   <string>WL</string>
	</RiskCode>
	<Sex />
	<Source >
	   <string>HM-Treasury Consolidated list of financial sanctions targets</string>
	</Source>
	<TIN />
	<Tonnage />
	<Type >
	   <string>Individual</string>
	</Type>
	<VesselFlag />
	<VesselOwner />
	<VesselType />
	<WantedBy />
	<Website />
	<Weight />
</SISPlusDetailsResult>
<SPFPlusDetailsResult >
	<Active>true</Active>
	<AddressDetails>
		<SanctionsPlusAddressDetails>
			<Address/>
			<AddressRemarks/>
			<City/>
			<Country>United Kingdom</Country>
			<Postcode/>
			<Province/>
		</SanctionsPlusAddressDetails>
	</AddressDetails>
	<AliasDetails/>
	<Callsign/>
	<CitizenShip/>
	<Constituancy/>
	<DateOfBirth/>
	<Documents/>
	<Email/>
	<Eyes/>
	<Fax/>
	<GRT/>
	<Hair/>
	<Height/>
	<ImageUrl/>
	<Languages/>
	<LegalBasis/>
	<ListingDate/>
	<Marks/>
	<NameDetails>
		<SanctionsPlusNameDetails>
			<CourtesyTitle/>
			<FirstName>David</FirstName>
			<FullName>David William Donald CAMERON</FullName>
			<LastName/>
			<MiddleName>William Donald</MiddleName>
			<Suffix/>
			<Title>Prime Min</Title>
		</SanctionsPlusNameDetails>
	</NameDetails>
	<Offense/>
	<PageUrl>
	   <string>https://www.cia.gov/library/publications/world-leaders-1/UK.html</string>
	</PageUrl>
	<Phone/>
	<PlaceOfBirth/>
	<PoliticalParty/>
	<Program>
  	 <string>World Leaders</string>
	</Program>
	<Remarks/>
	<RiskCode>
	   <string>PEP</string>
	</RiskCode>
	<Sex/>
	<Source>
	</Source>
	<TIN/>
	<Tonnage/>
	<Type>
	   <string>Indiv</string>
	</Type>
	<VesselFlag/>
	<VesselOwner/>
	<VesselType/>
	<WantedBy>
	   <string>Central Intelligence Agency</string>
	</WantedBy>
	<Website/>
	<Weight/>
</SPFPlusDetailsResult>

Response Properties

Property Name Type Description
NameDetails SanctionsPlusNameDetails See below.
Eyes String  
Hair String  
Weight String  
Height String  
Marks String  
Sex String  
Languages String  
TIN String  
Documents String  
PlaceOfBirth String  
DateOfBirth String  
Citizenship String  
Phone String  
Fax String  
Email String  
Website String  
Constituancy String  
PoliticalParty String  
ImageURL String  
PageURL String  
Source String  
Type String  
Offense String  
WantedBy String  
Program String  
LegalBasis String  
ListingDate String  
Callsign String  
VesselType String  
Tonnage String  
GRT String  
VesselFlag String  
VesselOwner String  
Remarks String  
AddressDetails SanctionsPlusAddressDetails See below.
AliasDetails SanctionsPlusAliasDetails See below.
RiskCode String  
Active Boolean  
Timestamp DateTime  

Sanctions Plus Name Details

Property Name Type Description
FullName String  
CourtesyTitle String  
FirstName String  
MiddleName String  
LastName String  
Suffix String  
Title String  

Sanctions Plus Address Details

Property Name Type Description
Address String  
City String  
Province String  
Postcode String  
Country String  
AddressRemarks String  

Sanctions Plus Alias Details

Property Name Type Description
AliasType String  
AliasName String  

Watchlist Details Response

Example Response - Watchlist Details

"watchlistDetailsResult": {
	"personProfileMatchDetails": {
		"action": "Add",
		"actionDate": "21-Oct-2013",
		"activeStatus": "Active",
		"aliases": [{
				"aliasType": "PrimaryAlias",
				"combinedName": "Robert Tinotenda  Mugabe",
				"firstName": "Robert",
				"middleName": "Tinotenda",
				"surname": "Mugabe"
			}
		],
		"associations": [{
				"ex": false,
				"name": "Muller Rautenbach",
				"profileId": "d08e3df3-ac03-a76a-b813-154e8865db84",
				"relationship": "Associate"
			}
		],
		"birthPlaces": [{
				"birthPlace": "Kutama Mission, Zvimba, Zimbabwe"
			}
		],
		"classifications": [{
				"watchlistClassification": "Politically Exposed Person (PEP)"
			}, {
				"listClassification": "Sanctions Lists",
				"watchlistClassification": "Special Interest Person (SIP)"
			}
		],
		"countries": [{
				"countryCode": "ZIMBAB",
				"countryName": "Zimbabwe",
				"countryType": "Citizenship"
			}, {
				"countryCode": "ZIMBAB",
				"countryName": "Zimbabwe",
				"countryType": "Resident of"
			}, {
				"countryCode": "ZIMBAB",
				"countryName": "Zimbabwe",
				"countryType": "Jurisdiction"
			}, {
				"countryCode": "INTERNATIONAL",
				"countryName": "International",
				"countryType": "Jurisdiction"
			}
		],
		"dateEvents": [{
				"dateType": "Date of Birth",
				"day": 21,
				"month": 2,
				"year": 1924
			}
		],
		"deceased": false,
		"gender": "Male",
		"identifiers": [{
				"idType": "OFAC Program ID",
				"value": "ZIMBABWE"
			}
		],
		"images": [{
				"imageURL": "http://www.bbc.co.uk/cult/ilove/years/1988/gallery/340/mugabe.jpg"
			}, {
				"imageURL": "http://img.dailymail.co.uk/i/pix/2007/05_01/Mugabe_468x667.jpg"
			}, {
				"imageURL": "http://img.dailymail.co.uk/i/pix/2008/03_04/mugabeD2803_468x649.jpg"
			}
		],
		"matchType": "Person",
		"occupations": [{
				"occupationName": "Heads & Deputies State/National Government",
				"roleTypeName": "Primary Occupation",
				"sinceDay": 31,
				"sinceMonth": 12,
				"sinceYear": 1987,
				"title": "President of Zimbabwe"
			}
		],
		"primaryAlias": "Robert Gabriel Mugabe",
		"profileId": "cb5f2851-64c0-6866-0ed1-da306e45efb2",
		"profileNotes": "OFFICE OF FOREIGN ASSETS CONTROL (OFAC) NOTES",
		"sanctions": [{
				"listCategoryName": "Sanctions Lists",
				"sanctionName": "OFAC - Specially Designated National List",
				"sanctionStatus": "Current"
			}
		],
		"sources": [{
				"source": "Circular CSSF 05/192"
			}
		]
	}
}

<WatchlistDetailsResult >
	<EntityProfileMatchDetails />
	<PersonProfileMatchDetails>
		<Action>Add</Action>
		<ActionDate>21-Oct-2013</ActionDate>
		<ActiveStatus>Active</ActiveStatus>
		<Addresses />
		<Aliases>
			<WatchlistPersonAliasData>
				<AliasType>PrimaryAlias</AliasType>
				<CombinedName>Robert Gabriel Mugabe</CombinedName>
				<FirstName>Robert</FirstName>
				<MaidenName />
				<MiddleName>Gabriel</MiddleName>
				<OriginalScriptName />
				<SingleStringName />
				<Suffix />
				<Surname>Mugabe</Surname>
				<TitleHonorific />
			</WatchlistPersonAliasData>
		</Aliases>
		<Associations>
			<WatchlistAssociateData>
				<Ex>false</Ex>
				<Name>Muller Rautenbach</Name>
				<ProfileId>d08e3df3-ac03-a76a-b813-154e8865db84</ProfileId>
				<Relationship>Associate</Relationship>
			</WatchlistAssociateData>
		</Associations>
		<BirthPlaces>
			<WatchlistBirthPlaceData>
				<BirthPlace>Kutama Mission, Zvimba, Zimbabwe</BirthPlace>
			</WatchlistBirthPlaceData>
		</BirthPlaces>
		<Classifications>
			<WatchlistClassificationData>
				<ListClassification />
				<SubListClassification />
				<WatchlistClassification>
                                     Politically Exposed Person (PEP)
                                 </WatchlistClassification>
			</WatchlistClassificationData>
			<WatchlistClassificationData>
				<ListClassification>Sanctions Lists</ListClassification>
				<SubListClassification />
			<WatchlistClassification>
                                     Special Interest Person (SIP)
                                 </WatchlistClassification>
			</WatchlistClassificationData>
		</Classifications>
		<Countries>
			<WatchlistCountryData>
				<CountryCode>ZIMBAB</CountryCode>
				<CountryName>Zimbabwe</CountryName>
				<CountryType>Citizenship</CountryType>
			</WatchlistCountryData>
			<WatchlistCountryData>
				<CountryCode>ZIMBAB</CountryCode>
				<CountryName>Zimbabwe</CountryName>
				<CountryType>Resident of</CountryType>
			</WatchlistCountryData>
			<WatchlistCountryData>
				<CountryCode>ZIMBAB</CountryCode>
				<CountryName>Zimbabwe</CountryName>
				<CountryType>Jurisdiction</CountryType>
			</WatchlistCountryData>
			<WatchlistCountryData>
				<CountryCode>INTERNATIONAL</CountryCode>
				<CountryName>International</CountryName>
				<CountryType>Jurisdiction</CountryType>
			</WatchlistCountryData>
		</Countries>
		<DateEvents>
			<WatchlistDateEventData>
				<DateType>Date of Birth</DateType>
				<Day>21</Day>
				<Month>2</Month>
				<Notes />
				<Year>1924</Year>
			</WatchlistDateEventData>
		</DateEvents>
		<Deceased>false</Deceased>
		<Gender>Male</Gender>
		<Identifiers />
		<Images>
			<WatchlistImageData>
				<ImageURL>
				http://www.bbc.co.uk/cult/ilove/years/1988/gallery/340/mugabe.jpg
				</ImageURL>
			</WatchlistImageData>
			<WatchlistImageData>
				<ImageURL>
				http://img.dailymail.co.uk/i/pix/2007/05_01/Mugabe_468x667.jpg
				</ImageURL>
			</WatchlistImageData>
			<WatchlistImageData>
				<ImageURL>
				http://img.dailymail.co.uk/i/pix/2008/03_04/mugabeD2803_468x649.jpg
				</ImageURL>
			</WatchlistImageData>
		</Images>
		<MatchType>Person</MatchType>
		<Occupations>
			<WatchlistOccupationData>
				<OccupationName>Heads &amp; Deputies State/National Government</OccupationName>
				<RoleTypeName>Primary Occupation</RoleTypeName>
				<SinceDay>31</SinceDay>
				<SinceMonth>12</SinceMonth>
				<SinceYear>1987</SinceYear>
				<Title>President of Zimbabwe</Title>
				<ToDay />
				<ToMonth />
				<ToYear />
			</WatchlistOccupationData>
		</Occupations>
		<PrimaryAlias>Robert Gabriel Mugabe</PrimaryAlias>
		<ProfileId>69e10264-4b90-64fe-b4b7-c9dddafd0241</ProfileId>
		<ProfileNotes>OFFICE OF FOREIGN ASSETS CONTROL (OFAC) NOTES</ProfileNotes>
		<Sanctions>
			<WatchlistSanctionData>
				<ListCategoryName>Sanctions Lists</ListCategoryName>
				<SanctionName>OFAC - Specially Designated National List</SanctionName>
				<SanctionStatus>Current</SanctionStatus>
				<SinceDay />
				<SinceMonth />
				<SinceYear />
				<ToDay />
				<ToMonth />
				<ToYear />
			</WatchlistSanctionData>
		</Sanctions>
		<Sources>
			<WatchlistSourceData>
				<Source>Circular CSSF 05/192</Source>
			</WatchlistSourceData>
		</Sources>
	</PersonProfileMatchDetails>
</WatchlistDetailsResult>

Response Properties

Property Name Type Description
Action WatchlistActionStatusEnum The last action that was performed on the record. See below for more information.
ActionDate String The date the last action was performed on the record.
ActiveStatus WatchlistActiveStatusEnum Whether or not the record is marked as active. See below for more information.
Addresses WatchlistAddressData The addresses of the record. See below for details.
Aliases WatchlistEntityAliasData The aliases of the record. See below for details.
Associations WatchlistAssociateData The known associates of the record. See below for details.
BirthPlaces WatchlistBirthPlaceData Information about the birth places of the record. See below for details.
Classifications WatchlistClassificationData The classifications of the record. See below for details.
Countries WatchlistCountryData The countries associated with the record. See below for details.
DateEvents WatchlistDateEventData The dates of key events related to the record. See below for details.
Deceased Boolean Whether or not the record is deceased.
Gender WatchlistGenderEnum The gender of the record. See below for details.
Identifiers WatchlistIdentifierData Any identifiers associated with the record. See below for details.
Images WatchlistImageData Any images associated with the record. See below for details.
MatchType MatchTypeEnum The type of record. See below for details.
Occupations WatchlistOccupationData The occupations associated with the record. See below for details.
PrimaryAlias String The primary alias of the record.
ProfileId String The unique Profile Id for this record.
ProfileNotes String Additional notes associated with the record.
Sanctions WatchlistSanctionData The sanctions that apply to this record. See below for details.
Sources WatchlistSourceData The sources the information about this record is derived from.
Vessels WatchlistVesselData Any vessels (usually maritime) associated with the record. See below for details.

WatchlistActionStatusEnum

Enumeration Name Value Description
Delete 1 Represents a delete action.
Change 2 Represents a change action.
Add 3 Represents an add action.

WatchlistActiveStatusEnum

Enumeration Name Value Description
Active 1 The record is active.
Inactive 2 The record is inactive.

WatchlistAddressData

Property Name Type Description
AddressLine String The first line of the address, usually house number, stret name, PO Box, etc.
CountryProfileUrl String Represents the name of the Dow Jones Country Profile Document.
City String The city component of the address.
CountryCode String The country code for the address.

WatchlistEntityAliasData

Property Name Type Description
Name String The name of the alias.
SingleStringName String The single string name of the alias.
OriginalScriptName String The name of the alias in its original script if available.
AliasType WatchlistAliasTypeEnum The type of alias. See below for further details.

WatchlistAliasTypeEnum

Enumeration Name Value Description
PrimaryAlias 1 The alias is the primary alias of the record.
AlsoKnownAs 2 The record is also known as this alias.
FormerlyKnownAs 3 The record was formerly known by this alias.
NowKnownAs 4 The record is now known by this alias.
Unknown 5 The type of alias is unknown.
MaidenName 6 The alias is a madiden name of the record.
SpellingVariation 7 The alias a spelling variation of another alias.
LowQualityAlsoKnownAs 8 The alias is record is also known by this alias, but the reliability of this information may be poor.

WatchlistAssociateData

Property Name Type Description
Name String The name of the associate.
ProfileId String The Profile Id of the associate.
Relationship String The relationship the associate has to the record.
Ex Boolean Whether or not the associate is an ex-associate.

WatchlistBirthPlaceData

Property Name Type Description
BirthPlace String The birthplace of the record.

WatchlistClassificationData

Property Name Type Description
WatchlistClassification String The main classification, usually Politically Exposed Person (PEP), Relative or Close Associate (RCA), Special Interest Person (SIP), or Special Interest Entity (SIE).
ListClassification String The list classification. This depends on the WatchlistClassification. It usually indicates a type of crime or a list the record belongs to that is relevant to the WatchlistClassification.
SubListClassification String The sub classification. This depends on the ListClassification. It is usually a more specific classification, for example a specific crime.

WatchlistCountryData

Property Name Type Description
CountryCode String The country code.
CountryName String The name of the country.
CountryType String The type of relationship with the country. For example, the record could be a resident.

WatchlistDateEventData

Property Name Type Description
Day Integer The day the event occurred.
Month Integer The month the event occurred.
Year Integer The year the event occurred.
Notes String Any notes associated with the date event.
DateType String The type of event, e.g. date of birth, date of resignation, etc.

WatchlistGenderEnum

Enumeration Name Value Description
Unknown 0 The record’s gender is unknown or unspecified.
Male 1 The record’s gender is Male.
Female 2 The record’s gender is Female.

WatchlistIdentifierData

Property Name Type Description
IDType String The type of identifier. This is usually a document identifier such as company number, passport number, etc.
Value String The value of the identifier. This is the actual value of the IDType, such as the actual passport number.
Notes Integer Any notes associated with the identifier.

WatchlistImageData

Property Name Type Description
ImageURL String The URL of an image associated with the record.

MatchTypeEnum

Enumeration Name Value Description
Person 1 The match is a Person.
Entity 2 the match is an Entity.
Unknown 3 The match is of unknown type. This may represent missing data and does not necessarily mean ‘other’.
Vessel 4 The match is a vessel (usually maritime).
Aircraft 5 The match is an aircraft.

WatchlistOccupationData

Property Name Type Description
RoleTypeName String The type of the role, usually primary occupation, other role, or previous role.
SinceDay Integer The day the occupation began.
SinceMonth Integer The month the occupation began.
SinceYear Integer The year the occupation began.
ToDay Integer The day the occupation ended.
ToMonth Integer The month the occupation ended.
ToYear Integer The year the occupation ended..
OccupationName String The name of the occupation.
Title String The title the record holds. If the record is deceased this may sometimes be indicated here.

WatchlistSanctionData

Property Name Type Description
SanctionName String The name of the sanction, usually an official list.
SanctionStatus String The status of the sanction (not the record), usually whether it is a current or suspended sanction.
ListCategoryName String The ListCategory associated with the sanction (not the record).
SinceDay Integer The day this sanction started.
SinceMonth Integer The month this sanction started.
SinceYear Integer The year this sanction started.
ToDay Integer The day this sanction ended.
ToMonth Integer The month this sanction ended.
ToYear Integer The year this sanction ended.

WatchlistSourceData

Property Name Type Description
Source String The source used to obtain data about the record. Usually a URL or document name.

WatchlistVesselData

Property Name Type Description
VesselCallSign String The call sign of the vessel.
VesselType String The type of vessel.
VesselTonnage String The tonnage of the vessel.
VesselGRT String The gross register tonnage (GRT) of the vessel.
VesselOwner String The owner of the vessel.
VesselFlag String The flag belonging to the vessel.

PEP and Sanctions 006 Details Response

Example Response - PEP and Sanctions 006 Details

            "w2DataPepAndSanction006DetailsResult": {
                "addresses": [],
                "aka": "",
                "aliases": [],
                "countryName": "Zimbabwe",
                "directId": "c113dd71-56eb-4e",
                "dob": "February 21, 1924",
                "dob2": "",
                "effectiveDate": "",
                "entryCategory": "Sanction List",
                "entryDesc": "Individual",
                "firstName": "Robert Gabriel",
                "govDesignation": "",
                "lastName": "MUGABE",
                "levelDesc": "N/A",
                "masterId": 1868226,
                "name": "MUGABE, Robert Gabriel",
                "nationalId": "",
                "otherId": "",
                "passportId": "AD002119",
                "pob": "",
                "positions": "Added to OFAC's SDN List.",
                "prefix": "",
                "primaryName": "",
                "profileId": "WC401565",
                "relatedId": 0,
                "relationships": [
                    {
                        "is": "Affiliated Company",
                        "toName": "HARMONY FARM",
                        "toProfileId": "WC565518"
                    }
                ],
                "remarks": "MUGABE, Robert Gabriel; DOB 21 Feb 1924; Passport AD002119 (Zimbabwe); President of the Republic of Zimbabwe (individual) [ZIMBABWE].",
                "sourceName": "US-U.S. Office of Foreign Asset Control (OFAC) - SDN List",
                "subCatDesc": "N/A",
                "suffix": "",
                "touchDate": "2019-06-28T01:00:54.53",
                "watch": false
            }

<ProfileDetailsResult>
    <W2DataPepAndSanction006DetailsResult>
        <Addresses />
        <Aka />
        <Aliases xmlns:d="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
        <CountryName>Laos</CountryName>
        <DirectId>6cc10306-fb5d-4aae-a2a9-29ae64d03dde</DirectId>
        <Dob />
        <Dob2 />
        <EffectiveDate>2009</EffectiveDate>
        <EntryCategory>PEP</EntryCategory>
        <EntryDesc>Individual</EntryDesc>
        <FirstName>Nao</FirstName>
        <GovDesignation />
        <LastName>Boutta</LastName>
        <LevelDesc>National</LevelDesc>
        <MasterId>0</MasterId>
        <Name>Boutta, Nao</Name>
        <NationalId />
        <OtherId />
        <ParentId>0</ParentId>
        <PassportId />
        <Pob />
        <Positions>Former Deputy Chief of Cabinet, Ministry of Public Health (2009 - 2011)</Positions>
        <Prefix>Dr.</Prefix>
        <PrimaryName />
        <ProfileId>WC6395</ProfileId>
        <RelatedId>0</RelatedId>
        <Relationships />
        <Remarks>Career: 2009 - 2011: Deputy Chief of Cabinet, Ministry of Public Health</Remarks>
        <SourceName>Website</SourceName>
        <SourceWebLink i:nil="true" />
        <SubCatDesc>Govt Branch Member</SubCatDesc>
        <Suffix />
        <TouchDate i:nil="true" />
        <Watch>false</Watch>
    </W2DataPepAndSanction006DetailsResult>
</ProfileDetailsResult>

Response Properties

Property Name Type Description
Addresses String[] List of addresses
Aka String Nickname
Aliases String[] List of alternative names
CountryName String Country
DirectId String Original supplier ID
DOB String Date of birth
DOB2 String Second date of birth
EffectiveDate String Date that record became active
EntryCategory String Category of record
EntryDesc String Type of entity
ExpirationDate String Date of record expiry
FirstName String First name
GovDesignation String Categorisation of record as given by the regulatory body
LastName String Last name
LevelDesc String Level of exposure for the PEP
MasterId String Profile ID for consolidated sanctions profiles
Name String Full name
NationalId String National ID number
Organization String Organisation that entity belongs to
OtherId String Identification value for other unique forms of identification offered by countries
PassportId String Passport number
PictureFile String Indicates if a picture is available
Pob String Place of birth
Positions String Positions held
Prefix String Title, i.e. “Mr”
PrimaryName String Original, non-Romanized name
ProfileId String Profile ID
RelatedId String Indicates that relationships exist with other entities
Relationships String Lists relationships with other entities. These contain the following values:
Is (string): Nature of relationship
ToName (string): Name of relation
ToProfileId (string): Profile ID of relation
Remarks String Any additional miscellaneous information
SourceName String Source where entry originated
SourceWebLink String URL of information source
SubCatDesc String Record sub-category
Suffix String Name suffix
TouchDate String Last date of change to record
Watch String Indicates that there is negative news about the PEP

Sandbox

If the Sandbox query option is set to “true” the following entry will be returned in the ServiceResult:

Example Response for “DIR-123456789”:

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "NotApplicable",
	"ServiceTransactionResult": "Success",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "NotApplicable"
}

<HaltTriggered>False</HaltTriggered>
<ServiceInterpretResult>NotApplicable</ServiceInterpretResult>
<ServiceTransactionResult>Success</ServiceTransactionResult>
<ServiceTransactionResultMessage>"This call was generated using sandbox mode"</ServiceTransactionResultMessage>
<ValidationResult>NotApplicable</ValidationResult>

Example Response for “69e10264-4b90-64fe-b4b7-c9dddafd0241”:

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "NotApplicable",
	"ServiceTransactionResult": "Success",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "NotApplicable"
}

<HaltTriggered>False</HaltTriggered>
<ServiceInterpretResult>NotApplicable</ServiceInterpretResult>
<ServiceTransactionResult>Success</ServiceTransactionResult>
<ServiceTransactionResultMessage>"This call was generated using sandbox mode"</ServiceTransactionResultMessage>
<ValidationResult>NotApplicable</ValidationResult>

Example Response for “cb5f2851-64c0-6866-0ed1-da306e45efb2”:

 {
	"HaltTriggered": "False",
	"ServiceInterpretResult": "NotApplicable",
	"ServiceTransactionResult": "Success",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "NotApplicable"
}

<HaltTriggered>False</HaltTriggered>
<ServiceInterpretResult>NotApplicable</ServiceInterpretResult>
<ServiceTransactionResult>Success</ServiceTransactionResult>
<ServiceTransactionResultMessage>"This call was generated using sandbox mode"</ServiceTransactionResultMessage>
<ValidationResult>NotApplicable</ValidationResult>

Example Response for “79bb61cd-6dca-b477-d688-c41947e11c4f”:

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "NotApplicable",
	"ServiceTransactionResult": "Success",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "NotApplicable"
}

<HaltTriggered>False</HaltTriggered>
<ServiceInterpretResult>NotApplicable</ServiceInterpretResult>
<ServiceTransactionResult>Success</ServiceTransactionResult>
<ServiceTransactionResultMessage>"This call was generated using sandbox mode"</ServiceTransactionResultMessage>
<ValidationResult>NotApplicable</ValidationResult>

Example Response for “SANC-a39a68a8-f82b-df96-f880-dedcafc2f1fb”:

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "NotApplicable",
	"ServiceTransactionResult": "Success",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "NotApplicable"
}

<HaltTriggered>False</HaltTriggered>
<ServiceInterpretResult>NotApplicable</ServiceInterpretResult>
<ServiceTransactionResult>Success</ServiceTransactionResult>
<ServiceTransactionResultMessage>"This call was generated using sandbox mode"</ServiceTransactionResultMessage>
<ValidationResult>NotApplicable</ValidationResult>

Example Response for “SANC-cbe61692-1455-5cb6-879f-03864696e457”:

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "NotApplicable",
	"ServiceTransactionResult": "Success",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "NotApplicable"
}

<HaltTriggered>False</HaltTriggered>
<ServiceInterpretResult>NotApplicable</ServiceInterpretResult>
<ServiceTransactionResult>Success</ServiceTransactionResult>
<ServiceTransactionResultMessage>"This call was generated using sandbox mode"</ServiceTransactionResultMessage>
<ValidationResult>NotApplicable</ValidationResult>

PEP and Sanction 006
The following profile ID’s will give PEP and Sanction 006 profile details responses in sandbox mode:

  • WC49767
  • WC66266
  • WC191511
  • WC209189
  • WC401565
  • WC1868226
  • WC1980603
  • WC2320427
  • WC7064012
  • WC7245560
  • WC7310683
  • WC225000086

Example ServiceTransactions Result

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "NotApplicable",
	"ServiceTransactionResult": "Success",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "NotApplicable"
}

<HaltTriggered>False</HaltTriggered>
<ServiceInterpretResult>NotApplicable</ServiceInterpretResult>
<ServiceTransactionResult>Success</ServiceTransactionResult>
<ServiceTransactionResultMessage>"This call was generated using sandbox mode"</ServiceTransactionResultMessage>
<ValidationResult>NotApplicable</ValidationResult>

Example ServiceTransactions Result

{
	"HaltTriggered": "False",
	"ServiceInterpretResult": "NotApplicable",
	"ServiceTransactionResult": "Success",
	"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
	"ValidationResult": "NotApplicable"
}

<HaltTriggered> False
<ServiceInterpretResult> NotApplicable
<ServiceInterpretResult> NoValidationPerformed
<ServiceTransactionResult> SuccessNoResults
<ServiceTransactionResultMessage> "This call was generated using sandbox mode"
<ValidationResult> NotApplicable

PEP and Sanction 006


PEP and Sanctions 006 service checks if a specified person is a politically exposed person, i.e. they are in a prominent public position or a close relative of someone who is, or under sanction. If there are multiple matches, it provides a list of them, up to a limit of 100.

Properties

The following properties pertain to this service.

Property Name Type Optional/Mandatory Notes
NameQuery String Mandatory The name of the person you are searching for.
NameQueryMatchThreshold Integer Optional The minimum name match score to match against. Default is 80 (all matches).
DateOfBirthMatchThreshold Integer Optional The minimum date of birth score to match against. Default is null (off). If supplied, at least one component of the date of birth must be supplied.
DayOfBirth Integer Optional Used with DateOfBirthMatchThreshold.
MonthOfBirth Integer Optional Used with DateOfBirthMatchThreshold.
YearOfBirth Integer Optional Used with DateOfBirthMatchThreshold.

Response

The following table gives some more details about the response.

Example Response - PEP and Sanction 006

"w2DataPepAndSanction006Result": {
	"matchResults": [{
			"birthYear": 1993,
			"matchType": "Person",
			"name": "Mugabe, Robert Peter",
			"nameMatchScore": 80,
			"profileId": "WC49767"
		}
	]
}

<W2DataPepAndSanction006Result>
	 <!-- One or more of these --> 
	 <MatchResults>
		<CheckMatch>
		   <BirthDay />
		   <BirthMonth />
		   <BirthYear />
		   <DateOfBirthMatchScore />
		   <MatchType>Person</MatchType>
		   <Name>Al Zoubi, Muhammad Hussein</Name>
		   <NameMatchScore>85</NameMatchScore>
		   <ProfileId>WC8042</ProfileId>
		</CheckMatch>
	 </MatchResults>
</W2DataPepAndSanction006Result>
Property Name Type Description
BirthDay Integer The birth day of the record matched against.
BirthMonth Integer The birth month of the record matched against.
BirthYea Integer The birth month of the record matched against.
DateOfBirthMatchScore Integer The score that this record’s date of birth matched the query date.
MatchType MatchTypeEnum The type of match where the data is available in the source. See below
Name String The name of the record matched against. Depending on the source data there may be multiple names here combined into one.
NameMatchScore Integer The score that this record’s name matched the query name.
ProfileId String A unique reference for a profile that can be subsequently retrieved in full using the ProfileDetails Service.

Transaction Result

HaltTriggered False
ServiceTransactionResult Success
SuccessIncompleteResults - Too many matches on the search criteria and the results have been truncated
ServerErrorGeneralError - An error occurred
ClientErrorInsufficientInformation - Required field not supplied - NameQuery or Forename / Surname
ServiceInterpretResult OneResult
MultipleResults
NoResults
NotPerformed - An error occurred and the search was not performed
ServiceTransactionResultMessage Usually empty, can contain optional information such as too many matches etc.
ValidationResult NotApplicable - No search occurred to match against
Fail - MissingMandatoryField or PatternNotMatched
Pass

MatchTypeEnum
More information about the match type

Enumeration Value Value Description
Person 1 The match is a Person.
Entity 2 The match is an Entity.
Unknown 3 The match is of unknown type. This may represent missing data and does not necessarily mean ‘other’.
Vessel 4 The match is a vessel (usually maritime).
Aircraft 5 The match is an aircraft.

Alert Filters

Available Filters

Applying Filters:

    "Options": {
        "Sandbox": "false",
        "IncludeCountries":"GBR,UDF,SUP - Up to 20 comma delimited countries",
        "ExcludeEntities": "true | false",
        "ExcludeIndividuals": "true | false",
    }

<QueryOptions>
  <KeyValueOfstringstring>
    <Key>Sandbox</Key>
    <Value>false</Value>
  </KeyValueOfstringstring>
  <KeyValueOfstringstring>
    <Key>IncludeCountries</Key>
    <Value>GBR,UDF,SUP - Up to 20 comma delimited countries</Value>
  </KeyValueOfstringstring>
  <KeyValueOfstringstring>
    <Key>ExcludeIndividuals</Key>
    <Value>true | false</Value>
  </KeyValueOfstringstring>
  <KeyValueOfstringstring>
    <Key>ExcludeEntities</Key>
    <Value>true | false</Value>
  </KeyValueOfstringstring>
</QueryOptions>
Filter Type Description
Include Countries If included, this filter will only return alerts that are on profiles that indicate that the main country of residence/activity is in the included country. Please note that if this filter is used, we advise to also use the 2 additional filters for undefined and supra-Nationals. This will include alerts generated for subjects that cannot be readily assigned to a country.
Exclude Individuals/Entities When applied, this filter will supress alerts that are generated on either individuals (if you are conducting a search on a known business/entity) OR supress entities (if conducting a search on an known individual)

Sandbox

W2-DATA-DISQUALIFIEDS-UK-008


W2-DATA-DISQUALIFIEDS-UK-008 This service searches a list of Disqualified Directors. This list is updated once a week.

Query Data & Request

This service uses the following query data:

Example Request - W2 Global Data Disqualified Directors Service

<serviceRequest>
    <BundleData>
        <BundleName>{YOUR BUNDLE NAME HERE}</BundleName>
    </BundleData>
    <QueryData>
        <DateOfBirthMatchThreshold>{e.g. 100}</DateOfBirthMatchThreshold>
        <DayOfBirth>{e.g. 01}</DayOfBirth>
        <Forename>{e.g. JOHN}</Forename>
        <MiddleNames>{e.g. JAMES} </MiddleNames>
        <MonthOfBirth>e.g. 01}</MonthOfBirth>
        <NameQueryMatchThreshold>{ e.g. 100}</NameQueryMatchThreshold>
        <Surname>{e.g. SMITH}</Surname>
        <YearOfBirth>{e.g. 1990}</YearOfBirth>
    </QueryData>
    <ServiceAuthorisation>
        <APIKey>{YOUR API KEY HERE}</APIKey>
        <ClientReference>>{YOUR CLIENT REFERENCE HERE}</ClientReference>
    </ServiceAuthorisation>
</serviceRequest>

{
	"Bundle": "YOURBUNDLE",
	"Data": {
  		"DateOfBirthMatchThreshold":100,
		"DayOfBirth": 22,
		"Forename": "JOHN",
    		"MiddleNames":"JAMES",
    		"NameQueryMatchThreshold":100,
		"MonthOfBirth": 10,
		"Surname": "JAMES",
		"YearOfBirth": 1997
	}
}
FieldName Type Mandatory Notes
Forename string Y The forename of the person you are searching for.
Middlenames string N The middlename of the person you are searching for.
Surname string Y The surname of the person you are searching for.
NameQueryMatchThreshold integer N The minimum name match score* to match against. If not supplied we will assume 80.
DayOfBirth integer Y The day of the date of birth.
MonthOfBirth integer Y The month of the date of birth.
YearOfBirth integer Y The year of the date of birth.
DateOfBirthMatchingThreshold integer N The minimum date of birth score* to match against. If not supplied we will assume 0.
Postcode string N Used to further filter results if supplied.

Response

Sample Response for W2 Global Data Disqualified Directors Service

"w2DataDisqualifiedsUk008Result": {
            "results": [
                {
                    "details": {
                        "disqualifications": [
                            {
                                "caseNumber": "IJK676897642398",
                                "companyName": "SOUTH SEA TRADING",
                                "courtName": "INSOLVENCY SERVICE",
                                "disqualificationType": "UNDERTAKING",
                                "endDate": "2018-03-14T00:00:00",
                                "sectionOfTheAct": "CDDA 1986 S7",
                                "startDate": "2013-03-15T00:00:00",
                                "undertakingDate": "0001-01-01T00:00:00"
                            }
                        ],
                        "exemptions": [
                            {
                                "companyName": "ACME PRODUCTION LIMITED",
                                "endDate": "2016-01-01T00:00:00",
                                "purpose": "SANDBOX",
                                "startDate": "2015-01-01T00:00:00"
                            },
                            {
                                "companyName": "ADVENTURE WORKS",
                                "endDate": "2016-01-01T00:00:00",
                                "purpose": "SANDBOX",
                                "startDate": "2015-01-01T00:00:00"
                            }
                        ],
                        "person": {
                            "dateOfBirth": "1944-12-31T00:00:00",
                            "foreName": "Billy",
                            "id": "4",
                            "postcode": "RH13 3HE",
                            "searchableNames": [
                                "Billy Jones"
                            ],
                            "surname": "Jones"
                        },
                        "variation": {
                            "actionDate": "2018-01-01T00:00:00",
                            "caseNumber": "LMN234682769827364",
                            "courtName": "GLASGOW HIGH COURT"
                        }
                    },
                    "dob": "1944-12-31T00:00:00",
                    "dobScore": 100,
                    "matchedName": "Billy Jones",
                    "nameScore": 100
                }
            ]
        }

<W2DataDisqualifiedsUk008Result>
    <ErrorMessage />
    <Results>
        <!-- 0 or more of these -->
        <DirectorsSearchResult>
            <Details>
                <Disqualification>
                    <CaseNumber>ABC1234567</CaseNumber>
                    <CompanyName>ACME PRODUCTIONS</CompanyName>
                    <CourtName>HIGH COURT</CourtName>
                    <DisqualificationType>UNDERTAKING</DisqualificationType>
                    <EndDate>2017-11-30T00:00:00</EndDate>
                    <SectionOfTheAct>CDDA 1986 S7</SectionOfTheAct>
                    <StartDate>2016-06-01T00:00:00</StartDate>
                    <UndertakingDate>2016-05-11T00:00:00</UndertakingDate>
                </Disqualification>
                <Exemptions>
                    <!-- 0 or more of these -->
                    <Exemption>
                       <CompanyName>SOUTH SEA TRADING Co.</CompanyName>
                       <EndDate>2018-12-01T00:00:00</EndDate>
                       <Purpose>0000000001</Purpose>
                       <StartDate>2016-07-27T00:00:00</StartDate>
                    </Exemption>
                </Exemptions>
                <Person>
                    <AddressLine1>1 HIGH STREET</AddressLine1>
                    <AddressLine2>SOME PLACE</AddressLine2>
                    <CorporateNumber/>
                    <Country>UK</Country>
                    <CountryRegistration/>
                    <County/>
                    <DateOfBirth>1900-01-01T00:00:00</DateOfBirth>
                    <ForeName>JOHN</ForeName>
                    <Honours/>
                    <Id>123456789</Id>
                    <Nationality>BRITISH</Nationality>
                    <PostTown>SOME TOWN</PostTown>
                    <Postcode>AB1 2CD</Postcode>
                    <SearchableNames>
                        <!-- 1 or more of these aliases -->
                        <string>JOHN SMITH</string>
                        <string>JOHN JAMES SMITH</string>   
                    </SearchableNames>
                    <Surname>SMITH</Surname>
                    <Title>MR</Title>
                </Person>
                <Variation>
                    <ActionDate>2016-01-01</ActionDate>
                    <CaseNumber>ABC123</CaseNumber> 
                    <CourtName>HIGH COURT</CourtName>
                </Variation>
            </Details>
            <!-- THE DOB we matched on -->
            <Dob>1900-01-01</Dob>
            <!-- The dob score we found -->
            <DobScore>100</DobScore>
            <!-- The alias we matched on -->
            <MatchedName>John Smith</MatchedName>
            <!-- The score of the name we matched on -->   
            <NameScore>100</NameScore>
        </DirectorsSearchResult>
    </Results>
</W2DataDisqualifiedsUk008Result>

The table below contains explanations for a few of the fields returned in the response:

Field Explanation
Dob This is the date of birth that was provided in the query data that was used for searching. This can be different to the Person.DateOfBirth field if a low threshold is set for dob scoring and an exact match is not required.
DobScore This is the match score for the Person.DateOfBirth field against the dob that was used in the query.
MatchedName This is the name in the Person.SearchableNames collection that had the highest score.
NameScore The highest score found from the searchable names.
Person.SearchableNames This is a collection of known aliases for the individual in question. This field is what is used for searching.

Sandbox

Query options for Sandbox

"options": {
	"sandbox": "true"
}

<QueryOptions>
  <KeyValueOfstringstring>
    <Key>Sandbox</Key>
    <Value>true</Value>
  </KeyValueOfstringstring>
</QueryOptions>

This service has the following Sandbox Cases:

Forename Surname Date Of Birth Postcode Searchable Names Notes
James Thorpe 1978-06-10 AB54 4PN “James Thorpe”, “James Sebastien Thorpe”, “Thorpe James”, “James Thorpey”, “Sebastien James Thorpe” Returns a Disqualified Director with no exemptions or validations.
Ahenobarbus Michal 1944-12-31 RH13 3HE “Ahenobarbus Michal”, “Ahenobarbus Geronimo Michal”, “Michal Ahenobarbus”, “Ahenobarbusero Michal”, “Sebastien Ahenobarbus Michal” Returns a Disqualified Director with one exemption and no validations.
Allen Kiril 1943-01-08 IVT X34 “Allen Kiril”, “Allen Brian Kiril”, “Kiril Allen” Returns a Disqualified Director with two exemptions and no validations.
Billy Jones 1944-12-31 RH13 3HE “Billy Jones” Returns a Disqualified Director with two exemptions and one validations.

Id Check Alpha Full


ID Check UK Alpha Full is an identity verification service that includes the full Electoral Roll and Credit Bureau data. This service will leave a money laundering footprint on the bureau profile of the person you are requesting information about.

Query Data & Request

Example Request for Id Check UK Alpha Service

  "Data": {
  	"City": "{ e.g. Bristol }",
  	"DayOfBirth": "{ e.g. 01}",
  	"Forename": "{ e.g. John }",
  	"HouseNameNumber": "{ e.g. 13 }",
  	"MonthOfBirth": "{ e.g. 01 }",
  	"Postcode": "{ e.g. BS1 6LR }",
  	"Street": "{ e.g. White Friars }",
  	"Surname": "{ e.g. Smith }",
  	"YearOfBirth": "{ e.g. 1983 }"
  }

<QueryData>
  <City>{ e.g. Bristol }</City>
  <DayOfBirth>{ e.g. 01}</DayOfBirth>
  <Forename>{ e.g. John }</Forename>
  <HouseNameNumber>{ e.g. 13 }</HouseNameNumber>
  <MonthOfBirth>{ e.g. 01 }</MonthOfBirth>               
  <Postcode>{ e.g. BS1 6LR }</Postcode>
  <Street>{ e.g. White Friars }</Street>
  <Surname>{ e.g. Smith }</Surname>
<YearOfBirth>{ e.g. 1983 }</YearOfBirth>
</QueryData>

The following QueryData properties pertain to this service. Please note in the actual SOAP request the fields should be in alphabetical order.

Property Name Type Length Optional/Mandatory Notes
Forename String 15 Mandatory  
MiddleNames String 15 Optional The contents of this field will be converted into initials, therefore the character limit can usually be ignored.
Surname String 30 Mandatory  
DayOfBirth Integer 2 Mandatory  
MonthOfBirth Integer 2 Mandatory  
YearOfBirth Integer 4 Mandatory  
HouseNameNumber String 26 Mandatory if no HouseName or HouseNumber given  
HouseName String 26 Mandatory if no HouseNameNumber or HouseNumber given  
HouseNumber String 26 Mandatory if no HouseNameNumber or HouseName given  
Flat String 16 Optional  
Street String 40 Optional If this value exceeds 40 characters, it will be automatically truncated down to 40 instead of being rejected.
County String 20 Optional  
City String 20 Optional If this value exceeds 20 characters, it will be automatically truncated down to 20 instead of being rejected.
Postcode String 8 Mandatory  
PhoneNumber String 16 Optional Please provide the phone number as one contiguous set of numbers with no other characters or spaces.

Response

Example Response for Id Check UK Alpha Service

"idCheckUKAlphaResult": {
	"creditHeaderMatches": [{
			"caisExactMatchCount": 1,
			"exactMatchActiveCCJCount": 0
		}
	],
	"dataSet": [{
			"addressData": {
				"city": "SOTS HOLE",
				"houseNumber": "99",
				"postcode": "IVT X34",
				"street": "Town Lane"
			},
			"electoralData": {
				"addressData": {
					"city": "SOTS HOLE",
					"houseNumber": "99",
					"postcode": "IVT X34",
					"street": "Town Lane"
				},
				"dateOfBirth": "1943-08-01T00:00:00"
			},
			"mortalityData": {
				"address": {},
				"dateOfDeath": {}
			},
			"referenceNumber": "XF9JKCF8RB",
			"verificationData": {
				"coaMatch": false,
				"dateOfBirthMatch": false,
				"deceasedMatch": false,
				"electoralRollDobMatch": true,
				"electoralRollMatch": false,
				"lendersOfActiveCAISAccountsCount": 0,
				"numberCCJ": 0,
				"telephoneDirectoryMatch": false,
				"telephoneNumberMatch": false
			}
		}
	]
}

<IDCheckUKAlphaResult>
  <CreditHeaderMatches>
    <IDCheckUKAlphaCreditHeaderMatch>
      <CAISAgeMatchCount />
      <CAISCloseMatchCount />
      <CAISExactMatchCount />
      <CAISValidMatchCount />
      <CAPSAgeMatchCount />
      <CAPSDobMatchCount />
      <CloseCAPSMatchCount />
      <CloseMatchActiveCCJCount />
      <CloseMatchLendersOfSettledCAISCount />
      <CloseMatchSatisfiedCCJCount />
      <ElectoralMatch />
      <ExactCAPSMatchCount />
      <ExactMatchActiveCCJCount />
      <ExactMatchLendersOfSettledCAISCount />
      <ExactMatchSatisfiedCCJCount />
      <ValidNameDobLendersOfSettledCAISCount />
    </IDCheckUKAlphaCreditHeaderMatch>
  </CreditHeaderMatches>
  <DataSet>
    <IDCheckUKAlphaData>
      <AddressData>
        <City>Bristol</City>
        <County />
        <District />
        <FlatNumber />
        <HouseName />
        <HouseNumber />
        <Postcode />
        <Street />
      </AddressData>
      <ElectoralData>
        <AddressData>
	  <City />
	  <County />
	  <District />
          <FlatNumber />
          <HouseName />
          <HouseNumber />
          <Postcode />
          <Street />
        </AddressData>
        <DateOfBirth />
	<Forename />
	<Gender />
	<SecondForename />
	<Suffix />
	<Surname />
	<Title />
      </ElectoralData>
      <MortalityData>
	<Address>
	  <City />
	  <County />
	  <District />
	  <FlatNumber />
	  <HouseName />
	  <HouseNumber />
	  <Postcode />
	  <Street />
        </Address>
	<DateOfDeath >
          <Day />
          <Month />
          <Year />
        </DateOfDeath>
	<Forename />
	<GenderFlag />
	<Initial />
	<Source />
	<Surname />
      </MortalityData>
      <ReferenceNumber />
      <VerificationData>
        <COAMatch />
        <DateOfBirthMatch />
        <DeceasedMatch />
        <ElectoralRollDobMatch />
        <ElectoralRollMatch />
        <LendersOfActiveCAISAccountsCount />
        <NumberCCJ />
        <TelephoneDirectoryMatch />
        <TelephoneNumberMatch />
      </VerificationData>
    </IDCheckUKAlphaData>
  </DataSet>
</IDCheckUKAlphaResult>

The following shows the basic schema for the <IDCheckUKAlphaResult> object that is returned in the <ServiceResult> Section of the <ProcessRequestResult> object.


Below is some more information about the some of the elements of the response that require explanation:

Credit Header Matches
Represents the credit header results of a record.

CAIS = Credit Account Information Sharing, pronounced (keys), is a unique database which holds information on over 490 million credit accounts.

CCJ = County Court Judgement.

CAPS = Credit Application Previous Search. This data is built on previous searches made as a result of credit applications.

Property Name Description
CAISCloseMatchCount The number of lenders of active CAIS accounts that are a close name match.
CAISExactMatchCount The number of lenders of active CAIS accounts that are an exact name match.
CAISValidMatchCount The number of lenders of active CAIS accounts that are a name and exact date of birth match.
CAPSDobMatchCount The number of CAPS name and exact date of birth matches.
ExactCAPSMatchCount The number of exact CAPS name matches.
CloseCAPSMatchCount The number of close CAPS name matches.
ExactMatchSatisfiedCCJCount The number of satisfied CCJ exact name matches.
CloseMatchSatisfiedCCJCount The number of satisfied CCJ close name matches.
ExactMatchActiveCCJCount The number of active CCJ exact name matches.
CloseMatchActiveCCJCount The number of active CCJ close name matches.
ExactMatchLendersOfSettledCAISCount The number of lenders of settled CAIS account exact name matches.
CloseMatchLendersOfSettledCAISCount The number of lenders of settled CAIS account close name matches.
ValidNameDobLendersOfSettledCAISCount The number of lenders of settled CAIS account valid name and date of birth matches.
CAPSAgeMatchCount The number of CAPS records that match the calculated age. If there are no records, this will be null.
CAISAgeMatchCount The number of CAIS records that match the calculated age. If there are no records, this will be null.
ElectoralMatch Indicated whether the matched electoral roll record validates against the calculated Age. If there are no records, this will be null.

Verification Data
Represents the verification information for the query.

Property Name Description
LendersOfActiveCAISAccountsCount The number of lenders of active CAIS accounts.
DateOfBirthMatch Represents whether or not a match was found on the date of birth. A null value represents no data.
ElectoralRollMatch Represents whether or not a match was found on the electoral roll.
ElectoralRollDobMatch Represents whether or not a date of birth match was found on the electoral roll. A null value represents no data.
TelephoneDirectoryMatch Represents whether or not an OSIS telephone directory match was found. A null value represents no data.
TelephoneNumberMatch Represents whether or not the telephone number matches the OSIS record for the surname and address. A null value represents no data.
COAMatch Represents whether or not a linked forward address exists.
NumberCCJ The number of CCJs.
DeceasedMatch Represents whether or not the match is deceased.

Sandbox

Query options for Sandbox

"options": {
	"sandbox": "true"
}

<QueryOptions>
  <KeyValueOfstringstring>
    <Key>Sandbox</Key>
    <Value>true</Value>
  </KeyValueOfstringstring>
</QueryOptions>

Sandbox Example Cases

        
          (Click on a sandbox case to see the service result data here)
Forename Surname Day Of Birth Month Of Birth Year Of Birth Flat House Name/Number Street Postcode Result
Aaron Cross 20 6 1973 254 Ocean View WT1 1TD None
Aaron John 3 8 1976 85 Ocean View WT1 1TD None
Abbie Forster 26 12 1962 241 Ocean View WT1 1TD None
Abbie Forster 26 12 1962 None
Adam Crawford 27 6 1980 374 Ocean View WT1 1TD None
Ahenobarbus Michal 31 12 1944 68 RH13 3HE Fail
Allen Kiril 8 1 1943 99 IVT X34 Pass
Amy Bowen 6 4 1983 310 Ocean View WT1 1TD None
Anquan Error 14 5 1978 10 Error Road ER3 3OR NotPerformed
Bethany Sharp 26 7 1949 259 Wellington Road South SK2 6NG Pass
Beverley Sharp 26 7 1949 259 SK2 6NG Pass
Billy Jones 31 12 1944 68 RH13 3HE Fail
Cameron Evans 24 12 1953 Flat B 5 Orchid Bank WT2 2DF Pass
Charlie Wilkinson 18 11 1968 26 LN4 7AT Pass
Connor Error 1 2 1947 8 Error Road ER3 3OR Pass
David Cameron 9 10 1966 5 BS8 1HN Inconclusive
David Error 7 3 1931 3 Error Road ER3 3OR NotPerformed
David Robson 9 5 1992 42 HU12 9FL Pass
Dylan Gill 10 4 1952 7 AB54 5TR Inconclusive
Dylan Rhodes 23 9 1952 333 Ocean View WT1 1TD NoResults
Edward Pearson 9 4 1985 253 Ocean View WT1 1TD NoResults
Ellis Price 17 11 1960 198 Ocean View WT1 1TD None
Evan Duncan 5 10 1962 202 Ocean View WT1 1TD OneResult
Francesca Murray 2 9 1964 32 TF12 3DY Pass
Francesca Woodward 23 9 1976 127 Ocean View WT1 1TD MultipleResults
Frank Duggan 10 2 1973 Willow BS3 2FF Pass
Freddie Tomlinson 13 12 1942 267 Wellington Road South SK2 6NG Pass
Frederik Tomlinson 13 12 1942 267 SK2 6NG Pass
James Thorpe 10 6 1978 4 AB54 4PN Inconclusive
Jennifer Sykes 13 3 1938 57 S66 6LT Inconclusive
Jonny Miles 8 1 1943 2 99 IVT X34 Pass
Jordan Sinclair 18 4 1944 77 NP7 8PE Inconclusive
Louise Smith 11 3 1982 3 Oaklands BS1 1ST Pass
Mark Franks 24 7 1958 12 BS11 5ST Pass
Micah Stefanu 10 4 1952 7 AB54 5TR Inconclusive
Rosie Duncan 1 2 1967 40 AB41 7YW NotPerformed
Samantha Abbott 23 2 1966 137 Ocean View WT1 1TD NotApplicable
Theron Marcel 8 1 1943 99 IVT X34 Pass
Vincenc Claus 10 4 1952 7 AB54 5TR Inconclusive
Yngvi Berinhard 31 12 1944 68 RH13 3HE Fail
  • Note that David Robson will also PASS for SISPlus, SPFPlus and PEPDesk, while Charlie Wilkinson will FAIL for SISPlus, SPFPlus and PEPDesk.

W2 DATA EKYC UK 007


W2_Data_Ekyc_Uk_007 Service is an identity verification service that includes the full Electoral Roll along with credit bureau data. This service will leave a money laundering footprint on the bureau profile of the person you are requesting information about.

Query Data

The following Query Data properties pertain to this service. Please note that in the SOAP request the fields should be in alphabetical order.  

Property Name Type Length Optional/Mandatory
Forename String 15 Mandatory
MiddleNames String 15 Optional
Surname String 30 Mandatory
DayOfBirth Integer 2 Mandatory
MonthOfBirth Integer 2 Mandatory
YearOfBirth Integer 4 Mandatory
HouseNameNumber String 26 Optional *
HouseName String 26 Optional *
HouseNumber String 26 Optional *
Flat String 20 Optional *
Street String 40 Optional *
Region String 20 Optional *
County String 20 Optional *
Country String 20 Optional *
City String 20 Optional *
Postcode String 8 Optional *

After performing the search, the validation result (pass, fail, etc.) will be part of the <TransactionInformation> returned for the service call. 

Notes

  • Address information is optional if an AddressLookupRef is supplied in the query options. The AddressLookupRef is retrieved from the W2_DATA_ADDRESS_LOOK_UP_007 service as an addressId.
  • If an AddressLookupRef is not supplied then a minimum of HouseNameNumber and Postcode are required. Though it is advised to supply as much address information as possible as this is more likely to return a match if no prematched addressId is supplied.
  • By default we include a check for Mortality Data. Users can turn this option off by adding the IncludeHaloMortalityCheck query option and setting it to false *Please note this setting is case sensitive, so something like includehalomortalitycheck (all lowercase) won’t be picked up. *You can find information about the sandbox version of this service here.

Example Requests

Example 1 Request

{
    "Bundle": "{YOUR BUNDLE NAME HERE}",
    "Data": {
        "DayOfBirth": 22,
        "Forename": "Isabelle",
        "MonthOfBirth": 10,
        "Surname": "Davidson",
        "YearOfBirth": 1997        
    },
    "Options": {
        "AddressLookupRef": "12345"
    },
    "ClientReference": "{YOUR CLIENT REFERENCE HERE}"
}

 <serviceRequest>
   <BundleData>
     <BundleName>{YOUR BUNDLE NAME HERE}</BundleName>
   </BundleData>
   <QueryData>
     <DayOfBirth>{e.g. 01}</DayOfBirth>
     <Forename>{e.g. JOHN}</Forename>
     <MiddleNames>{e.g. JAMES} </MiddleNames>
     <MonthOfBirth>{e.g. 01}</MonthOfBirth>
     <Surname>e.g. SMITH</Surname>
     <YearOfBirth>{e.g. 1990}</YearOfBirth>
   </QueryData>
   <QueryOptions>
     <KeyValueOfstringstring>
       <Key>{AddressLookupRef}</Key>
       <Value>{e.g. 12345}</Value>
     </KeyValueOfstringstring>
   </QueryOptions>
   <ServiceAuthorisation>
     <APIKey>{YOUR API KEY HERE}</APIKey>
     <ClientReference>{YOUR CLIENT REFERENCE HERE}</ClientReference>
   </ServiceAuthorisation>
 </serviceRequest>

Example 2 Request

{
    "Bundle": "{YOUR BUNDLE NAME HERE}",
    "Data": {
    	"City": "Newport",
        "DayOfBirth": 22,
        "Forename": "Isabelle",
        "MonthOfBirth": 10,
        "Postcode": "WT1 1TD",
        "Surname": "Davidson",
        "YearOfBirth": 1997,
        "HouseNameNumber": "40",
        "MiddleNames":"Hope",
        "Street":"Awesome Street"
    },
    "ClientReference": "{YOUR CLIENT REFERENCE HERE}"
}

    <serviceRequest>
        <BundleData>
            <BundleName>{YOUR BUNDLE NAME HERE}</BundleName>
        </BundleData>
        <QueryData>
            <City>{e.g. Cardiff }</City>
            <DayOfBirth>{e.g. 01}</DayOfBirth>
            <Forename>{e.g. JOHN}</Forename>
            <HouseNameNumber>{e.g. 1 or "Regus House"}</HouseNameNumber>
            <MiddleNames>{e.g. JAMES} </MiddleNames>
            <MonthOfBirth>{e.g. 01}</MonthOfBirth>
            <Postcode>{e.g. CF10 4RU }</Postcode>
            <Street>{e.g. Falcon Dr}</Street>
            <Surname>{e.g. SMITH}</Surname>
            <YearOfBirth>{e.g. 1990}</YearOfBirth>
        </QueryData>
        <ServiceAuthorisation>
            <APIKey>{YOUR API KEY HERE}</APIKey>
            <ClientReference>{YOUR CLIENT REFERENCE HERE}</ClientReference>
        </ServiceAuthorisation>
    </serviceRequest>

Example 3 Request

{
    "Bundle": "{YOUR BUNDLE NAME HERE}",
    "Data": {
        "DayOfBirth": 22,
        "Forename": "Isabelle",
        "MonthOfBirth": 10,
        "Surname": "Davidson",
        "YearOfBirth": 1997        
    },
    "Options": {
        "AddressLookupRef": "12345",
        "IncludeHaloMortalityCheck":"true"
    },
    "ClientReference": "{YOUR CLIENT REFERENCE HERE}"
}

    <serviceRequest>
        <BundleData>
            <BundleName>{YOUR BUNDLE NAME HERE}</BundleName>
        </BundleData>
        <QueryData>
            <DayOfBirth>{e.g. 01}</DayOfBirth>
            <Forename>{e.g. JOHN}</Forename>
            <MiddleNames>{e.g. JAMES} </MiddleNames>
            <MonthOfBirth>{e.g. 01}</MonthOfBirth>
            <Surname>{e.g. SMITH}</Surname>
            <YearOfBirth>{e.g. 1990}</YearOfBirth>
        </QueryData>
        <QueryOptions>
            <KeyValueOfstringstring>
                <Key>{AddressLookupRef}</Key>
                <Value>{e.g. 12345}</Value>
            </KeyValueOfstringstring>
            <KeyValueOfstringstring>
                <Key>{IncludeHaloMortalityCheck}</Key>
                <Value>{false}</Value>
            </KeyValueOfstringstring>
        </QueryOptions>
        <ServiceAuthorisation>
            <APIKey>{YOUR API KEY HERE}</APIKey>
            <ClientReference>{YOUR CLIENT REFERENCE HERE}</ClientReference>
        </ServiceAuthorisation>
    </serviceRequest>

Example Responses

The responses below are just a few examples of possible responses there are other possible responses which may vary based on your particular bundle configuration but the examples below cover the main examples. 

General Response

{
    "clientReference": "{YOUR CLIENT REFERENCE}",
    "results": {
        "w2DataEkycUk007Result": {
            "identityCheckResult": {
                "matchInformation": {
                    "independentDataSources": true | false | null ,
                    "nameAndAddressMatch": true | false,
                    "nameAndDateOfBirthMatch": true | false
                },
                "matchResult": "NotChecked | TwoPlusTwo | TwoPlusOne | OnePlusOne | NoMatch"
            }
        }
    },
    "transaction": {
        "interpretResult": "Pass | Fail | Inconclusive | NotApplicable | NotPerformed",
        "serviceCallReference": "{Call reference will be a new GUID here}",
        "serviceTransactions": [
            {
                "haltTriggered": true | false,
                "service": "W2DataEkycUk007",
                "serviceInterpretResult": "Pass | Fail | Inconclusive",
                "serviceTransactionResult": "Success",
                "serviceTransactionResultMessage": " Any information pertinent to this call",
                "validationResult": "Pass | Fail | Inconclusive | NoValidationPerformed | NotApplicable"
            }
        ]
    }
}

    <ProcessRequestResult>
        <ServiceResult>
            {other services excluded from this example}
            <W2DataEkycUk007Result>
                <IdentityCheckResult>
                    <MatchInformation>
                        <IndependantDataSources>{ true | false | null }</IndependantDataSources>
                        <NameAndAddressMatch>{ true | false }</NameAndAddressMatch>
                        <NameAndDateOfBirthMatch>{ true | false }</NameAndDateOfBirthMatch>
                    </MatchInformation>
                    <MatchResult>                      { NotChecked | TwoPlusTwo | TwoPlusOne | OnePlusOne | NoMatch }                    </MatchResult>
                </IdentityCheckResult>
            </W2DataEkycUk007Result>
        </ServiceResult>
        <TransactionInformation>
            <InterpretResult>                { Pass | Fail | Inconclusive | NotApplicable | NotPerformed }            </InterpretResult>
            <ServiceCallReference>{Call reference will be a new GUID here}</ServiceCallReference>
            <ServiceTransactions>
                <ServiceTransactionInformation>
                    <FailedOverTo>{ only used if failovers are configured }</FailedOverTo>
                    <HaltTriggered>{ true | false }</HaltTriggered>
                    <Service>W2DataEkycUk007</Service>
                    <ServiceInterpretResult>{ Pass | Fail | Inconclusive }</ServiceInterpretResult>
                    <ServiceTransactionResult>{ Success }</ServiceTransactionResult>
                    <ServiceTransactionResultMessage>                         { Any information pertinent to this call }                    </ServiceTransactionResultMessage>
                    <ServiceValidationDetails>                         { only filled in if there are problems with the validation}                    </ServiceValidationDetails>
                    <ValidationResult>                         { Pass | Fail | Inconclusive | NoValidationPerformed | NotApplicable }                    </ValidationResult>
                </ServiceTransactionInformation>
            </ServiceTransactions>
        </TransactionInformation>
    </ProcessRequestResult>

Successful Response

{
    "clientReference": "{YOUR CLIENT REFERENCE}",
    "results": {
        "w2DataEkycUk007Result": {
            "identityCheckResult": {
                "matchInformation": {
                    "independentDataSources": true,
                    "nameAndAddressMatch": true,
                    "nameAndDateOfBirthMatch": true
                },
                "matchResult": "TwoPlusTwo"
            }
        }
    },
    "transaction": {
        "interpretResult": "Pass",
        "serviceCallReference": "{Call reference will be a new GUID here}",
        "serviceTransactions": [
            {
                "haltTriggered": false,
                "service": "W2DataEkycUk007",
                "serviceInterpretResult": "Pass",
                "serviceTransactionResult": "Success",
                "validationResult": "Pass"
            }
        ]
    }
}

    <ProcessRequestResult>
        <ServiceResult>
            <W2DataEkycUk007Result>
                <IdentityCheckResult>
                    <MatchInformation>
                        <IndependantDataSources>true</IndependantDataSources>
                        <NameAndAddressMatch>true</NameAndAddressMatch>
                        <NameAndDateOfBirthMatch>true</NameAndDateOfBirthMatch>
                    </MatchInformation>
                    <MatchResult>TwoPlusTwo</MatchResult>
                </IdentityCheckResult>
            </W2DataEkycUk007Result>
        </ServiceResult>
        <TransactionInformation>
            <InterpretResult>Pass</InterpretResult>
            <ServiceCallReference>{e.g. 558003c3-3154-4e55-9c9e-e2dfb897b098}</ServiceCallReference>
            <ServiceTransactions>
                <ServiceTransactionInformation>
                    <FailedOverTo />
                    <HaltTriggered>false</HaltTriggered>
                    <Service>W2DataEkycUk007</Service>
                    <ServiceInterpretResult>Pass</ServiceInterpretResult>
                    <ServiceTransactionResult>Success</ServiceTransactionResult>
                    <ServiceTransactionResultMessage />
                    <ServiceValidationDetails />
                    <ValidationResult>Pass</ValidationResult>
                </ServiceTransactionInformation>
            </ServiceTransactions>
        </TransactionInformation>
    </ProcessRequestResult>

Inconclusive Response

{
    "clientReference": "{YOUR CLIENT REFERENCE}",
    "results": {
        "w2DataEkycUk007Result": {
            "identityCheckResult": {
                "matchInformation": {
                    "independentDataSources": false,
                    "nameAndAddressMatch": true,
                    "nameAndDateOfBirthMatch": true
                },
                "matchResult": "TwoPlusTwo"
            }
        }
    },
    "transaction": {
        "interpretResult": "Inconclusive",
        "serviceCallReference": "{Call reference will be a new GUID here}",
        "serviceTransactions": [
            {
                "haltTriggered": false,
                "service": "W2DataEkycUk007",
                "serviceInterpretResult": "Inconclusive",
                "serviceTransactionResult": "Success",
                "validationResult": "Pass"
            }
        ]
    }
}

    <ProcessRequestResult>
        <ServiceResult>
            <W2DataEkycUk007Result>
                <IdentityCheckResult>
                    <MatchInformation>
                        <IndependantDataSources>false</IndependantDataSources>
                        <NameAndAddressMatch>true</NameAndAddressMatch>
                        <NameAndDateOfBirthMatch>true</NameAndDateOfBirthMatch>
                    </MatchInformation>
                    <MatchResult>TwoPlusOne</MatchResult>
                </IdentityCheckResult>
            </W2DataEkycUk007Result>
        </ServiceResult>
        <TransactionInformation>
            <InterpretResult>Inconclusive</InterpretResult>
            <ServiceCallReference>{e.g. 558003c3-3154-4e55-9c9e-e2dfb897b098}</ServiceCallReference>
            <ServiceTransactions>
                <ServiceTransactionInformation>
                    <FailedOverTo />
                    <HaltTriggered>false</HaltTriggered>
                    <Service>W2DataEkycUk007</Service>
                    <ServiceInterpretResult>Inconclusive</ServiceInterpretResult>
                    <ServiceTransactionResult>Success</ServiceTransactionResult>
                    <ServiceTransactionResultMessage />
                    <ServiceValidationDetails />
                    <ValidationResult>Pass</ValidationResult>
                </ServiceTransactionInformation>
            </ServiceTransactions>
        </TransactionInformation>
    </ProcessRequestResult>

Example Failing Response

{
    "clientReference": "{YOUR CLIENT REFERENCE}",
    "results": {
        "w2DataEkycUk007Result": {
            "identityCheckResult": {
                "matchInformation": {
                    "nameAndAddressMatch": false,
                    "nameAndDateOfBirthMatch": false
                },
                "matchResult": "NoMatch"
            }
        }
    },
    "transaction": {
        "interpretResult": "Fail",
        "serviceCallReference": "{Call reference will be a new GUID here}",
        "serviceTransactions": [
            {
                "haltTriggered": false,
                "service": "W2DataEkycUk007",
                "serviceInterpretResult": "Fail",
                "serviceTransactionResult": "Success",
                "validationResult": "Pass"
            }
        ]
    }
}

    <ProcessRequestResult>
        <ServiceResult>
            <W2DataEkycUk007Result>
                <IdentityCheckResult>
                    <MatchInformation>
                        <IndependantDataSources />
                        <NameAndAddressMatch>false</NameAndAddressMatch>
                        <NameAndDateOfBirthMatch>false</NameAndDateOfBirthMatch>
                    </MatchInformation>
                    <MatchResult>NoMatch</MatchResult>
                </IdentityCheckResult>
            </W2DataEkycUk007Result>
        </ServiceResult>
        <TransactionInformation>
            <InterpretResult>Fail</InterpretResult>
            <ServiceCallReference>{e.g. 558003c3-3154-4e55-9c9e-e2dfb897b098}</ServiceCallReference>
            <ServiceTransactions>
                <ServiceTransactionInformation>
                    <FailedOverTo />
                    <HaltTriggered>false</HaltTriggered>
                    <Service>W2DataEkycUk007</Service>
                    <ServiceInterpretResult>Fail</ServiceInterpretResult>
                    <ServiceTransactionResult>Success</ServiceTransactionResult>
                    <ServiceTransactionResultMessage />
                    <ServiceValidationDetails />
                    <ValidationResult>Pass</ValidationResult>
                </ServiceTransactionInformation>
            </ServiceTransactions>
        </TransactionInformation>
    </ProcessRequestResult>

Additional Information Response

"w2DataEkycUk007Result": {
	"fullResponse": {
		"mortalityData": [],
		"mortalityDataCheckType": "NotChecked | FullMatch | PartialMatch | NoMatch | MultipleMatch",
		"uniqueAddressMatchFound": true | false,
		"verificationData": {
			"electoralRollNameAndAddressMatch": true | false,
			"electoralRollNameAndDateOfBirthMatch": "NotChecked | FullMatch | PartialMatch | NoMatch | MultipleMatch",
			"lendersContributingToTheCreditFileCount": 0 - 99,
			"matchDateOfBirthUsingCreditRecords": "NotChecked | FullMatch | PartialMatch | NoMatch | MultipleMatch",
			"numberCcj": 0 - 99
		}
	},
	"identityCheckResult": {
		"matchInformation": {
			"independentDataSources": true | false | null,
			"nameAndAddressMatch": true | false,
			"nameAndDateOfBirthMatch": true | false
		},
		"matchResult": "NotChecked | TwoPlusTwo | TwoPlusOne | OnePlusOne | NoMatch"
	}
}

    <W2DataEkycUk007Result>
        <FullResponse>
            <MortalityData/>
            <MortalityDataCheckType>
                { NotChecked | FullMatch | PartialMatch | NoMatch | MultipleMatch }
            </MortalityDataCheckType>
            <UniqueAddressMatchFound>                { true | false }           </UniqueAddressMatchFound>
            <VerificationData>
                <ElectoralRollNameAndAddressMatch>                    { true | false }                </ElectoralRollNameAndAddressMatch>
                <ElectoralRollNameAndDateOfBirthMatch>
                    { NotChecked | FullMatch | PartialMatch | NoMatch | MultipleMatch }
                </ElectoralRollNameAndDateOfBirthMatch>
                <LendersContributingToTheCreditFileCount>                    { 0 - 99 }                </LendersContributingToTheCreditFileCount>
                <MatchDateOfBirthUsingCreditRecords>
                    { NotChecked | FullMatch | PartialMatch | NoMatch | MultipleMatch }
                </MatchDateOfBirthUsingCreditRecords>
                <NumberCcj>                    { 0 - 99 }                </NumberCcj>
            </VerificationData>
        </FullResponse>
        <IdentityCheckResult>
            <MatchInformation>
                <IndependantDataSources>{ true | false | null }</IndependantDataSources>
                <NameAndAddressMatch>{ true | false }</NameAndAddressMatch>
                <NameAndDateOfBirthMatch>{ true | false }</NameAndDateOfBirthMatch>
            </MatchInformation>
            <MatchResult>
                { NotChecked | TwoPlusTwo | TwoPlusOne | OnePlusOne | NoMatch }
            </MatchResult>
        </IdentityCheckResult>
    </W2DataEkycUk007Result>

Sandbox

 

Listed below are the details to set and the response you should expect to see (to see the details of the service response of each sandbox case, simply click on it in the table below).

Sandbox Example Cases

        
          (Click on a sandbox case to see the service result data here)
Forename Surname Day Of Birth Month Of Birth Year Of Birth Flat House Name/Number Street Postcode Result
Aaron Cross 20 6 1973 254 Ocean View WT1 1TD Inconclusive
Aaron John 3 8 1976 85 Ocean View WT1 1TD None
Abbie Forster 26 12 1962 241 Ocean View WT1 1TD None
Adam Davidson 12 5 1965 29 North Promenade FK14 2WX None
Ahenobarbus Michal 31 12 1944 68 RH13 3HE NotPerformed
Alice Jenkins 13 10 1983 First Floor Flat 9 Orchid Bank WT2 2DF Inconclusive
Allen Kiril 8 1 1943 99 IVT X34 None
Allison Leigh 17 4 1974 91 Brick Lane E1 6QL Pass
Angeline Error 12 3 1972 380 Ocean View NP1 1NP NotPerformed
Anquan Error 14 5 1978 10 Error Road ER3 3OR NotPerformed
Bethany Sharp 26 7 1949 259 Wellington Road South SK2 6NG None
Bradley Oliver 15 11 1973 209 Ocean View WT1 1TD Pass
Cameron Evans 24 12 1953 Flat B 5 Orchid Bank WT2 2DF Fail
Cerys Clayton 21 4 1983 Second Floor Flat 9 Orchid Bank WT2 2DF Inconclusive
Chloe Hardy 12 1 1979 1A 1 Orchid Bank WT2 2DF Pass
Connor Error 1 2 1947 8 Error Road ER3 3OR NotPerformed
David Cameron 9 10 1966 5 BS8 1HN None
David Error 7 3 1931 3 Error Road ER3 3OR Pass
Edward Pearson 9 4 1985 253 Ocean View WT1 1TD None
Evan Duncan 5 10 1962 202 Ocean View WT1 1TD None
Faisul Miah 4 12 1977 91 Brick Lane E1 6QL Pass
Francesca Murray 2 9 1964 32 TF12 3DY Fail
Francesca Woodward 23 9 1976 127 Ocean View WT1 1TD None
Isabelle Error 15 2 1973 168 Ocean View NP1 1NP NotPerformed
Jane Error 27 7 1986 168 Ocean View NP1 1NP NotPerformed
Jennifer Sykes 13 3 1938 57 S66 6LT Inconclusive
Jonny Miles 8 1 1943 2 99 IVT X34 NotPerformed
Kelvin Thursby 25 4 1985 91 Brick Lane E1 6QL Pass
Lily Error 9 3 1995 381 Ocean View NP1 1NP NotPerformed
Luana Melania 11 12 1924 8 AB54 5TR Inconclusive
Madison Reynolds 1 1 1900 85 NR24 9JB Pass
Megan Crawford 5 4 1957 1B 1 Orchid Bank WT2 2DF Pass
Moray Abdiou 11 12 1924 26 LN4 7AT Pass
Nicole Williamson 12 2 1976 379 WT1 1TD None
Rob James 12 10 1983 91 Brick Lane E1 6QL Pass
Rosie Duncan 1 2 1967 40 AB41 7YW None
Samantha Abbott 23 2 1966 137 Ocean View WT1 1TD None
Scott James 17 8 1976 91 Brick Lane E1 6QL Pass
Shannon Macdonald 21 1 1962 Flat B 7 Orchid Bank WT2 2DF Pass

ID Check UK Delta


IDCheckUKDelta is an identity verification service that includes the full Electoral Roll and other supporting information, it does not include credit bureau data. This service will however leave a money laundering footprint on the profile of the person you are requesting information about. Properties Request Response Sandbox

Properties
IDCheckUKDelta is divided into multiple sub-services that make up the ID check. Each subservice will be used in the ID check provided of all of the relevant fields for that service are supplied. Below is a list of all of the fields to use with each service.

Address

Required Fields Optional Fields Notes
Forename
Surname
HouseNameNumber or HouseName or HouseNumber
Postcode		 MiddleNames
Flat
Gender
DayOfBirth
MonthOfBirth
YearOfBirth
Street
City
County		 All components of the date of birth must be provided if used.

Mortality

Required Fields Optional Fields Notes
Forename
Surname
DayOfBirth
MonthOfBirth
YearOfBirth
HouseNameOrNumber or HouseName or HouseNumber
Postcode		 MiddleNames
Flat
Gender
Street
City
County		  

Date of Birth

Required Fields Optional Fields Notes
Forename
Surname
DayOfBirth
MonthOfBirth
YearOfBirth
HouseNameNumber or HouseName or HouseNumber
Postcode		 MiddleNames
Flat
Gender
Street
City
County		  

Telephone

Required Fields Optional Fields Notes
PhoneNumber    

Passport

Required Fields Optional Fields Notes
DayOfBirth
MonthOfBirth
YearOfBirth
Gender
PassportNumber		    

Driving License

Required Fields Optional Fields Notes
Forename
MiddleNames
Surname
DayOfBirth
MonthOfBirth
YearOfBirth
Gender
DrivingLicenceNumber		    

Smartlink

Required Fields Optional Fields Notes
Forename
Surname
Gender
DayOfBirth
MonthOfBirth
YearOfBirth
HouseNameNumber or HouseName or HouseNumber
Postcode		 MiddleNames
Flat
Street
City
County		  

Insolvency

Required Fields Optional Fields Notes
Forename
Surname
Gender
DayOfBirth
MonthOfBirth
YearOfBirth		    

Electoral Roll

Required Fields Optional Fields Notes
Forename
Surname
DayOfBirth
MonthOfBirth
YearOfBirth
HouseNameOrNumber or HouseName or HouseNumber
Postcode		 MiddleNames
Gender
Flat
Street
City
County		  

CCJ

Required Fields Optional Fields Notes
Forename
Surname
DayOfBirth*
MonthOfBirth*
YearOfBirth*
HouseNameOrNumber or HouseName or HouseNumber*
Postcode*		 MiddleNames
Gender
Flat
Street
City
County		 You should provide at least one of the following: Date of birth (all fields)
or HouseNameOrNumber and Postcode together.

ID Card

Required Fields Optional Fields Notes
DayOfBirth
MonthOfBirth
YearOfBirth
Gender
IdCardNumber		    

Company Director

Required Fields Optional Fields Notes
Forename
Surname
HouseNameOrNumber or HouseName or HouseNumber
Postcode		 DayOfBirth
MonthOfBirth
YearOfBirth
Flat
Street
City
County		 All components of the date of birth must be provided if used.

After performing the search, the validation result (pass, fail, etc.) will be part of the TransactionInformation returned for the service call.

Request

Example Request - IDCheckUKDelta

"Data": {
	"County": "Bristol",
	"DayOfBirth": 1,
	"Forename": "Harry",
	"Gender": "M",
	"HouseNameNumber": "200",
	"MiddleNames": "James",
	"MonthOfBirth": 1,
	"Postcode": "BS7 8EU",
	"Street": "Privet Drive",
	"Surname": "Potter",
	"YearOfBirth": 1985
}

 <QueryData>
   <County>Bristol</County>
   <DayOfBirth>01</DayOfBirth>
   <Forename>Harry</Forename>
   <Gender>M</Gender>
   <HouseNameNumber>200</HouseNameNumber>
   <MiddleNames>James</MiddleNames>
   <MonthOfBirth>01</MonthOfBirth>
   <Postcode>BS7 8EU</Postcode>
   <Street>Privet Drive</Street>
   <Surname>Potter</Surname>
   <YearOfBirth>1985</YearOfBirth>
 </QueryData>

 

Response

Example Response - IDCheckUKDelta

        "idCheckUKDeltaResult": {
            "ccjResultTypeEnum": "NotFound",
            "dateOfBirthResultTypeEnum": "Match",
            "drivingLicenceResultTypeEnum": "Match",
            "electoralRollResultTypeEnum": "Match",
            "idCardResultTypeEnum": "Match",
            "mobileResultTypeEnum": "Match",
            "mortalityResultTypeEnum": "NotFound",
            "passportResultTypeEnum": "Match",
            "telephoneResultTypeEnum": "Match",
            "travelVisaResultTypeEnum": "Match"
        }

<IDCheckUKDeltaResult >
  <Address>
    <AddressValidated />
    <DateOfBirth />
    <DateOfBirthAppended />
    <Forename />
    <ForenameAppended />
    <GoneAway />
    <MatchType />
    <MiddleName />
    <MiddleNameAppended />
    <Mosaic />
    <Occupants>
      <IDCheckUKDeltaOccupant>
        <DateOfBirth />
        <Name />
	<Recency />
	<Residency />
	<ResidencyScore />
	<Source />
	<Telephone />
	<TelephoneName />
      </IDCheckUKDeltaOccupant>
      <IDCheckUKDeltaOccupant>
        <DateOfBirth />
	<Name />
	<Recency />
	<Residency />
	<ResidencyScore />
	<Source />
	<Telephone />
	<TelephoneName />
      </IDCheckUKDeltaOccupant>
      <IDCheckUKDeltaOccupant>
        <DateOfBirth />
	<Name />
	<Recency />
	<Residency />
	<ResidencyScore />
	<Source />
	<Telephone />
	<TelephoneName />
      </IDCheckUKDeltaOccupant>
      <IDCheckUKDeltaOccupant>
        <DateOfBirth />
	<Name />
	<Recency />
	<Residency />
	<ResidencyScore />
	<Source />
	<Telephone />
	<TelephoneName />
      </IDCheckUKDeltaOccupant>
    </Occupants>
    <Properties>
      <IDCheckUKDeltaProperty>
	<Date />
	<Price />
	<Tenure />
	<Type />
      </IDCheckUKDeltaProperty>
    </Properties>
    <Recency />
    <Source />
    <Surname />
    <Telephone />
    <TelephoneName />
  </Address>
  <CCJ />
  <CCJResultTypeEnum />
  <CompanyDirector />
  <DateOfBirth>
    <SourceCheck1 />
    <SourceCheck2 />
  </DateOfBirth>
  <DateOfBirthResultTypeEnum />
  <DrivingLicence />
  <DrivingLicenceResultTypeEnum />
  <ElectoralRoll>
    <IsNotFoundOnEditedElectoralRoll />
  </ElectoralRoll>
  <ElectoralRollResultTypeEnum />
  <IDCard />
  <IdCardResultTypeEnum />
  <Insolvency />
  <Mobile />
  <MobileResultTypeEnum />
  <Mortality />
  <MortalityResultTypeEnum />
  <Passport />
  <PassportResultTypeEnum />
  <Smartlink>
    <IDCheckUKDeltaSmartlink>
      <AddressLabel>
        <City/>
        <County/>
        <DPS/>
        <Flat />
        <HouseNameNumber />
        <Postcode />
        <Street/>
      </AddressLabel>
      <DateOfBirth />
      <Forename />
      <LinkSource />
      <Middle />
      <Recency />
      <Residency />
      <Surname />
      <Title />
    </IDCheckUKDeltaSmartlink>
    <IDCheckUKDeltaSmartlink>
      <AddressLabel>
        <City/>
        <County/>
        <DPS />
        <Flat />
        <HouseNameNumber />
        <Postcode />
        <Street />      </AddressLabel>
      <DateOfBirth />
      <Forename />
      <LinkSource />
      <Middle />
      <Recency />
      <Residency />
      <Surname />
      <Title />
    </IDCheckUKDeltaSmartlink>
  </Smartlink>
  <Summary>
    <Reference />
    <ResultText />
    <Scorecard />
    <Smartscore />
    <UniqueSearchId />
    <UniqueSearchIdKey />
  </Summary>
  <Telephone />
  <TelephoneResultTypeEnum />
  <TravelVisa />
  <TravelVisaResultTypeEnum />
</IDCheckUKDeltaResult>

Response Properties

The following tables give more information about the various elements of the response to this service.

Contains

Property Name Type Description
Summary IDCheckUKDeltaSummary Summary
Address IdCheckUkDeltaAddress Address service.
CCJ IDCheckUKDeltaCCJ Array of results from the CCJ service.
CompanyDirector IDCheckUKDeltaCompanyDirector Array of results from the Company Director service.
ElectoralRoll IDCheckUKDeltaElectoralRoll Electoral Roll service. Contains one element, **IsNotFoundOnEditedElectoralRoll, **which Returns true if subject was not found on edited Electoral Roll for at least one year but found on Full Electoral Roll
Mortality IDCheckUKDeltaMortality Array of results from the Mortality service.
DateOfBirth IDCheckUKDeltaDateOfBirth Date of birth service.
DrivingLicence IDCheckUKDeltaDrivingLicence Driving Licence service. Contains two boolean properties, ResultFlag, which returns true if the driving licence is valid, and MiddleNameWarning which returns true if the middle name does not appear to match that on the licence.
IDCard IDCheckUKDeltaIDCard ID Card service.
Insolvency IDCheckUKDeltaInsolvency Array of results from the Insolvency service.
Mobile IDCheckUKDeltaMobile Mobile service.
Passport IDCheckUKDeltaPassport Passport service.
Smartlink IDCheckUKDeltaSmartlink Array of results from the Smartlink service.
Telephone IDCheckUKDeltaTelephone Telephone service.
TravelVisa IDCheckUKDeltaTravelVisa Travel Visa service.
CCJResultTypeEnum IDCheckUKDeltaFoundTypeEnum CCJ service result type.
ElectoralRollResultTypeEnum IDCheckUKDeltaMatchTypeEnum ElectoralRoll service result type.
MortalityResultTypeEnum IDCheckUKDeltaFoundTypeEnum Mortality service result type
DateOfBirthResultTypeEnum IDCheckUKDeltaMatchTypeEnum Date of birth service result type
DrivingLicenceResultTypeEnum IDCheckUKDeltaMatchTypeEnum Driving Licence service result type
IdCardResultTypeEnum IDCheckUKDeltaMatchTypeEnum ID Card service result type
MobileResultTypeEnum IDCheckUKDeltaMatchTypeEnum Mobile service result type
PassportResultTypeEnum IDCheckUKDeltaMatchTypeEnum Passport service result type
TelephoneResultTypeEnum IDCheckUKDeltaMatchTypeEnum Telephone service result type
TravelVisaResultTypeEnum IDCheckUKDeltaMatchTypeEnum Travel Visa service result type

IdCheckUkDeltaSummary
In addition to response parameters for each service, there is also a set of response parameters which contain general summary details relating to the search carried out

Property Name Type Description
UniqueSearchId String A unique search ID, automatically generated by the system
UniqueSearchIdKey String A unique search ID Key, automatically generated by the system
Reference String Reference value provided by user
Scorecard String Score card
Smartscore Int32 The score the search achieved, based upon the scorecard
ResultText String Classification of the score e.g. Pass

IdCheckUkDeltaAddress

Property Name Type Description
Forename String Confirmation of the forename that has been matched to
MiddleName String Confirmation of the middle name that has been matched to
Surname String Confirmation of the surname that has been matched to
MatchType IDCheckUKDeltaAddressMatchTypeEnum Level of matching between the name provided and the name matched to
DateOfBirth DateTime Confirmation of the date of birth that has been matched to
ForenameAppended Boolean If a forename was not provided and it has been appended to this record, this object will be true
MiddleNameAppended Boolean If a middle name was not provided and it has been appended to this record, this object will be true
DateOfBirthAppended Boolean If a date of birth was not provided and it has been appended to this record, this object will be true
Telephone String Telephone number taken from the Telephone Directory
TelephoneName String Telephone directory matched name.
GoneAway IDCheckUKDeltaAddressGoneAwayEnum Shows if the subject has gone away
Mosaic String Mosaic
Source String Shows the sources used to confirm the identity of the subject. Sources are displayed as a set data type using a comma separated list.
Recency String Shows the last capture date for the data sources displayed in the Source field. The date reflects the capture date for the most recent source.
Occupants IDCheckUKDeltaOccupant Array of occupants
Properties IDCheckUKDeltaProperty Array of properties
AddressValidated Boolean Returns true if the address was validated against Tracesmart’s address database, otherwise returns false. This field can be used to update the score provided and effect the overall result of the ID verification as required.

IDCheckUKDeltaCCJ
The County Court Judgement Web Service

Property Name Type Description
Name String Name of the individual who is subject to the CCJ
DateOfBirth String Date of birth of the individual subject to the CCJ
Flat String Flat of the address at which the CCJ was registered
HouseNameNumber String House name/number of the address at which the CCJ was registered
Street String Street of the address street at which the CCJ was registered
City String City of the address at which the CCJ was registered
County String County of the address at which the CCJ was registered
Postcode String Postcode at which the CCJ was registered
JudgementDate String Date the CCJ was issued
JudgementType IDCheckUKDeltaCCJJudgementTypeEnum Judgement type of the CCJ issued
Amount String Amount of the CCJ debt
CaseNumber String Case number of the matched record
CourtName String Name of the court where the CCJ was registered
DateEnd DateTime? Date the CCJ will end

IDCheckUKDeltaCompanyDirector
Company director service 

Property Name Type Description
MatchType IDCheckUKDeltaCompanyDirectorMatchTypeEnum Identifies how this match was found
DateAppointed DateTime? The date the person was appointed
CompanyRegistrationNumber Int32 The company registration number
CompanyName String The name of the company
RegisteredOffice String The registered office address of the company
CompanyAppointments IDCheckUKDeltaCompanyAppointment Array of company appointments

IDCheckUKDeltaCompanyDirectorMatchTypeEnum
Identifies how this match was found., either ‘Name & DOB’, ‘Name & Address’ or ‘Name, DOB & Address’

Enumeration Name Value Description
NameAndDateOfBirth 0 Represents name and date of birth
NameAndAddress 1 Represents name and address
NameDateOfBirthAndAddress 2 Represents name, date of birth and address

IDCheckUKDeltaCompanyAppointment
Company Appointment

Property Name Type Description
Title String The title of the person appointed
Name String The name of the person appointed.
Address String The address of the person appointed.
DateOfBirth DateTime The date of birth of the person appointed.
Occupation String The occupation of the person appointed.
Nationality String The nationality of the person appointed.
AppointmentDate DateTime The date the appointment started.
AppointmentType String The type of appointment held.

IDCheckUKDeltaMortality
Mortality service

Property Name Type Description
Forename String Forename of the individual in the death record found
SecondName String Second name of the individual in the death record found
ThirdName String Third initial of the individual in the death record found
FourthName String Forth initial of the individual in the death record found
Surname String Surname of the individual in the death record found
District String District the death was registered in
DateOfBirth DateTime? Date of birth of the individual in the death record found
DateOfDeath DateTime? Date of death of the individual in the death record found
DateOfRegistration String Date of registration of the death MM/YYYY
VolumeNumber String Death registration volume number of the death record found
DistrictNumber String Death registration district number of the death record found
PageNumber String Death registration page number of the death record found
DeathRegistrationNumber String Death registration number of the death found
DeathRegistrationEntryNumber String Death registration entry number of the death found
PlaceOfBirth String Place of birth of the death found
MaidenName String Mother’s maiden name for the death found
GROReference String GRO reference number for the death found, used for deaths post 2007
Flat String Flat of address for death found
HouseNameNumber String House name/number for death found
Street String Street of address for death found
City String City of address for death found
County String County of address for death found
Postcode String Postcode for death found
MatchType String MatchType to show how the death record was matched. ‘NAME, ADDRESS AND DOB’ - the name, address and date of birth all matched against the subject details, ‘NAME AND ADDRESS’ - the name and address matched but date of birth was not provided or not contained within the death record. The system will not match to conflicting dates of birth, ‘NAME AND DOB’ - name and date of birth provided a match but the address was different or missing from either subject or matched record.

IDCheckUKDeltaDateOfBirth
Date of birth service

Property Name Type Description
SourceCheck1 Int32 Shows the number of times the date of birth has been confirmed by a Source Check 1 source. Displays 0 if the date of birth is incorrect or not confirmed.
SourceCheck2 Int32 Shows the number of times the date of birth has been confirmed by the Source Check 2 source. Displays 0 if the date of birth is incorrect or not confirmed.

IDCheckUKDeltaIDCard

Property Name Type Description
IsMRZValid Boolean Returns true if the machine readable zone (MRZ) is valid
IsDateOfBirthValid Boolean Returns true if the date of birth is valid
IsGenderValid Boolean Returns true if the gender is valid
IsExpiryValid Boolean Returns true if the ID Card has not expired

IDCheckUKDeltaInsolvency

Property Name Type Description
Type IDCheckUKDeltaInsolvencyTypeEnum Insolvency result type
Name String Name of the person who is subject to insolvency
CaseNumber String Court case number of the insolvency
AddressLabel IDCheckUKDeltaAddressLabel Address at which the insolvency was registered
DateOfBirth DateTime Date of birth of the individual subject to insolvency
Court String Name of the court at which the insolvency was registered
StartDate DateTime Date the insolvency started
Status String Current status of the case, text description
Occupation String The occupation of the subject at the time of the insolvency
Aliases String Other known aliases for the subject
Description String A text description of the case
ServiceOffice String A text description of the case
TelephoneNumber String Insolvency service office telephone number
CaseType String Additional definition of the type of case, displayed as a text description.
TradingNames String Details of trading names that relate to the subject
DebtTotal String The amount of debt the sequestration relates to
AssetTotal String Total assets the subject had at the time of the sequestration
PreviousAddressLabel IDCheckUKDeltaAddressLabel Previous address, if available and only relates to NI Bankruptcy
PresentationDate DateTime? Date of presentation of a petition, relates to NI Bankruptcy.

IDCheckUKDeltaInsolvencyTypeEnum

Enumeration Name Value Description
NorthernIrelandBankruptcy 0 Represents a Northern Ireland Bankruptcy
ScottishSequestrationBankruptcy 1 Represents a Scottish Sequestration (Bankruptcy)
EnglandAndWalesIVA 2 Represents a England & Wales IVA
EnglandAndWalesDRO 3 Represents England & Wales DRO
EnglandAndWalesBankruptcy 4 Represents England & Wales Bankruptcy

IDCheckUKDeltaAddressLabel

Property Name Type Description
Flat String Flat
HouseNameNumber String House name or number
Street String Street
City String City
County String County
Postcode String Postcode
DPS String Delivery Point Suffix (DPS)

IDCheckUKDeltaMobile

Property Name Type Description
Status String Live - switched on / Live - switched off / Invalid
Provider String Name of mobile operator or N/A if status is Invalid
CurrentLocation String Name of country where the phone is currently located or N/A if status is Invalid
PhoneVerify IDCheckUKDeltaMobilePhoneVerifyEnum The phone verify result

IDCheckUKDeltaMobilePhoneVerifyEnum

Enumeration Name Value Description
NotChecked 0 Not Checked
Verified 1 Verified
Failed 2 Failed

IDCheckUKDeltaSmartlink

Property Name Type Description
Title String Title of the subject in the matched record
Forename String Forename of the subject in the matched record
Middle String Middle name or middle initial of the subject in the matched record
Surname String Surname of the subject in the matched record
DateOfBirth String Date of birth of the subject in the matched record
AddressLabel IDCheckUKDeltaAddressLabel Address the matched record
Recency String Date of the matched record
Residency String Year matched record highlights the subject as having first resided at the linked address
LinkSource String Source of the Smartlink: F - forwarding address, P - previous address, D - name and date of birth link to an alternative address

IDCheckUKDeltaPassport

Property Name Type Description
IsMRZValid Boolean Returns true if the machine readable zone (MRZ) number is valid
IsDateOfBirthValid Boolean Returns true if the date of birth is valid
IsGenderValid Boolean Returns true if the gender is valid
IsExpiryValid Boolean Returns true if the passport has not expired.

IDCheckUKDeltaTelephone

Property Name Type Description
ResultFlag Boolean Returns true if data relating to the telephone number has been found
AreaName String The name of the area the telephone exchange is in
Locality String The name of the locality the telephone exchange is in
Postcode String The postcode outcode that the telephone exchange is in
Operator String The telephone operator/service provider for this telephone number
IsActive Boolean? Indicates whether the telephone number is active, inactive or the service was not able to determine whether the telephone number was Active or Inactive.
PhoneVerify IDCheckUKDeltaMobilePhoneVerifyEnum 0 = NotChecked, 1 = Verified, 2 = Failed

IDCheckUKDeltaTravelVisa

Property Name Type Description
IsMRZValid Boolean Returns true if the machine readable zone (MRZ) is valid
InDate Boolean Returns true if the travel visa has not expired
IsUKResidenceValid Boolean Returns true if the travel visa dictates that the subject can reside in the UK

IDCheckUKDeltaFoundTypeEnum

Enumeration Name Value Description
NotFound 0 Represents a not found result type
Found 1 Represents a found, result type
Error 2 Represents an error result type
Warning 3 Represents an warning result type

IDCheckUKDeltaMatchTypeEnum

Enumeration Name Value Description
Match 0 Represents match result type
NoMatch 1 Represents not match result type
Warning 2 Represents warning result type
Error 3 Represents an error result type
NotChecked 4 Represents not checked result type

Sandbox

The corresponding entry in ServiceTransactions will show the following properties:

HaltTriggered: False
ServiceTransactionResult: Success
ServiceInterpretResult: Pass
ServiceTransactionResultMessage: “This call was generated using sandbox mode”
ValidationResult: NotApplicable

 

ID Check Name Lookup


IDCheckNameLookupService is a name verification service. It checks that the name is not salacious, incomplete or randomly typed characters.

Properties

The following properties pertain to this service.

Property Name Type Length Optional/Mandatory Notes
NameQuery String   Optional  
Forename String   Optional Used when NameQuery is not specified
MiddleNames String   Optional Used when NameQuery is not specified
Surname String   Optional Used when NameQuery is not specified

Response

Example Response - ID Check Name Lookup

"idCheckNameLookupResult": {
"validationResultReason": "The name is not salacious"
}

<IDCheckNameLookupResult>
  <ValidationResultReason>    The name is not salacious  </ValidationResultReason>
</IDCheckNameLookupResult>

 

Sandbox

Query options for Sandbox

"options": {
	"sandbox": "true"
}

<QueryOptions>
  <KeyValueOfstringstring>
    <Key>Sandbox</Key>
    <Value>true</Value>
  </KeyValueOfstringstring>
</QueryOptions>

Sandbox Examples

Example Response for “John Smith”

"idCheckNameLookupResult": {
"validationResultReason": "The name is not salacious"
}

<IDCheckNameLookupResult>
  <ValidationResultReason>    The name is not salacious  </ValidationResultReason>
</IDCheckNameLookupResult>

The corresponding ServiceTransactions will show the following properties:

HaltTriggered False
ServiceTransactionResult - Success
ServiceInterpretResult - Pass
ServiceTransactionResultMessage “This call was generated using sandbox mode”
ValidationResult - NotApplicable

Example Response for “Mickey Mouse”

"idCheckNameLookupResult": {
"validationResultReason": "The name is flagged against our blacklist of known salacious words"
}

<IDCheckNameLookupResult>
  <ValidationResultReason>    The name is flagged against our blacklist of known salacious words  </ValidationResultReason>
</IDCheckNameLookupResult>

The corresponding ServiceTransactions will show the following properties:

HaltTriggered False
ServiceTransactionResult - Success
ServiceInterpretResult - Inconclusive
ServiceTransactionResultMessage “This call was generated using sandbox mode”
ValidationResult - NotApplicable

Example Response for “aabbccddee”

"idCheckNameLookupResult": {
	"validationResultReason": "The name appears to have been entered by hitting random keys"
}

<IDCheckNameLookupResult>
  <ValidationResultReason>    The name appears to have been entered by hitting random keys  </ValidationResultReason>
</IDCheckNameLookupResult>

The corresponding ServiceTransactions will show the following properties:

HaltTriggered False
ServiceTransactionResult - Success
ServiceInterpretResult - Inconclusive
ServiceTransactionResultMessage “This call was generated using sandbox mode”
ValidationResult - NotApplicable

The corresponding IDCheckNameLookupResult will show the following properties:

HaltTriggered False
ServiceTransactionResult - Success
ServiceInterpretResult - Pass
ServiceTransactionResultMessage “This call was generated using sandbox mode”
ValidationResult - NotApplicable

Director Check UK


Director Check UK (DirectorUKCheck) service lets you search by name the UK database of directors (Companies House). If there are multiple matches, it provides a list of them, up to a limit of 100.

Properties

The following Query Data properties pertain to this service.

Property Name Type Optional/Mandatory Notes
NameQuery String Mandatory The name of the person you are searching for.

Request

Example Request

<QueryData >
  <NameQuery>John Smith</NameQuery>
</QueryData>

"Data": {
	"NameQuery": "Jessica Black"
}

Response

Example Response

"directorUKCheckResult": {
	"directorUKCheckErrors": {
		"errorDetails": []
	},
	"directorUKCheckResults": {
		"result": [{
				"address1": "221B Baker Street",
				"address2": "",
				"birthDate": "01/01/1970",
				"country": "United Kingdrom",
				"county": "",
				"directorNumber": "1234565789",
				"name": "Jessica Black",
				"postcode": "W1S 1AA",
				"town": "London"
			}
		]
	}
}

<DirectorUKCheckResult>  <DirectorUKCheckErrors>
    <ErrorDetails/>
  </DirectorUKCheckErrors>
  <DirectorUKCheckResults>
    <!-- One or more of these -->
    <Result>
      <Address1>221B Baker Street</Address1>
      <Address2/>
      <BirthDate>01/01/1970</BirthDate>
      <Country>United Kingdom</Country>
      <County/>
      <DirectorNumber>1234565789</DirectorNumber>
      <Name>John Smith</Name>
      <Postcode>W1S 1AA</Postcode>
      <Town>London</Town>
    </Result>
  </DirectorUKCheckResults>
</DirectorUKCheckResult>

Sandbox

Query options for Sandbox

"options": {
	"sandbox": "true"
}

<QueryOptions>
  <KeyValueOfstringstring>
    <Key>Sandbox</Key>
    <Value>true</Value>
  </KeyValueOfstringstring>
</QueryOptions>

Sandbox Examples

Sample Response for “Jessica Black”

"directorUKCheckResult": {
	"directorUKCheckErrors": {
		"errorDetails": []
	},
	"directorUKCheckResults": {
		"result": [{
				"address1": "221B Baker Street",
				"address2": "",
				"birthDate": "01/01/1970",
				"country": "United Kingdrom",
				"county": "",
				"directorNumber": "1234565789",
				"name": "Jessica Black",
				"postcode": "W1S 1AA",
				"town": "London"
			}, {
				"address1": "221B Flour Street",
				"address2": "",
				"birthDate": "01/01/1960",
				"country": "United Kingdrom",
				"county": "",
				"directorNumber": "1234565789",
				"name": "Jessica Black",
				"postcode": "W1S 1BB",
				"town": "London"
			}
		]
	}
}

<DirectorUKCheckResult>
  <DirectorUKCheckErrors>
    <ErrorDetails/>
  </DirectorUKCheckErrors>  <DirectorUKCheckResults> 
    <Result>
      <Result>
        <Address1>221B Baker Street</Address1>
        <Address2/>
        <BirthDate>01/01/1970</BirthDate>
        <Country>United Kingdrom</Country>
        <County/>
        <DirectorNumber>1234565789</DirectorNumber>
        <Name>Jessica Black</Name>
        <Postcode>W1S 1AA</Postcode>
        <Town>London</Town>
      </Result>
      <Result>
        <Address1>221B Flour Street</Address1>
        <Address2/>
        <BirthDate>01/01/1960</BirthDate>
        <Country>United Kingdom</Country>
        <County/>
        <DirectorNumber>1234565789</DirectorNumber>
        <Name>Jessica Black</Name>
        <Postcode>W1S 1BB</Postcode>
        <Town>London</Town>
      </Result>
    </Result>
  </DirectorUKCheckResults>
</DirectorUKCheckResult>

The corresponding ServiceTransactions will show the following properties:

HaltTriggered False
ServiceTransactionResult - Success
ServiceInterpretResult - MultipleResults
ServiceTransactionResultMessage “This call was generated using sandbox mode”
ValidationResult - NotApplicable

The corresponding ServiceTransactions will show the following properties:

HaltTriggered False
ServiceTransactionResult SuccessNoResult
ServiceInterpretResult NoResults
ServiceTransactionResultMessage “This call was generated using sandbox mode”
ValidationResult NotApplicable

W2 Data Ekyc UK 004


W2 Data Ekyc UK 004 is an identity verification service that includes the full Electoral Roll and Credit Bureau data. This service will leave a money laundering footprint on the bureau profile of the person you are requesting information about.

Query Data

The following QueryData properties pertain to this service. Please note in the actual SOAP request the fields should be in alphabetical order.

Property Name Type Length Optional/Mandatory Notes
Forename String 15 Mandatory  
MiddleNames String 15 Optional The contents of this field will be converted into initials, therefore the character limit can usually be ignored.
Surname String 30 Mandatory  
DayOfBirth Integer 2 Mandatory  
MonthOfBirth Integer 2 Mandatory  
YearOfBirth Integer 4 Mandatory  
HouseNameNumber String 26 Optional  Mandatory if using address fields and no HouseName or HouseNumber given
HouseName String 26 Optional  Mandatory if using address fields and no HouseNameNumber or HouseNumber given
HouseNumber String 26 Optional  Mandatory if using address fields and no HouseName or HouseNameNumber given
Flat String 16 Optional  
Street String 40 Optional If this value exceeds 40 characters, it will be automatically truncated down to 40 instead of being rejected.
County String 20 Optional  
City String 20 Optional If this value exceeds 20 characters, it will be automatically truncated down to 20 instead of being rejected.
Postcode String 8 Optional  
PhoneNumber String 16 Optional Please provide the phone number as one contiguous set of numbers with no other characters or spaces.

After performing the search, the validation result (pass, fail, etc.) will be part of the <TransactionInformation> returned for the service call. 

Notes

  • Address information is optional if an AddressLookupRef is supplied in the query options. The AddressLookupRef is retrieved from the W2 Data Address Lookup 024 service as an addressId.

  • If an AddressLookupRef is not supplied then a minimum of House Name/Number and Postcode are required. Though it is advised to supply as much address information as possible as this is more likely to return a match if no prematched addressId is supplied.

Request

Example Request to the W2 Data Ekyc UK 004 Service

<QueryData>
  <City>{ e.g. Bristol }</City>
  <DayOfBirth>{ e.g. 01}</DayOfBirth>
  <Forename>{ e.g. John }</Forename>
  <HouseNameNumber>{ e.g. 13 }</HouseNameNumber>
  <MonthOfBirth>{ e.g. 01 }</MonthOfBirth>               
  <Postcode>{ e.g. BS1 6LR }</Postcode>
  <Street>{ e.g. White Friars }</Street>
  <Surname>{ e.g. Smith }</Surname>
  <YearOfBirth>{ e.g. 1983 }</YearOfBirth></QueryData>

"Data": {
	"City": "Bristol",
	"DayOfBirth": 1,
	"Forename": "John",
	"HouseNameNumber": "284",
	"MonthOfBirth": 12,
	"Postcode": "WT1 1TD",
	"Street": "Ocean View",
	"Surname": "Randall",
	"YearOfBirth": 1960
}

Response

The following shows the basic schema for the <W2DataEkycUk004Result> object that is returned in the <ServiceResult> Section of the <ProcessRequestResult> object.

Example Response for the W2 Data Ekyc UK 004 Service

<W2DataEkycUk004Result>
    <DataSources>
        <!-- An array of MatchingSource elements --> 
        <MatchingSource>
            <AllowMultipleRecordsAsSeparateDataSources>
                { true | false }
            </AllowMultipleRecordsAsSeparateDataSources>
            <MatchingCriteria>
                { 
                    NotAssigned | NameAndAddress | NameAndDateOfBirth |
                    NameAndAddressAndDateOfBirth | MortalityHighConfidence | 
                    MortalityLowConfidence | SurnameAndPhoneNumberAtAddress
                }
            </MatchingCriteria>
            <NumberOfMatches>           
                { 0 - 99 }
            <NumberOfMatches>
            <Source>
               {
                    0 = NotAssigned 
                    1 = ElectoralRoll 
                    2 = CCJ
                    3 = CreditLendersA
                    4 = CreditLendersB
                    5 = BT_OSIS 
                    6 = MortalityData
                }            
            <Source>
        </MatchingSource>
    </DataSources>
    <InterpretResult>
        { 
            NotPerformed | Pass | Fail | Refer | NoInterpretPerformed 
        }
    </InterpretResult>
    <Message>
        { A message containing additional information about the call }
    </Message>
    <TransactionResult>
        {
            None | Success | SuccessNoResults | SuccessIncompleteResults |
            MultipleChoices | ClientErrorInformationFormatInvalid | ClientErrorInsufficientInformation |
            NotExecutedDueToPreviousHalt | ServerErrorGeneralError | ServiceFailureError
        }
    </TransactionResult>
</W2DataEkycUk004Result>

"w2DataEkycUk004Result": {
	"dataSources": {
		"AllowMultipleRecordsAsSeparateDataSources": false,
		"MatchingCriteria": "NameAndAddressAndDateOfBirth",
		"NumberOfMatches": 2,
		"Source": "CreditLendersB"
		}
	,
	"interpretResult": "Pass",
	"Message": "The call was successful",
	"transactionResult": "SuccessIncompleteResults"
}

Below is some more information about the some of the elements of the response that require explanation:
DataSources = A collection showing every source of data that was used to formulate the result. Each source is represented by a <MatchingSource> elment.
AllowMultipleRecordsAsSeparateDataSources = Indicates that two different record matches from the same data source may count as independent sources when formulating the 2 + 2 result. For example, two CCJ results may count as two sources, rather than one, as they would do under normal service circumstances.
MatchingCriteria = Precisely what data has been matched by the data source. E.g. NameAndAddressAndDateOfBirth
NumberOfMatches = The number of matches found by this data source
Source = The source of the data match. E.g. CCJ

SourceId Source Matched
1 Electoral Roll
2 County Court Judgements (CCJs)
3 Credit Lenders (CAIS)
4 N/A
5 BT_OSIS
6 Mortality Data

Transaction Result

HaltTriggered False
ServiceTransactionResult - Success
- SuccessIncompleteResults - Too many matches on the search criteria and the results have been truncated
- SuccessNoResults - No matches found
- ServerErrorGeneralError - An error occurred
- ServiceFailureError - Unable to contact third party service
- ClientErrorInsufficientInformation- Required field not supplied or insufficient/invalid information
- ClientErrorInformationFormatInvalid - Address fields cannot contain commas
ServiceInterpretResult - OneResult
- MultipleResults
- NoResults
- NotPerformed - An error occurred and the search was not performed
ServiceTransactionResultMessage Usually empty, can contain optional information such as too many matches etc.
ValidationResult - Pass
- NotPerformed - No search occurred to match against
- Fail- MissingMandatoryField or PatternNotMatched

Sandbox

Query options for Sandbox

"options": {
	"sandbox": "true"
}

<QueryOptions>
  <KeyValueOfstringstring>
    <Key>Sandbox</Key>
    <Value>true</Value>
  </KeyValueOfstringstring>
</QueryOptions>

To see the details of the service response of each sandbox case, simply click on it in the table below:  

Sandbox Example Cases

      
        (Click on a sandbox case to see the service result data here)
Forename Surname Day Of Birth Month Of Birth Year Of Birth Flat House Name/Number Street Postcode
Aaron Cross 20 6 1973 254 Ocean View WT1 1TD
Aaron John 3 8 1976 85 Ocean View WT1 1TD
Abbie Forster 26 12 1962 241 Ocean View WT1 1TD
Abigail Ford 22 10 1956 146 Ocean View WT1 1TD
Adam Crawford 27 6 1980 374 Ocean View WT1 1TD
Adam Sharpe 20 11 1996 250 Ocean View WT1 1TD
Ahenobarbus Michal 31 12 1944 68 RH13 3HE
Alexander Ball 21 5 1966 108 Ocean View WT1 1TD
Alexander Wallis 28 3 1953 142 Ocean View WT1 1TD
Alisha Owen 16 8 1979 113 Ocean View WT1 1TD
Allen Kiril 8 1 1943 99 IVT X34
Amber Ball 9 7 1957 147 Ocean View WT1 1TD
Amelia Brady 14 8 1978 121 Ocean View WT1 1TD
Amy Bowen 6 4 1983 310 Ocean View WT1 1TD
Amy Freeman 12 7 1982 134 Ocean View WT1 1TD
Andrew Lyons 25 12 1973 304 Ocean View WT1 1TD
Andrew Sanders 26 2 1968 116 Ocean View WT1 1TD
Ben Blake 5 7 1960 106 Ocean View WT1 1TD
Benjamin Davis 3 7 1962 321 Ocean View WT1 1TD
Bethany Bentley 10 9 1968 312 Ocean View WT1 1TD
Bethany Watts 30 4 1952 255 Ocean View WT1 1TD
Billy Jones 31 12 1944 68 RH13 3HE
Bradley Swift 14 7 1997 247 Ocean View WT1 1TD
Brandon Rose 13 4 1964 378 Ocean View WT1 1TD
Caitlin ODonnell 8 11 1961 268 Ocean View WT1 1TD
Caitlin Williams 1 1 1974 365 Ocean View WT1 1TD
Callum Saunders 13 10 1976 122 Ocean View WT1 1TD
Cerys Holden 24 9 1985 265 Ocean View WT1 1TD
Cerys Reeves 3 3 1978 270 Ocean View WT1 1TD
Charles Coleman 24 2 1964 306 Ocean View WT1 1TD
Charlie Byrne 30 1 1986 300 Ocean View WT1 1TD
Charlie Carroll 24 11 1957 112 Ocean View WT1 1TD
Charlie Clarke 14 2 1957 105 Ocean View WT1 1TD
Charlie Glover 3 12 1990 90 Ocean View WT1 1TD
Charlie Wilkinson 18 11 1968 26 LN4 7AT
Charlotte Cooper 18 4 1973 126 Ocean View WT1 1TD
Christopher Norman 2 5 1966 144 Ocean View WT1 1TD
Christopher Townsend 13 5 1972 83 Ocean View WT1 1TD
Courtney Webb 24 2 1952 148 Ocean View WT1 1TD
Daisy North 12 11 1979 86 Ocean View WT1 1TD
Danielle Evans 1 4 1963 295 Ocean View WT1 1TD
David Armstrong 25 2 1951 114 Ocean View WT1 1TD
David Cameron 9 10 1966 5 BS8 1HN
David Robson 9 5 1992 42 HU12 9FL
Dominic Andrews 2 2 1960 367 Ocean View WT1 1TD
Elise Bryant 19 5 1956 263 Ocean View WT1 1TD
Elizabeth Sheppard 23 10 1952 89 Ocean View WT1 1TD
Ella Fox 25 4 1974 303 Ocean View WT1 1TD
Ella Rowe 3 8 1955 107 Ocean View WT1 1TD
Ellie Horton 1 12 1953 279 Ocean View WT1 1TD
Elliot Gardiner 21 1 1977 259 Ocean View WT1 1TD
Elliot Simpson 21 4 1955 94 Ocean View WT1 1TD
Ellis Bryan 15 10 1967 290 Ocean View WT1 1TD
Emma Coles 10 8 1985 264 Ocean View WT1 1TD
Erin Godfrey 20 3 1964 160 Ocean View WT1 1TD
Eva Little 13 4 1985 150 Ocean View WT1 1TD
Evan Barnett 11 10 1968 153 Ocean View WT1 1TD
Evan Brown 13 4 1956 133 Ocean View WT1 1TD
Evan Butcher 24 8 1947 96 Ocean View WT1 1TD
Evie Boyle 7 4 1942 319 Ocean View WT1 1TD
Finlay Jones 25 10 1966 287 Ocean View WT1 1TD
Finlay Reynolds 20 5 1967 302 Ocean View WT1 1TD
Francesca Kemp 22 6 1968 317 Ocean View WT1 1TD
Francesca Woodward 23 9 1976 127 Ocean View WT1 1TD
Fred Error 3 4 1986 56 Ocean View NP1 1NP
Gabriel Stephens 21 11 1995 357 Ocean View WT1 1TD
Georgina Bird 1 1 1961 322 Ocean View WT1 1TD
Georgina Heath 15 12 1979 293 Ocean View WT1 1TD
Grace Anderson 9 3 1979 102 Ocean View WT1 1TD
Grace Bull 20 11 1978 82 Ocean View WT1 1TD
Gracie Gibbons 7 12 1988 364 Ocean View WT1 1TD
Gracie OSullivan 5 9 1950 111 Ocean View WT1 1TD
Gracie Williamson 28 2 1993 324 Ocean View WT1 1TD
Hannah Harvey 12 4 1983 162 Ocean View WT1 1TD
Hannah Hilton 6 4 1940 323 Ocean View WT1 1TD
Hannah Warner 8 12 1976 130 Ocean View WT1 1TD
Hayden Gray 22 2 1978 143 Ocean View WT1 1TD
Henry Brookes 25 3 1970 245 Ocean View WT1 1TD
Henry Gibson 18 1 1963 251 Ocean View WT1 1TD
Henry Hodgson 12 2 1963 132 Ocean View WT1 1TD
Holly Chapman 3 5 1990 375 Ocean View WT1 1TD
Holly Martin 1 10 1947 115 Ocean View WT1 1TD
Imogen Wilkins 19 4 1973 294 Ocean View WT1 1TD
Isaac Townsend 11 9 1971 138 Ocean View WT1 1TD
Isabella Wallis 22 5 1987 369 Ocean View WT1 1TD
Isabelle Error 15 2 1973 168 Ocean View NP1 1NP
Isabelle Error 15 2 1973 168 Ocean View NP1 1NP
Isabelle Taylor 5 7 1951 273 Ocean View WT1 1TD
Isabelle Vincent 19 9 1949 286 Ocean View WT1 1TD
Jake George 3 6 1977 260 Ocean View WT1 1TD
Jake Perkins 30 8 1978 285 Ocean View WT1 1TD
James Error 10 6 1978 4 Ocean View NP1 1NP
James Owen 23 2 1947 129 Ocean View WT1 1TD
James Smith 29 9 1977 314 Ocean View WT1 1TD
James Thorpe 10 6 1978 4 AB54 4PN
Jamie Error 15 8 1959 57 Ocean View NP1 1NP
Jamie Morton 19 8 1959 355 Ocean View WT1 1TD
Jane Error 27 7 1986 168 Ocean View NP1 1NP
Jasmine Lord 26 3 1949 103 Ocean View WT1 1TD
Jay Greenwood 14 6 1989 101 Ocean View WT1 1TD
Jennifer Error 3 11 1975 151 Ocean View NP1 1NP
Jessica Berry 29 1 1962 377 Ocean View WT1 1TD
Jodie Nolan 14 5 1967 152 Ocean View WT1 1TD
Jodie Woodward 29 6 1982 104 Ocean View WT1 1TD
Joe Sharpe 22 1 1965 87 Ocean View WT1 1TD
Joe Smith 10 5 1985 281 Ocean View WT1 1TD
Joe Waters 22 11 1991 362 Ocean View WT1 1TD
Joe West 21 11 1966 288 Ocean View WT1 1TD
John Bond 1 8 1948 123 Ocean View WT1 1TD
John Error 23 3 1956 45 Ocean View NP1 1NP
Jonathan Boyle 11 10 1983 120 Ocean View WT1 1TD
Jonathan Gibbons 28 3 1961 156 Ocean View WT1 1TD
Jonathan Newman 13 5 1985 93 Ocean View WT1 1TD
Jonny Miles 8 1 1943 2 99 IVT X34
Jordan McLean 14 10 1963 252 Ocean View WT1 1TD
Jordan Payne 28 12 1987 139 Ocean View WT1 1TD
Joshua Bryant 12 3 1977 274 Ocean View WT1 1TD
Katherine Cunningham 22 1 1987 155 Ocean View WT1 1TD
Katherine Stone 5 11 1972 157 Ocean View WT1 1TD
Katie Thornton 30 11 1977 315 Ocean View WT1 1TD
Keira Lamb 5 8 1948 109 Ocean View WT1 1TD
Kian Bartlett 30 7 1974 117 Ocean View WT1 1TD
Kian Morley 11 12 1972 372 Ocean View WT1 1TD
Kian Turnbull 13 6 1977 249 Ocean View WT1 1TD
Kiera Humphries 16 9 1985 297 Ocean View WT1 1TD
Kieran Collins 26 6 1970 258 Ocean View WT1 1TD
Laura Error 28 7 1965 33 Ocean View NP1 1NP
Laura Hewitt 5 10 1951 299 Ocean View WT1 1TD
Laura Sampson 11 3 1982 3 Oaklands BS1 1ST
Leman Russ 22 2 1942 49 BS4 1LT
Lewis Davey 5 10 1986 318 Ocean View WT1 1TD
Lewis Ingram 16 8 1976 140 Ocean View WT1 1TD
Liam Jackson 18 2 1985 277 Ocean View WT1 1TD
Libby Sharpe 23 2 1982 272 Ocean View WT1 1TD
Lilly Watson 24 12 1961 366 Ocean View WT1 1TD
Logan Douglas 1 6 1992 359 Ocean View WT1 1TD
Logan Fraser 11 10 1951 292 Ocean View WT1 1TD
Logan Pearce 6 3 1983 311 Ocean View WT1 1TD
Lola Turner 24 8 1981 291 Ocean View WT1 1TD
Louie Morrison 27 9 1984 356 Ocean View WT1 1TD
Louie Walters 5 2 1947 308 Ocean View WT1 1TD
Louis Poole 17 12 1980 354 Ocean View WT1 1TD
Louise Error 28 2 1987 567 Ocean View NP1 1NP
Louise Lucas 4 3 1984 269 Ocean View WT1 1TD
Luca Dale 12 11 1950 301 Ocean View WT1 1TD
Lydia Howe 30 5 1967 267 Ocean View WT1 1TD
Maddison Cox 7 11 1993 373 Ocean View WT1 1TD
Maisie Davey 11 10 1964 125 Ocean View WT1 1TD
Maisie Duffy 9 10 1966 276 Ocean View WT1 1TD
Mark Error 14 9 1938 800 Ocean View NP1 1NP
Martin Error 3 9 1987 63 Ocean View NP1 1NP
Mary Error 1 12 1991 32 Ocean View NP1 1NP
Mason Wallis 6 3 1981 88 Ocean View WT1 1TD
Matilda Hewitt 20 5 1963 278 Ocean View WT1 1TD
Matthew Dukes 10 2 1973 Willow BS3 2FF
Max Carpenter 19 11 1953 158 Ocean View WT1 1TD
Maya Burrows 23 1 1953 48 Ocean View WT1 1TD
Maya Harper 25 7 1981 256 Ocean View WT1 1TD
Mia Evans 14 10 1964 320 Ocean View WT1 1TD
Mia Holt 17 7 1972 151 Ocean View WT1 1TD
Millie Richards 18 6 1952 99 Ocean View WT1 1TD
Mohammed Collier 6 9 1996 368 Ocean View WT1 1TD
Molly Abbott 11 1 1973 248 Ocean View WT1 1TD
Morgan Hutchinson 10 10 1988 97 Ocean View WT1 1TD
Morgan Weston 17 2 1965 246 Ocean View WT1 1TD
Naomi Law 23 3 1971 313 Ocean View WT1 1TD
Natasha Pritchard 16 5 1976 87 Ponteland Rd PA6 0TH
Nicholas Chapman 7 7 1973 124 Ocean View WT1 1TD
Nicole Miles 23 12 1969 360 Ocean View WT1 1TD
Nicole Williamson 12 2 1976 379 WT1 1TD
Oliver Pickering 16 3 1986 358 Ocean View WT1 1TD
Oliver Watts 18 8 1982 346 Ocean View WT1 1TD
Olivia Godfrey 14 3 1974 353 Ocean View WT1 1TD
Olivia Jones 12 4 1964 296 Ocean View WT1 1TD
Oscar Doyle 11 1 1979 363 Ocean View WT1 1TD
Owen Talbot 11 4 1984 84 Ocean View WT1 1TD
Patrick Fleming 24 10 1947 98 Ocean View WT1 1TD
Reece Savage 15 9 1972 266 Ocean View WT1 1TD
Rhys Chadwick 2 5 1969 376 Ocean View WT1 1TD
Rhys Page 11 9 1950 283 Ocean View WT1 1TD
Ruby Smith 30 10 1951 161 Ocean View WT1 1TD
Ryan Howarth 26 12 1967 261 Ocean View WT1 1TD
Sam Error 7 5 1967 102 Ocean View NP1 1NP
Sam Foster 19 7 1952 275 Ocean View WT1 1TD
Sam Leach 27 2 1957 159 Ocean View WT1 1TD
Samantha Abbott 23 2 1966 137 Ocean View WT1 1TD
Samantha Stokes 2 5 1990 141 Ocean View WT1 1TD
Scott Buckley 3 6 1986 257 Ocean View WT1 1TD
Sean Pope 30 4 1972 282 Ocean View WT1 1TD
Sean Wheeler 30 6 1969 119 Ocean View WT1 1TD
Sophie Benson 16 4 1975 149 Ocean View WT1 1TD
Taylor Benson 21 3 1975 309 Ocean View WT1 1TD
Taylor Coles 6 7 1963 128 Ocean View WT1 1TD
Taylor Giles 19 6 1984 164 Ocean View WT1 1TD
Taylor Giles 19 6 1984
Tegan Steele 17 10 1952 110 Ocean View WT1 1TD
Thomas Holden 30 5 1952 305 Ocean View WT1 1TD
Toby Hussain 29 7 1958 371 Ocean View WT1 1TD
Toby Norton 1 11 1968 95 Ocean View WT1 1TD
Tom Dale 28 3 1957 131 Ocean View WT1 1TD
Tom Payne 8 5 1969 135 Ocean View WT1 1TD
Tom Smithersby 24 7 1958 12 BS11 5ST
William Byrne 14 2 1985 92 Ocean View WT1 1TD
Zak Carr 2 3 1985 243 Ocean View WT1 1TD
Zak Error 2 3 1985 243 Ocean View NP1 1NP
Zak Randall 24 12 1960 284 Ocean View WT1 1TD

W2 Data Ekyc UK 005


W2 Data Ekyc UK 005 is an identity verification service that includes the full Electoral Roll and Credit Bureau data. This service will leave a money laundering footprint on the bureau profile of the person you are requesting information about.

Query Data

The following QueryData properties pertain to this service. Please note in the actual SOAP request the fields should be in alphabetical order.

Property Name Type Length Optional/Mandatory Notes
Forename String 15 Mandatory  
MiddleNames String 15 Optional The contents of this field will be converted into initials, therefore the character limit can usually be ignored.
Surname String 30 Mandatory  
DayOfBirth Integer 2 Mandatory  
MonthOfBirth Integer 2 Mandatory  
YearOfBirth Integer 4 Mandatory  
HouseName String 26 [Optional Either house name or house number must be supplied
HouseNumber String 26 [Optional  Either house name or house number must be supplied
Flat String 16 [Optional  
Street String 40 [Optional  
County String 20 [Optional  
City String 20 [Optional  
Postcode String 8 Mandatory  
PhoneNumber String 16 Optional Please provide the phone number as one contiguous set of numbers with no other characters or spaces.

After performing the search, the validation result (pass, fail, etc.) will be part of the <TransactionInformation> returned for the service call.  Notes

  • Address information is optional if an AddressLookupRef is supplied in the query options. The AddressLookupRef is retrieved from the W2 Data Address Lookup 024 service as an addressId.

If an AddressLookupRef is not supplied then a minimum of House Name/Number and Postcode are required. Though it is advised to supply as much address information as possible as this is more likely to return a match if no prematched addressId is supplied. 

Request

Example Request - W2 Data Ekyc UK 005

"Data": {
	"DayOfBirth": 20,
	"Forename": "Aaron",
	"HouseNameNumber": "254",
	"MonthOfBirth": 6,
	"Postcode": "WT1 1TD",        "Street": "Ocean View",
	"Surname": "Cross",
	"YearOfBirth": 1973
}

<QueryData>
<DayOfBirth>20</DayOfBirth>
<Forename>Aaron</Forename>
<HouseNameNumber>254</HouseNameNumber>
<MonthOfBirth>6</MonthOfBirth>     
<Postcode>WT1 1TD</Postcode>  <Street>Ocean View</Street>
<Surname>Cross</Surname>
<YearOfBirth>1973</YearOfBirth></QueryData>

Response

The following shows the basic schema for the <W2DataEkycUk005Result> object that is returned in the <ServiceResult> Section of the <ProcessRequestResult> object. 

Example Response - W2 Data Ekyc UK 005

"Data": {
	"DayOfBirth": 20,
	"Forename": "Aaron",
	"HouseNameNumber": "254",
	"MonthOfBirth": 6,
	"Postcode": "WT1 1TD",
  "Street": "Ocean View",
	"Surname": "Cross",
	"YearOfBirth": 1973
}

"w2DataEkycUk005Result": {
	"dataSources": [{
			"AllowMultipleRecordsAsSeparateDataSources": false,
			"MatchingCriteria": "NameAndAddress",
			"NumberOfMatches": 1,
			"Source": "CreditLendersA"
		}, {
			"AllowMultipleRecordsAsSeparateDataSources": false,
			"MatchingCriteria": "NameAndDateOfBirth",
			"NumberOfMatches": 1,
			"Source": "Electoral Roll"
		}
	],
	"interpretResult": "Pass",
	"Message": "The call was successful",
	"transactionResult": "SuccessIncompleteResults"
}

<W2DataEkycUk005Result>
    <DataSources>
        <!-- An array of MatchingSource elements --> 
        <MatchingSource>
            <AllowMultipleRecordsAsSeparateDataSources>
                { true | false }
            </AllowMultipleRecordsAsSeparateDataSources>
            <MatchingCriteria>
                { 
                    NotAssigned | NameAndAddress | NameAndDateOfBirth |
                    NameAndAddressAndDateOfBirth | MortalityHighConfidence | 
                    MortalityLowConfidence | SurnameAndPhoneNumberAtAddress
                }
            </MatchingCriteria>
            <NumberOfMatches>           
                { 0 - 99 }
            <NumberOfMatches>
            <Source>
               {
                    0 = NotAssigned 
                    1 = ElectoralRoll 
                    2 = CCJ
                    3 = CreditLendersA
                    4 = CreditLendersB
                    5 = BT_OSIS 
                    6 = MortalityData
                }            
            <Source>
        </MatchingSource>
    </DataSources>
    <InterpretResult>
        { 
            NotPerformed | Pass | Fail | Refer | NoInterpretPerformed 
        }
    </InterpretResult>
    <Message>
        { A message containing additional information about the call }
    </Message>
    <TransactionResult>
        {
            None | Success | SuccessNoResults | SuccessIncompleteResults |
            MultipleChoices | ClientErrorInformationFormatInvalid | ClientErrorInsufficientInformation |
            NotExecutedDueToPreviousHalt | ServerErrorGeneralError | ServiceFailureError
        }
    </TransactionResult>
</W2DataEkycUk005Result>

Below is some more information about the some of the elements of the response that require explanation:

Datasources = A collection showing every source of data that was used to formulate the result. Each source is represented by a element.

AllowMultipleRecordsAsSeparateDataSources = Indicates that two different record matches from the same data source may count as independent sources when formulating the 2 + 2 result. For example, two CCJ results may count as two sources, rather than one, as they would do under normal service circumstances.

MatchingCriteria = Precisely what data has been matched by the data source. E.g. NameAndAddressAndDateOfBirth

NumberOfMatches = The number of matches found by this data source

Source = The source of the data match. E.g. CCJ

SourceId Source Matched
1 Electoral Roll
2 County Court Judgements (CCJs)
3 Credit Lenders (CAIS)
4 N/A
5 BT_OSIS
6 Mortality Data

Transaction Result

HaltTriggered False
ServiceTransactionResult - Success
- SuccessIncompleteResults - Too many matches on the search criteria and the results have been truncated
- SuccessNoResults - No matches found
- ServerErrorGeneralError - An error occurred
- ServiceFailureError - Unable to contact third party service
- ClientErrorInsufficientInformation- Required field not supplied or insufficient/invalid information
- ClientErrorInformationFormatInvalid - Address fields cannot contain commas
ServiceInterpretResult - OneResult
- MultipleResults
- NoResults
- NotPerformed - An error occurred and the search was not performed
ServiceTransactionResultMessage Usually empty, can contain optional information such as too many matches etc.
ValidationResult - Pass
- NotPerformed - No search occurred to match against
- Fail - MissingMandatoryField or PatternNotMatched

Sandbox

Query options for Sandbox

"options": {
	"sandbox": "true"
}

<QueryOptions>
  <KeyValueOfstringstring>
    <Key>Sandbox</Key>
    <Value>true</Value>
  </KeyValueOfstringstring>
</QueryOptions>

To see the details of the service response of each sandbox case, simply click on it in the table below:

Sandbox Example Cases

       
       (Click on a sandbox case to see the service result data here)
Forename Surname Day Of Birth Month Of Birth Year Of Birth Flat House Name/Number Street Postcode
Aaron Cross 20 6 1973 254 Ocean View WT1 1TD
Aaron John 3 8 1976 85 Ocean View WT1 1TD
Abbie Forster 26 12 1962 241 Ocean View WT1 1TD
Abigail Ford 22 10 1956 146 Ocean View WT1 1TD
Adam Crawford 27 6 1980 374 Ocean View WT1 1TD
Adam Sharpe 20 11 1996 250 Ocean View WT1 1TD
Ahenobarbus Michal 31 12 1944 68 RH13 3HE
Alexander Ball 21 5 1966 108 Ocean View WT1 1TD
Alexander Wallis 28 3 1953 142 Ocean View WT1 1TD
Alisha Owen 16 8 1979 113 Ocean View WT1 1TD
Allen Kiril 8 1 1943 99 IVT X34
Allen Kiril 8 1 1943 99 IVT X34
Amber Ball 9 7 1957 147 Ocean View WT1 1TD
Amelia Brady 14 8 1978 121 Ocean View WT1 1TD
Amy Bowen 6 4 1983 310 Ocean View WT1 1TD
Amy Freeman 12 7 1982 134 Ocean View WT1 1TD
Andrew Lyons 25 12 1973 304 Ocean View WT1 1TD
Andrew Sanders 26 2 1968 116 Ocean View WT1 1TD
Angeline Error 12 3 1972 380 Ocean View NP1 1NP
Ben Blake 5 7 1960 106 Ocean View WT1 1TD
Benjamin Davis 3 7 1962 321 Ocean View WT1 1TD
Bethany Bentley 10 9 1968 312 Ocean View WT1 1TD
Bethany Watts 30 4 1952 255 Ocean View WT1 1TD
Billy Jones 31 12 1944 68 RH13 3HE
Bradley Swift 14 7 1997 247 Ocean View WT1 1TD
Brandon Rose 13 4 1964 378 Ocean View WT1 1TD
Caitlin ODonnell 8 11 1961 268 Ocean View WT1 1TD
Caitlin Williams 1 1 1974 365 Ocean View WT1 1TD
Callum Saunders 13 10 1976 122 Ocean View WT1 1TD
Cerys Holden 24 9 1985 265 Ocean View WT1 1TD
Cerys Reeves 3 3 1978 270 Ocean View WT1 1TD
Charles Coleman 24 2 1964 306 Ocean View WT1 1TD
Charlie Byrne 30 1 1986 300 Ocean View WT1 1TD
Charlie Carroll 24 11 1957 112 Ocean View WT1 1TD
Charlie Clarke 14 2 1957 105 Ocean View WT1 1TD
Charlie Glover 3 12 1990 90 Ocean View WT1 1TD
Charlie Wilkinson 18 11 1968 26 LN4 7AT
Charlotte Cooper 18 4 1973 126 Ocean View WT1 1TD
Christopher Norman 2 5 1966 144 Ocean View WT1 1TD
Christopher Townsend 13 5 1972 83 Ocean View WT1 1TD
Courtney Webb 24 2 1952 148 Ocean View WT1 1TD
Daisy North 12 11 1979 86 Ocean View WT1 1TD
Danielle Evans 1 4 1963 295 Ocean View WT1 1TD
David Armstrong 25 2 1951 114 Ocean View WT1 1TD
David Cameron 9 10 1966 5 BS8 1HN
David Robson 9