v1

latestSwagger 2.02026-08-047766481.4 KB

affordability

Request affordability income calculation for a user

Requires affordability_income:write and affordability_income:read scopes.

post/affordability/income

Request body

externalUserIdstring

Your reference ID for the user or individual affordability income check. The same value could be assigned to all reports created as part of the same affordability income check's lifecycle, for example

namestring

The full name of the user to whom the affordability income check applies

emailstring

The email address of the user to whom the affordability income check applies

Example request

{
  "externalUserId": "LENDERNAME-123",
  "name": "Joe Bloggs",
  "email": "joe.blogss@example.com"
}

Response

Successful Affordability Income Response

metaobject

Example response

{
  "data": {
    "createdAt": "2022-01-01T00:00:00Z",
    "id": "d372d09b-f50a-4114-9c83-687828fa8ac2",
    "income": {
      "amountConsistency": 1,
      "longevity": {
        "consecutiveIncomeMonths": 12,
        "incomePeriodLengthMonths": 12
      },
      "predicted": {
        "value": 189900,
        "majorUnits": 1899,
        "minorUnits": 0,
        "currency": "GBP"
      },
      "regularIncomeDetected": true
    },
    "overview": {
      "income": {
        "value": 189900,
        "majorUnits": 1899,
        "minorUnits": 0,
        "currency": "GBP"
      },
      "incomeIncludingTransfers": {
        "value": 210000,
        "majorUnits": 2100,
        "minorUnits": 0,
        "currency": "GBP"
      }
    },
    "primaryIncomeAccountId": "ac9bd177-d01e-449c-9f29-d3656d2edc2e"
  }
}