Wealth2B API

https://guides.wealth2b.com
Admin
Wealth2B is an institutional investment API that enables fintechs and neobanks to launch regulated...
Tokens:18,266
Snippets:102
Trust Score:5.1
Update:10 months ago
Show doc for...
Tokens:
Raw
### GET /robo-advisor/portfolios

Source: https://guides.wealth2b.com/index

Retrieves all portfolios.

```APIDOC
## GET /robo-advisor/portfolios

### Description
Retrieves all portfolios.

### Method
GET

### Endpoint
/robo-advisor/portfolios

### Parameters
No parameters.

### Request Example
N/A

### Response
#### Success Response (200)
- **portfolios** (array) - An array of portfolio objects.

#### Response Example
[{"portfolioId": "port1", "name": "Portfolio A"}, {"portfolioId": "port2", "name": "Portfolio B"}]

```

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

### GET /robo-advisor/portfolios/{id} - Get Portfolio Details

Source: https://guides.wealth2b.com/index

Retrieves detailed information about a specific Robo Advisor portfolio.

```APIDOC
## GET /robo-advisor/portfolios/{id}

### Description
Retrieves detailed information about a specific Robo Advisor portfolio.

### Method
GET

### Endpoint
/robo-advisor/portfolios/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the portfolio.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the portfolio.
- **name** (string) - The name of the portfolio.
- **description** (string) - A description of the portfolio.
- **holdings** (array) - A list of assets in the portfolio.
  - **symbol** (string) - The ticker symbol of the asset.
  - **weight** (number) - The percentage weight of the asset in the portfolio.

#### Response Example
```json
{
  "id": "portfolio_a",
  "name": "Conservative Growth",
  "description": "A low-risk portfolio focused on capital preservation.",
  "holdings": [
    {
      "symbol": "VTI",
      "weight": 0.6
    },
    {
      "symbol": "BND",
      "weight": 0.4
    }
  ]
}
```
```

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

### GET /robo-advisor/portfolios/{id}

Source: https://guides.wealth2b.com/index

Retrieves a portfolio by ID.

```APIDOC
## GET /robo-advisor/portfolios/{id}

### Description
Retrieves a portfolio by ID.

### Method
GET

### Endpoint
/robo-advisor/portfolios/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The portfolio ID.

### Request Example
N/A

### Response
#### Success Response (200)
- **portfolio** (object) - A portfolio object.

#### Response Example
{"portfolioId": "port1", "name": "Portfolio A", "description": "Description of Portfolio A"}

```

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

### GET /robo-advisor/accounts/{accountId}/plan - Get Client's Current Portfolio Plan

Source: https://guides.wealth2b.com/index

Retrieves the client's current Robo Advisor portfolio plan and target allocations.

```APIDOC
## GET /robo-advisor/accounts/{accountId}/plan

### Description
Retrieves the client's current Robo Advisor portfolio plan and target allocations.

### Method
GET

### Endpoint
/robo-advisor/accounts/{accountId}/plan

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The ID of the Robo Advisor account.

### Response
#### Success Response (200)
- **portfolioId** (string) - The ID of the currently assigned portfolio.
- **targetAllocation** (object) - The target allocation for the portfolio.
  - **field1** (number) - Example allocation percentage.

#### Response Example
```json
{
  "portfolioId": "portfolio_a",
  "targetAllocation": {
    "VTI": 0.6,
    "BND": 0.4
  }
}
```
```

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

### GET /robo-advisor/projections

Source: https://guides.wealth2b.com/index

Generates projections for a portfolio.

```APIDOC
## GET /robo-advisor/projections

### Description
Generates projections for a portfolio.

### Method
GET

### Endpoint
/robo-advisor/projections

### Parameters
#### Query Parameters
- (Parameters will need to be determined based on the actual API implementation.)

### Request Example
N/A

### Response
#### Success Response (200)
- (Response structure will depend on the API implementation.)

#### Response Example
(Response will vary based on the projection result.)

```

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

### GET /robo-advisor/portfolios/{id}/flatten

Source: https://guides.wealth2b.com/index

Flattens a portfolio.

```APIDOC
## GET /robo-advisor/portfolios/{id}/flatten

### Description
Flattens a portfolio.

### Method
GET

### Endpoint
/robo-advisor/portfolios/{id}/flatten

### Parameters
#### Path Parameters
- **id** (string) - Required - The portfolio ID.

### Request Example
N/A

### Response
#### Success Response (200)
-  (Response structure will depend on the API implementation.)

#### Response Example
(Response will vary based on the flattening result.)

```

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

### GET /robo-advisor/portfolios - List Available Portfolios

Source: https://guides.wealth2b.com/index

Retrieves a list of all available Robo Advisor portfolios.

