address

Synopsis The employee's address.
Where used

/contributions request

The address is an object that represents a postal address.

The first line of the address must be provided as line1, and two other lines must be provided as well (for example, line1, line2, and line5). If a postcode is provided as the value of line5 then this will be validated, otherwise all the fields of the address will be accepted as-is.

An employee’s address will only be updated when the new address provided in a /contributions request is not one that has previously been used for the employee, and is not one that has been marked as returned or gone away.

Data type

Address: an object representing a postal address

Example

...
"address": {
"line1": "59 Frensham Close",
"line2": "Banbury",
"line3": "Oxon",
"line5": "OX16 1FQ"
},
...

Related errors

D/J01 – line1 is missing

D/J02 – line1 exceeds 50 characters

D/J03 – at least three address lines must be completed

D/J04 – address must contain at least 15 characters

D/K01 – line2 exceeds 50 characters

D/L01 – line3 exceeds 50 characters

D/M01 – line4 exceeds 50 characters

D/N01 – line5 exceeds 25 characters

See also

Address line1

Address line2

Address line3

Address line4

Address line5