BetterWealth B2B API API Reference

BetterWealth B2B API

API Endpoint
http://http://test.local/
Terms of Service: Terms of service
Contact: api@betterwealth.se
Version: API 0.9

healthz-resource

Healthz Resource

healthz-resource

healthz

GET /healthz
200 OK

OK

type
string
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
"string"

b-2-b-user-sign-resource

B 2 B User Sign Resource

b-2-b-user-sign-resource

signUserCreate

POST /v2/b2b/sign/user/create
SignUserCreateSignRequest

payload

Request Content-Types: application/json
Request Example
{
  "signable": {
    "actionCode": "string",
    "adviceMaterial": {
      "accountType": "string",
      "age": "integer (int32)",
      "bearLoss": "string",
      "income": "integer (int32)",
      "monthlyInvestment": "integer (int32)",
      "sri": "boolean",
      "startInvestment": "integer (int32)",
      "strategy": "string",
      "timeHorizon": "integer (int32)"
    },
    "allowedUnauthorized": "boolean",
    "appVersion": "string",
    "confirmEmailVersion": "string",
    "customerKnowledge": {
      "cashSources": "object",
      "citizenship": [
        "string"
      ],
      "completedAcceptActions": [
        {
          "action": "string",
          "timestamp": "string",
          "version": "integer (int32)"
        }
      ],
      "completedKnowledgeTests": [
        {
          "completionDate": "string",
          "questions": [
            {
              "answerId": "string",
              "questionId": "string"
            }
          ],
          "type": "string",
          "version": "integer (int32)"
        }
      ],
      "depositPeriodicity": "string",
      "employment": "string",
      "funds": "boolean",
      "income": "number (double)",
      "investmentPurpose": "object",
      "investmentSize": "string",
      "liquidAssets": "string",
      "loansAndCredits": "boolean",
      "lossKnowledge": "boolean",
      "ownage": "boolean",
      "pep": "string",
      "pepPosition": "string",
      "pepRelation": "string",
      "pepRelationPosition": "string",
      "privacyPolicyAccept": {
        "updated": "string",
        "value": "boolean"
      },
      "taxResidence": "string",
      "taxResidenceSweden": "boolean",
      "tin": "string",
      "transferSource": "string",
      "unrealizedLiquidAssets": "string",
      "withdrawalPeriodicity": "string"
    },
    "documents": [
      {
        "document": {
          "category": "string",
          "contentType": "string",
          "documentId": "string",
          "documentUrl": "string",
          "hash": "string",
          "title": "string",
          "type": "string"
        },
        "goalId": "string",
        "signableGroupId": {
          "groupId": "string",
          "groupType": "string",
          "major": "integer (int32)",
          "minor": "integer (int32)"
        }
      }
    ],
    "email": "string",
    "goals": [
      {
        "bearLoss": "string",
        "customTemplate": {
          "type": "string"
        },
        "endDate": "string",
        "goalAmount": "number (double)",
        "id": "string",
        "investmentPurpose": "string",
        "maximalRisk": "number (float)",
        "monthlyInvestment": "number (double)",
        "monthlyPayout": "number (double)",
        "name": "string",
        "parent": "boolean",
        "parentId": "string",
        "payoutEndDate": "string",
        "sri": "boolean",
        "startInvestment": "number (double)",
        "strategy": "string"
      }
    ],
    "personalNumber": "string",
    "phone": "string",
    "recommendedGoals": [
      {
        "bearLoss": "string",
        "customTemplate": {
          "type": "string"
        },
        "endDate": "string",
        "goalAmount": "number (double)",
        "id": "string",
        "investmentPurpose": "string",
        "maximalRisk": "number (float)",
        "monthlyInvestment": "number (double)",
        "monthlyPayout": "number (double)",
        "name": "string",
        "parent": "boolean",
        "parentId": "string",
        "payoutEndDate": "string",
        "sri": "boolean",
        "startInvestment": "number (double)",
        "strategy": "string"
      }
    ],
    "requestType": "string",
    "singleInvestment": "boolean",
    "source": "string",
    "userDrivenInvestment": "boolean",
    "utm": "string"
  },
  "signer": {
    "givenName": "string",
    "name": "string",
    "personalNumber": "string",
    "surname": "string"
  }
}
200 OK
User

