WealthOS API

https://wos-gb.sandbox.wealthos.cloud/admin/documentation
Admin
WealthOS API is a comprehensive RESTful and WebSocket API platform for building digital wealth...
Tokens:321,444
Snippets:1,106
Trust Score:6.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Example JSON Response for Fee Setups

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

This is an example of a successful JSON response when retrieving fee setups. It outlines the structure of fee setup details.

```json
{
  * "fee_setups": [
    * {
      * "fee_setup_id": "6efa81d9-073f-4ac2-9e09-66d6934b57e3",
      * "fee_calculation_entity": "Investor",
      * "fee_calculation_method": "Daily Accrual",
      * "primary_transaction_type": "Fees",
      * "sub_transaction_type": "Advisor ongoing fee",
      * "fee_code": "FF_50",
      * "assigned_to": "All",
      * "start_date": "2022-10-31",
      * "end_date": "2023-10-31",
      * "status": "Active",
      * "created_at": "2022-10-26T13:24:00.459Z",
      * "updated_at": "2022-10-26T13:24:00.459Z"
}
]

}
```

--------------------------------

### GET /tenant/fees/v1/setups

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation

Retrieves fee setups based on various criteria such as entity, method, sub-transaction type, fee codes, assignment, and date range. This endpoint is currently in BETA.

```APIDOC
## GET /tenant/fees/v1/setups

### Description
Retrieves fee setups in the system for recurring fee computations. This endpoint is currently in BETA and supports filtering by multiple parameters.

### Method
GET

### Endpoint
https://web_host_name/tenant/fees/v1/setups

### Query Parameters
- **fee_calculation_entity** (string) - Optional - Level at which the recurring fee sub transaction type is setup (Options: Investor, Financial Product, Portfolio, Investor Account).
- **fee_calculation_method** (string) - Optional - Fee calculation method used for fee computation (Options: Daily Accrual).
- **sub_transaction_type** (string) - Optional - Fee Sub transaction type (e.g., 'Service fees', 'Platform fees').
- **fee_codes** (string) - Optional - Fee codes of the fee setup to be retrieved (e.g., 'FF_50', 'PF_75').
- **assigned_to** (string) - Optional - Instances of the entity for which the fee sub transaction type is setup (Options: All, a single instance, or an array of instances).
- **start_date** (string) - Optional - Start date for filtering fee setups (YYYY-MM-DD format).
- **end_date** (string) - Optional - End date for filtering fee setups (YYYY-MM-DD format).
- **status** (string) - Optional - Status of the fee code to retrieve (Active, Inactive).

### Request Example
```curl
curl --request GET \
  --url 'https://wos-gb.sandbox.wealthos.cloud/tenant/fees/v1/setups?fee_calculation_entity=SOME_STRING_VALUE&fee_calculation_method=SOME_STRING_VALUE&sub_transaction_type=SOME_STRING_VALUE&fee_codes=SOME_STRING_VALUE&assigned_to=SOME_STRING_VALUE&start_date=SOME_STRING_VALUE&end_date=SOME_STRING_VALUE&status=SOME_STRING_VALUE' \
  --header 'x-api-key: REPLACE_KEY_VALUE'
```

### Response
#### Success Response (200)
- **fee_setups** (array) - A list of fee setup objects.
  - **fee_setup_id** (string) - The unique identifier for the fee setup.
  - **fee_calculation_entity** (string) - The entity level for fee calculation.
  - **fee_calculation_method** (string) - The method used for fee calculation.
  - **primary_transaction_type** (string) - The primary transaction type.
  - **sub_transaction_type** (string) - The sub-transaction type for the fee.
  - **fee_code** (string) - The associated fee code.
  - **assigned_to** (string) - Indicates how the fee is assigned.
  - **start_date** (string) - The start date of the fee setup.
  - **end_date** (string) - The end date of the fee setup.
  - **status** (string) - The status of the fee setup (e.g., 'Active').
  - **created_at** (string) - Timestamp when the fee setup was created.
  - **updated_at** (string) - Timestamp when the fee setup was last updated.

#### Response Example
```json
{
  "fee_setups": [
    {
      "fee_setup_id": "6efa81d9-073f-4ac2-9e09-66d6934b57e3",
      "fee_calculation_entity": "Investor",
      "fee_calculation_method": "Daily Accrual",
      "primary_transaction_type": "Fees",
      "sub_transaction_type": "Advisor ongoing fee",
      "fee_code": "FF_50",
      "assigned_to": "All",
      "start_date": "2022-10-31",
      "end_date": "2023-10-31",
      "status": "Active",
      "created_at": "2022-10-26T13:24:00.459Z",
      "updated_at": "2022-10-26T13:24:00.459Z"
    }
  ]
}
```

### Error Handling
- **400**: Bad Request - Indicates validation errors in the request.
- **401**: Unauthorized - Missing or invalid authentication information.
- **403**: Forbidden - Insufficient permissions to access the resource.
- **404**: Not Found - The specified resource was not found.
- **429**: Too Many Requests - Rate limit exceeded.
- **500**: Internal Server Error - System error.
```

