homePhoneNumber

Synopsis The employee's home phone number.
Where used

/contributions request

The employee’s home phone number is an optional field in the /contributions request.

The phone number provided may be used if we ever need to get in touch with the employee (for example, if an annual statement we post to them is returned to us undelivered, or there are issues with a retirement claim).

As the employee’s relationship with us may outlive their period of employment with the employer, we prefer this to be a home phone number.

If the value provided fails validation it will be treated as though the value was blank, and no error will be reported.

Data type

String

Constraints/format

maxLength: 20
pattern: '[0-9 ]{0,20}'

Example

...
"homePhoneNumber": "01604 867 575",
...

See also

mobilePhoneNumber

personalEmailAddress