Skip to content

[SD-7008] - adds OIDC docs #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alb3rto269 merged 2 commits into from
Nov 14, 2025
Merged

[SD-7008] - adds OIDC docs #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79996ae
adds OIDC docs
FranciscodeMaussion Nov 3, 2025
13d8619
adds provider name filtering for investors, accounts, households and MPs
FranciscodeMaussion Nov 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 25 additions & 24 deletions source/includes/_accounts.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,24 @@
}
```

| Name | Type | Description |
|-------------|--------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| id | int | Account ID |
| external_id | string | Your account identifier |
| name | string | Account name |
| value | string | Account value |
| type | string | Account type . |
| tax_status | string | Account tax status. One of [these values](http://api.stratifi.com/docs/v1/#account-tax-statuses). | |
| number | string | Account number |
| strategy | int | Account strategy represented as Model Portfolio Id. You can find the desired model portfolio using the [list or get endpoint](http://api.stratifi.com/docs/v1/#list-model-portfolios). |
| investor | int | Investor ID |
| Name | Type | Description |
|-------------|--------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| id | int | Account ID |
| external_id | string | Your account identifier |
| name | string | Account name |
| value | string | Account value |
| type | string | Account type . |
| tax_status | string | Account tax status. One of [these values](#account-tax-statuses). | |
| number | string | Account number |
| strategy | int | Account strategy represented as Model Portfolio Id. You can find the desired model portfolio using the [list or get endpoint](#list-model-portfolios). |
| investor | int | Investor ID |
| advisor | int | Advisor ID. Ideally, you would provide the investor ID. However, if you don't have that information but you know who is the advisor that owns this account then you can pass the advisor ID. We will assign the account to the `default_investor` of the selected advisor. |
| positions[] | List of [Positions Objects](#positions) | Account holdings |
| risk | [Risk Object](#risk-object-definition) | Account risk |
| tolerance | [Tolerance Object](#tolerance-object-definition) | Account tolerance |
| drift | float | Drift between the risk and the tolerance overall scores |
| sources | List of [Sources Objects](#account-source-object-definition) | List of sources that are associated with the account |
| teams | List of Teams Ids | List of teams ids that are associated with the account |
| positions[] | List of [Positions Objects](#positions) | Account holdings |
| risk | [Risk Object](#risk-object-definition) | Account risk |
| tolerance | [Tolerance Object](#tolerance-object-definition) | Account tolerance |
| drift | float | Drift between the risk and the tolerance overall scores |
| sources | List of [Sources Objects](#account-source-object-definition) | List of sources that are associated with the account |
| teams | List of Teams Ids | List of teams ids that are associated with the account |

### Account Source Object Definition

Expand Down Expand Up @@ -106,13 +106,14 @@ curl "https://backend.stratifi.com/api/v1/accounts/" -H "Authorization: Bearer {

**Filtering Fields**

| Name | Type | Description |
|-----------------|--------|--------------------------|
| external_id | string | Your account identifier |
| investor | int | Investor ID |
| household | int | Household ID |
| source_id | int | Source ID |
| source_provider | int | Source provider ID |
| Name | Type | Description |
|----------------------|--------|-------------------------|
| external_id | string | Your account identifier |
| investor | int | Investor ID |
| household | int | Household ID |
| source_id | int | Source ID |
| source_provider | int | Source provider ID |
| source_provider_name | str | Source provider Name |

## Get Account

Expand Down
Loading