| 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 true when the scheme is connected to NEST and the employer has the IncomingPensionApi beta feature flag enabled; the server coerces this to false when those preconditions are not met. |
boolean
|
true
|
|
businessError
|
string
|
"string"
|
|
lastOptOutSuccessAt
|
string
date
|
"2026-08-26"
|
|
lastStoppedContributionsSuccessAt
|
string
date
|
"2026-08-26"
|
|
lastRefundSuccessAt
|
string
date
|
"2026-08-26"
|
|
id
The unique id of the object
|
string
uuid
|
"string"
|
{
"incomingRetrieveEnabled": true,
"businessError": "string",
"lastOptOutSuccessAt": "2026-08-26",
"lastStoppedContributionsSuccessAt": "2026-08-26",
"lastRefundSuccessAt": "2026-08-26",
"id": "string"
}