W2 DocsW2 Data Vulnerability UK 045
Compatible Cases
About the service
This is a service which facilitates checks on whether a customer has a self-declared vulnerability.
Product Code: W2-DATA-VULNERABILITY-UK-045
Does this service leave a credit search Footprint? No
Request
Example request with all fields:
json
{
"Bundle": "W2_DATA_VULNERABILITY_UK_045",
"Data": {
"City": "Kings Landing",
"County": "Blaenau Gwent",
"DayOfBirth": 1,
"Email": "[email protected]",
"Forename": "John",
"HouseName": "Rose Cottage",
"HouseNumber": "14",
"MobileNumber": "07539587538",
"MonthOfBirth": 1,
"Postcode": "SW1A 1AA",
"Street": "Abbey Road",
"Surname": "Gurung",
"YearOfBirth": 1985
},
"Options": {
"Sandbox": "true"
},
"ClientReference": "your-client-reference"
}Request breakdown
Add these to the Data section of the request
| Property Name | Type | Length | Optional/Mandatory |
|---|---|---|---|
| Forename | String | 30 | Mandatory |
| Surname | String | 30 | Mandatory |
| DayOfBirth | Integer | 2 | Optional* |
| MonthOfBirth | Integer | 2 | Optional* |
| YearOfBirth | Integer | 4 | Optional* |
| HouseName | String | 26 | Optional* |
| HouseNumber | String | 26 | Optional* |
| Postcode | String | 8 | Optional* |
| Street | String | 40 | Optional* |
| County | String | 20 | Optional* |
| City | String | 20 | Optional* |
| String | 30 | Optional* | |
| MobileNumber | String | 12 | Optional* |
(*) Requirements
This service requires at least one of DOB, Email, Mobile number or Address to be provided with Forename + Surname.
A valid Address must contain at least a House Name/House Number, Street and Postcode.
Response
Example Response:
json
{
"w2dataVulnerabilityuk045Result": [
{
"record": {
"vrS_First_Registered": "2021-08-25T00:00:00",
"vrS_Flag_Updated": "2021-08-25T00:00:00",
"vrS_Sub_Flags": "iva",
"vrS_Sub_Flags_Description": "Individual Voluntary Agreement",
"vrS_VC_Flag": "FPr",
"vrS_VC_Flag_Description": "First Party - Refer"
"personId": 1767306
},
"client_ref": "testing",
"dod_reference": "testing",
"match_analysis": {
"ad1_match_percent": 0,
"ad2_match_percent": 0,
"ad3_match_percent": 0,
"ad4_match_percent": 0,
"county_match_percent": 0,
"dob_match_percent": 0,
"email_match_percent": 0,
"firstname_match_percent": 0,
"gender_match_percent": 0,
"landline_match_percent": 0,
"lastname_match_percent": 0,
"mobile_match_percent": 0,
"postcode_match_percent": 0,
"town_match_percent": 0
},
"match_percent": 100,
"response_status": {
"status_code": "200",
"status_message": "Match complete"
}
}
]
}VC Flags
The date the individual was first registered with the VRS
| VC Flag | Description | Further Explanation | Examples |
|---|---|---|---|
| FPd | First Party - Decline | Organisation submitted on behalf of consumer - DECLINE - deny any application | The individual has given consent to their bank to share information with the VRS and has requested that applications are declined. |
| FPnar | First Party - No Consumer Authorisation - Refer | Organisation submitted on behalf of consumer - REFER - treat any application with vulnerabilty in mind | There is a legitimate reason for the individual's bank to share information with the VRS, such as the individual has been the victim of a loan shark or fraud. |
| FPr | First Party - Refer | Organisation submitted on behalf of consumer- REFER - treat any application with vulnerabilty in mind | The individual has given consent to their bank to share information with the VRS and has requested for their vulnerable status to be considered when making applications. |
| SEd | Self Registered - Decline | Self-declared/registered by the indivdiual consumer - DECLINE - deny any application | The individual has registered with the VRS and declared that they are vulnerable, requesting that all applications are declined. |
| SEr | Self Registered - Review | Self-declared/registered by the indivdiual consumer - REVIEW - treat any application with vulnerabilty in mind | The individual has registered with the VRS and declared that they are vulnerable, requesting that their vulnerable status is considered when making applications. |
| TPd | Third Party - Decline | Third party (typically POA Power of Attorney) submitted on behalf of consumer - DECLINE - deny any application | A third party has the authority to act on behalf of the individual and they have registered the individual with the VRS and requested that all applications are declined. An example of this would be a relative with Power of Attorney. |
| TPnar | Third Party - No Consumer Authorisation - Refer | Third party (typically POA Power of Attorney) submitted - REFER - treat any application with vulnerabilty in mind | Ths data has been shared with the VRS where there is a legitimate or legal reason for a third party to register the individual, such as a Court of Protection Order, for example. |
| TPr | Third Party - Review | Third party (typically POA Power of Attorney) submitted - REVIEW - treat any application with vulnerabilty in mind | A third party has the authority to act on behalf of the individual and they have registered the individual with the VRS and requested the individual's vulnerable status is considered when making applications. An example of this would be a relative with Power of Attorney. |
Sub Flags
The Sub Flag which describes the vulnerability
| Description | Vulnerable Sub Flag Detail | Vulnerable Sub Flag Example |
|---|---|---|
| Accessibility | Someone who has difficulty accessing goods and services or communicating with suppliers. | Limited access to internet / digital services, Reliance upon on-line shopping, Difficulty physically visiting branches, Reliance on carers / third parties |
| Bankruptcy | Bankruptcy is a legal status that usually lasts for a year and can be a way to clear debts you can't pay. When you're bankrupt, your non-essential assets (property and what you own) and excess income are used to pay off your creditors (people you owe money to). At the end of the bankruptcy, most debts are cancelled. | Bankruptcy is a legal status that usually lasts for a year and can be a way to clear debts you can't pay. When you're bankrupt, your non-essential assets (property and what you own) and excess income are used to pay off your creditors (people you owe money to). At the end of the bankruptcy, most debts are cancelled. |
| Coercion | Coercion is compelling someone to act in an involuntary manner by use of intimidation,threats, including force. It involves a set of various types of forceful actions that violate the free will of an individual to induce a desired response | Forcing someone to borrow money in their name with the threat of violence, humiliation, intimidation, or even sexual assault. |
| Cognitive disorder | Someone who suffers from disorders that affect cognitive abilities, including learning, memory, perception and problem solving | Down Syndrome, Huntington disease, Mild cognitive impairment, Progressive supranuclear palsy, Dementia, Parkinson's disease |
| Coronavirus | Someone who has suffered directly as a result of the coronavirus pandemic. | Job loss, Reduced pay, Payment holidays, Furlough, Self-isolation/quarantine |
| Deceased | A third party can notify when an individual is deceased | A death certificate is required to load this flag |
| Debt Management Plan | Debt management is a way to manage your debt through financial planning and budgeting and move towards eliminating it completely. | High level of debt, Job loss, Reduced pay, Low or negative net disposable Income, Heavily reliant on benefits |
| Debt Relief Order | DRO (Debt Relief Order) | A Debt Relief Order (DRO) is a way of dealing with your debts if you can't afford to pay them. It means you don't have to pay certain kinds of debt for a specified period (usually 12 months). At the end of the DRO period, the debts included in it will be written off ('discharged') and you won't have to pay them |
| Financial capacity | Someone who lacks the knowledge, skill to make appropriate decisions about their finances. | Power of Attorney, Court Protection Orders, Appionteeships, English not first language, Low literacy or numeracy levels, Age-related impact (elderly or young) |
| Financial difficulty | Someone who, due to their financial situation, is not sufficiently resilient to manage financial shock | Low or negative net disposable Income, High level of debt, Heavily reliant on benefits, Insolvency |
| Gambling addiction | Gambling addiction | Gambling addiction, Compulsive gambling, Gambling disorder |
| Individual Voluntary Arrangement | IVA (Individual Voluntary Agreement) | An Individual Voluntary Arrangement (IVA) is an agreement with your creditors to pay all or part of your debts. You agree to make regular payments to an insolvency practitioner, who will divide this money between your creditors. An IVA can give you more control of your assets than bankruptcy. |
| Lifecycle event | Life events that impact on decision making | Relationship breakdown, Bereavement, Addiction, Unemployment, Criminal conviction, Financial abuse, Domsestic abuse, Victim of fraud |
| Mental health | Someone who suffers from a condition causing serious disorder in a person�s behaviour or thinking | Bipolar, Schizophrenia, Post-traumatic stress disorder, Personality disorder, Self-harm, Suicidal feelings, Depression |
| Physical health | Someone who suffers from a condition that causes serious and life-limiting physical health issues | Cancer, Stroke, Diabetes, Heart attack, Chronic fatigue syndrome, Cardiovascular disease, Multiple sclerosis, Athritis |
| Physical disability | A physical condition that affects a person's mobility, physical capacity, stamina or dexterity. | Spinal cord injuries, Multiple sclerosis, Cerebral palsy, Respiratory disorders, Epilepsy, Hearing and visual impairments, Wheelchair users |
Sandbox
Use these set responses to test your integration. Learn how to use our Sandbox here.
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