How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Smart Pension Benefit Form API

The BenefitForm API from Smart Pension — 9 operation(s) for benefitform.

Smart Pension Benefit Form API is one of 149 APIs that Smart Pension publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include BenefitForm. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and a support channel.

This API exposes 15 operations across 9 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version v12.

Requests are made against 2 base URLs: https://api.sandbox.autoenrolment.co.uk, /.

15 operations 9 paths 6 schemas 1 DELETE3 GET4 PATCH5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v12
Base URL
https://api.autoenrolment.co.uk
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Smart Pension Benefit Form API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oAuth2) using the authorizationCode flow, exposing 3 scopes.

Paths & Operations 15

Across 9 paths, the API surfaces 15 operations — 1 DELETE, 3 GET, 4 PATCH, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

BenefitForm 15
PATCH
/companies/{company_id}/employees/{employee_id}/benefit_form/benefit_evidence_uploads/confirm_all
BenefitEvidenceUploads/ConfirmAll
2 params body → 204404
POST
/companies/{company_id}/employees/{employee_id}/benefit_form/benefit_evidence_uploads
BenefitEvidenceUploads/Create
2 params body → 201422
GET
/companies/{company_id}/employees/{employee_id}/benefit_form/benefit_evidence_uploads
BenefitEvidenceUploads/Get
2 params → 200404
DELETE
/companies/{company_id}/employees/{employee_id}/benefit_form/benefit_evidence_uploads/{benefit_evidence_upload_id}
BenefitEvidenceUploads/Destroy
3 params → 204404
PUT
/companies/{company_id}/employees/{employee_id}/benefit_form/benefit_evidence_uploads/{benefit_evidence_upload_id}
BenefitEvidenceUploads/Update
3 params body → 204422
PATCH
/companies/{company_id}/employees/{employee_id}/benefit_form/benefit_evidence_uploads/{benefit_evidence_upload_id}
BenefitEvidenceUploads/Update
3 params body → 204422
PATCH
/companies/{company_id}/employees/{employee_id}/benefit_form/benefit_question_responses/
BenefitQuestionResponses/Update
2 params body → 204403
POST
/companies/{company_id}/employees/{employee_id}/benefit_form/cancel
BenefitForms/Cancel
2 params body → 200404
POST
/companies/{company_id}/employees/{employee_id}/benefit_categories/{benefit_category_id}/benefit_form
BenefitForms/Create
3 params body → 201403
PUT
/companies/{company_id}/employees/{employee_id}/benefit_categories/{benefit_category_id}/benefit_form
BenefitForms/Update
3 params body → 204404422
PATCH
/companies/{company_id}/employees/{employee_id}/benefit_categories/{benefit_category_id}/benefit_form
BenefitForms/Update
3 params body → 204404422
POST
/companies/{company_id}/employees/{employee_id}/benefit_form/verification_url
BenefitForms/GenerateVerificationUrl
2 params body → 200
GET
/companies/{company_id}/employees/{employee_id}/benefit_form/verification_url
BenefitForms/VerificationUrl
2 params → 200
GET
/companies/{company_id}/employees/{employee_id}/benefit_form
BenefitForms/Get
2 params → 200404
POST
/companies/{company_id}/employees/{employee_id}/benefit_form/submit
BenefitForms/Submit
2 params body → 200403

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are response_benefit_form (14 properties), response_benefit_evidence_upload (9 properties), response_benefit_question_response (3 properties), link (3 properties). Each schema is shown below with its type and property counts.

response_benefit_evidence_upload
object
9 properties
link
object
3 properties
response_task_list
object
2 properties
response_benefit_question_response
object
3 properties
response_benefit_form
object
14 properties
response_benefit_question
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

smart-pension-benefitform-api-openapi.yml Raw ↑

Other APIs Smart Pension publishes across the network.

Smart Pension Account Claiming API
Smart Pension Accounts API
Smart Pension Account Subaccounts Switch Plans API
Smart Pension Additional Tax Residences API
Smart Pension Add Money Forms API
Smart Pension Adviser API
Smart Pension Adviser Companies API
Smart Pension Adviser Exports API
Smart Pension Adviser Invitations API
Smart Pension Advisers API
Smart Pension Assessments API
Smart Pension Available Funds API
Where this information came from

This is an independent, third-party profile of Smart Pension Benefit Form API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.