Skip to main content
PUT
Create Address Edition

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Headers

If-Match
string | null
If-None-Match
string | null
X-Acting-User
string | null

The person acting through the access credential, recorded as created_by of what the request writes. Audit only: access is checked on the credential.

Required string length: 1 - 255

Path Parameters

organization_id
string
required
employee_id
string
required

Body

application/json
address_line_1
string
required

First address line

Required string length: 1 - 35
Example:

"10 Downing Street"

address_line_2
string
required

Second address line

Required string length: 1 - 35
Example:

"Westminster"

address_line_3
string | null
required

Third address line; null when none

Required string length: 1 - 35
address_line_4
string | null
required

Fourth address line; null when none

Required string length: 1 - 35
country
string
required

Country of residence, ISO 3166-1 alpha-2 code

Pattern: ^\w{2}$
Example:

"GB"

county
string | null
required

County, at most 35 characters, as an address line: filed to HMRC after the town when one of the four is free; null when none

Required string length: 1 - 35
postcode
string | null
required

Postcode. Required for GB, JE, GG and IM and stored in canonical form (SW1A 2AA); optional for other countries, where it is kept as sent

Example:

"SW1A 2AA"

town
string
required

Town or city, at most 35 characters, as an address line: filed to HMRC after the lines when one of the four is free

Required string length: 1 - 35
Example:

"London"

valid_from
string<date>
required
valid_to
string<date>
required

Response

Successful Response

created_at
string<date-time>
required
read-only
created_by
string
required
read-only

Who wrote the edition: the acting user (X-Acting-User, else the access credential), system for our own writes, or <authority>:<notice> for a write on an authority's behalf, e.g. hmrc:P6.

edition
integer
required
read-only
valid_from
string<date>
required
valid_to
string<date>
required
address_line_1
string | null
address_line_2
string | null
address_line_3
string | null
address_line_4
string | null
country
string | null
county
string | null
postcode
string | null
town
string | null