Financial Vulnerability UK 005
About the service
Financial Vulnerability UK 005 is a point in time check which returns Public Information data and can be used to identify potentially vulnerable individuals based on the amount & recency of the Public Information (e.g. CCJ, IVA, etc), as well as categorising the individual as either over 25 or under 25. Full list of sources included in this service
Product Code: FINANCIAL_VULNERABILITY_UK_005
Does this service leave a credit search Footprint? Yes
Request
Query Data
The following QueryData properties pertain to this service.
Property Name | Type | Length | Optional/Mandatory | Notes |
---|---|---|---|---|
Forename | String | 15 | Mandatory | |
MiddleNames | String | 15 | Optional | The contents of this field will be converted into initials, therefore the character limit can usually be ignored. |
Surname | String | 30 | Mandatory | |
DayOfBirth | Integer | 2 | Mandatory | |
MonthOfBirth | Integer | 2 | Mandatory | |
YearOfBirth | Integer | 4 | Mandatory | |
HouseName | String | 26 | Optional | Either house name or house number must be supplied |
HouseNumber | String | 10 | Optional | Either house name or house number must be supplied |
Flat | String | 16 | Optional | |
Street | String | 40 | Optional | |
County | String | 20 | Optional | |
City | String | 20 | Optional | |
Postcode | String | 8 | Mandatory | |
PhoneNumber | String | 16 | Optional | Please provide the phone number as one contiguous set of numbers with no other characters or spaces. |
Example Request
"Data": {
"Forename": "Brandon",
"Surname": "Marsh",
"DayOfBirth": 30,
"MonthOfBirth": 6,
"YearOfBirth": 1942,
"HouseNumber": "74",
"Street": "Guildford Rd",
"Postcode": "RH19 6EG"
}
Response
The following shows the basic schema for the financialVulnerabilityUK005Result
result.
Example Response
"financialVulnerabilityUK005Result": {
"foundData": [
{
"name": "V_PI_Insolvency",
"description": "One or more insolvency records (active or satisfied) found",
"result": "0"
},
{
"name": "V_PI_Insolvency_Active",
"description": "One or more active Insolvency records found",
"result": "0"
},
{
"name": "V_PI_CCJ_1K_6M",
"description": "One or more active CCJs with a total value over £1000, and one or more CCJs within the last 6 months, found",
"result": "0"
}
],
"interpretationProfile": {
"name": "Interpretation profile #1",
"groups": [
{
"name": "Fail check",
"order": 0,
"result": "Fail",
"condition": "Any",
"rules": [
{
"key": "V_PI_Insolvency",
"value": "0",
"condition": "GreaterThan"
}
]
},
{
"name": "Pass check",
"order": 1,
"result": "Pass",
"condition": "Any",
"rules": [
{
"key": "V_PI_Insolvency",
"value": "0",
"condition": "Equal"
},
{
"key": "V_PI_Insolvency_Active",
"value": "0",
"condition": "Equal"
}
]
}
]
}
}
Response Breakdown
As with all other bundle services the response is separated into two sections: Service specific outputs and the summarized results (Service transaction).
![](/images/bundle-result-breakdown.png)
The summarized results section is explained here: Service transaction information
Below is some information about service specific outputs.
Found data
Found data shows the rules which have been triggered according to what information has been relating to the individual.
Rule Name | Rule Text |
---|---|
V_EId_PAg18To24 | Data from a Primary data source found that indicates an age which is in the 18-24 category |
V_EId_PSAg18To24 | Data from a Primary or Secondary data source found that indicates an age which is in the 18-24 category |
V_EId_PSTAg18To24 | Data from a Primary, Secondary or Tertiary data source found that indicates an age which is in the 18-24 category |
V_EId_AllAg18To24 | Data found on an included data source that indicates an age which is in the 18-24 category |
V_PI_Insolvency | One or more insolvency records (active or satisfied) found |
V_PI_Insolvency_Active | One or more active Insolvency records found |
V_PI_CCJ_6M | One or more active CCJs within the last 6 months found |
V_PI_CCJ_1K | One or more active CCJs with a total value over £1000 found |
V_PI_CCJ_1K_6M | One or more active CCJs with a total value over £1000, and one or more CCJs within the last 6 months, found |
V_PI_CCJ_2500 | One or more active CCJs with a total value over £2500 found |
V_PI_CCJ_5000 | One or more active CCJs with a total value over £5000 found |
V_PI_CCJ_Active1Yr | One or more active CCJs within the last 1 year found |
V_PI_CCJ_Any1Yr | One or more CCJs within the last 1 year found |
V_PI_CCJ_Active3Yr | One or more active CCJs within the last 3 years found |
V_PI_CCJ_Any3Yr | One or more CCJs within the last 3 years found |
V_PI_CCJ_1Active | One or more active CCJ records found |
V_PI_CCJ_Any | One or more CCJ records found |
V_PI_CCJ_2Active | Two or more active CCJ records found |
V_PI_CCJ_ActiveAgU25 | Data found that indicates an age of under 25 and one or more active CCJs |
V_PI_CCJ_AgU25 | Data found that indicates an age of under 25 and one or more CCJs |
V_PI_CMO_Active | One or more Active Child Maintenance Order records found |
V_PI_CMO | One or more Child Maintenance Order records found |
Interpretation profile
This service uses our interpretation profile system to calculate the result. An interpretation profile is a set of rules applied to the output of the service. The rules that get triggered determine the overall result of the service. We return the profile used in the response so nothing is hidden from you.
Using an interpretation profile gives a huge amount of flexibility. It can be as complicated or as simple as you like. You get to decide what a Pass or Fail looks like.
![](/images/interpretation-profile.png)
Sandbox
Sandbox mode can be used to test the service. By setting the following query option and sending some the below query data we will return a pre-configured response without actually calling our suppliers.
Query options for Sandbox
"options": {
"sandbox": "true"
}
Sandbox cases
These are the sandbox options for these service. Learn about our Sandbox here
Click on a sandbox case to view the request and response
Categories and sources
These are the categories and sources included in this service.
Categories
- Bankruptcy
- Child Maintenance
- Debt Arrangements
- Judgments
- Miscellaneous
Sources
- Judgment
- Set Aside Judgment
- Satisfied Judgement
- CMG Judgment
- CMG Set Aside
- CMG Satisfied
- Administration Order
- Administration Order Revoked
- Administration Order Varied
- Sequestration
- Set Aside Admin Order
- Bankruptcy Order
- Satisfied Administration Order
- Bankruptcy Order Annulled
- Voluntary Arrangement
- Voluntary Arrangement Revoked
- Voluntary Arrangement Failed
- Voluntary Arrangement Completed
- Bankruptcy Restriction Order
- Bankruptcy Restriction Undertaking
- Scottish Trust Deed
- Debt Relief Order
- High Court Judgment
- High Court Judgment Satisfied
- High Court Judgment Set Aside
- Debt Relief Restriction Order
- Debt Relief Restriction Undertaking