```APIDOC
## GET /robo-advisor/portfolios

### Description
Retrieves a list of all available Robo Advisor portfolios.

### Method
GET

### Endpoint
/robo-advisor/portfolios

### Response
#### Success Response (200)
- **portfolios** (array) - A list of available portfolios.
  - **id** (string) - The unique identifier for the portfolio.
  - **name** (string) - The name of the portfolio.
  - **description** (string) - A description of the portfolio.

#### Response Example
```json
{
  "portfolios": [
    {
      "id": "portfolio_a",
      "name": "Conservative Growth",
      "description": "A low-risk portfolio focused on capital preservation."
    },
    {
      "id": "portfolio_b",
      "name": "Aggressive Growth",
      "description": "A high-risk portfolio focused on maximizing returns."
    }
  ]
}
```
```

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

### GET /market-data/assets

Source: https://guides.wealth2b.com/index

Retrieves detailed information about available assets for trading. Use this endpoint to get a list of assets before placing trades.

```APIDOC
## GET /market-data/assets

### Description
Retrieves a list of available assets.

### Method
GET

### Endpoint
/market-data/assets

### Parameters
No parameters.

### Request Example
N/A

### Response
#### Success Response (200)
- **assets** (array) - An array of asset objects.

#### Response Example
[{"symbol": "AAPL", "name": "Apple Inc."}, {"symbol": "MSFT", "name": "Microsoft Corp."}]

```

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

### GET /robo-advisor/accounts/{accountId}/plan/history - Get Portfolio Plan History

Source: https://guides.wealth2b.com/index

Retrieves the historical portfolio assignments and allocations for a client's Robo Advisor account.

```APIDOC
## GET /robo-advisor/accounts/{accountId}/plan/history

### Description
Retrieves the historical portfolio assignments and allocations for a client's Robo Advisor account.

### Method
GET

### Endpoint
/robo-advisor/accounts/{accountId}/plan/history

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The ID of the Robo Advisor account.

### Response
#### Success Response (200)
- **history** (array) - A list of historical portfolio plans.
  - **startDate** (string) - The start date of the plan.
  - **endDate** (string) - The end date of the plan.
  - **portfolioId** (string) - The ID of the portfolio assigned.
  - **allocation** (object) - The allocation details for that period.

#### Response Example
```json
{
  "history": [
    {
      "startDate": "2023-01-01T00:00:00Z",
      "endDate": "2023-06-30T23:59:59Z",
      "portfolioId": "portfolio_a",
      "allocation": {
        "VTI": 0.6,
        "BND": 0.4
      }
    },
    {
      "startDate": "2023-07-01T00:00:00Z",
      "endDate": null,
      "portfolioId": "portfolio_b",
      "allocation": {
        "SPY": 0.7,
        "QQQ": 0.3
      }
    }
  ]
}
```
```

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

### NTA Event Example: Instant Funding

Source: https://guides.wealth2b.com/index

An example payload for an NTA (Net Trading Asset) event, specifically illustrating an instant funding transaction. It includes account ID, amount, status, and entry type.

```JSON
{
  "timestamp": "2025-06-27T05:06:15.552Z",
  "data": {
    "accountId": "7a5cc3d6-f831-46b9-88bc-7512386217a6",
    "amount": 11.25,
    "status": "executed",
    "entryType": "MEM"
  },
  "id": "08aab21a-4c38-49f6-80f6-2f4a0dc1d966",
  "type": "nta"
}
```

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

### GET /auth/login

Source: https://guides.wealth2b.com/index

Authenticates a user and retrieves a JWT (access_token).

```APIDOC
## POST /auth/login

### Description
Authenticates a user and retrieves a JWT (access_token).

### Method
POST

### Endpoint
/auth/login

### Parameters
#### Request Body
- **apiKey** (string) - Required - The API key.
- **apiSecret** (string) - Required - The API secret.

### Request Example
{
  "apiKey": "your_api_key",
  "apiSecret": "your_api_secret"
}

### Response
#### Success Response (200)
- **access_token** (string) - The JWT access token.

#### Response Example
{"access_token": "your_jwt_token"}

```

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

### GET /people/documents/{id}/download

Source: https://guides.wealth2b.com/index

Downloads a document for a person.

```APIDOC
## GET /people/documents/{id}/download

### Description
Downloads a document for a person.

### Method
GET

### Endpoint
/people/documents/{id}/download

### Parameters
#### Path Parameters
- **id** (string) - Required - The document ID.

### Request Example
N/A

### Response
#### Success Response (200)
- **file** (binary) - The document file.

#### Response Example
(binary file data)

```

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

### Account Status Change Event Example (JSON)

Source: https://guides.wealth2b.com/index

This JSON structure illustrates an event signifying a change in an account's status. It captures the account ID and the transition from a previous status ('statusFrom') to a new status ('statusTo'). Common transitions include 'PENDING' to 'OPEN'.