User authentication data

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "clientId": "string",
  "clientIdMigrationTarget": "string",
  "clientIdOriginal": "string",
  "confirmEmail": "string",
  "created": "string",
  "deleted": "string",
  "email": "string",
  "firstName": "string",
  "idProvider": "string",
  "lastName": "string",
  "newsletter": "boolean",
  "notifications": "boolean",
  "personalNumber": {
    "age": "integer (int32)",
    "canonical": "string",
    "canonicalAsLong": "integer (int64)",
    "prefix": "string"
  },
  "phone": "string",
  "premiumContact": {
    "email": "string",
    "imageUrl": "string",
    "name": "string",
    "phone": "string",
    "uuid": "string"
  },
  "premiumLevel": "string",
  "referrer": "string",
  "riskCategory": "string",
  "simpleId": "integer (int64)",
  "source": "string",
  "userProfileAlias": "string",
  "uuid": "string"
}

b-2-b-user-auth-resource

B 2 B User Auth Resource

b-2-b-user-auth-resource

initiateUserAuth

POST /v2/b2b/auth/user/{userId}
userId: string
in path

userId

200 OK
BwUserAuthorizationWithToken

User authentication data

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK) 
{
  "authToken": "string",
  "authorities": [
    "string"
  ],
  "expiration": "integer (int64)",
  "userUuid": "string"
}

Schema Definitions

BankIdInitSignOnboardingRequest: object

actionCode: string
adviceMaterial: CustomerAdviceMaterial
allowedUnauthorized: boolean
appVersion: string
confirmEmailVersion: string VERSION_ONE, VERSION_TWO
customerKnowledge: UserKnowledge
documents: SignableOnboardingDocument
SignableOnboardingDocument
email: string
goals: GoalRepresentation
GoalRepresentation
personalNumber: SwedishPersonalNumber
phone: string
recommendedGoals: GoalRepresentation
GoalRepresentation
requestType: string
singleInvestment: boolean
source: string PENSION
userDrivenInvestment: boolean
utm: string
Example
{
  "actionCode": "string",
  "adviceMaterial": {
    "accountType": "string",
    "age": "integer (int32)",
    "bearLoss": "string",
    "income": "integer (int32)",
    "monthlyInvestment": "integer (int32)",
    "sri": "boolean",
    "startInvestment": "integer (int32)",
    "strategy": "string",
    "timeHorizon": "integer (int32)"
  },
  "allowedUnauthorized": "boolean",
  "appVersion": "string",
  "confirmEmailVersion": "string",
  "customerKnowledge": {
    "cashSources": "object",
    "citizenship": [
      "string"
    ],
    "completedAcceptActions": [
      {
        "action": "string",
        "timestamp": "string",
        "version": "integer (int32)"
      }
    ],
    "completedKnowledgeTests": [
      {
        "completionDate": "string",
        "questions": [
          {
            "answerId": "string",
            "questionId": "string"
          }
        ],
        "type": "string",
        "version": "integer (int32)"
      }
    ],
    "depositPeriodicity": "string",
    "employment": "string",
    "funds": "boolean",
    "income": "number (double)",
    "investmentPurpose": "object",
    "investmentSize": "string",
    "liquidAssets": "string",
    "loansAndCredits": "boolean",
    "lossKnowledge": "boolean",
    "ownage": "boolean",
    "pep": "string",
    "pepPosition": "string",
    "pepRelation": "string",
    "pepRelationPosition": "string",
    "privacyPolicyAccept": {
      "updated": "string",
      "value": "boolean"
    },
    "taxResidence": "string",
    "taxResidenceSweden": "boolean",
    "tin": "string",
    "transferSource": "string",
    "unrealizedLiquidAssets": "string",
    "withdrawalPeriodicity": "string"
  },
  "documents": [
    {
      "document": {
        "category": "string",
        "contentType": "string",
        "documentId": "string",
        "documentUrl": "string",
        "hash": "string",
        "title": "string",
        "type": "string"
      },
      "goalId": "string",
      "signableGroupId": {
        "groupId": "string",
        "groupType": "string",
        "major": "integer (int32)",
        "minor": "integer (int32)"
      }
    }
  ],
  "email": "string",
  "goals": [
    {
      "bearLoss": "string",
      "customTemplate": {
        "type": "string"
      },
      "endDate": "string",
      "goalAmount": "number (double)",
      "id": "string",
      "investmentPurpose": "string",
      "maximalRisk": "number (float)",
      "monthlyInvestment": "number (double)",
      "monthlyPayout": "number (double)",
      "name": "string",
      "parent": "boolean",
      "parentId": "string",
      "payoutEndDate": "string",
      "sri": "boolean",
      "startInvestment": "number (double)",
      "strategy": "string"
    }
  ],
  "personalNumber": "string",
  "phone": "string",
  "recommendedGoals": [
    {
      "bearLoss": "string",
      "customTemplate": {
        "type": "string"
      },
      "endDate": "string",
      "goalAmount": "number (double)",
      "id": "string",
      "investmentPurpose": "string",
      "maximalRisk": "number (float)",
      "monthlyInvestment": "number (double)",
      "monthlyPayout": "number (double)",
      "name": "string",
      "parent": "boolean",
      "parentId": "string",
      "payoutEndDate": "string",
      "sri": "boolean",
      "startInvestment": "number (double)",
      "strategy": "string"
    }
  ],
  "requestType": "string",
  "singleInvestment": "boolean",
  "source": "string",
  "userDrivenInvestment": "boolean",
  "utm": "string"
}