--------------------------------

### GET /tenant/fees/v1/setups

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

Retrieves fee setups from the system. This endpoint supports filtering by various criteria such as entity, method, sub-transaction type, fee codes, assignment, dates, and status.

```APIDOC
## GET /tenant/fees/v1/setups

### Description
Retrieves fee setups from the system. This endpoint supports filtering by various criteria such as entity, method, sub-transaction type, fee codes, assignment, dates, and status.

### Method
GET

### Endpoint
/tenant/fees/v1/setups

### Query Parameters
- **fee_calculation_entity** (string) - Optional - Level at which the recurring fee sub transaction type is setup. Can give multiple fee calculation entities as comma separated values (Options - Investor, Financial Product, Portfolio, Investor Account).
- **fee_calculation_method** (string) - Optional - Fee calculation method used for fee computation (Options - Daily Accrual).
- **sub_transaction_type** (string) - Optional - Fee Sub transaction type set up for the entity (ex- Service fees, Platform fees).
- **fee_codes** (string) - Optional - Fee codes of the fee setup to be retrieved (ex- FF_50, PF_75).
- **assigned_to** (string) - Optional - Instances of the entity for which the fee sub transaction type is setup.
- **start_date** (string) - Optional - Start date of the fee setup (YYYY-MM-DD format).
- **end_date** (string) - Optional - End date of the fee setup (YYYY-MM-DD format).
- **status** (string) - Optional - Status of the fee code to be retrieved (Active, Inactive).

### Request Example
```json
{
  "fee_calculation_entity": "SOME_STRING_VALUE",
  "fee_calculation_method": "SOME_STRING_VALUE",
  "sub_transaction_type": "SOME_STRING_VALUE",
  "fee_codes": "SOME_STRING_VALUE",
  "assigned_to": "SOME_STRING_VALUE",
  "start_date": "SOME_STRING_VALUE",
  "end_date": "SOME_STRING_VALUE",
  "status": "SOME_STRING_VALUE"
}
```

### Response
#### Success Response (200)
- **fee_setups** (array) - An array of fee setup objects.
  - **fee_setup_id** (string) - The unique identifier for the fee setup.
  - **fee_calculation_entity** (string) - The entity level for the fee setup.
  - **fee_calculation_method** (string) - The method used for fee calculation.
  - **primary_transaction_type** (string) - The primary transaction type.
  - **sub_transaction_type** (string) - The sub-transaction type for the fee.
  - **fee_code** (string) - The fee code associated with the setup.
  - **assigned_to** (string) - Indicates who the fee is assigned to.
  - **start_date** (string) - The start date of the fee setup.
  - **end_date** (string) - The end date of the fee setup.
  - **status** (string) - The status of the fee setup.
  - **created_at** (string) - The timestamp when the fee setup was created.
  - **updated_at** (string) - The timestamp when the fee setup was last updated.

#### Response Example
```json
{
  "fee_setups": [
    {
      "fee_setup_id": "6efa81d9-073f-4ac2-9e09-66d6934b57e3",
      "fee_calculation_entity": "Investor",
      "fee_calculation_method": "Daily Accrual",
      "primary_transaction_type": "Fees",
      "sub_transaction_type": "Advisor ongoing fee",
      "fee_code": "FF_50",
      "assigned_to": "All",
      "start_date": "2022-10-31",
      "end_date": "2023-10-31",
      "status": "Active",
      "created_at": "2022-10-26T13:24:00.459Z",
      "updated_at": "2022-10-26T13:24:00.459Z"
    }
  ]
}
```
```

--------------------------------

### Example Transaction Response

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

This is an example of a successful response when retrieving pot transactions. It includes details about the transactions and pagination information.

