Skip to content
On this page

Director Check UK

About the service

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.

Product Code: W2-DATA-DIRECTOR-UK-009

Does this service leave a credit search Footprint? No

Request

Properties

The following Query Data properties pertain to this service.

Property NameTypeLengthOptional/MandatoryNotes
NameQueryStringMandatory*Default field used for matching, can be blank if Forename/MiddleNames/Surname used instead
ForenameStringOptionalUsed when NameQuery is not specified
MiddleNamesStringOptionalUsed when NameQuery is not specified
SurnameStringOptionalUsed when NameQuery is not specified
DayOfBirthInteger2Optional
MonthOfBirthInteger2Optional
YearOfBirthInteger4Optional

Example Request

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

Response

Example Response

json
"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"
			}
		]
	}
}

Sandbox

To use sandbox the following example request can be used.

Remember to include the W2 provided API key in the Authorization Header.

Example Sandbox Request

json
{
    "Bundle": "DirectorUKCheck",
    "Data": {
        "NameQuery": "Jessica Black"
    },
    "Options": {
        "Sandbox": "true"
    },
    "ClientReference": "your-client-reference"
}

Sandbox Examples

If the Sandbox query option is set to "true" the following entries shown in Sandbox Examples will be returned in the ServiceResult

Jessica Black

If the NameQuery is entered as "Jessica Black"

DirectorUKCheckResult will contain two DirectorUKCheckResults and there is an empty, non-null DirectorUKCheckErrors.

json
"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"
			}
		]
	}
}

The corresponding ServiceTransactions will show the following properties:

PropertyValue
HaltTriggeredFalse
ServiceTransactionResult- Success
ServiceInterpretResult- MultipleResults
ServiceTransactionResultMessage"This call was generated using sandbox mode"
ValidationResult- NotApplicable

For all other name queries:

An empty, non-null DirectorUKCheckResult will be returned.

The corresponding ServiceTransactions will show the following properties:

PropertyValue
HaltTriggeredFalse
ServiceTransactionResultSuccessNoResult
ServiceInterpretResultNoResults
ServiceTransactionResultMessage"This call was generated using sandbox mode"
ValidationResultNotApplicable