BwDocument: object

category: string PRE_SALES_AGREEMENT, INVESTMENT_INSTRUCTION, AGREEMENT_CUSTOMER, AGREEMENT_ACCOUNT, AGREEMENT_OTHER, CAPITAL_ADEQUACY_REPORT, OTHER
contentType: string
documentId: string
documentUrl: string
hash: string
title: string
type: string PORTFOLIO, GENERIC
Example
{
  "category": "string",
  "contentType": "string",
  "documentId": "string",
  "documentUrl": "string",
  "hash": "string",
  "title": "string",
  "type": "string"
}

BwUserAuthorizationWithToken: object

authToken: string
authorities: string[]
string
expiration: integer (int64)
userUuid: string
Example
{
  "authToken": "string",
  "authorities": [
    "string"
  ],
  "expiration": "integer (int64)",
  "userUuid": "string"
}

ContactPerson: object

email: string
imageUrl: string
name: string
phone: string
uuid: string
Example
{
  "email": "string",
  "imageUrl": "string",
  "name": "string",
  "phone": "string",
  "uuid": "string"
}

CustomTemplatePortfolioSelection: object

type: string SELECT, CREATE
Example
{
  "type": "string"
}

CustomerAdviceMaterial: object

accountType: string isk, isk_limited_tax, entity_depot, pension_insurance, isk_track, entity_depot_track
age: integer (int32)
bearLoss: string CASH_PROBABLY_NEEDED, CASH_PROBABLY_NOT_NEEDED, CASH_NOT_NEEDED, CASH_NEED_UNKNOWN
income: integer (int32)
monthlyInvestment: integer (int32)
sri: boolean
startInvestment: integer (int32)
strategy: string STATIC, DYNAMIC
timeHorizon: integer (int32)
Example
{
  "accountType": "string",
  "age": "integer (int32)",
  "bearLoss": "string",
  "income": "integer (int32)",
  "monthlyInvestment": "integer (int32)",
  "sri": "boolean",
  "startInvestment": "integer (int32)",
  "strategy": "string",
  "timeHorizon": "integer (int32)"
}

DateRepresentation: string

Date and time in ISO 8601 format

DateTimeRepresentation: string

Date and time in ISO 8601 format

External: object

email: string
imageUrl: string
name: string
phone: string
Example
{
  "email": "string",
  "imageUrl": "string",
  "name": "string",
  "phone": "string"
}

ExternalAdmin: object

name: string
uuid: string
Example
{
  "name": "string",
  "uuid": "string"
}

GoalRepresentation: object

