---
title: "Request affordability income calculation for a user"
method: POST
path: "/affordability/income"
tags: ["affordability"]
---

# Request affordability income calculation for a user

`POST /affordability/income`

Requires **affordability_income:write** and **affordability_income:read** scopes.

## Request body

- AffordabilityIncomePost
  - `externalUserId` string — 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
  - `name` string — The full name of the user to whom the affordability income check applies
  - `email` string — The email address of the user to whom the affordability income check applies

## Response `200`

Successful Affordability Income Response

- object
  - `data` object
    - `id` string, required — The report id
    - `status` 'pending', required — Whether the report is 'complete', 'pending' or 'failed'. This will always be 'pending' when using this endpoint.
  - `links` Links
    - `next` string, uri — The url to retrieve the next page of results from
    - `prev` string, uri — The url to retrieve the previous page of results from
    - `self` string, uri, required — The url of the current resource(s)
  - `meta` object

## Other responses

- `401` — Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token
- `403` — Unsuccessful Response - Forbidden - Invalid scopes
- `404` — Unsuccessful Response - Resource Not found

---

[API](https://skmtc.net/moneyhubenterprise/apis/moneyhub-identity-service.md) · [All operations](https://skmtc.net/moneyhubenterprise/apis/moneyhub-identity-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moneyhubenterprise/moneyhub-identity-service/revisions/8841721f7aae/schema)