forename

Synopsis The employee's first name.
Where used

/contributions request

/accounts/.../opt-outs response

The employee’s forename 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.

Forename values are cleaned to normalise case and formatting (for example, “john” will be changed to “John”).

Data type

String

Constraints/format

minLength: 1
maxLength: 30

Can include up to one apostrophe, up to four hyphens, and up to four spaces.

Example

...
"forename": "Laura",
...

Other valid values would be "John", "John-Paul", "John Paul", "John-Paul O’Grady"

Related errors

D/D01 – value is missing

D/D02 – cannot contain numbers

D/D03 – length is more than 30 characters

D/D04 – can contain only 1 apostrophe

D/D05 – has more than 4 hyphens

D/D06 – has more than 4 spaces

D/D07 – cannot contain special characters

See also

title

middleName

surname

optOuts