bearLoss: string CASH_PROBABLY_NEEDED, CASH_PROBABLY_NOT_NEEDED, CASH_NOT_NEEDED, CASH_NEED_UNKNOWN
customTemplate: CustomTemplatePortfolioSelection
endDate: DateRepresentation
goalAmount: number (double)
id: string
investmentPurpose: string BUFFER, RETIREMENT, GENERAL, CHILD_SAVINGS, OTHER
maximalRisk: number (float)
monthlyInvestment: number (double)
monthlyPayout: number (double)
name: string
parent: boolean
parentId: string
payoutEndDate: DateRepresentation
sri: boolean
startInvestment: number (double)
strategy: string BUFFER, RETIREMENT, GENERAL, GENERAL_GOAL, GENERAL_GOAL_TIME, GENERAL_GOAL_TIME_AMOUNT, GENERAL_PROTECTED, BUFFER_STATIC, RETIREMENT_STATIC, GENERAL_STATIC, GENERAL_STATIC_SIMPLE, CUSTOM, CUSTOM_ASYNC, CUSTOM_COPY, NONE, NONE_CASH, NONE_ASYNC, PENSION
Example
{
  "bearLoss": "string",
  "customTemplate": {
    "type": "string"
  },
  "endDate": "string",
  "goalAmount": "number (double)",
  "id": "string",
  "investmentPurpose": "string",
  "maximalRisk": "number (float)",
  "monthlyInvestment": "number (double)",
  "monthlyPayout": "number (double)",
  "name": "string",
  "parent": "boolean",
  "parentId": "string",
  "payoutEndDate": "string",
  "sri": "boolean",
  "startInvestment": "number (double)",
  "strategy": "string"
}

KnowledgeTest: object

completionDate: DateTimeRepresentation
questions: KnowledgeTestQuestion
KnowledgeTestQuestion
type: string test, funds, stocks, copy_portfolio, sri_preference
version: integer (int32)
Example
{
  "completionDate": "string",
  "questions": [
    {
      "answerId": "string",
      "questionId": "string"
    }
  ],
  "type": "string",
  "version": "integer (int32)"
}

KnowledgeTestQuestion: object

answerId: string
questionId: string STOCKS, FUNDS, RISK_LOSS, KNOWLEDGE_EXPERIENCE, ECONOMIC_SITUATION, PURPOSE_OF_THE_INVESTMENT, INVESTMENT_BASE, TIME_HORIZON, SIGN_DOCUMENTS, INCLUDE_SRI_PREFERENCE
Example
{
  "answerId": "string",
  "questionId": "string"
}

OrganizationNumber: object

canonical: string
canonicalAsLong: integer (int64)
prefix: string
vatnumber: string
Example
{
  "canonical": "string",
  "canonicalAsLong": "integer (int64)",
  "prefix": "string",
  "vatnumber": "string"
}

OrganizationUser: object

lastUpdated: DateTimeRepresentation
organizationId: string
organizationRole: string editor, viewer, none
userId: string
userName: string
uuid: string
Example
{
  "lastUpdated": "string",
  "organizationId": "string",
  "organizationRole": "string",
  "userId": "string",
  "userName": "string",
  "uuid": "string"
}

OrganizationWithUsers: object

confirmEmail: string
email: string
lei: string
name: string
organizationNumber: OrganizationNumber
principal: Principal
status: string pending, reviewing, active, pending_delete, deleted, stale
users: OrganizationUser
OrganizationUser
uuid: string
Example
{
  "confirmEmail": "string",
  "email": "string",
  "lei": "string",
  "name": "string",
  "organizationNumber": {
    "canonical": "string",
    "canonicalAsLong": "integer (int64)",
    "prefix": "string",
    "vatnumber": "string"
  },
  "principal": {
    "name": "string",
    "personalNumber": {
      "age": "integer (int32)",
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string"
    }
  },
  "status": "string",
  "users": [
    {
      "lastUpdated": "string",
      "organizationId": "string",
      "organizationRole": "string",
      "userId": "string",
      "userName": "string",
      "uuid": "string"
    }
  ],
  "uuid": "string"
}

PersonalNumber: object

age: integer (int32)
canonical: string
canonicalAsLong: integer (int64)
prefix: string
Example
{
  "age": "integer (int32)",
  "canonical": "string",
  "canonicalAsLong": "integer (int64)",
  "prefix": "string"
}

Principal: object

name: string
personalNumber: PersonalNumber
Example
{
  "name": "string",
  "personalNumber": {
    "age": "integer (int32)",
    "canonical": "string",
    "canonicalAsLong": "integer (int64)",
    "prefix": "string"
  }
}

SignUserCreateSignRequest: object