```JSON
{
  "pot_id": "pot-UKW3452850",
  "transactions": [
    {
      "transaction_id": "80784c92-8f9d-4150-b83c-dc6d217a8155",
      "created_at": "2023-01-27T05:45:56.839Z",
      "updated_at": "2023-01-27T05:45:56.839Z",
      "primary_transaction_type": "Contribution",
      "sub_transaction_type": "Lump sum",
      "investment_product_id": "cash",
      "transaction_value": "20000.00",
      "settlement_date": "2023-01-27",
      "currency": "GBP",
      "direction": "in",
      "type": "archived",
      "sub_type": "settled",
      "origin": "api"
}
],
  "next_page_available": true
}
```

--------------------------------

### Get Fee Setups using Curl

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

Use this snippet to retrieve fee setups from the WealthOS API. Replace 'REPLACE_KEY_VALUE' with your API key and adjust query parameters as needed.

```curl
curl --request GET \
  --url 'https://wos-gb.sandbox.wealthos.cloud/tenant/fees/v1/setups?fee_calculation_entity=SOME_STRING_VALUE&fee_calculation_method=SOME_STRING_VALUE&sub_transaction_type=SOME_STRING_VALUE&fee_codes=SOME_STRING_VALUE&assigned_to=SOME_STRING_VALUE&start_date=SOME_STRING_VALUE&end_date=SOME_STRING_VALUE&status=SOME_STRING_VALUE' \
  --header 'x-api-key: REPLACE_KEY_VALUE'
```

--------------------------------

### Sample Response: Configured Investment Products

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation

This is a sample JSON response when successfully retrieving configured investment products. It includes product details and pagination information.

```json
{
  * "investment_products": [
    * {
      * "investment_product_id": "MAX2854",
      * "asset_type": "funds",
      * "status": "active",
      * "name": "Canada Life Canadian Growth T5",
      * "created_at": "2020-07-08T07:36:05.884Z",
      * "updated_at": "2020-07-10T07:36:05.884Z"
}
],
  * "next_page_available": true

}
```

--------------------------------

### Get Current Pot Value Response

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation

Example response for the 'Get Current Pot Value' endpoint, detailing various value components like total value, free value, and cash positions.

```json
{
  "pot_id": "pot-UKW3452850",
  "pot_currency": "GBP",
  "total_value": "600",
  "total_free_value": "300",
  "total_locked_value": "300",
  "total_cash_value": "250",
  "total_free_cash_value": "50",
  "total_locked_cash_value": "200",
  "settled_cash_position": "334.87"

}
```

--------------------------------

### Get Recurring Withdrawals Response Sample

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

Example JSON response when retrieving recurring withdrawals. Indicates if more pages are available.

```json
{
  "recurring_withdrawals": [
    {
      "withdrawal_id": "RCW-AB24DE7",
      "withdrawal_name": "Withdrawals to SIPP",
      "investor_id": "inv-AUX11265",
      "pot_id": "pot-GYQ5423100",
      "bank_account_id": "ba-92yu982d-at6u-4242-9856-83",
      "amount": "100.00",
      "currency": "GBP",
      "withdrawal_schedule": {
        "interval_unit": "monthly",
        "interval": 2,
        "date": 1,
        "start_date": "2026-04-02",
        "end_date": "2026-11-02"
},
      "status": "active",
      "next_withdrawal_date": "2023-05-01T00:00:00.000Z",
      "created_at": "2023-04-04T15:12:30.000Z",
      "updated_at": "2023-04-04T15:12:30.000Z",
      "reference_version": 1
}
],
  "next_page_available": true
}
```

--------------------------------

### Sample Response for Get All Workplace Employers

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

Example JSON response for a successful retrieval of workplace employers, including pagination information.

```json
{
  "workplace_employers": [
    {
      "name": "Romayo Ltd",
      "registration_number": "1234567",
      "registered_address": {
        "postal_code": "S2 2DF",
        "address_line": "14",
        "street_name": "Tottenham Court Road",
        "city": "London",
        "state": "England",
        "country": "GBR"
},
      "correspondence_address": {
        "postal_code": "A3 2CF",
        "address_line": "17",
        "street_name": "Flower Road",
        "city": "London",
        "state": "England",
        "country": "GBR"
},
      "company_structure": "LLC",
      "contact_details": {
        "name": "Adam Clark",
        "email": "adamclark@gmail.com",
        "phone_number": "+441234567890"
},
      "kyb_aml_status": "clear",
      "status": "active",
      "workplace_employer_id": "wem-AHY58878",
      "reference_version": 1,
      "created_at": "2023-07-08T07:36:05.884Z",
      "updated_at": "2023-07-10T07:36:05.884Z"
}
],
  "next_page_available": true
}
```

