Smart Pension Expression Of Wish API

openapi: 3.2.0
info:
  title: Keystone Expression Of Wish API
  version: v12
  description: This is the endpoint description of Keystone API.
servers:
- url: https://api.sandbox.autoenrolment.co.uk
- url: /
tags:
- name: ExpressionOfWish
paths:
  /companies/{company_id}/employees/{employee_id}/expression_of_wish:
    post:
      summary: Companies/Employees/ExpressionOfWish/Create
      tags:
      - ExpressionOfWish
      security:
      - oAuth2:
        - customer
      parameters:
      - name: company_id
        in: path
        required: true
        example: 619
        schema:
          type: string
      - name: employee_id
        in: path
        required: true
        example: 289
        schema:
          type: string
      requestBody:
        content:
          application/json:
            examples:
              valid_request:
                value:
                  expression_of_wish:
                    beneficiaries:
                    - born_on: '2000-10-02'
                      title: Lady
                      name: Carolyn
                      email: rwood@kwinu.mil
                      address: 2836 Darwin Road
                      postcode: 67271-7963
                      relation: Friend
                      percentage: 100
                      type: primary
              invalid_parameters:
                value:
                  expression_of_wish:
                    beneficiaries:
                    - born_on: '2001-08-05T13:00:54.272+01:00'
                      title: Bursar
                      name: Scott
                      email: dmason@ainyx.org
                      address: 9 Lake View Center
                      postcode: '82242'
                      relation: Friend
                      percentage: 999
                      type: primary
            schema:
              type: object
              properties:
                expression_of_wish:
                  type: object
                  properties:
                    beneficiaries:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          born_on:
                            type: string
                          title:
                            type: string
                          name:
                            type: string
                          email:
                            type: string
                          address:
                            type: string
                          postcode:
                            type: string
                          relation:
                            type: string
                          percentage:
                            type: number
                          type:
                            type: string
                          _destroy:
                            type: string
                    contingent_beneficiaries:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          born_on:
                            type: string
                          title:
                            type: string
                          name:
                            type: string
                          email:
                            type: string
                          address:
                            type: string
                          postcode:
                            type: string
                          relation:
                            type: string
                          percentage:
                            type: number
                          type:
                            type: string
                          _destroy:
                            type: string
                    follow_local_law:
                      type: boolean
      responses:
        '201':
          description: Creates an expression of wish
          content:
            application/json:
              example:
                id: 1
                employee_id: 289
                created_at: '2026-08-05T13:00:54.000+01:00'
                updated_at: '2026-08-05T13:00:54.000+01:00'
                follow_local_law: false
                beneficiaries:
                - id: 1
                  title: Lady
                  name: Carolyn
                  email: rwood@kwinu.mil
                  address: 2836 Darwin Road
                  postcode: 67271-7963
                  relation: Friend
                  percentage: 100
                  born_on: '2000-10-02'
                  type: primary
                contingent_beneficiaries: []
              schema:
                $ref: '#/components/schemas/response_expression_of_wish'
        '422':
          description: Invalid parameters
          content:
            application/json:
              example:
                errors:
                - code: 2410
                  title: Percentage must be less than or equal to 100.
                  detail: You need to enter a percentage which must be a numerical value greater than or equal to 1 and less than or equal to 100.
                  meta:
                    value: '999.0'
                    count: 100
                  source:
                    pointer: /data/relationships/beneficiaries/0/attributes/percentage
                - code: 2301
                  title: Total percentage is not valid.
                  detail: The sum of the percentages has to equal 100 percent.
                  meta:
                    numeric_attribute: percentage
                    expected_sum: 100
                  source:
                    pointer: /data
    get:
      summary: Companies/Employees/ExpressionOfWish/Get
      tags:
      - ExpressionOfWish
      security:
      - oAuth2:
        - customer
      parameters:
      - name: company_id
        in: path
        required: true
        example: 623
        schema:
          type: string
      - name: employee_id
        in: path
        required: true
        example: 293
        schema:
          type: string
      - name: include[]
        in: query
        schema:
          type: array
          items:
            enum:
            - employee
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              examples:
                success:
                  value:
                    id: 2
                    employee_id: 291
                    created_at: '2026-08-05T13:00:54.000+01:00'
                    updated_at: '2026-08-05T13:00:54.000+01:00'
                    follow_local_law: false
                    beneficiaries: []
                    contingent_beneficiaries: []
                success_with_client_credentials_token:
                  value:
                    id: 3
                    employee_id: 293
                    created_at: '2026-08-05T13:00:55.000+01:00'
                    updated_at: '2026-08-05T13:00:55.000+01:00'
                    follow_local_law: false
                    beneficiaries: []
                    contingent_beneficiaries: []
              schema:
                $ref: '#/components/schemas/response_expression_of_wish'
        '401':
          description: Unauthorized
        '404':
          description: Not Found
    put:
      summary: Companies/Employees/ExpressionOfWish/Update
      tags:
      - ExpressionOfWish
      security:
      - oAuth2:
        - employee
      parameters:
      - name: company_id
        in: path
        required: true
        example: 625
        schema:
          type: string
      - name: employee_id
        in: path
        required: true
        example: 295
        schema:
          type: string
      requestBody:
        content:
          application/json:
            examples:
              success:
                value:
                  expression_of_wish:
                    beneficiaries:
                    - born_on: '2000-10-02'
                      title: Lord
                      name: Ashley
                      email: tburns@kazio.net
                      address: a different address
                      postcode: '58770'
                      relation: Friend
                      percentage: 100
                      type: primary
              invalid_parameters:
                value:
                  expression_of_wish:
                    beneficiaries:
                    - born_on: '2001-08-05T13:00:58.304+01:00'
                      title: Bursar
                      name: Carolyn
                      email: rcox@jumpxs.net
                      address: 74 Bashford Court
                      postcode: '24548'
                      relation: Friend
                      percentage: 999
                      type: primary
            schema:
              type: object
              properties:
                expression_of_wish:
                  type: object
                  properties:
                    beneficiaries:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          born_on:
                            type: string
                          title:
                            type: string
                          name:
                            type: string
                          email:
                            type: string
                          address:
                            type: string
                          postcode:
                            type: string
                          relation:
                            type: string
                          percentage:
                            type: number
                          type:
                            type: string
                          _destroy:
                            type: string
                    contingent_beneficiaries:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          born_on:
                            type: string
                          title:
                            type: string
                          name:
                            type: string
                          email:
                            type: string
                          address:
                            type: string
                          postcode:
                            type: string
                          relation:
                            type: string
                          percentage:
                            type: number
                          type:
                            type: string
                          _destroy:
                            type: string
                    follow_local_law:
                      type: boolean
      responses:
        '204':
          description: Success
        '422':
          description: Invalid parameters
          content:
            application/json:
              example:
                errors:
                - code: 2410
                  title: Percentage must be less than or equal to 100.
                  detail: You need to enter a percentage which must be a numerical value greater than or equal to 1 and less than or equal to 100.
                  meta:
                    value: '999.0'
                    count: 100
                  source:
                    pointer: /data/relationships/beneficiaries/0/attributes/percentage
                - code: 2301
                  title: Total percentage is not valid.
                  detail: The sum of the percentages has to equal 100 percent.
                  meta:
                    numeric_attribute: percentage
                    expected_sum: 100
                  source:
                    pointer: /data
    patch:
      summary: Companies/Employees/ExpressionOfWish/Update
      tags:
      - ExpressionOfWish
      security:
      - oAuth2:
        - employee
      parameters:
      - name: company_id
        in: path
        required: true
        example: 627
        schema:
          type: string
      - name: employee_id
        in: path
        required: true
        example: 297
        schema:
          type: string
      requestBody:
        content:
          application/json:
            examples:
              success:
                value:
                  expression_of_wish:
                    beneficiaries:
                    - born_on: '2000-10-02'
                      title: Mx
                      name: Johnny
                      email: sferguson@blogpad.net
                      address: a different address
                      postcode: '49643'
                      relation: Friend
                      percentage: 100
                      type: primary
              invalid_parameters:
                value:
                  expression_of_wish:
                    beneficiaries:
                    - born_on: '2001-08-05T13:00:59.103+01:00'
                      title: Mrs
                      name: Anna
                      email: jcollins@zoonder.biz
                      address: 602 Manitowish Circle
                      postcode: 17587-5265
                      relation: Friend
                      percentage: 999
                      type: primary
            schema:
              type: object
              properties:
                expression_of_wish:
                  type: object
                  properties:
                    beneficiaries:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          born_on:
                            type: string
                          title:
                            type: string
                          name:
                            type: string
                          email:
                            type: string
                          address:
                            type: string
                          postcode:
                            type: string
                          relation:
                            type: string
                          percentage:
                            type: number
                          type:
                            type: string
                          _destroy:
                            type: string
                    contingent_beneficiaries:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                          born_on:
                            type: string
                          title:
                            type: string
                          name:
                            type: string
                          email:
                            type: string
                          address:
                            type: string
                          postcode:
                            type: string
                          relation:
                            type: string
                          percentage:
                            type: number
                          type:
                            type: string
                          _destroy:
                            type: string
                    follow_local_law:
                      type: boolean
      responses:
        '204':
          description: Success
        '422':
          description: Invalid parameters
          content:
            application/json:
              example:
                errors:
                - code: 2410
                  title: Percentage must be less than or equal to 100.
                  detail: You need to enter a percentage which must be a numerical value greater than or equal to 1 and less than or equal to 100.
                  meta:
                    value: '999.0'
                    count: 100
                  source:
                    pointer: /data/relationships/beneficiaries/0/attributes/percentage
                - code: 2301
                  title: Total percentage is not valid.
                  detail: The sum of the percentages has to equal 100 percent.
                  meta:
                    numeric_attribute: percentage
                    expected_sum: 100
                  source:
                    pointer: /data
