DocumentationDirector Check UK
Compatible Cases
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 Name | Type | Length | Optional/Mandatory | Notes |
|---|---|---|---|---|
| Forename | String | Mandatory* | Default field used for matching, can be blank if NameQuery used instead | |
| MiddleNames | String | Optional | ||
| Surname | String | Mandatory* | Default field used for matching, can be blank if NameQuery used instead | |
| NameQuery | String | Optional | Used when Forename/MiddleNames/Surname is not specified | |
| DayOfBirth | Integer | 2 | Optional | Optional as long as MonthOfBirth and YearOfBirth are specified |
| MonthOfBirth | Integer | 2 | Optional | |
| YearOfBirth | Integer | 4 | Optional |
Example Request
"Data": {
"Forename": "Jessica",
"Surname": "Black",
"MonthOfBirth": 1,
"YearOfBirth": 1970
}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"
}
]
}
}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
{
"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.
"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:
| Property | Value |
|---|---|
| HaltTriggered | False |
| 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:
| Property | Value |
|---|---|
| HaltTriggered | False |
| ServiceTransactionResult | SuccessNoResult |
| ServiceInterpretResult | NoResults |
| ServiceTransactionResultMessage | "This call was generated using sandbox mode" |
| ValidationResult | NotApplicable |