```json
{
  "timestamp": "2025-01-01T00:00:00.000Z",
  "data": {
    "accountId": "account-uuid",
    "statusFrom": "PENDING",
    "statusTo": "OPEN"
  },
  "id": "event-uuid",
  "type": "account_status"
}
```

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

### Order Filled Event Example (JSON)

Source: https://guides.wealth2b.com/index

This JSON object represents an event where an order has been successfully filled. It includes details about the order, the asset, and the execution price and quantity. The 'status' field specifically indicates a 'filled' state.

```json
{
  "timestamp": "2025-01-01T00:00:00.000Z",
  "data": {
    "accountId": "account-uuid",
    "symbol": "AAPL",
    "orderId": "order-uuid",
    "status": "filled",
    "filledQty": "100",
    "filledPrice": "150.75",
    "side": "buy"
  },
  "id": "event-uuid",
  "type": "trade"
}
```

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

### GET /settlements/search

Source: https://guides.wealth2b.com/index

Lists settlements.

```APIDOC
## GET /settlements/search

### Description
Lists settlements.

### Method
GET

### Endpoint
/settlements/search

### Parameters
#### Query Parameters
-  (Various search parameters to filter results. Specific parameters will need to be defined based on the actual API implementation.)

### Request Example
N/A

### Response
#### Success Response (200)
- **settlements** (array) - An array of settlement objects.

#### Response Example
[{"settlementId": "1", "accountId": "123", "amount": 100.00, "status": "complete"}]

```

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

### GET /robo-advisor/funds/{id}

Source: https://guides.wealth2b.com/index

Retrieves a single fund by its ID.

```APIDOC
## GET /robo-advisor/funds/{id}

### Description
Retrieves a single fund by ID.

### Method
GET

### Endpoint
/robo-advisor/funds/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The fund ID.

### Request Example
N/A

### Response
#### Success Response (200)
- **fund** (object) - A fund object.

#### Response Example
{
  "fundId": "fund1",
  "name": "Fund A",
  "description": "Description of Fund A",
  "weight": 0.5
}

```

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

### GET /trading/positions

Source: https://guides.wealth2b.com/index

Retrieves all open positions. Allows for the display of current portfolio data.

```APIDOC
## GET /trading/positions

### Description
Retrieves all open positions.

### Method
GET

### Endpoint
/trading/positions

### Parameters
No parameters.

### Request Example
N/A

### Response
#### Success Response (200)
- **positions** (array) - An array of position objects.

#### Response Example
[{"positionId": "1", "symbol": "AAPL", "quantity": 10, "avgPrice": 170.00}, {"positionId": "2", "symbol": "MSFT", "quantity": 5, "avgPrice": 280.00}]

```

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

### GET /robo-advisor/accounts/{accountId}/plan/history

Source: https://guides.wealth2b.com/index

Retrieves the plan history for an account.

```APIDOC
## GET /robo-advisor/accounts/{accountId}/plan/history

### Description
Retrieves the plan history for an account.

### Method
GET

### Endpoint
/robo-advisor/accounts/{accountId}/plan/history

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The account ID.

### Request Example
N/A

### Response
#### Success Response (200)
- (Response structure will depend on the API implementation.)

#### Response Example
(Response will vary based on the plan history.)

```

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

### GET /robo-advisor/accounts/{accountId}/plan

Source: https://guides.wealth2b.com/index

Retrieves the active plan for an account.

```APIDOC
## GET /robo-advisor/accounts/{accountId}/plan

### Description
Retrieves the active plan for an account.

### Method
GET

### Endpoint
/robo-advisor/accounts/{accountId}/plan

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The account ID.

### Request Example
N/A

### Response
#### Success Response (200)
- (Response structure will depend on the API implementation.)

#### Response Example
(Response will vary based on the plan details.)

```

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

### GET /robo-advisor/funds - List Available Funds

Source: https://guides.wealth2b.com/index

Retrieves a list of individual funds or ETFs available for inclusion in portfolios.

```APIDOC
## GET /robo-advisor/funds

### Description
Retrieves a list of individual funds or ETFs available for inclusion in portfolios.

### Method
GET

### Endpoint
/robo-advisor/funds

### Response
#### Success Response (200)
- **funds** (array) - A list of available funds.
  - **id** (string) - The unique identifier for the fund.
  - **name** (string) - The name of the fund.
  - **symbol** (string) - The ticker symbol of the fund.

#### Response Example
```json
{
  "funds": [
    {
      "id": "fund_vti",
      "name": "Vanguard Total Stock Market ETF",
      "symbol": "VTI"
    },
    {
      "id": "fund_bnd",
      "name": "Vanguard Total Bond Market ETF",
      "symbol": "BND"
    }
  ]
}
```
```

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

### GET /trading/positions/accounts/{accountId}

