generated: '2026-08-05' method: derived source: openapi/smart-pension-keystone-openapi.yml note: Index of the response examples the provider ships INSIDE its own OpenAPI. Keystone embeds concrete JSON example payloads on response content across most of the surface — this is genuine provider-authored example data, not generated by API Evangelist. The example payloads themselves live in the spec; this file indexes which operations carry them so an agent can find a worked payload for an operation without parsing a 3.6MB document. operationId values are the ones added by overlays/smart-pension-keystone-overlay.yaml, since the published spec declares none. counts: operations_total: 383 operations_with_response_examples: 337 response_examples_total: 503 request_bodies: 160 request_example_note: 'Request examples are largely absent: create/update inputs are documented as bracketed query parameters in the narrative guides rather than as requestBody examples in the spec.' operations: - operationId: accountClaimingConfirmPersonalData operation: POST /account-claiming/confirm-personal-data summary: Account-Claiming/confirm-personal-data response_examples: - status: '200' media_type: application/json - status: '404' media_type: application/json - status: '409' media_type: application/json - status: '422' media_type: application/json - operationId: accountClaimingCurrentAttempt operation: GET /account-claiming/current-attempt summary: Account-Claiming/current-attempt response_examples: - status: '200' media_type: application/json - operationId: accountClaimingAttempt operation: GET /account-claiming/attempts/{uuid}/ summary: Account-Claiming/Attempt response_examples: - status: '200' media_type: application/json - status: '404' media_type: application/json - operationId: accountClaimingPasswordValidations operation: GET /account-claiming/password-validations summary: Account-Claiming/Password-Validations response_examples: - status: '200' media_type: application/json - operationId: accountClaimingAttemptAdditionalData operation: PATCH /account-claiming/attempts/{uuid}/additional-data summary: Account-Claiming/Attempt/AdditionalData response_examples: - status: '200' media_type: application/json - status: '409' media_type: application/json - status: '422' media_type: application/json - operationId: accountClaimingAttemptEmail operation: PATCH /account-claiming/attempts/{uuid}/email summary: Account-Claiming/Attempt/Email response_examples: - status: '200' media_type: application/json - status: '409' media_type: application/json - status: '422' media_type: application/json - operationId: accountClaimingAttemptPassword operation: PATCH /account-claiming/attempts/{uuid}/password summary: Account-Claiming/Attempt/Password response_examples: - status: '200' media_type: application/json - status: '409' media_type: application/json - status: '422' media_type: application/json - operationId: accountClaimingAttempt2 operation: POST /account-claiming/attempts summary: Account-Claiming/Attempt response_examples: - status: '200' media_type: application/json - status: '422' media_type: application/json - operationId: listAllAccountsAssociatedWithTheAuthenticatedIdentity operation: GET /accounts summary: List all accounts associated with the authenticated identity response_examples: - status: '200' media_type: application/json - operationId: adviserCompanyCreate operation: POST /adviser_companies summary: AdviserCompany/Create response_examples: - status: '201' media_type: application/json - operationId: adviserCompaniesUpdate operation: PATCH /adviser_companies/adviser/{adviser_id}/company/{company_id} summary: AdviserCompanies/Update response_examples: - status: '422' media_type: application/json - operationId: advisersCreate operation: POST /advisers summary: Advisers/Create response_examples: - status: '201' media_type: application/json - operationId: advisersList operation: GET /advisers summary: Advisers/List response_examples: - status: '200' media_type: application/json - operationId: exportsCreate operation: POST /advisers/{adviser_id}/exports summary: Exports/Create response_examples: - status: '201' media_type: application/json - operationId: exportsList operation: GET /advisers/{adviser_id}/exports summary: Exports/List response_examples: - status: '200' media_type: application/json - operationId: advisersExportsGet operation: GET /advisers/{adviser_id}/exports/{id} summary: Advisers/Exports/Get response_examples: - status: '200' media_type: application/json - operationId: advisersGetByToken operation: GET /advisers/by_token summary: Advisers/GetByToken response_examples: - status: '200' media_type: application/json - operationId: advisersGet operation: GET /advisers/{id} summary: Advisers/Get response_examples: - status: '200' media_type: application/json - operationId: advisersUpdate operation: PUT /advisers/{id} summary: Advisers/Update response_examples: - status: '422' media_type: application/json - operationId: advisersUpdate2 operation: PATCH /advisers/{id} summary: Advisers/Update response_examples: - status: '422' media_type: application/json - operationId: usersCreate operation: POST /advisers/{adviser_id}/users summary: Users/Create response_examples: - status: '201' media_type: application/json - status: '403' media_type: application/json - status: '422' media_type: application/json - operationId: usersList operation: GET /advisers/{adviser_id}/users summary: Users/List response_examples: - status: '200' media_type: application/json - operationId: usersGet operation: GET /advisers/{adviser_id}/users/{id} summary: Users/Get response_examples: - status: '200' media_type: application/json - status: '403' media_type: application/json - status: '404' media_type: application/json - operationId: usersUpdate operation: PUT /advisers/{adviser_id}/users/{id} summary: Users/Update response_examples: - status: '404' media_type: application/json - status: '422' media_type: application/json - operationId: usersUpdate2 operation: PATCH /advisers/{adviser_id}/users/{id} summary: Users/Update response_examples: - status: '404' media_type: application/json - status: '422' media_type: application/json - operationId: batch operation: POST /batch summary: Batch response_examples: - status: '200' media_type: application/json - operationId: tokensCallback operation: GET /employee/callbacks/smartpension summary: Tokens/Callback response_examples: - status: '302' media_type: text/html - operationId: citiesAutocomplete operation: GET /cities/{country_code}/autocomplete summary: Cities/Autocomplete response_examples: - status: '200' media_type: application/json - status: '422' media_type: application/json - operationId: companiesAdviserInvitationsCreate operation: POST /companies/{company_id}/adviser_invitations summary: Companies/AdviserInvitations/Create response_examples: - status: '201' media_type: application/json - operationId: companiesAdviserInvitationsList operation: GET /companies/{company_id}/adviser_invitations summary: Companies/AdviserInvitations/List response_examples: - status: '200' media_type: application/json - operationId: companiesAdvisersList operation: GET /companies/{company_id}/advisers summary: Companies/Advisers/List response_examples: - status: '200' media_type: application/json - operationId: availableFundsList operation: GET /companies/{company_id}/available_funds summary: AvailableFunds/List response_examples: - status: '200' media_type: application/json - operationId: companiesBankAccountDetailsCreate operation: POST /companies/{company_id}/bank_account_details summary: Companies/BankAccountDetails/Create response_examples: - status: '201' media_type: application/json - operationId: companiesBankAccountDetailsList operation: GET /companies/{company_id}/bank_account_details summary: Companies/BankAccountDetails/List response_examples: - status: '200' media_type: application/json - operationId: companiesBankAccountDetailsDestroy operation: DELETE /companies/{company_id}/bank_account_details/{id} summary: Companies/BankAccountDetails/Destroy response_examples: - status: '404' media_type: application/json - operationId: companiesBankAccountDetailsList2 operation: GET /companies/{company_id}/bank_account_details/{id} summary: Companies/BankAccountDetails/List response_examples: - status: '200' media_type: application/json - operationId: companiesBankAccountDetailsManagable operation: GET /companies/{company_id}/bank_account_details/managable summary: Companies/BankAccountDetails/Managable response_examples: - status: '200' media_type: application/json - operationId: companiesBankAccountDetailsSensitiveData operation: GET /companies/{company_id}/bank_account_details/{bank_account_detail_id}/sensitive_data summary: Companies/BankAccountDetails/SensitiveData response_examples: - status: '200' media_type: application/json - status: '404' media_type: application/json - operationId: companiesBenefitGroupAutoAllocatorResultsGet operation: GET /companies/{company_id}/benefit_group_auto_allocator_results/{id} summary: Companies/BenefitGroupAutoAllocatorResults/Get response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/plain - status: '404' media_type: application/json - operationId: companiesBenefitGroupAutoAllocatorResultsList operation: GET /companies/{company_id}/benefit_group_auto_allocator_results summary: Companies/BenefitGroupAutoAllocatorResults/List response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/plain - status: '422' media_type: application/json - operationId: companiesBenefitGroupsList operation: GET /companies/{company_id}/benefit_groups/{id} summary: Companies/BenefitGroups/List response_examples: - status: '200' media_type: application/json - operationId: companiesBenefitGroupsList2 operation: GET /companies/{company_id}/benefit_groups summary: Companies/BenefitGroups/List response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/plain - operationId: companiesBenefitStatementsCreate operation: POST /companies/{company_id}/benefit_statements/ summary: Companies/BenefitStatements/Create response_examples: - status: '202' media_type: application/json - operationId: companyAutomationsGet operation: GET /companies/{company_id}/company_automation summary: CompanyAutomations/Get response_examples: - status: '200' media_type: application/json - operationId: companyBrandingCreate operation: POST /companies/{company_id}/company_branding summary: CompanyBranding/Create response_examples: - status: '201' media_type: application/json - operationId: companyBrandingGet operation: GET /companies/{company_id}/company_branding summary: CompanyBranding/Get response_examples: - status: '200' media_type: application/json - operationId: companyFeesInvoice operation: GET /companies/{company_id}/company_fees/{company_fee_id}/invoice summary: CompanyFees/Invoice response_examples: - status: '200' media_type: application/json - operationId: companyFeesList operation: GET /companies/{company_id}/company_fees summary: CompanyFees/List response_examples: - status: '200' media_type: application/json - operationId: companiesCompanyRulesGet operation: GET /companies/{company_id}/company_rules summary: Companies/CompanyRules/Get response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/plain - status: '404' media_type: text/html - operationId: companiesContributionsListWithHistoricalEmployeeData operation: GET /companies/{company_id}/contributions summary: Companies/Contributions/List with Historical Employee Data response_examples: - status: '200' media_type: application/json - operationId: summariesPayableGet operation: GET /companies/{company_id}/contributions/summary/payable summary: SummariesPayable/Get response_examples: - status: '200' media_type: application/json - operationId: summariesGet operation: GET /companies/{company_id}/contributions/summary summary: Summaries/Get response_examples: - status: '200' media_type: application/json - operationId: summariesTotalsGet operation: GET /companies/{company_id}/contributions/summary/totals summary: SummariesTotals/Get response_examples: - status: '200' media_type: application/json - operationId: companiesCreate operation: POST /companies summary: Companies/Create response_examples: - status: '201' media_type: application/json - status: '422' media_type: application/json - operationId: companiesList operation: GET /companies summary: Companies/List response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/plain - status: '401' media_type: application/json - operationId: customAppStylingGet operation: GET /companies/{company_id}/style summary: CustomAppStyling/Get response_examples: - status: '200' media_type: application/json - operationId: customersCreate operation: POST /companies/{company_id}/customers summary: Customers/Create response_examples: - status: '201' media_type: application/json - operationId: customersList operation: GET /companies/{company_id}/customers summary: Customers/List response_examples: - status: '200' media_type: application/json - operationId: customersDestroy operation: DELETE /companies/{company_id}/customers/{id} summary: Customers/Destroy response_examples: - status: '403' media_type: application/json - operationId: customersGet operation: GET /companies/{company_id}/customers/{id} summary: Customers/Get response_examples: - status: '200' media_type: application/json - operationId: customersUpdate operation: PUT /companies/{company_id}/customers/{id} summary: Customers/Update response_examples: - status: '403' media_type: application/json - status: '422' media_type: application/json - operationId: customersUpdate2 operation: PATCH /companies/{company_id}/customers/{id} summary: Customers/Update response_examples: - status: '403' media_type: application/json - status: '422' media_type: application/json - operationId: paymentApprovalsCreate operation: POST /companies/{company_id}/payment_approvals summary: PaymentApprovals/Create response_examples: - status: '201' media_type: application/json - operationId: customersRolesCreate operation: POST /companies/{company_id}/customers/{customer_id}/role summary: Customers/Roles/Create response_examples: - status: '201' media_type: application/json - operationId: declarationOfComplianceEmployeeTotalsList operation: GET /companies/{company_id}/declaration_of_compliance_employee_totals summary: DeclarationOfComplianceEmployeeTotals/List response_examples: - status: '200' media_type: application/json - operationId: documentsList operation: GET /companies/{company_id}/documents summary: Documents/List response_examples: - status: '200' media_type: application/json - operationId: activePayrollConfigurationGet operation: GET /companies/{company_id}/employees/{employee_id}/active_payroll_configuration summary: ActivePayrollConfiguration/Get response_examples: - status: '200' media_type: application/json - status: '404' media_type: application/json - operationId: addMoneyFormsCreate operation: POST /companies/{company_id}/employees/{employee_id}/add_money_forms/{type} summary: AddMoneyForms/Create response_examples: - status: '201' media_type: application/json - operationId: addMoneyFormsGet operation: GET /companies/{company_id}/employees/{employee_id}/add_money_forms/{type} summary: AddMoneyForms/Get response_examples: - status: '200' media_type: application/json - operationId: assessmentsGet operation: GET /companies/{company_id}/employees/{employee_id}/assessments/{id} summary: Assessments/Get response_examples: - status: '200' media_type: application/json - operationId: assessmentsList operation: GET /companies/{company_id}/employees/{employee_id}/assessments summary: Assessments/List response_examples: - status: '200' media_type: application/json - operationId: availableGlidepathsList operation: GET /companies/{company_id}/employees/{employee_id}/available_glidepaths summary: AvailableGlidepaths/List response_examples: - status: '200' media_type: application/json - operationId: availableWithdrawalOptionsList operation: GET /companies/{company_id}/employees/{employee_id}/available_withdrawal_options summary: AvailableWithdrawalOptions/List response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/plain - status: '404' media_type: text/html - status: '422' media_type: application/json - operationId: companiesEmployeesBankAccountDetailCreate operation: POST /companies/{company_id}/employees/{employee_id}/bank_account_detail summary: Companies/Employees/BankAccountDetail/Create response_examples: - status: '201' media_type: application/json - status: '403' media_type: application/json - status: '422' media_type: application/json - operationId: companiesEmployeesBankAccountDetailGet operation: GET /companies/{company_id}/employees/{employee_id}/bank_account_detail summary: Companies/Employees/BankAccountDetail/Get response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/plain - operationId: companiesEmployeesBankAccountDetailValidate operation: POST /companies/{company_id}/employees/{employee_id}/bank_account_detail/validate summary: Companies/Employees/BankAccountDetail/Validate response_examples: - status: '200' media_type: application/json - operationId: benefitCategoriesGet operation: GET /companies/{company_id}/employees/{employee_id}/benefit_categories/{benefit_rule_set_id} summary: BenefitCategories/Get response_examples: - status: '200' media_type: application/json - operationId: benefitCategoriesList operation: GET /companies/{company_id}/employees/{employee_id}/benefit_categories summary: BenefitCategories/List response_examples: - status: '200' media_type: application/json - operationId: benefitCheckResultsGet operation: GET /companies/{company_id}/employees/{employee_id}/benefits/{id}/benefit_check_results summary: BenefitCheckResults/Get response_examples: - status: '200' media_type: application/json - operationId: benefitEvidenceTypesGet operation: GET /companies/{company_id}/employees/{employee_id}/benefit_form/benefit_evidences summary: BenefitEvidenceTypes/Get response_examples: - status: '200' media_type: application/json - operationId: benefitEvidenceUploadsConfirmAll operation: PATCH /companies/{company_id}/employees/{employee_id}/benefit_form/benefit_evidence_uploads/confirm_all summary: BenefitEvidenceUploads/ConfirmAll response_examples: - status: '404' media_type: application/json - operationId: benefitEvidenceUploadsCreate operation: POST /companies/{company_id}/employees/{employee_id}/benefit_form/benefit_evidence_uploads summary: BenefitEvidenceUploads/Create response_examples: - status: '201' media_type: application/json - status: '422' media_type: application/json - operationId: benefitEvidenceUploadsGet operation: GET /companies/{company_id}/employees/{employee_id}/benefit_form/benefit_evidence_uploads summary: BenefitEvidenceUploads/Get response_examples: - status: '200' media_type: application/json - operationId: benefitEvidenceUploadsDestroy operation: DELETE /companies/{company_id}/employees/{employee_id}/benefit_form/benefit_evidence_uploads/{benefit_evidence_upload_id} summary: BenefitEvidenceUploads/Destroy response_examples: - status: '404' media_type: application/json - operationId: benefitEvidenceUploadsUpdate operation: PUT /companies/{company_id}/employees/{employee_id}/benefit_form/benefit_evidence_uploads/{benefit_evidence_upload_id} summary: BenefitEvidenceUploads/Update response_examples: - status: '422' media_type: application/json - operationId: benefitEvidenceUploadsUpdate2 operation: PATCH /companies/{company_id}/employees/{employee_id}/benefit_form/benefit_evidence_uploads/{benefit_evidence_upload_id} summary: BenefitEvidenceUploads/Update response_examples: - status: '422' media_type: application/json - operationId: benefitFormsCancel operation: POST /companies/{company_id}/employees/{employee_id}/benefit_form/cancel summary: BenefitForms/Cancel response_examples: - status: '200' media_type: application/json - status: '404' media_type: application/json - operationId: benefitFormsCreate operation: POST /companies/{company_id}/employees/{employee_id}/benefit_categories/{benefit_category_id}/benefit_form summary: BenefitForms/Create response_examples: - status: '201' media_type: application/json - operationId: benefitFormsUpdate operation: PUT /companies/{company_id}/employees/{employee_id}/benefit_categories/{benefit_category_id}/benefit_form summary: BenefitForms/Update response_examples: - status: '422' media_type: application/json - operationId: benefitFormsUpdate2 operation: PATCH /companies/{company_id}/employees/{employee_id}/benefit_categories/{benefit_category_id}/benefit_form summary: BenefitForms/Update response_examples: - status: '422' media_type: application/json - operationId: benefitFormsGenerateVerificationUrl operation: POST /companies/{company_id}/employees/{employee_id}/benefit_form/verification_url summary: BenefitForms/GenerateVerificationUrl response_examples: - status: '200' media_type: application/json - operationId: benefitFormsVerificationUrl operation: GET /companies/{company_id}/employees/{employee_id}/benefit_form/verification_url summary: BenefitForms/VerificationUrl response_examples: - status: '200' media_type: application/json - operationId: benefitFormsGet operation: GET /companies/{company_id}/employees/{employee_id}/benefit_form summary: BenefitForms/Get response_examples: - status: '200' media_type: application/json - operationId: benefitFormsSubmit operation: POST /companies/{company_id}/employees/{employee_id}/benefit_form/submit summary: BenefitForms/Submit response_examples: - status: '200' media_type: application/json - operationId: benefitGroupsGet operation: GET /companies/{company_id}/employees/{employee_id}/benefit_group summary: BenefitGroups/Get response_examples: - status: '200' media_type: application/json - operationId: benefitMoneyOutStateGet operation: GET /companies/{company_id}/employees/{employee_id}/benefit_money_out_state summary: BenefitMoneyOutState/Get response_examples: - status: '200' media_type: application/json - operationId: taxPreviewGet operation: GET /companies/{id}/employees/{employee_id}/benefit_categories/{benefit_rule_set_id}/tax_preview summary: TaxPreview/Get response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/plain - status: '422' media_type: application/json - operationId: benefitSchedulesDestroy operation: DELETE /companies/{company_id}/employees/{employee_id}/benefit_schedule summary: BenefitSchedules/Destroy response_examples: - status: '200' media_type: application/json - status: '404' media_type: application/json - operationId: benefitSchedulesUpdate operation: GET /companies/{company_id}/employees/{employee_id}/benefit_schedule summary: BenefitSchedules/Update response_examples: - status: '200' media_type: application/json - status: '404' media_type: application/json - operationId: benefitSchedulesUpdate2 operation: PUT /companies/{company_id}/employees/{employee_id}/benefit_schedule summary: BenefitSchedules/Update response_examples: - status: '404' media_type: application/json - status: '422' media_type: application/json - operationId: benefitSchedulesUpdate3 operation: PATCH /companies/{company_id}/employees/{employee_id}/benefit_schedule summary: BenefitSchedules/Update response_examples: - status: '404' media_type: application/json - status: '422' media_type: application/json - operationId: benefitStatementsCreate operation: POST /companies/{company_id}/employees/{employee_id}/benefit_statements summary: BenefitStatements/Create response_examples: - status: '201' media_type: application/json - status: '422' media_type: application/json - operationId: companiesEmployeesBenefitStatementsGet operation: GET /companies/{company_id}/employees/{employee_id}/benefit_statements/{id} summary: Companies/Employees/BenefitStatements/Get response_examples: - status: '200' media_type: application/json - operationId: benefitsGet operation: GET /companies/{company_id}/employees/{employee_id}/benefits/{id} summary: Benefits/Get response_examples: - status: '200' media_type: application/json - operationId: benefitsList operation: GET /companies/{company_id}/employees/{employee_id}/benefits summary: Benefits/List response_examples: - status: '200' media_type: application/json - operationId: employeesBenefitsCreate operation: POST /companies/{company_id}/employees/{employee_id}/benefits summary: Employees/Benefits/Create response_examples: - status: '201' media_type: application/json - operationId: contributionsCreate operation: POST /companies/{company_id}/employees/{employee_id}/contributions summary: Contributions/Create response_examples: - status: '201' media_type: application/json - status: '403' media_type: application/json - status: '422' media_type: application/json - operationId: contributionsList operation: GET /companies/{company_id}/employees/{employee_id}/contributions summary: Contributions/List response_examples: - status: '200' media_type: application/json - operationId: contributionsDestroy operation: DELETE /companies/{company_id}/employees/{employee_id}/contributions/{id} summary: Contributions/Destroy response_examples: - status: '403' media_type: application/json - status: '404' media_type: application/json - operationId: contributionsGet operation: GET /companies/{company_id}/employees/{employee_id}/contributions/{id} summary: Contributions/Get response_examples: - status: '200' media_type: application/json - operationId: contributionsUpdate operation: PUT /companies/{company_id}/employees/{employee_id}/contributions/{id} summary: Contributions/Update response_examples: - status: '403' media_type: application/json - operationId: contributionsUpdate2 operation: PATCH /companies/{company_id}/employees/{employee_id}/contributions/{id} summary: Contributions/Update response_examples: - status: '403' media_type: application/json - operationId: summariesGet2 operation: GET /companies/{company_id}/employees/{employee_id}/contributions/summary summary: Summaries/Get response_examples: - status: '200' media_type: application/json - operationId: employeesCreate operation: POST /companies/{company_id}/employees summary: Employees/Create response_examples: - status: '201' media_type: application/json - status: '422' media_type: application/json - operationId: companiesEmployeesListWithHistoricalEmployeeData operation: GET /companies/{company_id}/employees summary: Companies/Employees/List with Historical Employee Data response_examples: - status: '200' media_type: application/json - operationId: companiesEmployeesGet operation: GET /companies/{company_id}/employees/{id} summary: Companies/Employees/Get response_examples: - status: '200' media_type: application/json - operationId: employeesUpdate operation: PUT /companies/{company_id}/employees/{id} summary: Employees/Update response_examples: - status: '403' media_type: application/json - status: '422' media_type: application/json - operationId: employeesUpdate2 operation: PATCH /companies/{company_id}/employees/{id} summary: Employees/Update response_examples: - status: '403' media_type: application/json - status: '422' media_type: application/json - operationId: discountedValuationGet operation: GET /companies/{company_id}/employees/{employee_id}/discounted_valuation summary: DiscountedValuation/Get response_examples: - status: '200' media_type: application/json - operationId: employeeConfigurationUpdate operation: PUT /companies/{company_id}/employees/{employee_id}/employee_configurations summary: EmployeeConfiguration/Update response_examples: - status: '422' media_type: application/json - operationId: employeeConfigurationUpdate2 operation: PATCH /companies/{company_id}/employees/{employee_id}/employee_configurations summary: EmployeeConfiguration/Update response_examples: - status: '422' media_type: application/json - operationId: companiesEmployeesEmployeeExternalPensionsBulkUpdate operation: POST /companies/{company_id}/employees/{employee_id}/employee_external_pensions/bulk_update summary: Companies/Employees/EmployeeExternalPensions/BulkUpdate response_examples: - status: '200' media_type: application/json - status: '422' media_type: application/json - operationId: companiesEmployeesEmployeeExternalPensionsList operation: GET /companies/{company_id}/employees/{employee_id}/employee_external_pensions summary: Companies/Employees/EmployeeExternalPensions/List response_examples: - status: '200' media_type: application/json - operationId: companiesEmployeesEmployeeFundHoldingsGet operation: GET /companies/{company_id}/employees/{employee_id}/employee_fund_holdings/{id} summary: Companies/Employees/EmployeeFundHoldings/Get response_examples: - status: '200' media_type: application/json - operationId: companiesEmployeesEmployeeFundHoldingsList operation: GET /companies/{company_id}/employees/{employee_id}/employee_fund_holdings summary: Companies/Employees/EmployeeFundHoldings/List response_examples: - status: '200' media_type: application/json - operationId: companiesEmployeesEmployeeFundsValuationsGet operation: GET /companies/{company_id}/employees/{employee_id}/employee_funds_valuations summary: Companies/Employees/EmployeeFundsValuations/Get response_examples: - status: '200' media_type: application/json - operationId: companiesEmployeesEmployeeRateRecommendationCreate operation: POST /companies/{company_id}/employees/{id}/employee_rate_recommendation summary: Companies/Employees/EmployeeRateRecommendation/Create response_examples: - status: '200' media_type: application/json - operationId: companiesEmployeesExpressionOfWishCreate operation: POST /companies/{company_id}/employees/{employee_id}/expression_of_wish summary: Companies/Employees/ExpressionOfWish/Create response_examples: - status: '201' media_type: application/json - status: '422' media_type: application/json - operationId: companiesEmployeesExpressionOfWishGet operation: GET /companies/{company_id}/employees/{employee_id}/expression_of_wish summary: Companies/Employees/ExpressionOfWish/Get response_examples: - status: '200' media_type: application/json - operationId: companiesEmployeesExpressionOfWishUpdate operation: PUT /companies/{company_id}/employees/{employee_id}/expression_of_wish summary: Companies/Employees/ExpressionOfWish/Update response_examples: - status: '422' media_type: application/json - operationId: companiesEmployeesExpressionOfWishUpdate2 operation: PATCH /companies/{company_id}/employees/{employee_id}/expression_of_wish summary: Companies/Employees/ExpressionOfWish/Update response_examples: - status: '422' media_type: application/json - operationId: companiesEmployeesFundsSplitsList operation: GET /companies/{company_id}/employees/{employee_id}/fund_splits summary: Companies/Employees/FundsSplits/List response_examples: - status: '200' media_type: application/json - operationId: glidepathsCreate operation: POST /companies/{company_id}/employees/{employee_id}/glidepaths summary: Glidepaths/Create response_examples: - status: '201' media_type: application/json - status: '403' media_type: application/json - status: '422' media_type: application/json - operationId: historicalContributionGet operation: GET /companies/{company_id}/employees/{employee_id}/historical_contributions/{id} summary: HistoricalContribution/Get response_examples: - status: '200' media_type: application/json - operationId: historicalContributionList operation: GET /companies/{company_id}/employees/{employee_id}/historical_contributions summary: HistoricalContribution/List response_examples: - status: '200' media_type: application/json - operationId: historicalTransferInGet operation: GET /companies/{company_id}/employees/{employee_id}/historical_transfer_ins/{id} summary: HistoricalTransferIn/Get response_examples: - status: '200' media_type: application/json - operationId: historicalTransferInsList operation: GET /companies/{company_id}/employees/{employee_id}/historical_transfer_ins summary: HistoricalTransferIns/List response_examples: - status: '200' media_type: application/json - operationId: companiesEmployeesIncomeAdequacyProjectionCreateModes operation: POST /companies/{company_id}/employees/{id}/income_adequacy_projection summary: Companies/Employees/IncomeAdequacyProjection/Create (modes) response_examples: - status: '200' media_type: application/json - operationId: investmentsPerformanceList operation: GET /companies/{company_id}/employees/{employee_id}/investments_performance summary: InvestmentsPerformance/List response_examples: - status: '200' media_type: application/json - operationId: laterLifeProjectionGet operation: GET /companies/{company_id}/employees/{employee_id}/later_life_projection summary: LaterLifeProjection/Get response_examples: - status: '200' media_type: application/json - operationId: lettersCreate operation: POST /companies/{company_id}/employees/{employee_id}/letters summary: Letters/Create response_examples: - status: '201' media_type: application/json - operationId: companiesEmployeesLettersList operation: GET /companies/{company_id}/employees/{employee_id}/letters summary: Companies/Employees/Letters/List response_examples: - status: '200' media_type: application/json - operationId: lettersGet operation: GET /companies/{company_id}/employees/{employee_id}/letters/{id} summary: Letters/Get response_examples: - status: '200' media_type: application/json - operationId: companiesEmployeesOptStatesGet operation: GET /companies/{company_id}/employees/{id}/opt_state summary: Companies/Employees/OptStates/Get response_examples: - status: '200' media_type: application/json - operationId: overfundingThresholdsGet operation: GET /companies/{company_id}/employees/{employee_id}/overfunding_threshold summary: OverfundingThresholds/Get response_examples: - status: '200' media_type: application/json - operationId: employeesPageVisitsCreate operation: POST /companies/{company_id}/employees/{employee_id}/page_visits summary: Employees/PageVisits/Create response_examples: - status: '422' media_type: application/json - operationId: paidInAmountsList operation: GET /companies/{company_id}/employees/{employee_id}/paid_in_amounts summary: PaidInAmounts/List response_examples: - status: '200' media_type: application/json - operationId: companiesEmployeesPensionForecastInputsCreate operation: POST /companies/{company_id}/employees/{employee_id}/pension_forecast summary: Companies/Employees/PensionForecastInputs/Create response_examples: - status: '200' media_type: application/json - operationId: companiesEmployeesPensionForecastInputsCreate2 operation: GET /companies/{company_id}/employees/{employee_id}/pension_forecast summary: Companies/Employees/PensionForecastInputs/Create response_examples: - status: '200' media_type: application/json - operationId: companiesEmployeesPensionForecastInputsGet operation: GET /companies/{company_id}/employees/{id}/pension_forecast_inputs summary: Companies/Employees/PensionForecastInputs/Get response_examples: - status: '200' media_type: application/json - operationId: pensionlabConsentGet operation: GET /companies/{company_id}/employees/{employee_id}/pensionlab_consent summary: PensionlabConsent/Get response_examples: - status: '200' media_type: application/json - operationId: portfoliosCreate operation: POST /companies/{company_id}/employees/{employee_id}/portfolios summary: Portfolios/Create response_examples: - status: '201' media_type: application/json - operationId: portfoliosList operation: GET /companies/{company_id}/employees/{employee_id}/portfolios summary: Portfolios/List response_examples: - status: '200' media_type: application/json - operationId: companiesEmployeesPortfoliosGet operation: GET /companies/{company_id}/employees/{employee_id}/portfolios/{id} summary: Companies/Employees/Portfolios/Get response_examples: - status: '200' media_type: application/json - operationId: postponementCreate operation: POST /companies/{company_id}/employees/{employee_id}/postponements summary: Postponement/Create response_examples: - status: '201' media_type: application/json - status: '422' media_type: application/json - operationId: postponementList operation: GET /companies/{company_id}/employees/{employee_id}/postponements summary: Postponement/List response_examples: - status: '200' media_type: application/json - operationId: postponementGet operation: GET /companies/{company_id}/employees/{employee_id}/postponements/{id} summary: Postponement/Get response_examples: - status: '200' media_type: application/json - operationId: postponementUpdate operation: PUT /companies/{company_id}/employees/{employee_id}/postponements/{id} summary: Postponement/Update response_examples: - status: '403' media_type: application/json - status: '404' media_type: application/json - status: '422' media_type: application/json - operationId: postponementUpdate2 operation: PATCH /companies/{company_id}/employees/{employee_id}/postponements/{id} summary: Postponement/Update response_examples: - status: '403' media_type: application/json - status: '404' media_type: application/json - status: '422' media_type: application/json - operationId: previewContributionRatesGet operation: GET /companies/{company_id}/employees/{employee_id}/preview_contribution_rates summary: PreviewContributionRates/Get response_examples: - status: '200' media_type: application/json - operationId: regularIncomeProjectionGet operation: GET /companies/{company_id}/employees/{employee_id}/regular_income_projection summary: RegularIncomeProjection/Get response_examples: - status: '200' media_type: application/json - operationId: schemesAvailableCurrenciesList operation: GET /companies/{company_id}/employees/{employee_id}/available_currencies summary: SchemesAvailableCurrencies/List response_examples: - status: '200' media_type: application/json - operationId: subaccountGroupsValuationsList operation: GET /companies/{company_id}/employees/{employee_id}/subaccount_groups_valuations summary: SubaccountGroupsValuations/List response_examples: - status: '200' media_type: application/json - operationId: companiesEmployeesSubaccountsDefaultFundSplits operation: GET /companies/{company_id}/employees/{employee_id}/subaccounts/{uuid}/default_fund_splits summary: Companies/Employees/Subaccounts/DefaultFundSplits response_examples: - status: '200' media_type: application/json - operationId: companiesEmployeesSubaccountsGet operation: GET /companies/{company_id}/employees/{employee_id}/subaccounts/{uuid} summary: Companies/Employees/Subaccounts/Get response_examples: - status: '200' media_type: application/json - operationId: companiesEmployeesSubaccounts operation: GET /companies/{company_id}/employees/{employee_id}/subaccounts summary: Companies/Employees/Subaccounts response_examples: - status: '200' media_type: application/json - operationId: projectionsCreate operation: POST /companies/{company_id}/employees/{employee_id}/subaccounts/{subaccount_uuid}/projections summary: Projections/Create response_examples: - status: '200' media_type: application/json - operationId: tasksList operation: GET /companies/{company_id}/employees/{employee_id}/tasks summary: Tasks/List response_examples: - status: '200' media_type: application/json - operationId: companiesEmployeesTaxInformationChangeList operation: GET /companies/{company_id}/employees/{employee_id}/tax_information_change summary: Companies/Employees/TaxInformationChange/List response_examples: - status: '200' media_type: application/json - operationId: companiesEmployeesTaxResidenceCreate operation: POST /companies/{company_id}/employees/{employee_id}/tax_residence summary: Companies/Employees/TaxResidence/Create response_examples: - status: '201' media_type: application/json - operationId: companiesEmployeesTaxResidenceGet operation: GET /companies/{company_id}/employees/{employee_id}/tax_residence summary: Companies/Employees/TaxResidence/Get response_examples: - status: '200' media_type: application/json - operationId: todoItemsComplete operation: PATCH /companies/{company_id}/employees/{employee_id}/todo_items/complete summary: TodoItems/Complete response_examples: - status: '422' media_type: application/json - operationId: todoItemsList operation: GET /companies/{company_id}/employees/{employee_id}/todo_items summary: TodoItems/List response_examples: - status: '200' media_type: application/json - operationId: transactionsGet operation: GET /companies/{company_id}/employees/{employee_id}/transactions/{transaction_type}/{transaction_id} summary: Transactions/Get response_examples: - status: '200' media_type: application/json - operationId: transactionsList operation: GET /companies/{company_id}/employees/{employee_id}/transactions summary: Transactions/List response_examples: - status: '200' media_type: application/json - operationId: transferInGet operation: GET /companies/{company_id}/employees/{employee_id}/transfer_ins/{id} summary: TransferIn/Get response_examples: - status: '200' media_type: application/json - operationId: transferInList operation: GET /companies/{company_id}/employees/{employee_id}/transfer_ins summary: TransferIn/List response_examples: - status: '200' media_type: application/json - operationId: transferMoneyReviewPost operation: POST /companies/{company_id}/employees/{employee_id}/transfer_money_review summary: TransferMoneyReview/Post response_examples: - status: '200' media_type: application/json - operationId: valuationsList operation: GET /companies/{company_id}/employees/{employee_id}/valuations summary: Valuations/List response_examples: - status: '200' media_type: application/json - operationId: valuationsGet operation: GET /companies/{company_id}/employees/{employee_id}/valuations/{id} summary: Valuations/Get response_examples: - status: '200' media_type: application/json - operationId: verificationChecksGenerateVerificationUrl operation: POST /companies/{company_id}/employees/{employee_id}/verification_checks/generate_verification_url summary: VerificationChecks/GenerateVerificationUrl response_examples: - status: '422' media_type: application/json - operationId: verificationChecksState operation: GET /companies/{company_id}/employees/{employee_id}/verification_checks/state summary: VerificationChecks/State response_examples: - status: '200' media_type: application/json - status: '422' media_type: application/json - operationId: verificationChecksGetVerificationUrl operation: GET /companies/{company_id}/employees/{employee_id}/verification_checks/verification_url summary: VerificationChecks/GetVerificationUrl response_examples: - status: '200' media_type: application/json - status: '422' media_type: application/json - operationId: companiesEmploymentCategoriesList operation: GET /companies/{company_id}/employment_categories summary: Companies/EmploymentCategories/List response_examples: - status: '200' media_type: application/json - operationId: companiesEnrolmentsCreate operation: POST /companies/{company_id}/enrolments summary: Companies/Enrolments/Create response_examples: - status: '201' media_type: application/json - status: '403' media_type: application/json - status: '422' media_type: application/json - operationId: companiesEnrolmentsList operation: GET /companies/{company_id}/enrolments summary: Companies/Enrolments/List response_examples: - status: '200' media_type: application/json - operationId: companiesEnrolmentsGet operation: GET /companies/{company_id}/enrolments/{id} summary: Companies/Enrolments/Get response_examples: - status: '200' media_type: application/json - operationId: companiesEnrolmentsUpdate operation: PUT /companies/{company_id}/enrolments/{id} summary: Companies/Enrolments/Update response_examples: - status: '403' media_type: application/json - status: '422' media_type: application/json - operationId: companiesEnrolmentsUpdate2 operation: PATCH /companies/{company_id}/enrolments/{id} summary: Companies/Enrolments/Update response_examples: - status: '403' media_type: application/json - status: '422' media_type: application/json - operationId: companiesEnrolmentsEmployeesList operation: GET /companies/{company_id}/enrolments/{enrolment_id}/employees summary: Companies/Enrolments/Employees/List response_examples: - status: '200' media_type: application/json - operationId: companiesEnvelopesGet operation: GET /companies/{company_id}/envelope summary: Companies/Envelopes/Get response_examples: - status: '200' media_type: application/json - operationId: companiesEnvelopeRemindsCreate operation: POST /companies/{company_id}/envelope/remind summary: Companies/Envelope/Reminds/Create response_examples: - status: '404' media_type: application/json - operationId: companiesEnvelopeSigning operation: GET /companies/{company_id}/envelope/signing summary: Companies/Envelope/Signing response_examples: - status: '200' media_type: application/json - operationId: estimateBenefitValuationsGet operation: GET /companies/{company_id}/employees/{employee_id}/benefit_categories/{benefit_category_id}/estimate_benefit_valuations summary: EstimateBenefitValuations/Get response_examples: - status: '200' media_type: application/json - operationId: companiesExportsCreate operation: POST /companies/{company_id}/exports summary: Companies/Exports/Create response_examples: - status: '201' media_type: application/json - operationId: companiesExportsList operation: GET /companies/{company_id}/exports summary: Companies/Exports/List response_examples: - status: '200' media_type: application/json - operationId: companiesExportsGet operation: GET /companies/{company_id}/exports/{id} summary: Companies/Exports/Get response_examples: - status: '200' media_type: application/json - operationId: companiesExternalEmployeeDataAvailabilityGet operation: GET /companies/{company_id}/external_employee_data_availability summary: Companies/ExternalEmployeeDataAvailability/Get response_examples: - status: '200' media_type: application/json - operationId: fundsList operation: GET /companies/{company_id}/funds summary: Funds/List response_examples: - status: '200' media_type: application/json - operationId: companiesBySlugGet operation: GET /companies/by_slug summary: CompaniesBySlug/Get response_examples: - status: '200' media_type: application/json - operationId: companiesGet operation: GET /companies/{company_id} summary: Companies/Get response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/plain - status: '401' media_type: application/json - operationId: companiesUpdate operation: PUT /companies/{company_id} summary: Companies/Update response_examples: - status: '422' media_type: application/json - operationId: companiesUpdate2 operation: PATCH /companies/{company_id} summary: Companies/Update response_examples: - status: '422' media_type: application/json - operationId: companiesGroupsCreate operation: POST /companies/{company_id}/groups summary: Companies/Groups/Create response_examples: - status: '201' media_type: application/json - status: '403' media_type: application/json - status: '422' media_type: application/json - operationId: companiesGroupsList operation: GET /companies/{company_id}/groups summary: Companies/Groups/List response_examples: - status: '200' media_type: application/json - operationId: companiesGroupsGet operation: GET /companies/{company_id}/groups/{id} summary: Companies/Groups/Get response_examples: - status: '200' media_type: application/json - status: '404' media_type: application/json - operationId: companiesGroupsUpdate operation: PUT /companies/{company_id}/groups/{id} summary: Companies/Groups/Update response_examples: - status: '422' media_type: application/json - operationId: companiesGroupsUpdate2 operation: PATCH /companies/{company_id}/groups/{id} summary: Companies/Groups/Update response_examples: - status: '422' media_type: application/json - operationId: importCreate operation: POST /companies/{company_id}/imports summary: Import/Create response_examples: - status: '201' media_type: application/json - operationId: importList operation: GET /companies/{company_id}/imports summary: Import/List response_examples: - status: '200' media_type: application/json - operationId: importGet operation: GET /companies/{company_id}/imports/{id} summary: Import/Get response_examples: - status: '200' media_type: application/json - operationId: importImportResultsList operation: GET /companies/{company_id}/imports/{import_id}/import_results summary: Import/ImportResults/List response_examples: - status: '200' media_type: application/json - operationId: companiesLettersCreate operation: POST /companies/{company_id}/letters summary: Companies/Letters/Create response_examples: - status: '201' media_type: application/json - status: '403' media_type: application/json - status: '422' media_type: application/json - operationId: companiesLettersListWithHistoricalEmployeeData operation: GET /companies/{company_id}/letters summary: Companies/Letters/List with Historical Employee Data response_examples: - status: '200' media_type: application/json - operationId: companiesLettersGet operation: GET /companies/{company_id}/letters/{id} summary: Companies/Letters/Get response_examples: - status: '200' media_type: application/json - operationId: companiesLettersPostponementCreate operation: POST /companies/{company_id}/letters/postponement summary: Companies/Letters/Postponement/Create response_examples: - status: '403' media_type: application/json - status: '404' media_type: application/json - status: '404' media_type: text/html - status: '422' media_type: application/json - operationId: companiesLettersWelcomeCreate operation: POST /companies/{company_id}/letters/welcome summary: Companies/Letters/Welcome/Create response_examples: - status: '403' media_type: application/json - status: '404' media_type: application/json - status: '404' media_type: text/html - status: '422' media_type: application/json - operationId: companiesMandateChargeScheduleCreate operation: POST /companies/{company_id}/mandate_charge_schedule summary: Companies/MandateChargeSchedule/Create response_examples: - status: '201' media_type: application/json - status: '401' media_type: text/plain - status: '422' media_type: application/json - operationId: companiesMandateChargeScheduleGet operation: GET /companies/{company_id}/mandate_charge_schedule summary: Companies/MandateChargeSchedule/Get response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/plain - status: '404' media_type: text/html - operationId: companiesMandateChargeScheduleUpdate operation: PATCH /companies/{company_id}/mandate_charge_schedule summary: Companies/MandateChargeSchedule/Update response_examples: - status: '401' media_type: text/plain - status: '422' media_type: application/json - operationId: companiesMembershipFeesGet operation: GET /companies/{company_id}/membership_fees summary: Companies/MembershipFees/Get response_examples: - status: '200' media_type: application/json - operationId: companiesNextPayPeriodDatesList operation: GET /companies/{company_id}/next_pay_period_dates summary: Companies/NextPayPeriodDates/List response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/plain - status: '403' media_type: application/json - status: '404' media_type: application/json - status: '422' media_type: application/json - operationId: notificationsCreate operation: POST /companies/{company_id}/notifications summary: Notifications/Create response_examples: - status: '201' media_type: application/json - status: '422' media_type: application/json - operationId: notificationsList operation: GET /companies/{company_id}/notifications summary: Notifications/List response_examples: - status: '200' media_type: application/json - operationId: companiesOptInRequestsList operation: GET /companies/{company_id}/opt_in_requests summary: Companies/OptInRequests/List response_examples: - status: '200' media_type: application/json - operationId: companiesPaymentsGet operation: GET /companies/{company_id}/payments/{id} summary: Companies/Payments/Get response_examples: - status: '200' media_type: application/json - status: '404' media_type: application/json - operationId: companiesPaymentsList operation: GET /companies/{company_id}/payments summary: Companies/Payments/List response_examples: - status: '200' media_type: application/json - operationId: payrollConfigurationDetailsBatchCreate operation: POST /companies/{company_id}/payroll_configurations/{payroll_configuration_id}/payroll_configuration_details/batch_create summary: PayrollConfigurationDetails/BatchCreate response_examples: - status: '201' media_type: application/json - status: '403' media_type: application/json - status: '404' media_type: text/html - status: '404' media_type: application/json - status: '422' media_type: application/json - operationId: payrollConfigurationDetailsGet operation: GET /companies/{company_id}/payroll_configurations/{payroll_configuration_id}/payroll_configuration_details/{id} summary: PayrollConfigurationDetails/Get response_examples: - status: '200' media_type: application/json - status: '404' media_type: text/html - status: '404' media_type: application/json - operationId: payrollConfigurationDetails operation: PUT /companies/{company_id}/payroll_configurations/{payroll_configuration_id}/payroll_configuration_details/{id} summary: PayrollConfigurationDetails response_examples: - status: '404' media_type: text/html - status: '404' media_type: application/json - status: '422' media_type: application/json - operationId: payrollConfigurationDetails2 operation: PATCH /companies/{company_id}/payroll_configurations/{payroll_configuration_id}/payroll_configuration_details/{id} summary: PayrollConfigurationDetails response_examples: - status: '404' media_type: text/html - status: '404' media_type: application/json - status: '422' media_type: application/json - operationId: payrollConfigurationDetailsList operation: GET /companies/{company_id}/payroll_configurations/{payroll_configuration_id}/payroll_configuration_details summary: PayrollConfigurationDetails/List response_examples: - status: '200' media_type: application/json - status: '404' media_type: text/html - status: '404' media_type: application/json - operationId: payrollConfigurations operation: POST /companies/{company_id}/payroll_configurations summary: payroll_configurations response_examples: - status: '201' media_type: application/json - status: '422' media_type: application/json - operationId: payrollConfigurationsList operation: GET /companies/{company_id}/payroll_configurations summary: PayrollConfigurations/List response_examples: - status: '200' media_type: application/json - operationId: payrollConfigurationsGet operation: GET /companies/{company_id}/payroll_configurations/{payroll_configuration_id} summary: PayrollConfigurations/Get response_examples: - status: '200' media_type: application/json - status: '403' media_type: application/json - status: '404' media_type: text/html - status: '404' media_type: application/json - operationId: previewPayrollConfigurationDetails operation: POST /companies/{company_id}/payroll_configurations/{payroll_id}/preview_payroll_configuration_details summary: preview_payroll_configuration_details response_examples: - status: '200' media_type: application/json - status: '422' media_type: application/json - operationId: companiesPostponementsCreate operation: POST /companies/{company_id}/postponements summary: Companies/Postponements/Create response_examples: - status: '201' media_type: application/json - status: '403' media_type: application/json - status: '422' media_type: application/json - operationId: companiesPostponementsListWithHistoricalEmployeeData operation: GET /companies/{company_id}/postponements summary: Companies/Postponements/List with Historical Employee Data response_examples: - status: '200' media_type: application/json - operationId: companiesSchemesList operation: GET /companies/{company_id}/schemes summary: Companies/Schemes/List response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/plain - operationId: sSIFHeadersMappingsCreate operation: POST /companies/{company_id}/ssif_headers_mappings summary: SSIFHeadersMappings/Create response_examples: - status: '201' media_type: application/json - status: '422' media_type: application/json - operationId: sSIFHeadersMappingsList operation: GET /companies/{company_id}/ssif_headers_mappings summary: SSIFHeadersMappings/List response_examples: - status: '200' media_type: application/json - operationId: sSIFHeadersMappingsDestroy operation: DELETE /companies/{company_id}/ssif_headers_mappings/{id} summary: SSIFHeadersMappings/Destroy response_examples: - status: '404' media_type: application/json - operationId: sSIFHeadersMappingsList2 operation: GET /companies/{company_id}/ssif_headers_mappings/{id} summary: SSIFHeadersMappings/List response_examples: - status: '200' media_type: application/json - operationId: sSIFHeadersMappingsUpdate operation: PUT /companies/{company_id}/ssif_headers_mappings/{id} summary: SSIFHeadersMappings/Update response_examples: - status: '200' media_type: application/json - status: '422' media_type: application/json - operationId: sSIFHeadersMappingsUpdate2 operation: PATCH /companies/{company_id}/ssif_headers_mappings/{id} summary: SSIFHeadersMappings/Update response_examples: - status: '200' media_type: application/json - status: '422' media_type: application/json - operationId: sSIFImportsAssignSSIFHeadersMapping operation: POST /companies/{company_id}/ssif_imports/{ssif_import_id}/assign_ssif_headers_mapping summary: SSIFImports/AssignSSIFHeadersMapping response_examples: - status: '200' media_type: application/json - status: '403' media_type: application/json - status: '404' media_type: application/json - status: '422' media_type: application/json - operationId: sSIFImportsCreate operation: POST /companies/{company_id}/ssif_imports summary: SSIFImports/Create response_examples: - status: '201' media_type: application/json - operationId: sSIFImportsList operation: GET /companies/{company_id}/ssif_imports summary: SSIFImports/List response_examples: - status: '200' media_type: application/json - operationId: sSIFImportsFileHeaders operation: GET /companies/{company_id}/ssif_imports/{ssif_import_id}/file_headers summary: SSIFImports/FileHeaders response_examples: - status: '200' media_type: application/json - operationId: sSIFImportsTemplate operation: GET /companies/{company_id}/ssif_imports/template summary: SSIFImports/Template response_examples: - status: '200' media_type: text/csv - operationId: sSIFImportsGet operation: GET /companies/{company_id}/ssif_imports/{ssif_import_id} summary: SSIFImports/Get response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/html - status: '403' media_type: application/json - status: '404' media_type: application/json - operationId: sSIFImportsSSIFImportMissingEmployeesList operation: GET /companies/{company_id}/ssif_imports/{ssif_import_id}/ssif_import_missing_employees summary: SSIFImports/SSIFImportMissingEmployees/List response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/plain - operationId: sSIFImportsSSIFImportResultsList operation: GET /companies/{company_id}/ssif_imports/{ssif_import_id}/ssif_import_results summary: SSIFImports/SSIFImportResults/List response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/plain - status: '401' media_type: text/html - status: '403' media_type: application/json - operationId: tasksList2 operation: GET /companies/{company_id}/tasks summary: Tasks/List response_examples: - status: '200' media_type: application/json - operationId: companiesThirdPartyPaymentProvidersGet operation: GET /companies/{company_id}/third_party_payment_providers/{id} summary: Companies/ThirdPartyPaymentProviders/Get response_examples: - status: '200' media_type: application/json - operationId: companiesThirdPartyPaymentProvidersList operation: GET /companies/{company_id}/third_party_payment_providers summary: Companies/ThirdPartyPaymentProviders/List response_examples: - status: '200' media_type: application/json - operationId: companiesThirdPartyPaymentProvidersGet2 operation: GET /companies/{company_id}/third_party_payment_providers/{id}/sensitive_data summary: Companies/ThirdPartyPaymentProviders/Get response_examples: - status: '200' media_type: application/json - operationId: companiesTotalFundsAmcsList operation: GET /companies/{company_id}/total_funds_amcs summary: Companies/TotalFundsAmcs/List response_examples: - status: '200' media_type: application/json - operationId: ultimateBeneficialOwnerAndConfigurationsCreate operation: POST /companies/{company_id}/ultimate_beneficial_owner_and_configuration summary: UltimateBeneficialOwnerAndConfigurations/Create response_examples: - status: '201' media_type: application/json - status: '422' media_type: application/json - operationId: companiesUltimateBeneficialOwnerAndConfigurationsGet operation: GET /companies/{company_id}/ultimate_beneficial_owner_and_configuration summary: Companies/UltimateBeneficialOwnerAndConfigurations/Get response_examples: - status: '200' media_type: application/json - operationId: companiesUltimateBeneficialOwnersGet operation: GET /companies/{company_id}/ultimate_beneficial_owners/{id} summary: Companies/UltimateBeneficialOwners/Get response_examples: - status: '200' media_type: application/json - operationId: companiesUltimateBeneficialOwnersList operation: GET /companies/{company_id}/ultimate_beneficial_owners summary: Companies/UltimateBeneficialOwners/List response_examples: - status: '200' media_type: application/json - operationId: companyBrandingStocksList operation: GET /company_branding_stocks summary: CompanyBrandingStocks/List response_examples: - status: '200' media_type: application/json - operationId: companyLookupsGet operation: GET /company_lookups/{country_code}/{id} summary: CompanyLookups/Get response_examples: - status: '200' media_type: application/json - operationId: companyLookupsGet2 operation: GET /company_lookups/{id} summary: CompanyLookups/Get response_examples: - status: '200' media_type: application/json - operationId: companyLookupsList operation: GET /company_lookups summary: CompanyLookups/List response_examples: - status: '200' media_type: application/json - operationId: constantsGet operation: GET /constants summary: Constants/Get response_examples: - status: '200' media_type: application/json - operationId: countriesLegalBankLocationList operation: GET /countries/legal_bank_location summary: Countries/LegalBankLocation/List response_examples: - status: '200' media_type: application/json - operationId: countriesList operation: GET /countries summary: Countries/List response_examples: - status: '200' media_type: application/json - operationId: countriesNationalityList operation: GET /countries/nationality summary: Countries/Nationality/List response_examples: - status: '200' media_type: application/json - operationId: currenciesList operation: GET /currencies summary: Currencies/List response_examples: - status: '200' media_type: application/json - operationId: customerLeadsCreate operation: POST /customer_leads/ summary: CustomerLeads/Create response_examples: - status: '200' media_type: application/json - status: '422' media_type: application/json - operationId: customerLeadsEarliestPlanEffectiveDate operation: GET /customer_leads/earliest_plan_effective_date summary: CustomerLeads/EarliestPlanEffectiveDate response_examples: - status: '200' media_type: application/json - operationId: companiesGet2 operation: GET /customer_leads/{customer_lead_id} summary: Companies/Get response_examples: - status: '200' media_type: application/json - operationId: passwordCreate operation: POST /customers/password summary: Password/Create response_examples: - status: '201' media_type: application/json - operationId: customersReferralsCreate operation: POST /customers/referrals summary: Customers/Referrals/Create response_examples: - status: '201' media_type: application/json - operationId: customersSession operation: GET /customers/session summary: Customers/Session response_examples: - status: '200' media_type: application/json - operationId: companiesAdditionalTaxResidencesCreate operation: POST /companies/{company_id}/employees/{employee_id}/additional_tax_residences summary: Companies/AdditionalTaxResidences/Create response_examples: - status: '201' media_type: application/json - status: '422' media_type: application/json - operationId: companiesAdditionalTaxResidencesList operation: GET /companies/{company_id}/employees/{employee_id}/additional_tax_residences summary: Companies/AdditionalTaxResidences/List response_examples: - status: '200' media_type: application/json - operationId: companiesAdditionalTaxResidencesDestroy operation: DELETE /companies/{company_id}/employees/{employee_id}/additional_tax_residences/{id} summary: Companies/AdditionalTaxResidences/Destroy response_examples: - status: '401' media_type: text/plain - status: '403' media_type: application/json - status: '404' media_type: application/json - operationId: companiesAdditionalTaxResidencesUpdate operation: PUT /companies/{company_id}/employees/{employee_id}/additional_tax_residences/{id} summary: Companies/AdditionalTaxResidences/Update response_examples: - status: '422' media_type: application/json - operationId: companiesAdditionalTaxResidencesUpdate2 operation: PATCH /companies/{company_id}/employees/{employee_id}/additional_tax_residences/{id} summary: Companies/AdditionalTaxResidences/Update response_examples: - status: '422' media_type: application/json - operationId: employeesEmploymentPeriodsList operation: GET /employees/employment_periods summary: Employees/EmploymentPeriods/List response_examples: - status: '200' media_type: application/json - operationId: employeesMarketingPreferenceUpdate operation: PUT /employees/marketing_preference summary: Employees/MarketingPreference/Update response_examples: - status: '401' media_type: text/plain - status: '422' media_type: application/json - operationId: employeesMarketingPreferenceUpdate2 operation: PATCH /employees/marketing_preference summary: Employees/MarketingPreference/Update response_examples: - status: '401' media_type: text/plain - status: '422' media_type: application/json - operationId: employeesMoneySummary operation: GET /companies/{company_id}/employees/{employee_id}/money_summary summary: Employees/MoneySummary response_examples: - status: '200' media_type: application/json - operationId: employeesPresignedPostCreate operation: POST /companies/{company_id}/employees/{employee_id}/presigned_post summary: Employees/PresignedPost/Create response_examples: - status: '200' media_type: application/json - status: '403' media_type: application/json - operationId: employeesRecurringContributionScheduleCreate operation: POST /companies/{company_id}/employees/{employee_id}/recurring_contribution_schedule summary: Employees/RecurringContributionSchedule/Create response_examples: - status: '201' media_type: application/json - status: '401' media_type: text/plain - status: '422' media_type: application/json - operationId: employeesRecurringContributionScheduleDestroy operation: DELETE /companies/{company_id}/employees/{employee_id}/recurring_contribution_schedule summary: Employees/RecurringContributionSchedule/Destroy response_examples: - status: '401' media_type: text/plain - operationId: employeesRecurringContributionScheduleShow operation: GET /companies/{company_id}/employees/{employee_id}/recurring_contribution_schedule summary: Employees/RecurringContributionSchedule/Show response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/plain - status: '404' media_type: application/json - operationId: employeesRecurringContributionScheduleUpdate operation: PATCH /companies/{company_id}/employees/{employee_id}/recurring_contribution_schedule summary: Employees/RecurringContributionSchedule/Update response_examples: - status: '401' media_type: text/plain - status: '422' media_type: application/json - operationId: employeesRetirement operation: GET /employees/retirement summary: Employees/Retirement response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/plain - operationId: employeesRetirementOptions operation: GET /employees/retirement_options summary: Employees/RetirementOptions response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/plain - status: '403' media_type: application/json - operationId: employeesSession operation: GET /employees/session summary: Employees/Session response_examples: - status: '200' media_type: application/json - operationId: employeesSingleContributionPaymentsCreate operation: POST /companies/{company_id}/employees/{employee_id}/single_contribution_payments summary: Employees/SingleContributionPayments/Create response_examples: - status: '201' media_type: application/json - status: '401' media_type: text/plain - status: '403' media_type: application/json - status: '422' media_type: application/json - operationId: subaccountGroupsValuationsList2 operation: GET /employees/subaccount_groups_valuations summary: SubaccountGroupsValuations/List response_examples: - status: '200' media_type: application/json - operationId: employeesAccountSubaccountsSwitchPlansConfirm operation: POST /companies/{company_id}/employees/{employee_id}/subaccount_switch_plans/{id}/confirm summary: Employees/AccountSubaccountsSwitchPlans/Confirm response_examples: - status: '404' media_type: application/json - operationId: employeesAccountSubaccountsSwitchPlansCreate operation: POST /companies/{company_id}/employees/{employee_id}/subaccount_switch_plans summary: Employees/AccountSubaccountsSwitchPlans/Create response_examples: - status: '201' media_type: application/json - operationId: companiesEmployeesSwitchesDelayability operation: GET /companies/{company_id}/employees/{employee_id}/switches/delayability summary: Companies/Employees/Switches/Delayability response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/plain - operationId: companiesEmployeesSwitchesRequestForCurrentHoldings operation: POST /companies/{company_id}/employees/{employee_id}/switches/request_for_current_holdings summary: Companies/Employees/Switches/RequestForCurrentHoldings response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/plain - status: '403' media_type: application/json - status: '422' media_type: application/json - operationId: companiesEmployeesSwitchesRequestMonetary operation: POST /companies/{company_id}/employees/{employee_id}/switches/request_monetary summary: Companies/Employees/Switches/RequestMonetary response_examples: - status: '200' media_type: application/json - status: '401' media_type: text/plain - status: '403' media_type: application/json - status: '422' media_type: application/json - operationId: valuationsList2 operation: GET /employees/valuations summary: Valuations/List response_examples: - status: '200' media_type: application/json - operationId: valuationsGet2 operation: GET /employees/valuations/{id} summary: Valuations/Get response_examples: - status: '200' media_type: application/json - operationId: featureFlagsList operation: GET /feature_flags summary: FeatureFlags/List response_examples: - status: '200' media_type: application/json - operationId: identityProfilesPersonalData operation: GET /identity/api/profiles/personal-data summary: Identity/profiles/personal-data response_examples: - status: '200' media_type: application/json - status: '401' media_type: application/json - operationId: identityProfilesPersonalData2 operation: PATCH /identity/api/profiles/personal-data summary: Identity/profiles/personal-data response_examples: - status: '200' media_type: application/json - status: '401' media_type: application/json - status: '422' media_type: application/json - operationId: identityProfilesRegistrationData operation: GET /identity/api/profiles/registration-data summary: Identity/profiles/registration-data response_examples: - status: '200' media_type: application/json - status: '401' media_type: application/json - status: '422' media_type: application/json - operationId: individualsRetirementAge operation: PUT /individuals/retirement_age summary: Individuals/RetirementAge response_examples: - status: '200' media_type: application/json - operationId: jwksGet operation: GET /.well-known/jwks summary: Jwks/Get response_examples: - status: '200' media_type: application/json - operationId: discoveryList operation: GET / summary: Discovery/List response_examples: - status: '200' media_type: application/json - operationId: mobileAppVersionsGet operation: GET /mobile_app_versions/{mobile_platform} summary: MobileAppVersions/Get response_examples: - status: '200' media_type: application/json - operationId: onboardingAcceptTerms operation: POST /onboarding/accept-terms summary: Onboarding/AcceptTerms response_examples: - status: '200' media_type: application/json - status: '422' media_type: application/json - operationId: onboardingStatus operation: GET /onboarding/status summary: Onboarding/Status response_examples: - status: '200' media_type: application/json - operationId: onboardingOptions operation: GET /onboarding/options summary: Onboarding/Options response_examples: - status: '200' media_type: application/json - status: '400' media_type: application/json - status: '422' media_type: application/json - operationId: onboardingPersonalData operation: GET /onboarding/personal-data summary: Onboarding/PersonalData response_examples: - status: '200' media_type: application/json - operationId: onboardingPersonalData2 operation: PATCH /onboarding/personal-data summary: Onboarding/PersonalData response_examples: - status: '200' media_type: application/json - status: '422' media_type: application/json - operationId: transferOutsCreate operation: POST /partners/employees/{employee_id}/transfer_out summary: TransferOuts/Create response_examples: - status: '201' media_type: application/json - operationId: companiesMandatesComplete operation: POST /payments_service/companies/{company_uuid}/mandates/{mandate_uuid}/complete summary: Companies/Mandates/Complete response_examples: - status: '200' media_type: application/json - operationId: companiesMandatesCreate operation: POST /payments_service/companies/{company_uuid}/mandates summary: Companies/Mandates/Create response_examples: - status: '200' media_type: application/json - operationId: companiesMandatesList operation: GET /payments_service/companies/{company_uuid}/mandates summary: Companies/Mandates/List response_examples: - status: '200' media_type: application/json - operationId: companiesMandatesGet operation: GET /payments_service/companies/{company_uuid}/mandates/{mandate_uuid} summary: Companies/Mandates/Get response_examples: - status: '200' media_type: application/json - operationId: companiesMandatesSelect operation: POST /payments_service/companies/{company_uuid}/mandates/{mandate_uuid}/select summary: Companies/Mandates/Select response_examples: - status: '200' media_type: application/json - operationId: pensionForecastModellerProjectionsCreate operation: POST /pension_forecast/modeller_projection summary: PensionForecast/ModellerProjections/Create response_examples: - status: '200' media_type: application/json - status: '422' media_type: application/json - operationId: schemesAvailable operation: GET /schemes/available summary: Schemes/Available response_examples: - status: '200' media_type: application/json - operationId: sSIFImportGet operation: GET /ssif_imports/download_template summary: SSIFImport/Get response_examples: - status: '200' media_type: text/csv - operationId: tokensInfo operation: GET /oauth/token/info summary: Tokens/Info response_examples: - status: '200' media_type: application/json - operationId: tokensCreate operation: POST /oauth/token summary: Tokens/Create response_examples: - status: '200' media_type: application/json - status: '401' media_type: application/json - operationId: tokensRefresh operation: POST /refresh_token summary: Tokens/Refresh response_examples: - status: '200' media_type: application/json - operationId: stagingDateGet operation: GET /tpr/staging_date summary: StagingDate/Get response_examples: - status: '200' media_type: application/json - operationId: urlsList operation: GET /urls summary: Urls/List response_examples: - status: '200' media_type: application/json - operationId: advisersUsersMarketingPreferenceUpdate operation: PUT /users/marketing_preference summary: Advisers/Users/MarketingPreference/Update response_examples: - status: '401' media_type: text/plain - status: '422' media_type: application/json - operationId: advisersUsersMarketingPreferenceUpdate2 operation: PATCH /users/marketing_preference summary: Advisers/Users/MarketingPreference/Update response_examples: - status: '401' media_type: text/plain - status: '422' media_type: application/json - operationId: password operation: POST /users/password summary: Password response_examples: - status: '201' media_type: application/json - operationId: usersSession operation: GET /users/session summary: Users/Session response_examples: - status: '200' media_type: application/json - operationId: verificationChecksGenerateVerificationUrl2 operation: POST /verification_checks/generate_verification_url summary: VerificationChecks/GenerateVerificationUrl response_examples: - status: '422' media_type: application/json - operationId: verificationChecksState2 operation: GET /verification_checks/state summary: VerificationChecks/State response_examples: - status: '200' media_type: application/json - status: '422' media_type: application/json - operationId: verificationChecksVerificationUrl operation: GET /verification_checks/verification_url summary: VerificationChecks/verification_url response_examples: - status: '200' media_type: application/json - status: '422' media_type: application/json