surname
Synopsis | The employee's last name. |
Where used | /contributions request /accounts/.../opt-outs response |
The employee’s surname is a mandatory field in the /contributions request. The value provided will be returned in the /accounts/…/opt-outs response if the employee opts out of the scheme.
Surname values are cleaned to normalise case and formatting (for example, “SMITH” will be changed to “Smith”).
Data type | String |
Constraints/format | minLength: 2 Can include up to one apostrophe, up to four hyphens, and up to four spaces. |
Example | ... Other valid values would be "Jones", "Wright-Phillips", "Eaton Williams", "O’Donnell" |
Related errors |
D/F01 – value is missing D/F02 – length is more than 45 characters D/F03 – length is less than 2 characters D/F04 – can contain only 1 apostrophe D/F05 – has more than 4 hyphens D/F06 – has more than 4 spaces D/F07 – cannot contain special characters |
See also |