--------------------------------

### Cash Deposit Buy Instruction Response Sample

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation

Example of a successful JSON response after creating a cash deposit buy instruction.

```json
{
  "aggregated_transaction_id": "c106b5e7-aac5-4466-9698-fe4ea792a63r",
  "transaction_id": "c106b5e7-aac5-4466-9698-fe4ea792a67e",
  "investment_product_id": "CASHINV-EUQ86362",
  "pot_id": "pot-NAH5143230",
  "counterparty_id": "CPY-AHY58878",
  "primary_transaction_type": "Buy",
  "sub_transaction_type": "Cash deposit buy",
  "transaction_value": "110",
  "type": "pending",
  "sub_type": "scheduled",
  "currency": "GBP",
  "direction": "in",
  "origin": "api",
  "is_a_topup": false,
  "created_at": "2024-10-20T14:49:59.878Z",
  "updated_at": "2024-10-20T14:49:59.878Z"

}
```

--------------------------------

### Get Transaction Details Sample

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

Example JSON response detailing a cash investment transaction. Includes identifiers, transaction values, and timestamps.

```json
{
  "transaction_id": "c106b5e7-aac5-4466-9698-fe4ea792a63r",
  "aggregated_transaction_id": "e2af9f53-1cfc-4081-aab5-09250bd7d059",
  "pot_id": "pot-NAH5143230",
  "investment_product_id": "CASHINV-EUQ86362",
  "deposit_reference": "REDEMP-EUQ86362",
  "redemption_type": "partial",
  "currency": "GBP",
  "transaction_value": "1000.00",
  "primary_transaction_type": "Sell",
  "sub_transaction_type": "Cash deposit - full redemption",
  "type": "pending",
  "sub_type": "pending",
  "created_at": "2024-10-20T14:49:59.878Z",
  "updated_at": "2024-10-20T14:49:59.878Z"
}
```

--------------------------------

### POST /tenant/portfolio-templates/v1/

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

Creates a new portfolio template with specified name and investment ratios.

```APIDOC
## POST /tenant/portfolio-templates/v1/

### Description
Creates a new portfolio template. Requires a portfolio name and a list of investment ratios.

### Method
POST

### Endpoint
https://web_host_name/tenant/portfolio-templates/v1/

### Headers
- **x-api-key** (string) - Required - Your API secret key.

### Request Body
- **portfolio_name** (string) - Required - User given identifier for the portfolio name. Must be between 3 and 50 characters. The first character must be a letter, the last character can be a number, letter, or underscore, and other characters can be letters, numbers, spaces, underscores, or dashes.
- **ratios** (array of objects) - Required - Percentages allocated to different investment products within the portfolio template.
  - **investment_product_id** (string) - Required - The ID of the investment product.
  - **ratio** (string) - Required - The percentage allocation for the investment product.

### Request Example
```json
{
  "portfolio_name": "PFT5689",
  "ratios": [
    {
      "investment_product_id": "ETF069GBP",
      "ratio": "60"
    },
    {
      "investment_product_id": "BND058GBP",
      "ratio": "40"
    }
  ]
}
```

### Response
#### Success Response (201)
- **portfolio_template_id** (string) - The unique identifier for the newly created portfolio template.
- **portfolio_name** (string) - The name of the portfolio template.
- **reference_version** (integer) - The reference version of the template.
- **ratios** (array) - An array of ratio objects, detailing investment product allocations.
  - **investment_product_id** (string) - The ID of the investment product.
  - **ratio** (string) - The percentage allocation for the investment product.
- **created_at** (string) - The timestamp when the template was created.
- **updated_at** (string) - The timestamp when the template was last updated.

#### Error Responses
- **400** - Bad Request: Request is not complete and may have validation errors.
- **401** - Unauthorized: You do not have permissions to access this resource.
- **403** - Forbidden: Your authentication information is missing or invalid.
- **404** - Not Found: The specified resource was not found.
- **429** - Too Many Requests: You have sent too many requests. Please retry later.
- **500** - Internal Server Error: System error. Retry later.

### Response Example (201)
```json
{
  "portfolio_template_id": "pft-c60c9472-6668-4f7a-aa69",
  "portfolio_name": "PFT5689",
  "reference_version": 1,
  "ratios": [
    {
      "investment_product_id": "ETF069GBP",
      "ratio": "60"
    },
    {
      "investment_product_id": "BND058GBP",
      "ratio": "40"
    }
  ],
  "created_at": "2020-07-08T07:36:05.884Z",
  "updated_at": "2020-07-10T07:36:05.884Z"
}
```
```

