Affordability API Documentation

Workflow Options

Full Client Workflow

Clients and searches fed to the API will be available to brokers through the web application.

POST to /clients to create a new client

POST to /affordability to create a search

GET to /affordability to retrieve results/PDF

Simplified Workflow

Process is streamlined where the web application is not required

POST to /affordability to create a search

GET to /affordability to retrieve results/PDF


Available Endpoints

Affordability

GET /affordability – View a list of all affordability searches

Parameters – None

POST /affordability – Create a new affordability search

{

“name”: “New house mortgage”,

“numberOfApplicants”: 1,

“numberOfDependents”: 2,

“numberOfDependentAdults”: 2,

“deposit”: “25000”,

“mortgageTermYears”: 25,

“property”: {

“value”: “220000”,

“addressLineOne”: “”,

“addressLineTwo”: “”,

“addressLineThree”: “”,

“town”: “”,

“county”: “”,

“country”: “”,

“postcode”: “”,

“type”: “House”,

“region”: “Unknown”

},

“paymentType”: “Capital Repayment”,

“client”: {

“id”: “string”

},

“interestOnlyAmount”: 0,

“pdfStatus”: “string”,

“helpToBuy”: “Not Used”,

“helpToBuyAmount”: “50”,

“sharedOwnershipRent”: “50”,

“applicantOneDateOfBirth”: “2018-04-16 11:11:11”,

“applicantTwoDateOfBirth”: “2018-04-16 11:11:11”,

“applicantOneRetirementAge”: 0,

“applicantTwoRetirementAge”: 0,

“loanType”: “Purchase”,

“productPeriod”: 2,

“interestRate”: 0,

“expenditure”: {

“councilTax”: “90”,

“utilities”: “50”,

“food”: “200”,

“travel”: “50”,

“houseKeeping”: “50”,

“creditCardBalance”: “2500”,

“creditCardMonthlyRepayments”: “220”,

“creditCardBalanceAfterCompletion”: “2500”,

“creditCardMonthlyRepaymentsAfterCompletion”: “220”,

“monthlyLoanPayments”: “150”,

“additionalMortgagePayments”: “0”,

“childCare”: “100”,

“maintenance”: “0”,

“groundRent”: “0”,

“insurance”: “50”

},

“incomes”: [

{

“employmentType”: “Employed”,

“benefitsPeriod”: “Yearly”,

“taxBracket”: “Basic Rate”,

“employedBasicSalary”: “25000”,

“employedGuaranteedIncome”: “2000”,

“employedNonGuaranteedIncome”: “0”,

“selfEmployedLimitedSalary”: “8000”,

“selfEmployedLimitedDividendsLatestYear”: “30000”,

“selfEmployedLimitedDividendsLastYear”: “27000”,

“selfEmployedLimitedDividendsThirdYear”: “27000”,

“selfEmployedNetProfitLatestYear”: “24000”,

“selfEmployedNetProfitLastYear”: “26000”,

“selfEmployedNetProfitThirdYear”: “26000”,

“secondJobIncome”: “5600”,

“rentIncome”: “6500”,

“guaranteedOvertime”: “6500”,

“guaranteedBonus”: “6500”,

“guaranteedCommission”: “6500”,

“regularOvertime”: “6500”,

“regularBonus”: “6500”,

“regularCommission”: “6500”,

“regularShiftAllowance”: “6500”,

“regularCarAllowance”: “6500”,

“childBenefit”: “200”,

“childTaxCredit”: “0”,

“disabilityLivingAllowance”: “0”,

“workingTaxCredit”: “0”,

“privatePension”: “0”,

“statePension”: “0”,

“maintenancePayments”: “0”,

“personalIndependencePayment”: “0”,

“universalCredit”: “0”

}

]

}

GET /affordability/{id} – View the details and results of a particular affordability search

Parameters – {id} (string)

PUT /affordability/{id} – Updates an affordability search