signable: BankIdInitSignOnboardingRequest
signer: Signer
Example
{
  "signable": {
    "actionCode": "string",
    "adviceMaterial": {
      "accountType": "string",
      "age": "integer (int32)",
      "bearLoss": "string",
      "income": "integer (int32)",
      "monthlyInvestment": "integer (int32)",
      "sri": "boolean",
      "startInvestment": "integer (int32)",
      "strategy": "string",
      "timeHorizon": "integer (int32)"
    },
    "allowedUnauthorized": "boolean",
    "appVersion": "string",
    "confirmEmailVersion": "string",
    "customerKnowledge": {
      "cashSources": "object",
      "citizenship": [
        "string"
      ],
      "completedAcceptActions": [
        {
          "action": "string",
          "timestamp": "string",
          "version": "integer (int32)"
        }
      ],
      "completedKnowledgeTests": [
        {
          "completionDate": "string",
          "questions": [
            {
              "answerId": "string",
              "questionId": "string"
            }
          ],
          "type": "string",
          "version": "integer (int32)"
        }
      ],
      "depositPeriodicity": "string",
      "employment": "string",
      "funds": "boolean",
      "income": "number (double)",
      "investmentPurpose": "object",
      "investmentSize": "string",
      "liquidAssets": "string",
      "loansAndCredits": "boolean",
      "lossKnowledge": "boolean",
      "ownage": "boolean",
      "pep": "string",
      "pepPosition": "string",
      "pepRelation": "string",
      "pepRelationPosition": "string",
      "privacyPolicyAccept": {
        "updated": "string",
        "value": "boolean"
      },
      "taxResidence": "string",
      "taxResidenceSweden": "boolean",
      "tin": "string",
      "transferSource": "string",
      "unrealizedLiquidAssets": "string",
      "withdrawalPeriodicity": "string"
    },
    "documents": [
      {
        "document": {
          "category": "string",
          "contentType": "string",
          "documentId": "string",
          "documentUrl": "string",
          "hash": "string",
          "title": "string",
          "type": "string"
        },
        "goalId": "string",
        "signableGroupId": {
          "groupId": "string",
          "groupType": "string",
          "major": "integer (int32)",
          "minor": "integer (int32)"
        }
      }
    ],
    "email": "string",
    "goals": [
      {
        "bearLoss": "string",
        "customTemplate": {
          "type": "string"
        },
        "endDate": "string",
        "goalAmount": "number (double)",
        "id": "string",
        "investmentPurpose": "string",
        "maximalRisk": "number (float)",
        "monthlyInvestment": "number (double)",
        "monthlyPayout": "number (double)",
        "name": "string",
        "parent": "boolean",
        "parentId": "string",
        "payoutEndDate": "string",
        "sri": "boolean",
        "startInvestment": "number (double)",
        "strategy": "string"
      }
    ],
    "personalNumber": "string",
    "phone": "string",
    "recommendedGoals": [
      {
        "bearLoss": "string",
        "customTemplate": {
          "type": "string"
        },
        "endDate": "string",
        "goalAmount": "number (double)",
        "id": "string",
        "investmentPurpose": "string",
        "maximalRisk": "number (float)",
        "monthlyInvestment": "number (double)",
        "monthlyPayout": "number (double)",
        "name": "string",
        "parent": "boolean",
        "parentId": "string",
        "payoutEndDate": "string",
        "sri": "boolean",
        "startInvestment": "number (double)",
        "strategy": "string"
      }
    ],
    "requestType": "string",
    "singleInvestment": "boolean",
    "source": "string",
    "userDrivenInvestment": "boolean",
    "utm": "string"
  },
  "signer": {
    "givenName": "string",
    "name": "string",
    "personalNumber": "string",
    "surname": "string"
  }
}

SignableGroupId: object

groupId: string
groupType: string SIGN_UP, AUTO_GIRO, ADD_PORTFOLIO, ADD_PENSION_INSURANCE, SIGN_UP_ORG, ADD_ENTITY_DEPOT_PORTFOLIO
major: integer (int32)
minor: integer (int32)
Example
{
  "groupId": "string",
  "groupType": "string",
  "major": "integer (int32)",
  "minor": "integer (int32)"
}

SignableOnboardingDocument: object

document: BwDocument
goalId: string
signableGroupId: SignableGroupId
Example
{
  "document": {
    "category": "string",
    "contentType": "string",
    "documentId": "string",
    "documentUrl": "string",
    "hash": "string",
    "title": "string",
    "type": "string"
  },
  "goalId": "string",
  "signableGroupId": {
    "groupId": "string",
    "groupType": "string",
    "major": "integer (int32)",
    "minor": "integer (int32)"
  }
}

