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
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
string
required

The address as one string, lines separated by commas or new lines. FPS files the first four lines.

Minimum string length: 1
Example:

"10 Downing Street, London, SW1A 2AA"

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

Response

Successful Response

edition
integer
required
read-only
valid_from
string<date>
required
valid_to
string<date>
required
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.

address
string | null