--------------------------------

### Sample Response for Get Specific Workplace Employer

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

Example JSON response for a successful retrieval of a specific workplace employer's details.

```json
{
  "name": "Romayo Ltd",
  "registration_number": "1234567",
  "registered_address": {
    "postal_code": "S2 2DF",
    "address_line": "14",
    "street_name": "Tottenham Court Road",
    "city": "London",
    "state": "England",
    "country": "GBR"
},
  "correspondence_address": {
    "postal_code": "A3 2CF",
    "address_line": "17",
    "street_name": "Flower Road",
    "city": "London",
    "state": "England",
    "country": "GBR"
},
  "company_structure": "LLC",
  "contact_details": {
    "name": "Adam Clark",
    "email": "adamclark@gmail.com",
    "phone_number": "+441234567890"
},
  "kyb_aml_status": "clear",
  "status": "active",
  "workplace_employer_id": "wem-AHY58878",
  "reference_version": 1,
  "created_at": "2023-07-08T07:36:05.884Z",
  "updated_at": "2023-07-10T07:36:05.884Z"
}
```

--------------------------------

### Create New Portfolio Template Request Sample

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

Example of a successful request to create a new portfolio template, including the required payload structure.

```shell
curl --request POST \
  --url https://wos-gb.sandbox.wealthos.cloud/tenant/portfolio-templates/v1/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: REPLACE_KEY_VALUE' \
  --data '{
  "portfolio_name": "PFT5689",
  "ratios": [
    {
      "investment_product_id": "ETF069GBP",
      "ratio": "60"
},
    {
      "investment_product_id": "BND058GBP",
      "ratio": "40"
}
]'
```

--------------------------------

### Get Pot Holdings Request Sample

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

Example of a cURL request to retrieve the current holdings of a pot. Replace 'REPLACE_KEY_VALUE' with your actual API key.

```shell
curl --request GET \
  --url https://wos-gb.sandbox.wealthos.cloud/tenant/pots/v1/%7Bpot_id%7D/holdings \
  --header 'x-api-key: REPLACE_KEY_VALUE'
```

--------------------------------

### Portfolio Template Investment Ratios

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

This example illustrates how a portfolio template defines the allocation ratios for different investment products. The sum of ratios must equal 100% for the template to be valid.

```text
Investment Product | Ratio  
---|---
Investment Product A | 20%  
Investment Product B | 30%  
Investment Product C | 50%
```

--------------------------------

### Get Configured Investment Products (Shell + Curl)

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

Use this cURL command to retrieve all investment products configured for a tenancy. You can filter by status and control pagination using query parameters. Ensure you replace 'REPLACE_KEY_VALUE' with your actual ApiSecretKey.

```shell
curl --request GET \
  --url 'https://wos-gb.sandbox.wealthos.cloud/tenant/investment-products/v1?status=SOME_STRING_VALUE&page_size=SOME_STRING_VALUE&page_number=SOME_STRING_VALUE' \
  --header 'x-api-key: REPLACE_KEY_VALUE'
```

--------------------------------

### Get Pot Value Request Sample

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

Example of a cURL request to retrieve the current value of a pot. Replace 'REPLACE_KEY_VALUE' with your actual API key.

```shell
curl --request GET \
  --url https://wos-gb.sandbox.wealthos.cloud/tenant/pots/v1/%7Bpot_id%7D/value \
  --header 'x-api-key: REPLACE_KEY_VALUE'
```

--------------------------------

### GET /tenant/portfolio-templates/v1/

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

Retrieves a list of portfolio templates with optional pagination and sorting.