Source: https://guides.wealth2b.com/index

Retrieves all positions for a specific account.

```APIDOC
## GET /trading/positions/accounts/{accountId}

### Description
Retrieves all positions for a specific account.

### Method
GET

### Endpoint
/trading/positions/accounts/{accountId}

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The account ID.

### Request Example
N/A

### Response
#### Success Response (200)
- **positions** (array) - An array of position objects.

#### Response Example
[{"positionId": "1", "symbol": "AAPL", "quantity": 10, "avgPrice": 170.00}, {"positionId": "2", "symbol": "MSFT", "quantity": 5, "avgPrice": 280.00}]

```

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

### GET /internal-transfers/search

Source: https://guides.wealth2b.com/index

Searches for internal transfers.

```APIDOC
## GET /internal-transfers/search

### Description
Searches for internal transfers.

### Method
GET

### Endpoint
/internal-transfers/search

### Parameters
#### Query Parameters
-  (Various search parameters to filter results. Specific parameters will need to be defined based on the actual API implementation.)

### Request Example
N/A

### Response
#### Success Response (200)
- **transfers** (array) - An array of internal transfer objects.

#### Response Example
[{"transferId": "1", "fromAccountId": "123", "toAccountId": "456", "amount": 50.00}]

```

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

### GET /money-movements/search

Source: https://guides.wealth2b.com/index

Searches for money movements.

```APIDOC
## GET /money-movements/search

### Description
Searches for money movements.

### Method
GET

### Endpoint
/money-movements/search

### Parameters
#### Query Parameters
-  (Various search parameters to filter results. Specific parameters will need to be defined based on the actual API implementation.)

### Request Example
N/A

### Response
#### Success Response (200)
- **movements** (array) - An array of money movement objects.

#### Response Example
[{"movementId": "1", "accountId": "123", "amount": 100.00, "type": "deposit"}]

```

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

### GET /auth/profile

Source: https://guides.wealth2b.com/index

Retrieves user information if the provided JWT is valid.

```APIDOC
## GET /auth/profile

### Description
Retrieves user information if the provided JWT is valid.

### Method
GET

### Endpoint
/auth/profile

### Parameters
Requires Bearer Token (JWT) in the Authorization header.

### Request Example
N/A

### Response
#### Success Response (200)
- **user** (object) - User information.

#### Response Example
{"userId": "123", "username": "testuser", "email": "test@example.com"}

```

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

### GET /trading/positions/{id}

Source: https://guides.wealth2b.com/index

Retrieves a specific position by its ID.

```APIDOC
## GET /trading/positions/{id}

### Description
Retrieves a specific position by ID.

### Method
GET

### Endpoint
/trading/positions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The position ID.

### Request Example
N/A

### Response
#### Success Response (200)
- **position** (object) - Position details.

#### Response Example
{"positionId": "1", "symbol": "AAPL", "quantity": 10, "avgPrice": 170.00}

```

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

### GET /market-data/latest-prices

Source: https://guides.wealth2b.com/index

Fetches the latest prices for available assets. Useful for real-time market data display.

```APIDOC
## GET /market-data/latest-prices

### Description
Retrieves the latest prices for available assets.

### Method
GET

### Endpoint
/market-data/latest-prices

### Parameters
No parameters.

### Request Example
N/A

### Response
#### Success Response (200)
- **prices** (array) - An array of price objects.

#### Response Example
[{"symbol": "AAPL", "price": 170.00}, {"symbol": "MSFT", "price": 280.00}]

```

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

### GET /trading/orders/{id}

Source: https://guides.wealth2b.com/index

Retrieves the details of a specific order by its ID.

```APIDOC
## GET /trading/orders/{id}

### Description
Retrieves the details of a specific order.

### Method
GET

### Endpoint
/trading/orders/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The order ID.

### Request Example
N/A

### Response
#### Success Response (200)
- **order** (object) - Order details.

#### Response Example
{"orderId": "12345", "symbol": "AAPL", "quantity": 10, "side": "buy", "type": "market", "status": "open"}

```

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

### Money Movement Status Change Event Example (JSON)

Source: https://guides.wealth2b.com/index

This JSON structure details an event indicating a change in the status of a money movement. It provides the account ID, the specific money movement ID ('moneyMovementId'), and the transition from an initial status ('statusFrom') to a final status ('statusTo'), such as 'APPROVED' to 'SUCCESSFUL'.

```json
{
  "timestamp": "2025-01-01T00:00:00.000Z",
  "data": {
    "accountId": "account-uuid",
    "moneyMovementId": "money-movement-uuid",
    "statusFrom": "APPROVED",
    "statusTo": "SUCCESSFUL"
  },
  "id": "event-uuid",
  "type": "money_movement_status"
}
```

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

### Person Status Change Event Example (JSON)

Source: https://guides.wealth2b.com/index

