Contract.PensionNoticeSettingsRequest

Settings controlling automatic retrieval of incoming pension notices for a scheme.

Schema

Name / Description Type / Format Example
incomingRetrieveEnabled
Whether the scheme is opted in to automatically retrieving opt-outs
and ceased contributions from NEST and applying them to employee records.
May only be set to true when the provider is NEST, NEST is connected, and the
IncomingPensionApi employer feature flag is enabled; the server coerces this to
false when those preconditions are not met.
 boolean true

JSON Example 

{
  "incomingRetrieveEnabled": true
}

References

Contained in Models
Contract.PensionSchemeRequest
Consumed by Operations

- none -

Returned by Operations

- none -