```APIDOC
## GET /tenant/portfolio-templates/v1/

### Description
Retrieves a list of portfolio templates. Supports pagination and sorting.

### Method
GET

### Endpoint
https://web_host_name/tenant/portfolio-templates/v1/

### Query Parameters
- **page_size** (string) - Optional - Specifies the number of results per page.
- **page_number** (string) - Optional - Specifies the page number to retrieve.
- **sort** (string) - Optional - Specifies the sorting order for the results.

### Headers
- **x-api-key** (string) - Required - Your API secret key.

### Response
#### Success Response (200)
- **portfolio_templates** (array) - A list of portfolio template objects.
  - **portfolio_template_id** (string) - The unique identifier for the portfolio template.
  - **portfolio_name** (string) - The name of the portfolio template.
  - **reference_version** (integer) - The reference version of the template.
  - **ratios** (array) - An array of ratio objects, detailing investment product allocations.
    - **investment_product_id** (string) - The ID of the investment product.
    - **ratio** (string) - The percentage allocation for the investment product.
  - **created_at** (string) - The timestamp when the template was created.
  - **updated_at** (string) - The timestamp when the template was last updated.
- **next_page_available** (boolean) - Indicates if there are more pages of results.

#### Error Responses
- **401** - Unauthorized: You do not have permissions to access this resource.
- **403** - Forbidden: Your authentication information is missing or invalid.
- **404** - Not Found: The specified resource was not found.
- **429** - Too Many Requests: You have sent too many requests. Please retry later.
- **500** - Internal Server Error: System error. Retry later.

### Request Example
```curl
curl --request GET \
  --url 'https://wos-gb.sandbox.wealthos.cloud/tenant/portfolio-templates/v1/?page_size=SOME_STRING_VALUE&page_number=SOME_STRING_VALUE&sort=SOME_STRING_VALUE' \
  --header 'x-api-key: REPLACE_KEY_VALUE'
```

### Response Example (200)
```json
{
  "portfolio_templates": [
    {
      "portfolio_template_id": "pft-c60c9472-6668-4f7a-aa69",
      "portfolio_name": "PFT5689",
      "reference_version": 1,
      "ratios": [
        {
          "investment_product_id": "ETF069GBP",
          "ratio": "60"
        },
        {
          "investment_product_id": "BND058GBP",
          "ratio": "40"
        }
      ],
      "created_at": "2020-07-08T07:36:05.884Z",
      "updated_at": "2020-07-10T07:36:05.884Z"
    }
  ],
  "next_page_available": true
}
```
```

--------------------------------

### Get Pot Holdings Response Sample

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

Example JSON response detailing the holdings of a pot, including investment products, quantities, values, and pricing information.

```json
{
  "pot_id": "pot-GYQ5423100",
  "holdings": [
    {
      "investment_product_id": "F0573GBP1",
      "investment_product_name": "VG 500",
      "price": "257.7856",
      "price_date": "2022-12-29",
      "currency": "GBP",
      "total_quantity": "300",
      "total_value": "534.87",
      "free_quantity": "30",
      "free_value": "34",
      "locked_quantity": "270",
      "locked_value": "500.87",
      "average_book_cost": "34.89",
      "cost_of_holding": "876.98",
      "settled_cash_position": "56.90",
      "additional_external_details": { },
      "total_investment": "1231.21",
      "start_date": "2019-08-24",
      "end_date": "2019-08-24",
      "external_deposit_reference": "string",
      "deposit_reference": "string",
      "accrued_interest": "string",
      "compounded_interest": "string",
      "interest_credited": "string",
      "net_balance": "string",
      "interest_earned": "string",
      "frozen": false
}
]

}
```

--------------------------------

### Get Investors for Workplace Employer (Curl)

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

Example using Curl to fetch investor details for a specific workplace employer. Replace 'REPLACE_KEY_VALUE' with your actual API key.

```shell
curl --request GET \
  --url https://wos-gb.sandbox.wealthos.cloud/tenant/workplace-employers/v1/%7Bworkplace_employer_id%7D/investors \
  --header 'x-api-key: REPLACE_KEY_VALUE'
```

--------------------------------

### GET /tenant/investors/v1 Request Sample (Shell + Curl)

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

Use this cURL command to make a GET request to the investors endpoint. Replace placeholder values with actual data and your API key. Supports pagination and filtering via query parameters.

```shell
curl --request GET \
  --url 'https://wos-gb.sandbox.wealthos.cloud/tenant/investors/v1?page_size=SOME_STRING_VALUE&page_number=SOME_STRING_VALUE&sort=SOME_STRING_VALUE&tax_id=SOME_STRING_VALUE' \
  --header 'x-api-key: REPLACE_KEY_VALUE'
```

--------------------------------