components:
  schemas:
    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_adviser_shortcut:
      type: object
      properties:
        id:
          type: integer
        token:
          type:
          - string
          - 'null'
        destination_url:
          type:
          - string
          - 'null'
        short_url:
          type:
          - string
          - 'null'
    response_customer_shortcut:
      type: object
      properties:
        id:
          type: integer
        token:
          type:
          - string
          - 'null'
        destination_url:
          type:
          - string
          - 'null'
        short_url:
          type:
          - string
          - 'null'
    response_enrolment:
      type: object
      properties:
        id:
          type: integer
        company_id:
          type: integer
        event_on:
          type: string
          format: date
        next_re_declaration_of_compliance_deadline_on:
          type:
          - string
          - 'null'
          format: date
        next_re_enrolment_window_starts_on:
          type:
          - string
          - 'null'
          format: date
        next_re_enrolment_window_ends_on:
          type:
          - string
          - 'null'
          format: date
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        links:
          type: array
          items:
            $ref: '#/components/schemas/link'
        company:
          $ref: '#/components/schemas/response_company'
    link:
      type: object
      properties:
        rel:
          type: string
        title:
          type: string
        href:
          type: string
    response_company_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'
        company_id:
          type: integer
        links:
          type: array
          items:
            $ref: '#/components/schemas/link'
        company:
          $ref: '#/components/schemas/response_company'
    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_employment_statuses:
      type: object
      properties:
        employment_statuses:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/response_employment_status'
    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_portfolio:
      type: object
      properties:
        id:
          type: integer
        custom:
          type: boolean
        starts_on:
          type: string
          format: date
        ends_on:
          type:
          - string
          - 'null'
          format: date
        money_in:
          type:
          - boolean
          - 'null'
        portfolio_composed_by_a_tdf:
          type:
          - boolean
          - 'null'
        subaccount_uuid:
          type:
          - string
          - 'null'
        subaccount_name:
          type:
          - string
          - 'null'
        subaccount_group:
          type:
          - string
          - 'null'
        fund_splits:
          type: object
          properties:
            limit:
              type:
              - integer
              - 'null'
            offset:
              type:
              - integer
              - 'null'
            total:
              type:
              - integer
              - 'null'
            links:
              type: array
              items:
                $ref: '#/components/schemas/link'
            fund_splits:
              type:
              - array
              - 'null'
              items:
                $ref: '#/components/schemas/response_fund_split'
    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_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_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_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_employee_shortcut:
      type: object
      properties:
        id:
          type: integer
        token:
          type:
          - string
          - 'null'
        destination_url:
          type:
          - string
          - 'null'
        short_url:
          type:
          - string
          - 'null'
    response_fund_split:
      type: object
      properties:
        id:
          type: integer
        fund_id:
          type: integer
        investment_account_uuid:
          type: string
        percentage:
          type: number
        fund:
          $ref: '#/components/schemas/response_fund'
        employee:
          $ref: '#/components/schemas/response_employee'
    response_company:
      type: object
      properties:
        id:
          type: integer
        name:
          type:
          - string
          - 'null'
        slug:
          type:
          - string
          - 'null'
        registration_number:
          type:
          - string
          - 'null'
        tax_office_number:
          type:
          - string
          - 'null'
        tax_office_employer_reference:
          type:
          - string
          - 'null'
        legal_structure:
          type:
          - string
          - 'null'
        welcome_letters_reminder_sent_at:
          type:
          - string
          - 'null'
          format: date-time
        pension_regulator_letter_code:
          type:
          - string
          - 'null'
        trading_address1:
          type:
          - string
          - 'null'
        trading_address2:
          type:
          - string
          - 'null'
        trading_address3:
          type:
          - string
          - 'null'
        trading_address_postcode:
          type:
          - string
          - 'null'
        trading_address_country:
          type:
          - string
          - 'null'
        reg_address1:
          type:
          - string
          - 'null'
        reg_address2:
          type:
          - string
          - 'null'
        reg_address3:
          type:
          - string
          - 'null'
        reg_address4:
          type:
          - string
          - 'null'
        reg_address_postcode:
          type:
          - string
          - 'null'
        reg_address_country:
          type:
          - string
          - 'null'
        pensionable_earning_type:
          type: string
        default_percentage:
          type:
          - number
          - 'null'
          format: float
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        state:
          type: string
        employee_can_change_contribution:
          type: boolean
        uuid:
          type: string
        layout_configuration_id:
          type:
          - integer
          - 'null'
        relief_at_source_active:
          type:
          - boolean
          - 'null'
        only_employer_manages_membership:
          type: boolean
        national_insurance_saving_share:
          type:
          - number
          - 'null'
          format: float
        tax_relief_basis_type:
          type:
          - string
          - 'null'
        tax_relief_fallback_type:
          type:
          - string
          - 'null'
        direct_debit_optional:
          type: boolean
        skip_contribution_validations:
          type: boolean
        self_certification_started_at:
          type:
          - string
          - 'null'
          format: date-time
        customers:
          type: object
          properties:
            limit:
              type:
              - integer
              - 'null'
            offse

# --- truncated at 32 KB (83 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/smart-pension/refs/heads/main/openapi/smart-pension-expressionofwish-api-openapi.yml