api.isSupported

Synopsis Indicates whether the admin account is supported by the Payroll Integration API.
Where used

/accounts response

The Payroll Integration API does not yet support all the types of admin account that The People’s Pension and B&CE offer, or have offered in the past. The /accounts operation returns a collection of all the accounts that a user has access to; within the response this mandatory field indicates those admin accounts that the API supports.

Accounts that are not supported by the Payroll Integration API can be managed using employer Online Services. The Payroll Integration API does not currently support:

  • Contractual enrolment accounts, where the employer is contributing to the pension outside of their auto-enrolment duties.
  • Accounts that have Employee Accident Cover and/or Employee Life Cover.
  • The People’s Pension accounts that follow the Construction Industry Joint Council (CIJC) Working Rule Agreement.
  • EasyBuild accounts: these are an older B&CE pension product, separate from The People’s Pension. EasyBuild accounts were closed to contributions on 1 September 2017.
  • Accounts for which your application would need The People’s Pension to perform assessment.

For these accounts, this field will be false and the reason field will contain an explanation.

Data type

Boolean

Example

...
"api": {
"isSupported": true
},
...

See also

api.reason

hasContractualEnrolment

hasEmployeeAccidentOrLifeCover