canonical: https://jentic.com/apis/wealthos.com/wealthos

# WealthOS API

Welcome to WealthOS. Here you will find the comprehensive set of information you need to rapidly build rich digital wealth management features. Getting Started Before you start developing your features using the WealthOS API, please make sure that the following steps are complete: * Set-up your own environment unique to your organisation using the link we have provided * Follow the step-by-step [g. The API exposes 79 endpoints secured with apiKey authentication.

## For AI agents

Programmatically wealth manager greeting for be, create investor. Covers 79 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Wealth Manager Greeting for BE
- Create Investor
- Get All Investors
- Update Investor
- Monitor WealthOS API operational status and events

## Use cases

### Developer Tools Operations

Use the WealthOS API to perform developer tools operations programmatically. The API provides 79 endpoints covering core functionality including wealth manager greeting for be, create investor, get all investors.

Example prompt: Call GET `/tenant/test/hello-world-be` to wealth manager greeting for be

### Automated Investors Management

Automate investors operations by combining multiple WealthOS API endpoints. Agents can create investor and then get all investors in a single workflow.

Example prompt: Call POST `/tenant/investors/v1` to create investor, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call WealthOS API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'wealth manager greeting for be', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/tenant/test/hello-world-be` | Wealth Manager Greeting for BE |
| POST | `/tenant/investors/v1` | Create Investor |
| GET | `/tenant/investors/v1` | Get All Investors |
| GET | `/tenant/investors/v1/{investor_id}` | Get Investor |
| PATCH | `/tenant/investors/v1/{investor_id}` | Update Investor |
| GET | `/tenant/financial-products/v1` | Get All Financial Products |
| GET | `/tenant/payments/v1/{transaction_id}` | Get Payment by Transaction Id |
| POST | `/tenant/pots/v1` | Create new pots |

## Key resources

- **Investors** — The Investor endpoint allows you to create investors, update investors and retrieve investor records
- **Pots, Holdings and Transactions** — Pots allows a wealth manager to compartmentalise investments made by (or on behalf of) an investor t
- **Recurring Contributions** — The recurring contribution endpoints allow a tenant to manage their investors regular contribution r
- **Workplace Employers** — <div class="warning" style='padding:0.1em; background-color:#FEEFB3; color:#9F6000;'>
    <span>
- **Portfolio Templates** — A portfolio template captures how an investor’s cash (once transferred to a pot) should be automatic

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 50 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 48 / 100
  - Developer Experience & Jentic Compatibility: 73 / 100
  - AI-Readiness & Agent Experience: 31 / 100
  - Agent Usability: 89 / 100
  - Security: 38 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/wealthos.com/wealthos/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the WealthOS API by hand means learning its public key and secret key headers, resolving your tenant host, and handling responses yourself. Through Jentic you install once, import the WealthOS API from the API Directory, store those keys once, and your agent calls it.
- **Permission scoping:** WealthOS puts the record id in the URL path (`/tenant/investors/v1/{investor_id}`, `/tenant/payments/v1/{transaction_id}`), so a rule can pin your agent to one investor or transaction and nothing else. You choose the operations it may call, so writes like creating an investor or a pot are not included unless you add them.
- **Credential handling:** Your WealthOS public and secret keys are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get an investor' or 'look up a payment', and Jentic returns the matching WealthOS operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the WealthOS API use?

The WealthOS API uses an API key passed in the `Authorization` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I wealth manager greeting for be with the WealthOS API?

Yes. Use the GET `/tenant/test/hello-world-be` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the WealthOS API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I wealth manager greeting for be through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'wealth manager greeting for be'. Jentic returns the matching WealthOS API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the WealthOS API have?

The WealthOS API exposes 79 endpoints covering investors, pots, holdings and transactions, recurring contributions operations.

### Can I limit what my agent is allowed to do with the WealthOS API?

Yes. Because you run Jentic One yourself, your own rules decide which WealthOS operations and credentials the agent may use. WealthOS puts the record id in the URL path, such as `/tenant/investors/v1/{investor_id}` and `/tenant/payments/v1/{transaction_id}`, so a rule can pin the agent to a single investor or transaction and nothing else. You choose the operations it can call, so write actions like creating an investor or a pot stay out of reach unless you explicitly grant them.