Pre-submission checks: affordability application salary

Endpoint

POST /affordability/pre-submission-checks/{widgetId}/restricted

Existing route scopes are unchanged (caller must hold one of the restricted widget read scopes). Sending application salary requires an additional client scope.

Scope

affordability_application_salary:write — required only when affordabilityApplicationSalary is present in the request body. If the field is omitted or null, this scope is not required.

Without the scope, requests that include affordabilityApplicationSalary receive 403 Forbidden.

Request body (additive)

Field	Type	Required	Notes
`incomeThreshold`	string or null	Unchanged	Major units (pounds), string — not converted by the gateway
`affordabilityApplicationSalary`	object	Optional	Partner-declared gross annual income for the application

`affordabilityApplicationSalary`

{
  "affordabilityApplicationSalary": {
    "value": 3200000,
    "currency": "GBP"
  }
}

value: positive integer in minor units (pence for GBP). Example: 3200000 = £32,000.
currency: must be GBP.
null is treated as absent (field not sent).

Invalid values return 400 Bad Request (non-object, non-integer pence, zero, negative, or non-GBP currency).

Example

POST /affordability/pre-submission-checks/{widgetId}/restricted
Authorization: Bearer <token with restricted read scope and affordability_application_salary:write>

{
  "incomeThreshold": "25000",
  "affordabilityApplicationSalary": {
    "value": 3200000,
    "currency": "GBP"
  }
}