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

# Request affordability calculation for a user

`POST /affordability`

## Request

- Base URL: `https://api.moneyhub.co.uk/v3`
- URL: `https://api.moneyhub.co.uk/v3/affordability`
- Auth: API key in header `Authorization`

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

## Request body

- AffordabilityPost
  - `externalUserId` string: Your reference ID for the user or individual affordability application. The same value could be assigned to all reports created as part of the same affordability application's lifecycle, for example
  - `name` string: The full name of the user to whom the affordability application applies
  - `email` string: The email address of the user to whom the affordability application applies

## Response `200`

Successful Affordability 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.dev/moneyhubenterprise/apis/moneyhub-data-api-v3.md) - [All operations](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-data-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/moneyhubenterprise/apis/moneyhub-data-api-v3/revisions/2e08b5dbee56?raw)