{

“name”: “New house mortgage”,

“numberOfApplicants”: 1,

“numberOfDependents”: 2,

“numberOfDependentAdults”: 2,

“deposit”: “25000”,

“mortgageTermYears”: 25,

“property”: {

“value”: “220000”,

“addressLineOne”: “”,

“addressLineTwo”: “”,

“addressLineThree”: “”,

“town”: “”,

“county”: “”,

“country”: “”,

“postcode”: “”,

“type”: “House”,

“region”: “Unknown”

},

“paymentType”: “Capital Repayment”,

“client”: {

“id”: “string”

},

“interestOnlyAmount”: 0,

“pdfStatus”: “string”,

“helpToBuy”: “Not Used”,

“helpToBuyAmount”: “50”,

“sharedOwnershipRent”: “50”,

“applicantOneDateOfBirth”: “2018-04-16 11:11:11”,

“applicantTwoDateOfBirth”: “2018-04-16 11:11:11”,

“applicantOneRetirementAge”: 0,

“applicantTwoRetirementAge”: 0,

“loanType”: “Purchase”,

“productPeriod”: 2,

“interestRate”: 0,

“expenditure”: {

“councilTax”: “90”,

“utilities”: “50”,

“food”: “200”,

“travel”: “50”,

“houseKeeping”: “50”,

“creditCardBalance”: “2500”,

“creditCardMonthlyRepayments”: “220”,

“creditCardBalanceAfterCompletion”: “2500”,

“creditCardMonthlyRepaymentsAfterCompletion”: “220”,

“monthlyLoanPayments”: “150”,

“additionalMortgagePayments”: “0”,

“childCare”: “100”,

“maintenance”: “0”,

“groundRent”: “0”,

“insurance”: “50”

},

“incomes”: [

{

“employmentType”: “Employed”,

“benefitsPeriod”: “Yearly”,

“taxBracket”: “Basic Rate”,

“employedBasicSalary”: “25000”,

“employedGuaranteedIncome”: “2000”,

“employedNonGuaranteedIncome”: “0”,

“selfEmployedLimitedSalary”: “8000”,

“selfEmployedLimitedDividendsLatestYear”: “30000”,

“selfEmployedLimitedDividendsLastYear”: “27000”,

“selfEmployedLimitedDividendsThirdYear”: “27000”,

“selfEmployedNetProfitLatestYear”: “24000”,

“selfEmployedNetProfitLastYear”: “26000”,

“selfEmployedNetProfitThirdYear”: “26000”,

“secondJobIncome”: “5600”,

“rentIncome”: “6500”,

“guaranteedOvertime”: “6500”,

“guaranteedBonus”: “6500”,

“guaranteedCommission”: “6500”,

“regularOvertime”: “6500”,

“regularBonus”: “6500”,

“regularCommission”: “6500”,

“regularShiftAllowance”: “6500”,

“regularCarAllowance”: “6500”,

“childBenefit”: “200”,

“childTaxCredit”: “0”,

“disabilityLivingAllowance”: “0”,

“workingTaxCredit”: “0”,

“privatePension”: “0”,

“statePension”: “0”,

“maintenancePayments”: “0”,

“personalIndependencePayment”: “0”,

“universalCredit”: “0”

}

]

}

DELETE /affordability{id} – Delete an affordability search

Parameters – {id} (string)

GET /affordability/{id}/PDF – Request a PDF copy of the returned results

Parameters – {id} (string)

POST /affordability/{id}/PDF – Request a copy of the returned results

Parameters – {id} (string)

Clients

GET /clients – View a list of all current clients

Parameters – None

POST/clients – Create a new client

{

“firstName”: “string”,

“lastName”: “string”,

“middleName”: “string”,

“title”: “Mr”,

“dateOfBirth”: “1991-04-16”,

“active”: true

}

PUT /clients/{id} – Update a client

{

“firstName”: “string”,

“lastName”: “string”,

“middleName”: “string”,

“title”: “Mr”,

“dateOfBirth”: “1991-04-16”,

“active”: true

}

DELETE /clients/{id} – Updates an affordability search

Parameters – {id} (string)

Default

GET / – Root path for testing API connectivity

Parameters – None

Lenders

GET /lenders – View a list of all lenders

Parameters – None

Authentification

All endpoints require authentication. This is done by sending your API key as a “x-api-key” header with every request.

curl -X GET https://api.brokersense.co.uk/ -H ‘x-api-key: API_KEY’

ReQuest Authorisation Code

Get in touch to discuss solutions and request API authorisation