The Benefit API from Smart Pension — 3 operation(s) for benefit.
openapi: 3.2.0
info:
title: Keystone Benefit API
version: v12
description: This is the endpoint description of Keystone API.
servers:
- url: https://api.sandbox.autoenrolment.co.uk
- url: /
tags:
- name: Benefit
paths:
/companies/{company_id}/employees/{employee_id}/benefits:
post:
summary: Employees/Benefits/Create
tags:
- Benefit
security:
- oAuth2:
- user
- employee
parameters:
- name: company_id
in: path
required: true
example: 1443
schema:
type: string
- name: employee_id
in: path
required: true
example: 666
schema:
type: string
requestBody:
content:
application/json:
example:
benefit:
benefit_rule_set_id: 92
request_mode: unit
currency: USD
bank_account_detail:
account_name: my account
bank_name: some bank
country_code: GB
account_number_format: local_bank_account_number
account_number: '12341234'
routing_number: 12-34-56
schema:
type: object
properties:
benefit:
type: object
properties:
requested_benefit_amount: {}
benefit_evidence_uploads_attributes:
type: object
benefit_rule_set_id:
type: integer
request_mode:
type: string
is_mobile:
type: boolean
benefit_subaccount_splits:
type: array
items:
type: object
properties:
percentage:
type: number
subaccount_uuid:
type: string
required:
- percentage
- subaccount_uuid
bank_account_detail:
type: object
properties:
account_name:
type: string
maximum: 255
x-ruby-regexp: (?-mix:\A[a-zA-Z0-9&\/\\\-\s]+\z)
bank_name:
type: string
maximum: 255
country_code:
type: string
account_number:
type: string
account_number_format:
type: string
enum:
- iban
- local_bank_account_number
account_category:
type: string
bank_identifier_code:
type: string
routing_number:
type: string
building_society_roll_number:
type: string
reviewed:
type: boolean
required:
- account_name
- country_code
- account_number_format
currency:
type: string
scheme_currency:
type: string
required:
- benefit_rule_set_id
- bank_account_detail
- currency
responses:
'201':
description: Success
content:
application/json:
example:
id: 26
admin_user_id: null
amount: null
amount_currency: USD
cancelled_at: null
category: something
benefit_type: full
withdrawal_type: benefit
description: null
employee_id: 666
benefit_rule_set_id: 92
state: created
created_at: '2026-08-05T13:05:34.000+01:00'
updated_at: '2026-08-05T13:05:34.000+01:00'
completed_at: null
receiving_contract_reference: null
withdrawal_application_state: pending
id_verification_state: not_applicable
payment_state: pending
request_mode: unit
benefit_check_results: []
schema:
$ref: '#/components/schemas/response_benefit'
'422':
description: Benefit rule set id does not exist
/companies/{company_id}/employees/{employee_id}/benefits/{id}/request_benefit_checks:
post:
summary: Employees/Benefits/RequestBenefitChecks
tags:
- Benefit
security:
- oAuth2:
- user
- employee
parameters:
- name: company_id
in: path
required: true
example: 1448
schema:
type: string
- name: employee_id
in: path
required: true
example: 669
schema:
type: string
- name: id
in: path
required: true
example: 27
schema:
type: string
requestBody:
content:
application/json:
example: null
responses:
'204':
description: No Content
'404':
description: Benefit does not exist
/partners/employees/{employee_id}/transfer_out:
post:
summary: TransferOuts/Create
tags:
- Benefit
security:
- oAuth2: []
parameters:
- name: employee_id
in: path
required: true
example: 804
schema:
type: string
requestBody:
content:
application/json:
example:
benefit:
full_amount: false
currency: GBP
receiving_contract_reference: '921281344'
bank_account_detail:
account_name: my account
country_code: GB
account_number_format: local_bank_account_number
account_number: '12341234'
routing_number: 12-34-56
requested_benefit_amount: 60
schema:
type: object
properties:
benefit:
type: object
properties:
description:
type: string
requested_benefit_amount: {}
receiving_contract_reference:
type: string
full_amount:
type: boolean
is_mobile:
type: boolean
bank_account_detail:
type: object
properties:
account_name:
type: string
maximum: 255
x-ruby-regexp: (?-mix:\A[a-zA-Z0-9&\/\\\-\s]+\z)
bank_name:
type: string
maximum: 255
country_code:
type: string
account_number:
type: string
account_number_format:
type: string
enum:
- iban
- local_bank_account_number
account_category:
type: string
bank_identifier_code:
type: string
routing_number:
type: string
building_society_roll_number:
type: string
reviewed:
type: boolean
required:
- account_name
- country_code
- account_number_format
currency:
type: string
scheme_currency:
type: string
required:
- bank_account_detail
- currency
responses:
'201':
description: Success
content:
application/json:
example:
id: 78
admin_user_id: null
amount: null
amount_currency: GBP
cancelled_at: null
category: something
benefit_type: partial
withdrawal_type: transfer_out
description: null
employee_id: 804
benefit_rule_set_id: 149
state: created
created_at: '2026-08-05T13:06:40.000+01:00'
updated_at: '2026-08-05T13:06:40.000+01:00'
completed_at: null
receiving_contract_reference: '921281344'
withdrawal_application_state: pending
id_verification_state: not_applicable
payment_state: pending
request_mode: monetary
bank_account_detail:
id: 77
routing_number: 12-34-56
account_number: '12341234'
building_society_roll_number: null
account_name: my account
country_code: GB
created_at: '2026-08-05T13:06:40.000+01:00'
updated_at: '2026-08-05T13:06:40.000+01:00'
account_number_format: local_bank_account_number
cancelled_at: null
reviewed: null
account_category: scheme
expires_on: '2027-08-05'
benefit_check_results: []
'422':
description: Ineligible benefit
components:
schemas:
response_band:
type: object
properties:
id:
type: integer
employee_minimum_percentage:
type: number
format: float
employee_maximum_percentage:
type:
- number
- 'null'
format: float
employer_percentage:
type: number
format: float
starts_on:
type: string
format: date
ends_on:
type: string
format: date
range_min:
type:
- integer
- 'null'
range_max:
type:
- integer
- 'null'
default:
type: boolean
response_scheme_contribution_limit:
type: object
properties:
minimum_one_off_contribution_amount:
type: number
format: float
minimum_one_off_contribution_amount_currency:
type: string
maximum_one_off_contribution_amount:
type: number
format: float
maximum_one_off_contribution_amount_currency:
type: string
minimum_recurring_contribution_amount:
type: number
format: float
minimum_recurring_contribution_amount_currency:
type: string
response_adviser:
type: object
properties:
intercom_user_id:
type:
- string
- 'null'
intercom_user_id_hash:
type:
- string
- 'null'
id:
type: integer
name:
type:
- string
- 'null'
type:
type:
- string
- 'null'
address:
type:
- string
- 'null'
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
signup_start:
type:
- string
- 'null'
format: text
signup_finish:
type:
- string
- 'null'
format: text
agent_number:
type:
- string
- 'null'
broker_channel:
type:
- string
- 'null'
broker_role:
type:
- string
- 'null'
abilities:
type:
- array
- 'null'
items: {}
companies:
type: object
properties:
limit:
type:
- integer
- 'null'
offset:
type:
- integer
- 'null'
total:
type:
- integer
- 'null'
links:
type: array
items:
$ref: '#/components/schemas/link'
companies:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/response_company'
imports:
type: object
properties:
limit:
type:
- integer
- 'null'
offset:
type:
- integer
- 'null'
total:
type:
- integer
- 'null'
links:
type: array
items:
$ref: '#/components/schemas/link'
data:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/response_adviser_import'
company_tax_reliefs:
type: object
properties:
limit:
type:
- integer
- 'null'
offset:
type:
- integer
- 'null'
total:
type:
- integer
- 'null'
links:
type: array
items:
$ref: '#/components/schemas/link'
data:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/response_company_tax_relief'
shortcut:
$ref: '#/components/schemas/response_adviser_shortcut'
response_salary:
type: object
properties:
annual_earnings_1:
type:
- number
- 'null'
format: float
annual_earnings_2:
type:
- number
- 'null'
format: float
created_at:
type: string
format: date-time
effective_on:
type: string
format: date
employee_id:
type: integer
id:
type: integer
updated_at:
type: string
format: date-time
employee:
$ref: '#/components/schemas/response_employee'
response_company_automation:
type: object
properties:
id:
type: integer
letter:
type: boolean
company_id:
type: integer
postponement_period:
type:
- string
- 'null'
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
links:
type: array
items:
$ref: '#/components/schemas/link'
response_know_your_customer_data:
type: object
properties:
id:
type: integer
state:
type: string
reference:
type:
- string
- 'null'
response_ultimate_beneficial_owner_configuration:
type: object
properties:
id:
type: integer
company_id:
type: integer
exempt:
type: boolean
exemption_reason:
type:
- string
- 'null'
natural_person_ubo:
type: boolean
links:
type: array
items:
$ref: '#/components/schemas/link'
response_adviser_company:
type: object
properties:
id:
type: integer
adviser_id:
type: integer
company_id:
type: integer
preferred_contact_user_id:
type:
- integer
- 'null'
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
response_customer:
type: object
properties:
intercom_user_id:
type:
- string
- 'null'
intercom_user_id_hash:
type:
- string
- 'null'
id:
type: integer
email:
type:
- string
- 'null'
reset_password_sent_at:
type:
- string
- 'null'
format: date-time
remember_created_at:
type:
- string
- 'null'
format: date-time
last_sign_in_at:
type:
- string
- 'null'
format: date-time
slug:
type:
- string
- 'null'
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
gauth_enabled:
type: boolean
gauth_tmp:
type:
- string
- 'null'
forename:
type:
- string
- 'null'
surname:
type:
- string
- 'null'
title:
type:
- string
- 'null'
authentication_token:
type:
- string
- 'null'
date_of_birth:
type:
- string
- 'null'
format: date
line2:
type:
- string
- 'null'
city:
type:
- string
- 'null'
county:
type:
- string
- 'null'
building_name:
type:
- string
- 'null'
postcode:
type:
- string
- 'null'
line1:
type:
- string
- 'null'
building_number:
type:
- string
- 'null'
telephone:
type:
- string
- 'null'
alternative_telephone:
type:
- string
- 'null'
referee_id:
type:
- integer
- 'null'
referee_type:
type:
- string
- 'null'
referral_state:
type: string
referral_clicks:
type:
- integer
- 'null'
referral_reward_name:
type:
- string
- 'null'
authentication_token_generated_at:
type:
- string
- 'null'
format: date-time
gender:
type:
- string
- 'null'
role:
type:
- string
- 'null'
middlename:
type:
- string
- 'null'
envelope_state:
type: string
enforce_password:
type:
- boolean
- 'null'
company_id:
type:
- integer
- 'null'
country_code:
type:
- string
- 'null'
uuid:
type: string
preferred_locale:
type:
- string
- 'null'
smart_analytics_access_permitted:
type:
- boolean
- 'null'
links:
type: array
items:
$ref: '#/components/schemas/link'
company:
$ref: '#/components/schemas/response_company'
employee:
$ref: '#/components/schemas/response_employee'
shortcut:
$ref: '#/components/schemas/response_customer_shortcut'
marketing_preference:
$ref: '#/components/schemas/response_marketing_preference'
response_payment:
type: object
properties:
id:
type: integer
state:
type: string
amount:
type:
- number
- 'null'
format: float
description:
type:
- string
- 'null'
invoice_name:
type:
- string
- 'null'
paid_at:
type:
- string
- 'null'
format: date-time
charge_on:
type:
- string
- 'null'
format: date
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
invoice_url:
type:
- string
- 'null'
invoice_details_url:
type:
- string
- 'null'
invoice_details_file_name:
type:
- string
- 'null'
source_of_funds:
type:
- string
- 'null'
response_employee_plan_participation:
type: object
properties:
id:
type: integer
in_waiting_period:
type:
- boolean
- 'null'
next_state:
type:
- string
- 'null'
updated_at:
type: string
format: date-time
state:
type: string
response_letter:
type: object
properties:
id:
type: integer
subject:
type:
- string
- 'null'
name:
type:
- string
- 'null'
employee_id:
type:
- integer
- 'null'
read:
type:
- boolean
- 'null'
file_url:
type:
- string
- 'null'
file_file_name:
type:
- string
- 'null'
created_at:
type:
- string
- 'null'
format: date-time
updated_at:
type:
- string
- 'null'
format: date-time
cancelled_at:
type:
- string
- 'null'
format: date-time
created_by_id:
type:
- integer
- 'null'
created_by_type:
type:
- string
- 'null'
send_employee_temporary_password_notification:
type:
- boolean
- 'null'
links:
type: array
items:
$ref: '#/components/schemas/link'
employee:
$ref: '#/components/schemas/response_employee'
response_base_payroll_configuration:
type: object
properties:
id:
type: integer
company_id:
type: integer
description:
type:
- string
- 'null'
frequency:
type: string
name:
type: string
salary_rate:
type: string
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
uuid:
type: string
links:
type: array
items:
$ref: '#/components/schemas/link'
response_company_tax_relief:
type: object
properties:
id:
type: integer
basis_type:
type: string
response_beneficiary:
type: object
properties:
id:
type: integer
title:
type: string
name:
type: string
email:
type:
- string
- 'null'
address:
type: string
postcode:
type:
- string
- 'null'
relation:
type: string
percentage:
type: number
format: float
born_on:
type: string
format: date
type:
type: string
response_adviser_import:
type: object
properties:
id:
type: integer
status_code:
type:
- integer
- 'null'
state:
type: string
response_errors:
type:
- array
- 'null'
items: {}
file_url:
type:
- string
- 'null'
file_file_name:
type:
- string
- 'null'
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
type:
type:
- string
- 'null'
metadata:
type:
- object
- 'null'
success_row_count:
type:
- integer
- 'null'
fail_row_count:
type:
- integer
- 'null'
adviser_id:
type: integer
links:
type: array
items:
$ref: '#/components/schemas/link'
adviser:
$ref: '#/components/schemas/response_adviser'
response_provider_scheme_migration:
type: object
properties:
id:
type: integer
state:
type: string
response_valuation:
type: object
properties:
id:
type: integer
amount:
type:
- number
- 'null'
format: float
calculated_on:
type: string
format: date
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
response_benefit_check_result:
type: object
properties:
id:
type: integer
benefit_id:
type: integer
state:
type: string
redirect_url:
type:
- string
- 'null'
has_redirect_url:
type:
- boolean
- 'null'
returned_back_at:
type:
- string
- 'null'
format: date-time
comment:
type:
- string
- 'null'
format: text
automated_checks_available:
type: boolean
response_benefit_group:
type: object
properties:
id:
type: integer
name:
type: string
employee_contribution_holiday_permitted:
type: boolean
company_contribution_holiday_permitted:
type: boolean
band_range_type:
type:
- string
- 'null'
employer_earnings_type:
type: string
employee_earnings_type:
type: string
employer_salary_cap:
type:
- number
- 'null'
format: float
employee_salary_cap:
type:
- number
- 'null'
format: float
voluntary_enrolment:
type: boolean
profit_share_allowed:
type: boolean
contribution_match_type:
type:
- string
- 'null'
stop_contributions_permitted:
type: boolean
national_insurance_saving_share:
type:
- number
- 'null'
format: float
enrolment_type:
type:
- string
- 'null'
bands:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/response_band'
response_scheme_tax_relief:
type: object
properties:
id:
type: integer
basis_type:
type: string
response_scheme_bank_detail:
type: object
properties:
account_number:
type:
- string
- 'null'
bank_name:
type: string
swift_code:
type: string
in_favor_of:
type: string
currency:
type:
- string
- 'null'
exchange_rate:
type:
- number
- 'null'
format: float
response_adviser_shortcut:
type: object
properties:
id:
type: integer
token:
type:
- string
- 'null'
destination_url:
type:
- string
- 'null'
short_url:
type:
- string
- 'null'
response_employee_configuration:
type: object
properties:
benefits_out_suspended:
type: boolean
disabled_switching:
type:
- boolean
- 'null'
enable_auto_increase_percentage:
type: boolean
gone_away:
type: boolean
id:
type: integer
investments_locked:
type: boolean
valuation_under_review:
type:
- boolean
- 'null'
preferred_currency:
type:
- string
- 'null'
preferred_locale:
type:
- string
- 'null'
blocked_rejoin:
type: boolean
response_employee:
type: object
properties:
updatable:
type:
- boolean
- 'null'
id:
type: integer
email:
type:
- string
- 'null'
forename:
type:
- string
- 'null'
surname:
type:
- string
- 'null'
date_of_birth:
type:
- string
- 'null'
format: date
national_insurance_number:
type:
- string
- 'null'
gender:
type: string
telephone:
type:
- string
- 'null'
identity_person_id:
type:
- string
- 'null'
reset_password_sent_at:
type:
- string
- 'null'
format: date-time
remember_created_at:
type:
- string
- 'null'
format: date-time
last_sign_in_at:
type:
- string
- 'null'
format: date-time
slug:
type:
- string
- 'null'
created_at:
type:
- string
- 'null'
format: date-time
updated_at:
type:
- string
- 'null'
format: date-time
confirmation_token:
type:
- string
- 'null'
gauth_enabled:
type:
- boolean
- 'null'
gauth_tmp:
type:
- string
- 'null'
title:
type:
- string
- 'null'
authentication_token:
type:
- string
- 'null'
group_id:
type:
- integer
- 'null'
line2:
type:
- string
- 'null'
city:
type:
- string
- 'null'
region:
type:
- string
- 'null'
postcode:
type:
- string
- 'null'
line1:
type:
- string
- 'null'
works_in_uk:
type: boolean
starts_on:
type:
- string
- 'null'
format: date
authentication_token_generated_at:
type:
- string
- 'null'
format: date-time
company_percentage:
type:
- number
- 'null'
format: float
company_percentage_matched:
type:
- number
- 'null'
format: float
company_match:
type: boolean
percentage:
type:
- number
- 'null'
format: float
avc_percentage:
type:
- number
-
# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/smart-pension/refs/heads/main/openapi/smart-pension-benefit-api-openapi.yml