This JSON object represents an event where a person's status has been updated. It includes the unique identifier for the person ('peopleId') and details the change from a previous status ('statusFrom') to a new status ('statusTo').

```json
{
  "timestamp": "2025-01-01T00:00:00.000Z",
  "data": {
    "peopleId": "people-uuid",
    "statusFrom": "PENDING",
    "statusTo": "APPROVED"
  },
  "id": "event-uuid",
  "type": "people_status"
}
```

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

### Settlement Status Change Event Example (JSON)

Source: https://guides.wealth2b.com/index

This JSON object represents a change in the status of a settlement. It includes the settlement ID ('settlementId'), the previous status ('statusFrom'), the new status ('statusTo'), and the total netting amount ('amount'). This event is typically sent daily.

```json
{
  "timestamp": "2025-07-30T05:51:00.041Z",
  "data": {
    "settlementId": "9e2f6117-51d3-48b9-945d-419f9c733c3c",
    "statusFrom": "open",
    "statusTo": "pending_confirmation",
    "amount": 3596.5
  },
  "id": "363e1709-4f2f-49bf-bb1f-2ed28f08d4e0",
  "type": "settlement_status_changed"
}
```

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

### GET /trading/positions/accounts/{accountId}/{symbol}

Source: https://guides.wealth2b.com/index

Retrieves a specific position for a specific symbol within an account.

```APIDOC
## GET /trading/positions/accounts/{accountId}/{symbol}

### Description
Retrieves a specific position for a specific symbol within an account.

### Method
GET

### Endpoint
/trading/positions/accounts/{accountId}/{symbol}

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The account ID.
- **symbol** (string) - Required - The asset symbol.

### Request Example
N/A

### Response
#### Success Response (200)
- **position** (object) - Position details.

#### Response Example
{"positionId": "1", "symbol": "AAPL", "quantity": 10, "avgPrice": 170.00}

```

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

### GET /people/{id}/accounts

Source: https://guides.wealth2b.com/index

Retrieves the accounts associated with a person.

```APIDOC
## GET /people/{id}/accounts

### Description
Retrieves the accounts associated with a person.

### Method
GET

### Endpoint
/people/{id}/accounts

### Parameters
#### Path Parameters
- **id** (string) - Required - The person ID.

### Request Example
N/A

### Response
#### Success Response (200)
- **accounts** (array) - An array of account objects.

#### Response Example
[{"accountId": "123", "accountNumber": "1234567890", "type": "investment"}]

```

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

### GET /market-data/historical

Source: https://guides.wealth2b.com/index

Retrieves historical data for assets. Used to analyze price movements over time.

```APIDOC
## GET /market-data/historical

### Description
Retrieves historical data for assets.

### Method
GET

### Endpoint
/market-data/historical

### Parameters
#### Query Parameters
- **symbol** (string) - Required - The asset symbol.
- **startDate** (string) - Required - Start date for historical data (YYYY-MM-DD).
- **endDate** (string) - Required - End date for historical data (YYYY-MM-DD).

### Request Example
N/A

### Response
#### Success Response (200)
- **historicalData** (array) - An array of historical data points.

#### Response Example
[{"date": "2023-10-26", "open": 170.00, "high": 171.00, "low": 169.00, "close": 170.50}]

```

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

### GET /market-data/assets/{symbol}

Source: https://guides.wealth2b.com/index

Retrieves detailed information about a specific asset using its symbol. This endpoint provides in-depth data for a single asset.

```APIDOC
## GET /market-data/assets/{symbol}

### Description
Retrieves detailed information for a specific asset using its symbol.

### Method
GET

### Endpoint
/market-data/assets/{symbol}

### Parameters
#### Path Parameters
- **symbol** (string) - Required - The asset symbol (e.g., AAPL).

### Request Example
N/A

### Response
#### Success Response (200)
- **asset** (object) - Asset details.

#### Response Example
{"symbol": "AAPL", "name": "Apple Inc.", "description": "Apple Inc. is an American multinational technology company.", "price": 170.00}

```

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

### POST /accounts - Open Investment Account

Source: https://guides.wealth2b.com/index

Creates a new investment account for a verified user. This step defines the product type the account will support (Savings, Robo-advisor, or Trading).

