What is an ClearScore Integration?

ClearScore provide free credit scores, credit reports, and personalised financial product recommendations to consumers.

We connect borrowers to credit products provided by lenders through an on-demand basis.

We are providing our API to partners so that they can also use our intelligent decisioning platform; a platform we have invested over a decade of engineering into.

Partner Integration Types

We provide a single type of partner integration via our API, but continue to build more options in the background.

Redirect API

The redirect API is named as such because we will always try to provide a redirect URL to our platform in the response.

This URL destination may vary depending on the input payload, for example, if the user provides invalidate input and they have managed to get past a Partner's validation, we will provide a link to that user so that they can amend the data they have provided.

If the customer has successfully been matched with offers, we will provide a URL that sends them to the offers page to proceed with one of the available offers.

We separate our possible APIs by products. Right now, two products are available: Unsecured loans and credit cards.

Both require different data from the applicant.

Unsecured Loan API

The unsecured loan API requires more information about the applicant than the credit card API. This is a result of how our decisioning system works and the requirements of the lenders and products apart of that system.

The primary difference is that there istwo additional nested payload objects. These objects are Other Income and Second Previous Address

Other income is dependent on the applicant's employment status, to learn more please visit the Employment Status & Income section.
Previous addresses are documented in the API reference for their corresponding API. The general rule is that lenders want 3 years of address history.

For the unsecured loan API, we ask for a current address and if that isn't at least 3 years of residency, we ask for a previous address. If both of these addresses don't equate to a total of 3 years, we ask for a second previous address.

Credit Card API

The credit card API has less rigorous data requirements than the unsecured loan API.

Other income is not required. You do not need to ask the applicant for this information.
Second previous address is not required either. You still need to make sure to ask the user for a first previous address if their residency at their current address is <3 years.
The credit card API uses a Quote vs Loan object to denote the applicant's product requirements.

Payload Examples

The complete payloads should look like this:

{
    "Partner": {
        "partner_code": "FFW-TEST",
        "reference": "1234567"
    },
    "Quote": {
        "cash_advance": "N",
        "balance_transfer": "Y",
        "balance_to_transfer": 5000
    },
    "Primary_Applicant": {
        "title": "Mrs",
        "first_name": "Clotilde",
        "middle_name": null,
        "surname": "Kemmer",
        "dob": "03/04/1981",
        "gender": "F",
        "email": "test@example.com",
        "home_phone": null,
        "mobile_phone": "07712345678",
        "marital_status": "M",
        "residential_status": "H",
        "no_of_dependents": 0,
        "other_household_income": 9050,
        "Current_Address": {
            "flat": null,
            "house_name": null,
            "house_number": "23",
            "street": "HIGH STREET",
            "locality": "Westbury",
            "posttown": "Westbury",
            "county": "Wiltshire",
            "postcode": "BA133BN",
            "country": "United Kingdom",
            "years_lived": 3,
            "months_lived": 1
        },
        "Current_Employment": {
            "employment_status": "U",
            "gross_income_all": 0
        },
        "Expenditure": {
            "monthly_mortgage_rent": 1560
        }
    }
}

{
    "Partner": {
        "partner_code": "FFW-TEST",
        "reference": "1234210"
    },
    "Loan": {
        "loan_amount": 62350,
        "loan_term": 60,
        "loan_purpose": "CA1"
    },
    "Primary_Applicant": {
        "title": "Mr",
        "forename": "Example",
        "surname": "Example",
        "dob": "01/11/1990",
        "email": "test@test.com",
        "home_phone": "0161123456789",
        "mobile_phone": "07777777777",
        "marital_status": "L",
        "residential_status": "M",
        "no_of_dependents": 1,
        "dependent_ages": "12",
        "Current_Address": {
            "flat": null,
            "house_name": null,
            "house_number": "3",
            "street": "HIGH STREET",
            "posttown": "WESTBURY",
            "locality": "WILTSHIRE",
            "postcode": "BA133BN ",
            "country": "UK",
            "years_lived": 0,
            "months_lived": 5
        },
        "First_Previous_Address": {
            "flat": "APARTMENT 22",
            "house_name": null,
            "house_number": "3",
            "street": "HIGH STREET",
            "posttown": "WESTBURY",
            "locality": "WILTSHIRE",
            "postcode": "BA133BN ",
            "country": "UK",
            "years_lived": 1,
            "months_lived": 0
        },
        "Second_Previous_Address": {
            "flat": null,
            "house_name": "ROBIN LANE",
            "house_number": "56",
            "street": "HIGH STREET",
            "posttown": "WESTBURY",
            "locality": "WILTSHIRE",
            "postcode": "BA133BN ",
            "country": "UK",
            "years_lived": 0,
            "months_lived": 3
        },
        "Current_Employment": {
            "employment_status": "R",
            "gross_income": 0,
            "emp_years": 0,
            "emp_months": 0
        },
        "Expenditure": {
            "monthly_mortgage_rent": 500
        },
        "Bank_Details": {
            "years_at_bank": 14,
            "months_at_bank": 1
        }
    }
}

Next Steps