DocumentationW2-DATA-DISQUALIFIEDS-UK-008
Compatible Cases
About the service
W2-DATA-DISQUALIFIEDS-UK-008 This service searches a list of Disqualified Directors. This list is updated once a week.
Product Code: W2-DATA-DISQUALIFIEDS-UK-008
Does this service leave a credit search Footprint? No
Request
Example Request
json
{
"Bundle": "YOURBUNDLE",
"Data": {
"DateOfBirthMatchThreshold":100,
"DayOfBirth": 22,
"Forename": "JOHN",
"MiddleNames":"JAMES",
"NameQueryMatchThreshold":100,
"MonthOfBirth": 10,
"Surname": "JAMES",
"YearOfBirth": 1997
}
}Query Data
This service uses the following query data:
| 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
Example Response
The individual service response will look like this sample on the side that we have filled in with some dummy data:
json
"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
}
]
}Response Breakdown
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
Example Request
To use sandbox the following example request can be used.
Remember to include the W2 provided API key in the Authorization Header.
json
{
"Bundle": "W2DataDisqualifiedsUk008",
"Data": {
"Forename": "James",
"Surname": "Thorpe",
"DayOfBirth": 10,
"MonthOfBirth": 6,
"YearOfBirth": 1978
},
"Options": {
"Sandbox": "true"
},
"ClientReference": "your-client-reference"
}Sandbox Cases
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. |