Skip to content
On this page

W2 Affordability VRS 045

About the service

This is a service which facilitates checks on whether a customer has a self-declared vulnerability.

Product Code: W2_AFFORDABILITY_VRS_045

Does this service leave a credit search Footprint? No

Request

Example request with all fields:

json
{
    "Bundle": "W2_AFFORDABILITY_VRS_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 NameTypeLengthOptional/Mandatory
ForenameString30Mandatory
SurnameString30Mandatory
DayOfBirthInteger2Optional*
MonthOfBirthInteger2Optional*
YearOfBirthInteger4Optional*
HouseNameString26Optional*
HouseNumberString26Optional*
PostcodeString8Optional*
StreetString40Optional*
CountyString20Optional*
CityString20Optional*
EmailString30Optional*
MobileNumberString12Optional*

(*) 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.

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