API Reference

Current and Previous Addresses

Why and how we expect addresses to be provided

We require address history for the past three years, this is an important datapoint for our lenders to use with regards to providing potential offers.

Address requirements

The address requirements differ slightly for the two redirect APIs:

  • The unsecured loan API is the most rigorous and requires more data; in this case, we require an address history of the past three years.

    • In the case that the applicant's current address does not fulfil this residency requirement, we require a previous address. We expect the current + previous address residency to be at least 36 months in total.
    • If this isn't the case, we require a second previous address and expect that the current + previous + second previous addresses accumulate to at least 36 months in total.
    • If this isn't the case, we no longer require anymore data from the applicant, but it would be wise to inform the client that the number of offers will be drastically reduced due to this residency requirement.

  • The credit card API requires less data but works in the same way as the above - we only require a current + previous address at most. We do not ask for a second previous address in this API.

How we use Address Data

One of the primary usages for the address data is for performing a credit score search for the customer - this allows us to match up the customer more appropriately to a lender's products which should hopefully result in a better offer rate.

It is important that address data supplied to the API be as accurate as possible. Our API contains multiple fields that contribute towards a complete address such as Flat or Building name or number, Street name, Post town etc.

This information is passed (as it has been provided to us) to our credit search bureau who in turn score the individual.

We have seen instances in the past where scoring can fail because the address data is not accurate and the individual cannot be correctly identified based on address history - whilst this does not always mean no offers are returned, it can mean that internal business rules or lender APIs could exclude a customer on this basis.

Common issues with Address Data

  1. If the current address matches the previous address then the API will return an EC resume link, so if you are building your own EC form it would be best to also validate this constraint before our API is invoked.
  2. The validation of Address Data can be a little complex, in that at least one of Flat, House number or House name is required so please be sure that all the constraints on the address data is met.