```APIDOC
## POST /accounts

### Description
Creates a new investment account for a verified user. This step defines the product type the account will support (Savings, Robo-advisor, or Trading).

### Method
POST

### Endpoint
/accounts

### Parameters
#### Request Body
- **personId** (string) - Required - The ID of the person for whom the account is created.
- **productType** (string) - Required - The type of product ('SAVINGS', 'ROBO_ADVISOR', 'TRADING').

### Request Example
```json
{
  "personId": "person_123abc",
  "productType": "SAVINGS"
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier for the created account.
- **personId** (string) - The ID of the person associated with the account.
- **productType** (string) - The type of product.
- **status** (string) - The status of the account.

#### Response Example
```json
{
  "id": "account_456def",
  "personId": "person_123abc",
  "productType": "SAVINGS",
  "status": "OPEN"
}
```
```

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

### POST /accounts

Source: https://guides.wealth2b.com/index

Opens a new investment account.

```APIDOC
## POST /accounts

### Description
Opens a new investment account.

### Method
POST

### Endpoint
/accounts

### Parameters
#### Request Body
- (Parameters will need to be determined based on the actual API implementation. E.g. peopleId, accountType.)

### Request Example
{
  "peopleId": "123",
  "accountType": "investment"
}

### Response
#### Success Response (200)
-  (Response structure will depend on the API implementation. E.g. accountId.)

#### Response Example
{"accountId": "456"}

```

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

### POST /people - Create Person Record

Source: https://guides.wealth2b.com/index

Creates a new client profile and initiates the Know Your Customer (KYC) process. This is the first step in the integration flow.

```APIDOC
## POST /people

### Description
Creates a new client profile and initiates the Know Your Customer (KYC) process. This is the first step in the integration flow.

### Method
POST

### Endpoint
/people

### Parameters
#### Request Body
- **firstName** (string) - Required - The first name of the client.
- **lastName** (string) - Required - The last name of the client.
- **email** (string) - Required - The email address of the client.

### Request Example
```json
{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com"
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier for the created person.
- **status** (string) - The current status of the person (e.g., 'PENDING_KYC').

#### Response Example
```json
{
  "id": "person_123abc",
  "status": "PENDING_KYC"
}
```
```

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

### POST /robo-advisor/funds

Source: https://guides.wealth2b.com/index

Retrieves all available funds with details and weights.

```APIDOC
## POST /robo-advisor/funds

### Description
Retrieves all available funds with details and weights.

### Method
POST

### Endpoint
/robo-advisor/funds

### Parameters
No parameters.

### Request Example
N/A

### Response
#### Success Response (200)
- **funds** (array) - An array of fund objects.

#### Response Example
[{
  "fundId": "fund1",
  "name": "Fund A",
  "description": "Description of Fund A",
  "weight": 0.5
},
{
  "fundId": "fund2",
  "name": "Fund B",
  "description": "Description of Fund B",
  "weight": 0.5
}]

```

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

### POST /robo-advisor/associations

Source: https://guides.wealth2b.com/index

Links an account to a portfolio.

```APIDOC
## POST /robo-advisor/associations

### Description
Links an account to a portfolio.

### Method
POST

### Endpoint
/robo-advisor/associations

### Parameters
#### Request Body
- (Parameters will need to be determined based on the actual API implementation. E.g. accountId, portfolioId.)

### Request Example
{
  "accountId": "123",
  "portfolioId": "port1"
}

### Response
#### Success Response (200)
-  (Response structure will depend on the API implementation. E.g. associationId.)

#### Response Example
{"associationId": "assoc1"}

```

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

### POST /trading/orders

Source: https://guides.wealth2b.com/index

Allows users to place trading orders. Enables the execution of trades in the market.

```APIDOC
## POST /trading/orders

### Description
Allows users to place trading orders.

### Method
POST

### Endpoint
/trading/orders

### Parameters
#### Request Body
- **symbol** (string) - Required - The asset symbol.
- **quantity** (number) - Required - The quantity of the asset.
- **side** (string) - Required - 'buy' or 'sell'.
- **type** (string) - Required - 'market', 'limit', etc.
- **price** (number) - Optional - For limit orders.

### Request Example
{
  "symbol": "AAPL",
  "quantity": 10,
  "side": "buy",
  "type": "market"
}

### Response
#### Success Response (200)
- **orderId** (string) - The order ID.

#### Response Example
{"orderId": "12345"}

```

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

### POST /robo-advisor/associations - Assign Portfolio to Account

Source: https://guides.wealth2b.com/index

Creates a new association between a client's Robo Advisor account and a chosen portfolio.

```APIDOC
## POST /robo-advisor/associations

### Description
Creates a new association between a client's Robo Advisor account and a chosen portfolio.

### Method
POST

### Endpoint
/robo-advisor/associations

### Parameters
#### Request Body
- **accountId** (string) - Required - The ID of the Robo Advisor account.
- **portfolioId** (string) - Required - The ID of the portfolio to assign.

### Request Example
```json
{
  "accountId": "account_456def",
  "portfolioId": "portfolio_a"
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier for the association.
- **accountId** (string) - The ID of the account.
- **portfolioId** (string) - The ID of the assigned portfolio.
- **status** (string) - The status of the association.

#### Response Example
```json
{
  "id": "association_jkl789",
  "accountId": "account_456def",
  "portfolioId": "portfolio_a",
  "status": "ACTIVE"
}
```
```

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

### POST /market-data/generate-websocket-token

Source: https://guides.wealth2b.com/index

Generates a WebSocket token for real-time streaming market data. Required for connecting to the WebSocket.

```APIDOC
## POST /market-data/generate-websocket-token

### Description
Generates a WebSocket token for real-time streaming market data.

### Method
POST

### Endpoint
/market-data/generate-websocket-token

### Parameters
No parameters.

### Request Example
N/A

### Response
#### Success Response (200)
- **token** (string) - The generated WebSocket token.

#### Response Example
{"token": "your_websocket_token"}

```

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

### Auth API

Source: https://guides.wealth2b.com/index

Endpoints for user authentication and profile management.

```APIDOC
## POST /auth/login

### Description
Authenticates a user and returns an access token.

### Method
POST

### Endpoint
/auth/login

### Request Body
- **username** (string) - Required - User's username
- **password** (string) - Required - User's password

### Response
#### Success Response (200)
- **token** (string) - Access token for authenticated user

```

```APIDOC
## GET /auth/profile

### Description
Retrieves the profile information for the authenticated user.

### Method
GET

### Endpoint
/auth/profile

### Response
#### Success Response (200)
- **userId** (string) - Unique user identifier
- **username** (string) - User's username
- **email** (string) - User's email address

```

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

### POST /people/{id}/documents - Upload KYC Documents

Source: https://guides.wealth2b.com/index

Uploads supporting documents for KYC verification for a specific person.

```APIDOC
## POST /people/{id}/documents

### Description
Uploads supporting documents for KYC verification for a specific person.

### Method
POST

### Endpoint
/people/{id}/documents

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the person to upload documents for.

#### Request Body
- **documentType** (string) - Required - The type of document (e.g., 'ID_FRONT', 'ID_BACK', 'PROOF_OF_ADDRESS').
- **file** (file) - Required - The document file to upload.

### Request Example
```json
{
  "documentType": "ID_FRONT",
  "file": "<file_content>"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Document uploaded successfully."
}
```
```

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

### POST /money-movements - Initiate Deposit or Withdrawal

Source: https://guides.wealth2b.com/index

Initiates deposits or withdrawals between linked bank accounts and investment accounts.

```APIDOC
## POST /money-movements

### Description
Initiates deposits or withdrawals between linked bank accounts and investment accounts.

### Method
POST

### Endpoint
/money-movements

### Parameters
#### Request Body
- **fromAccountId** (string) - Required - The ID of the account to transfer funds from.
- **toAccountId** (string) - Required - The ID of the account to transfer funds to.
- **amount** (number) - Required - The amount to transfer.
- **currency** (string) - Required - The currency of the transfer (e.g., 'USD').
- **paymentType** (string) - Required - The payment method (e.g., 'ACH', 'WIRE', 'INSTANT').

### Request Example
```json
{
  "fromAccountId": "bank_account_789ghi",
  "toAccountId": "account_456def",
  "amount": 1000.00,
  "currency": "USD",
  "paymentType": "ACH"
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier for the money movement transaction.
- **status** (string) - The status of the transaction.

#### Response Example
```json
{
  "id": "money_movement_abc123",
  "status": "PENDING"
}
```
```

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

### POST /robo-advisor/associations/{id}/end

Source: https://guides.wealth2b.com/index

Ends an association between an account and a portfolio.

```APIDOC
## POST /robo-advisor/associations/{id}/end

### Description
Ends an association between an account and a portfolio.

### Method
POST

### Endpoint
/robo-advisor/associations/{id}/end

### Parameters
#### Path Parameters
- **id** (string) - Required - The association ID.

### Request Example
N/A

### Response
#### Success Response (200)
- (Response structure will depend on the API implementation.)

#### Response Example
{"message": "Association ended"}

```

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

### Robo Advisor API

Source: https://guides.wealth2b.com/index

Endpoints for managing robo-advisor services, including funds, portfolios, and projections.

```APIDOC
## GET /robo-advisor/funds

### Description
Retrieves a list of available funds for the robo-advisor.

### Method
GET

### Endpoint
/robo-advisor/funds

### Response
#### Success Response (200)
- **funds** (array) - List of fund objects

```

```APIDOC
## GET /robo-advisor/funds/{id}

### Description
Retrieves details for a specific robo-advisor fund.

### Method
GET

### Endpoint
/robo-advisor/funds/{id}

### Path Parameters
- **id** (string) - Required - The unique identifier of the fund

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the fund
- **name** (string) - Name of the fund
- **description** (string) - Description of the fund

```

```APIDOC
## GET /robo-advisor/portfolios

### Description
Retrieves a list of robo-advisor portfolios.

### Method
GET

### Endpoint
/robo-advisor/portfolios

### Response
#### Success Response (200)
- **portfolios** (array) - List of portfolio objects

```

```APIDOC
## GET /robo-advisor/portfolios/{id}

### Description
Retrieves details for a specific robo-advisor portfolio.

### Method
GET

### Endpoint
/robo-advisor/portfolios/{id}

### Path Parameters
- **id** (string) - Required - The unique identifier of the portfolio

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the portfolio
- **name** (string) - Name of the portfolio
- **holdings** (array) - List of assets within the portfolio

```

```APIDOC
## GET /robo-advisor/portfolios/{id}/flatten

### Description
Retrieves a flattened representation of a robo-advisor portfolio.

### Method
GET

### Endpoint
/robo-advisor/portfolios/{id}/flatten

### Path Parameters
- **id** (string) - Required - The unique identifier of the portfolio

### Response
#### Success Response (200)
- **flattenedPortfolio** (object) - Flattened representation of the portfolio

```

```APIDOC
## POST /robo-advisor/projections

### Description
Generates investment projections based on provided parameters.

### Method
POST

### Endpoint
/robo-advisor/projections

### Request Body
- **initialInvestment** (number) - Required - The initial investment amount
- **contributionAmount** (number) - Required - Regular contribution amount
- **years** (number) - Required - Number of years for the projection
- **riskTolerance** (string) - Required - User's risk tolerance (e.g., conservative, aggressive)

### Response
#### Success Response (200)
- **projections** (array) - Array of projected portfolio values over time

```

```APIDOC
## POST /robo-advisor/associations

### Description
Associates a robo-advisor portfolio with a user account.

### Method
POST

### Endpoint
/robo-advisor/associations

### Request Body
- **accountId** (string) - Required - The user's account ID
- **portfolioId** (string) - Required - The ID
```

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

### POST /people/{id}/kyc - Reuse Existing KYC Data

Source: https://guides.wealth2b.com/index

Submits existing KYC data for a person to verify their identity. Use this if your platform already collects user identity data.

```APIDOC
## POST /people/{id}/kyc

### Description
Submits existing KYC data for a person to verify their identity. Use this if your platform already collects user identity data.

### Method
POST

### Endpoint
/people/{id}/kyc

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the person.

#### Request Body
- **identificationNumber** (string) - Required - The identification number of the user.
- **dateOfBirth** (string) - Required - The date of birth of the user (YYYY-MM-DD).
- **address** (object) - Required - The address of the user.
  - **street** (string) - Required
  - **city** (string) - Required
  - **state** (string) - Required
  - **zipCode** (string) - Required
  - **country** (string) - Required

### Request Example
```json
{
  "identificationNumber": "123456789",
  "dateOfBirth": "1990-01-01",
  "address": {
    "street": "123 Main St",
    "city": "Anytown",
    "state": "CA",
    "zipCode": "90210",
    "country": "USA"
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - The updated status of the person (e.g., 'APPROVED').

#### Response Example
```json
{
  "status": "APPROVED"
}
```
```

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

### POST /bank-accounts - Link Bank Account

Source: https://guides.wealth2b.com/index

Links a same-name bank account for funding purposes.

```APIDOC
## POST /bank-accounts

### Description
Links a same-name bank account for funding purposes.

### Method
POST

### Endpoint
/bank-accounts

### Parameters
#### Request Body
- **accountId** (string) - Required - The ID of the investment account.
- **routingNumber** (string) - Required - The routing number of the bank account.
- **accountNumber** (string) - Required - The bank account number.
- **accountName** (string) - Required - The name of the bank account holder (must match the client's name).
- **accountType** (string) - Required - The type of bank account ('CHECKING', 'SAVINGS').

### Request Example
```json
{
  "accountId": "account_456def",
  "routingNumber": "123456789",
  "accountNumber": "987654321",
  "accountName": "John Doe",
  "accountType": "CHECKING"
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier for the linked bank account.
- **status** (string) - The status of the linked bank account.

#### Response Example
```json
{
  "id": "bank_account_789ghi",
  "status": "LINKED"
}
```
```

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

### POST /people/{id}/kyc-raw - Submit Raw KYC Data

Source: https://guides.wealth2b.com/index

Submits raw KYC data for a person. Use this for direct submission of identity information.

```APIDOC
## POST /people/{id}/kyc-raw

### Description
Submits raw KYC data for a person. Use this for direct submission of identity information.

### Method
POST

### Endpoint
/people/{id}/kyc-raw

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the person.

#### Request Body
- **kycData** (object) - Required - Raw KYC data.
  - **field1** (string) - Required - Example KYC field.
  - **field2** (string) - Optional - Another example KYC field.

### Request Example
```json
{
  "kycData": {
    "field1": "value1",
    "field2": "value2"
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - The updated status of the person.

#### Response Example
```json
{
  "status": "PROCESSING"
}
```
```
Tokens:
Raw