### Example JSON Response for Pot Values

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation

Illustrates the structure of a successful response when retrieving pot values, including pot details and pagination information.

```json
{
  "pots_values": [
    {
      "pot_id": "pot-UKW3452850",
      "pot_currency": "GBP",
      "total_value": "600",
      "total_free_value": "300",
      "total_locked_value": "300",
      "total_cash_value": "250",
      "total_free_cash_value": "50",
      "total_locked_cash_value": "200",
      "settled_cash_position": "334.87"
}
],
  "next_page_available": true
}
```

--------------------------------

### Get All Recurring Withdrawals (Curl)

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

Example using Curl to retrieve all recurring withdrawals. Demonstrates how to include various query parameters for filtering and pagination, and set the API key.

```curl
curl --request GET \
  --url 'https://wos-gb.sandbox.wealthos.cloud/tenant/recurring-withdrawals/v1?withdrawal_id=SOME_STRING_VALUE&pot_id=SOME_STRING_VALUE&financial_product_id=SOME_STRING_VALUE&investor_id=SOME_STRING_VALUE&status=SOME_STRING_VALUE&page_size=SOME_STRING_VALUE&page_number=SOME_STRING_VALUE&sort=SOME_STRING_VALUE' \
  --header 'x-api-key: REPLACE_KEY_VALUE'
```

--------------------------------

### Example Response Body for Portfolio Templates

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

Illustrates the structure of a successful response when retrieving portfolio templates, including template details and pagination information.

```json
{
  "portfolio_templates": [
    {
      "portfolio_template_id": "pft-c60c9472-6668-4f7a-aa69",
      "portfolio_name": "PFT5689",
      "reference_version": 1,
      "ratios": [
        {
          "investment_product_id": "ETF069GBP",
          "ratio": "60"
},
        {
          "investment_product_id": "BND058GBP",
          "ratio": "40"
}
],
      "created_at": "2020-07-08T07:36:05.884Z",
      "updated_at": "2020-07-10T07:36:05.884Z"
}
],
  "next_page_available": true

}
```

--------------------------------

### Sample Financial Product Response

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

This JSON object represents a sample response for financial products, detailing various attributes like product ID, type, name, availability, currency options, dividend preferences, investment and withdrawal limits, interest preferences, ISA limits, and creation/update timestamps.

```json
{
  "financial_products": [
    {
      "financial_product_id": "stocks_isa",
      "product_type": "stocks_isa",
      "name": "Acorn ISA",
      "availability": [
        "All clients"
],
      "additional_cash_currencies": [
        "EUR",
        "USD"
],
      "dividend_options": [
        "Auto reinvest always",
        "Offer reinvest option"
],
      "investment_preferences": {
        "minimum_one_off_investment": "1000"
},
      "withdrawal_preferences": {
        "minimum_one_off_withdrawal": "1000"
},
      "interest_preferences": {
        "pay_interest": "Yes",
        "interest_accrual_basis": "Daily",
        "interest_payment_frequency": "Daily"
},
      "max_annual_ISA_subscription_limit": "20000",
      "flexible": "NO",
      "created_at": "2020-07-08T07:36:05.884Z",
      "updated_at": "2020-07-10T07:36:05.884Z"
}
]

}
```

--------------------------------

### Get Pot Value Response Sample

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation#tag/Test-Methods/operation/getBEGreeting

Example JSON response for the current value of a pot, including total value, free value, locked value, and cash positions.

```json
{
  "pot_id": "pot-UKW3452850",
  "pot_currency": "GBP",
  "total_value": "600",
  "total_free_value": "300",
  "total_locked_value": "300",
  "total_cash_value": "250",
  "total_free_cash_value": "50",
  "total_locked_cash_value": "200",
  "settled_cash_position": "334.87"
}
```

--------------------------------

### POST /tenant/investors/v2 - Create Investor V2

Source: https://wos-gb.sandbox.wealthos.cloud/admin/documentation

Creates a new investor in the system with comprehensive details. Requires an ApiSecretKey for authorization.

