Sign in
latestOpenAPI 3.0.12026-08-108798310.5 KB

fa1a72b9ecec

Addresses

Update the account holder's current address

post/api/v2/addresses

Request body

line1string required
line2string
line3string
postTownstring required
postCodestring required
countryCodestring required

Country code in ISO 3166-1 alpha-2. NB GB is the official country code for the UK. UK is not the officially assigned code, and so is not valid

udprnstring

The UDPRN of the property

umprnstring

The UMPRN of the property

fromstring date required

Date the account holder's residency at this address started

Example request

{
  "line1": "1A Admiralty Arch",
  "line2": "The Mall",
  "line3": "City of Westminster",
  "postTown": "London",
  "postCode": "SW1A 2WH",
  "countryCode": "GB",
  "udprn": "23748063",
  "umprn": "923827402",
  "from": "2023-01-01"
}

Response

Successful operation