Sign in

v1

latestOpenAPI 3.0.32026-07-138219.6 KB
UK Savings Account

Update a UK Savings Account name

This endpoint allows a developer to update UK savings account information. A National Insurance number and savings account ID must be provided.

Test data

Scenario simulation using Gov-Test-Scenario headers is only available in the sandbox environment.

Header Value (Gov-Test-Scenario)Scenario
N/A - DEFAULTSimulates success response.
NOT_FOUNDSimulates the scenario where no data is found.
REQUEST_CANNOT_BE_FULFILLEDSimulates the scenario where the request cannot be fulfilled for various reasons other than the ones triggering other errors.
STATEFULPerforms a stateful update.
put/individuals/savings-income/uk-accounts/{nino}/account-name/{savingsId}

Path parameters

ninostring required
Example:TC663795B

National Insurance number, in the format AA999999A

savingsAccountIdstring required
Example:SAVKB2UVwUTBQGJ

The unique identifier of the savings account.

Headers

Accept'application/vnd.hmrc.2.0+json' required

Specifies the response format and the version of the API to be used.

Content-Type'application/json' required

Specifies the format of the request body, which must be JSON.

Authorizationstring required
Example:Bearer bb7fed3fe10dd235a2ccda3d50fb

An OAuth 2.0 Bearer Token with the write:self-assessment scope.

Gov-Test-Scenariostring

Only in sandbox environment. See Test Data table for all header values.

Request body

accountNamestring required

Friendly account name. Must not be empty or contain only whitespace.

Example request

{
  "accountName": "Shares savings account"
}

Response

Success (No Content)