```APIDOC
## POST /tenant/investors/v2

### Description
Create a new investor in the system.

### Method
POST

### Endpoint
https://web_host_name/tenant/investors/v2

### Parameters
#### Header Parameters
- **x-api-key** (string) - Required - ApiSecretKey

#### Request Body schema: application/json
- **request_id** (string) - Required - Unique request ID to ensure idempotency. (ex: UUID)
- **title** (string) - Optional
- **gender** (string) - Optional
- **first_name** (string) - Required - <= 100 characters
- **last_name** (string) - Required - [ 2 .. 100 ] characters
- **email** (string) - Optional - <= 100 characters
- **mobile_number** (string) - Optional - <= 16 characters
- **home_number** (string) - Optional - <= 16 characters
- **office_number** (string) - Optional - <= 16 characters
- **nationality** (string) - Optional - 3 character country code inline with ISO 3166-1 alpha-3
- **tax_id** (string) - Optional - Mandatory if the “Tax ID uniqueness validation for investors” configuration is enabled. The status of this configuration can be verified under Firm Configurations in the Admin UI. Uniqueness of the investor's tax_id will only be validated if the configuration is enabled. For investors under 18 years of age (based on date_of_birth), the tax_id is optional. If provided, it must follow the NINO format. For investors under 16 years of age, if a tax_id is provided, the request will be rejected.
- **kyc_aml_status** (string) - Optional - Default: "not_started" Enum: "submitted" "kyc_failed_error" "pending" "clear" "not_started"
- **dealing_status** (string) - Optional - Default: "inactive" Enum: "inactive" "active"
- **id_numbers** (Array of objects) - Optional
- **address** (object) - Optional
- **mifid_tax_id** (string) - Optional
- **tax_residency_compliant** (boolean) - Optional
- **date_of_birth** (string) - Optional - <date> YYYY-MM-DD
- **retirement_age** (number) - Optional - Intended retirement age of the investor. This will only be applicable for the financial product SIPP.
- **tax_residence** (string) - Optional - Enum: "GB-ENG" "GB-NIR" "GB-SCT" "GB-WLS" Residence of the investor for tax purposes. (for example, to claim relief at source) GB-ENG=England GB-NIR=Northern Ireland GB-SCT=Scotland GB-WLS=Wales.
- **employment_status** (string) - Optional - Enum: "employed" "self_employed" "pensioner" "child_under_16" "in_full_time_education" "unemployed" "caring_for_a_person_over_16" "caring_for_a_person_under_16" "other" Status of an investor best describes their personal circumstances. This will only be applicable for the financial product SIPP.
- **mpaa_triggered** (boolean) - Optional - Whether the investor has triggered the Money Purchase Annual Allowance. This will only be applicable for the financial product SIPP.
- **mpaa_triggered_date** (string) - Optional - Date of triggering the Money Purchase Annual Allowance. This is only required if mpaa_triggered is true.The date format should be YYYY-MM-DD. This will only be applicable for the financial product SIPP.
- **workplace_employers** (Array of strings) - Optional - Unique IDs of workplace employers who are contributing to the workplace pension of the investor.
- **lta_protection_details** (Array of objects) - Optional - Additional details of the lifetime allowance protections of the investor. This will only be applicable for the financial product SIPP.
- **expression_of_wish** (object) - Optional - Beneficiary and nominee list of the expression of wish. This will only be applicable for the financial product SIPP.
- **bank_accounts** (Array of objects) - Optional - Allowed to create only one bank account when creating a new investor.
- **vulnerable_customer** (boolean) - Optional - Whether the investor has been identified as a person who is susceptible to harm, due to their personal circumstances.

### Request Example
```json
{
  "request_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "title": "Mr",
  "gender": "Male",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "mobile_number": "+1234567890",
  "nationality": "GBR",
  "tax_id": "AA123456C",
  "kyc_aml_status": "clear",
  "dealing_status": "active",
  "date_of_birth": "1990-01-01",
  "tax_residence": "GB-ENG",
  "employment_status": "employed",
  "vulnerable_customer": false,
  "bank_accounts": [
    {
      "account_number": "12345678",
      "sort_code": "112233"
    }
  ]
}
```

### Responses
#### Success Response (201)
- **Resource created**

#### Response Example
```json
{
  "investor_id": "inv_12345abcde",
  "message": "Investor created successfully."
}
```

#### Error Responses
- **400** - Request is not complete and may have one or more validations errors. Please check the error message and the code.
- **401** - You do not have permissions to access this resource.
- **403** - Your authentication information is missing or invalid. Please check the keys are properly set and its correct.
- **429** - You have sent too many requests to the system. Please retry later. If you need to increase your throtteling limits, please contact WOS support.
- **500** - System error. Retry later. If the error persist, contact WOS support.
```
Tokens:
Raw