KYC Check Request

This describes the shape of the KYC Check request

Full Request example

Here is a full KYC Check request detailing every data option.

	"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": "",
		"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"

Request Properties

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

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.

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.