Signer: object

givenName: string
name: string
personalNumber: string
surname: string
Example
{
  "givenName": "string",
  "name": "string",
  "personalNumber": "string",
  "surname": "string"
}

SwedishPersonalNumber: string

Personal number in the format se-YYYYNNDDXXXX

TimestampedValue«boolean»: object

updated: DateTimeRepresentation
value: boolean
Example
{
  "updated": "string",
  "value": "boolean"
}

User: object

clientId: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
clientIdMigrationTarget: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
clientIdOriginal: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
confirmEmail: string
created: DateTimeRepresentation
deleted: string NOT_DELETED, PENDING, DELETED
email: string
firstName: string
idProvider: string bankid
lastName: string
newsletter: boolean
notifications: boolean
personalNumber: PersonalNumber
phone: string
premiumContact: ContactPerson
premiumLevel: string none, level_one
referrer: string
riskCategory: string low, medium, high, unknown
simpleId: integer (int64)
source: string
userProfileAlias: string
uuid: string
Example
{
  "clientId": "string",
  "clientIdMigrationTarget": "string",
  "clientIdOriginal": "string",
  "confirmEmail": "string",
  "created": "string",
  "deleted": "string",
  "email": "string",
  "firstName": "string",
  "idProvider": "string",
  "lastName": "string",
  "newsletter": "boolean",
  "notifications": "boolean",
  "personalNumber": {
    "age": "integer (int32)",
    "canonical": "string",
    "canonicalAsLong": "integer (int64)",
    "prefix": "string"
  },
  "phone": "string",
  "premiumContact": {
    "email": "string",
    "imageUrl": "string",
    "name": "string",
    "phone": "string",
    "uuid": "string"
  },
  "premiumLevel": "string",
  "referrer": "string",
  "riskCategory": "string",
  "simpleId": "integer (int64)",
  "source": "string",
  "userProfileAlias": "string",
  "uuid": "string"
}

UserAccept: object

action: string test, autocopy, forum, welcome, intro
timestamp: DateTimeRepresentation
version: integer (int32)
Example
{
  "action": "string",
  "timestamp": "string",
  "version": "integer (int32)"
}

UserFavorite: object

created: DateTimeRepresentation
id: string
type: string ASSET, AUTO_COPY_PORTFOLIO
Example
{
  "created": "string",
  "id": "string",
  "type": "string"
}

UserKnowledge: object

