Director Check UK service

Director Check UK (DirectorUKCheck) service

Director UK Check 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

The following is an example request for this service:

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

Response

The following is an example response from the service. 

<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

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

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

1. If the NameQuery is entered as "Jessica Black"

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

<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

2. For all other name queries:

An empty, non-null DirectorUKCheckResult will be returned.

The corresponding ServiceTransactions will show the following properties:

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