cashSources: object
citizenship: string[]
string SE, DK, FI, IS, NO, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
completedAcceptActions: UserAccept
UserAccept
completedKnowledgeTests: KnowledgeTest
KnowledgeTest
depositPeriodicity: string MONTHLY, MULTIPLE_PER_YEAR, YEARLY, OCCASIONALLY
employment: string EMPLOYED, SELF_EMPLOYED, UNEMPLOYED, PENSION, STUDENT, SICK_LEAVE, OTHER
funds: boolean
income: number (double)
investmentPurpose: object
investmentSize: string GT_MILLION, LT_MILLION, GT_FIVE_MILLION, LT_FIVE_MILLION, GT_TEN_MILLION, LT_TEN_MILLION
liquidAssets: string GT_MILLION, LT_MILLION, GT_FIVE_MILLION, LT_FIVE_MILLION, GT_TEN_MILLION, LT_TEN_MILLION
loansAndCredits: boolean
lossKnowledge: boolean
ownage: boolean
pep: string YES, NO, RELATED
pepPosition: string CHIEF_OF_STATE, MEMBER_OF_PARLAMENT, JUDGE, PUBLIC_COMPANY, AMBASSADOR_OR_OFFICER, AUDIT_AUTHORITY, CENTRAL_BANK_MEMBER_OF_BOARD, INTERNATIONAL_LEADER, PUBLIC_FUNCTION
pepRelation: string PARTNER, PARENT, CHILD, PARTNER_OF_CHILD, ASSISTANT, OTHER
pepRelationPosition: string CHIEF_OF_STATE, MEMBER_OF_PARLAMENT, JUDGE, PUBLIC_COMPANY, AMBASSADOR_OR_OFFICER, AUDIT_AUTHORITY, CENTRAL_BANK_MEMBER_OF_BOARD, INTERNATIONAL_LEADER, PUBLIC_FUNCTION
privacyPolicyAccept: TimestampedValue«boolean»
taxResidence: string SE, DK, FI, IS, NO, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
taxResidenceSweden: boolean
tin: string
transferSource: string SWE_BANK, SWE_INSURANCE, ESS
unrealizedLiquidAssets: string GT_MILLION, LT_MILLION, GT_FIVE_MILLION, LT_FIVE_MILLION, GT_TEN_MILLION, LT_TEN_MILLION
withdrawalPeriodicity: string MONTHLY, MULTIPLE_PER_YEAR, YEARLY, OCCASIONALLY
Example
{
  "cashSources": "object",
  "citizenship": [
    "string"
  ],
  "completedAcceptActions": [
    {
      "action": "string",
      "timestamp": "string",
      "version": "integer (int32)"
    }
  ],
  "completedKnowledgeTests": [
    {
      "completionDate": "string",
      "questions": [
        {
          "answerId": "string",
          "questionId": "string"
        }
      ],
      "type": "string",
      "version": "integer (int32)"
    }
  ],
  "depositPeriodicity": "string",
  "employment": "string",
  "funds": "boolean",
  "income": "number (double)",
  "investmentPurpose": "object",
  "investmentSize": "string",
  "liquidAssets": "string",
  "loansAndCredits": "boolean",
  "lossKnowledge": "boolean",
  "ownage": "boolean",
  "pep": "string",
  "pepPosition": "string",
  "pepRelation": "string",
  "pepRelationPosition": "string",
  "privacyPolicyAccept": {
    "updated": "string",
    "value": "boolean"
  },
  "taxResidence": "string",
  "taxResidenceSweden": "boolean",
  "tin": "string",
  "transferSource": "string",
  "unrealizedLiquidAssets": "string",
  "withdrawalPeriodicity": "string"
}

UserWithRoles: object

admin: ExternalAdmin
clientId: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
clientIdMigrationTarget: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
clientIdOriginal: string betterwealth, collector, test, test_no_trade, betterwealth_diy, betterwealth_2, *
confirmEmail: string
created: DateTimeRepresentation
email: string
favorites: UserFavorite
UserFavorite
features: string[]
string
firstName: string
id: string
lastName: string
newsletter: boolean
notifications: boolean
organization: OrganizationWithUsers
personalNumber: PersonalNumber
phone: string
premiumContact: External
premiumLevel: string none, level_one
userProfileAlias: string
Example
{
  "admin": {
    "name": "string",
    "uuid": "string"
  },
  "clientId": "string",
  "clientIdMigrationTarget": "string",
  "clientIdOriginal": "string",
  "confirmEmail": "string",
  "created": "string",
  "email": "string",
  "favorites": [
    {
      "created": "string",
      "id": "string",
      "type": "string"
    }
  ],
  "features": [
    "string"
  ],
  "firstName": "string",
  "id": "string",
  "lastName": "string",
  "newsletter": "boolean",
  "notifications": "boolean",
  "organization": {
    "confirmEmail": "string",
    "email": "string",
    "lei": "string",
    "name": "string",
    "organizationNumber": {
      "canonical": "string",
      "canonicalAsLong": "integer (int64)",
      "prefix": "string",
      "vatnumber": "string"
    },
    "principal": {
      "name": "string",
      "personalNumber": {
        "age": "integer (int32)",
        "canonical": "string",
        "canonicalAsLong": "integer (int64)",
        "prefix": "string"
      }
    },
    "status": "string",
    "users": [
      {
        "lastUpdated": "string",
        "organizationId": "string",
        "organizationRole": "string",
        "userId": "string",
        "userName": "string",
        "uuid": "string"
      }
    ],
    "uuid": "string"
  },
  "personalNumber": {
    "age": "integer (int32)",
    "canonical": "string",
    "canonicalAsLong": "integer (int64)",
    "prefix": "string"
  },
  "phone": "string",
  "premiumContact": {
    "email": "string",
    "imageUrl": "string",
    "name": "string",
    "phone": "string"
  },
  "premiumLevel": "string",
  "userProfileAlias": "string"
}

Decimal: number (double)

Representad as a double in the API, will be stored as a fixed number (6 decimals) in the database

Example
"number (double)"
Documentation by Spectacle