{"id":809,"date":"2023-10-18T08:34:06","date_gmt":"2023-10-18T06:34:06","guid":{"rendered":"http:\/\/localhost:8083\/api-documentation\/"},"modified":"2025-07-08T14:20:35","modified_gmt":"2025-07-08T12:20:35","slug":"api-documentation","status":"publish","type":"page","link":"https:\/\/wealthapi.eu\/en\/api-documentation\/","title":{"rendered":"API Documentation"},"content":{"rendered":"<div class=\"wpb-content-wrapper\"><p>[vc_row row_height_percent=&#8221;0&#8243; override_padding=&#8221;yes&#8221; h_padding=&#8221;2&#8243; top_padding=&#8221;4&#8243; bottom_padding=&#8221;4&#8243; overlay_alpha=&#8221;50&#8243; gutter_size=&#8221;3&#8243; column_width_percent=&#8221;100&#8243; shift_y=&#8221;0&#8243; z_index=&#8221;0&#8243; uncode_shortcode_id=&#8221;381303&#8243;][vc_column column_width_percent=&#8221;60&#8243; align_horizontal=&#8221;align_center&#8221; gutter_size=&#8221;2&#8243; expand_height=&#8221;yes&#8221; overlay_alpha=&#8221;50&#8243; shift_x=&#8221;0&#8243; shift_y=&#8221;0&#8243; shift_y_down=&#8221;0&#8243; z_index=&#8221;0&#8243; medium_width=&#8221;0&#8243; mobile_width=&#8221;0&#8243; width=&#8221;1\/1&#8243; uncode_shortcode_id=&#8221;729019&#8243;][vc_custom_heading text_color=&#8221;color-217939&#8243; heading_semantic=&#8221;h4&#8243; text_size=&#8221;h4&#8243; text_weight=&#8221;700&#8243; uncode_shortcode_id=&#8221;211295&#8243; text_color_type=&#8221;uncode-palette&#8221;]API Documentation[\/vc_custom_heading][vc_custom_heading heading_semantic=&#8221;h1&#8243; text_size=&#8221;h1&#8243; uncode_shortcode_id=&#8221;199672&#8243;]Easy, fast and scalable[\/vc_custom_heading][vc_column_text uncode_shortcode_id=&#8221;676985&#8243;]wealthAPI uses an &#8216;API first&#8217; approach, meaning all finance manager and multi-banking functionality is available via a modern, REST based API.[\/vc_column_text][\/vc_column][\/vc_row][vc_row row_height_percent=&#8221;0&#8243; overlay_alpha=&#8221;50&#8243; gutter_size=&#8221;3&#8243; column_width_percent=&#8221;100&#8243; border_color=&#8221;color-gyho&#8221; border_style=&#8221;solid&#8221; shift_y=&#8221;0&#8243; z_index=&#8221;0&#8243; uncode_shortcode_id=&#8221;198218&#8243; css=&#8221;.vc_custom_1698745706472{border-top-width: 1px !important;}&#8221; border_color_type=&#8221;uncode-palette&#8221;][vc_column column_width_percent=&#8221;100&#8243; gutter_size=&#8221;2&#8243; overlay_alpha=&#8221;50&#8243; shift_x=&#8221;0&#8243; shift_y=&#8221;0&#8243; shift_y_down=&#8221;0&#8243; z_index=&#8221;0&#8243; medium_width=&#8221;0&#8243; mobile_width=&#8221;0&#8243; width=&#8221;1\/4&#8243; uncode_shortcode_id=&#8221;131291&#8243;][vc_custom_heading heading_semantic=&#8221;h3&#8243; text_size=&#8221;h5&#8243; uncode_shortcode_id=&#8221;871858&#8243; el_id=&#8221;documentation-link&#8221;]<a href=\"#general\">General<\/a>[\/vc_custom_heading][vc_custom_heading heading_semantic=&#8221;h3&#8243; text_size=&#8221;h5&#8243; uncode_shortcode_id=&#8221;212977&#8243; el_id=&#8221;documentation-link&#8221;]<a href=\"#technical-documentation\">Technical documentation<\/a>[\/vc_custom_heading][vc_custom_heading heading_semantic=&#8221;h3&#8243; text_size=&#8221;h5&#8243; uncode_shortcode_id=&#8221;198766&#8243; el_id=&#8221;documentation-link&#8221;]<a href=\"#how-to-start\">How to start using the API<\/a>[\/vc_custom_heading][vc_custom_heading heading_semantic=&#8221;h3&#8243; text_size=&#8221;h5&#8243; uncode_shortcode_id=&#8221;190964&#8243; el_id=&#8221;documentation-link&#8221;]<a href=\"#environments\">Environments<\/a>[\/vc_custom_heading][vc_custom_heading heading_semantic=&#8221;h3&#8243; text_size=&#8221;h5&#8243; uncode_shortcode_id=&#8221;748068&#8243; el_id=&#8221;documentation-link&#8221;]<a href=\"#uri-info\">URI Information<\/a>[\/vc_custom_heading][vc_custom_heading heading_semantic=&#8221;h3&#8243; text_size=&#8221;h5&#8243; uncode_shortcode_id=&#8221;154919&#8243; el_id=&#8221;documentation-link&#8221;]<a href=\"#request-types\">Request Types<\/a>[\/vc_custom_heading][vc_custom_heading heading_semantic=&#8221;h3&#8243; text_size=&#8221;h5&#8243; uncode_shortcode_id=&#8221;201454&#8243; el_id=&#8221;documentation-link&#8221;]<a href=\"#status-codes\">Status codes<\/a>[\/vc_custom_heading][vc_custom_heading heading_semantic=&#8221;h3&#8243; text_size=&#8221;h5&#8243; uncode_shortcode_id=&#8221;699801&#8243; el_id=&#8221;documentation-link&#8221;]<a href=\"#accept-and-content-types\">Accept and Content Types<\/a>[\/vc_custom_heading][vc_custom_heading heading_semantic=&#8221;h3&#8243; text_size=&#8221;h5&#8243; uncode_shortcode_id=&#8221;123633&#8243; el_id=&#8221;documentation-link&#8221;]<a href=\"#response-format\">Response format<\/a>[\/vc_custom_heading][vc_custom_heading heading_semantic=&#8221;h3&#8243; text_size=&#8221;h5&#8243; uncode_shortcode_id=&#8221;188267&#8243; el_id=&#8221;documentation-link&#8221;]<a href=\"#date-time-format\">Date &amp; Time format<\/a>[\/vc_custom_heading][vc_custom_heading heading_semantic=&#8221;h3&#8243; text_size=&#8221;h5&#8243; uncode_shortcode_id=&#8221;184001&#8243; el_id=&#8221;documentation-link&#8221;]<a href=\"#authentication\">Authentication<\/a>[\/vc_custom_heading][vc_custom_heading heading_semantic=&#8221;h3&#8243; text_size=&#8221;h5&#8243; uncode_shortcode_id=&#8221;501199&#8243; el_id=&#8221;documentation-link&#8221;]<a href=\"#authorization\">Authorization<\/a>[\/vc_custom_heading][\/vc_column][vc_column column_width_percent=&#8221;100&#8243; gutter_size=&#8221;2&#8243; overlay_alpha=&#8221;50&#8243; shift_x=&#8221;0&#8243; shift_y=&#8221;0&#8243; shift_y_down=&#8221;0&#8243; z_index=&#8221;0&#8243; medium_width=&#8221;0&#8243; mobile_width=&#8221;0&#8243; width=&#8221;3\/4&#8243; uncode_shortcode_id=&#8221;135246&#8243;][vc_column_text uncode_shortcode_id=&#8221;279633&#8243;]<\/p>\n<div>\n<h2 id=\"general\" class=\"MuiTypography-root MuiTypography-h2 css-1fqmgmk\">General<\/h2>\n<p class=\"MuiTypography-root MuiTypography-body1 css-4xbftp\">The wealthAPI API is a RESTful interface for accessing the wealthAPI system programmatically.<\/p>\n<div class=\"MuiBox-root css-16ltkz0\">\n<h3 class=\"MuiTypography-root MuiTypography-h3 css-1dgcucz\">Regulatory Compliance for Account Information Services<\/h3>\n<\/div>\n<p class=\"MuiTypography-root MuiTypography-body1 css-4xbftp\">wealthAPI provides PSD2 relevant services via its partners. As a customer of wealthAPI services, regulatory requirements of the European PSD2 regulation (ZAG law in Germany) may apply to you. Please visit our PSD2 regulations page for details.<\/p>\n<\/div>\n<div>\n<h2 id=\"technical-documentation\" class=\"MuiTypography-root MuiTypography-h2 css-bwwcbh\">Technical documentation<\/h2>\n<p class=\"MuiTypography-root MuiTypography-body1 css-178zy3y\">Please find our API documentation in OpenAPI format by clicking on the buttons below.<\/p>\n<p class=\"MuiTypography-root MuiTypography-body1 css-178zy3y\">API docs for fans of the classic swagger editor can be found <a href=\"https:\/\/sandbox.wealthapi.eu\/apiDocumentation\/partners\/swagger\/scalar\">here<\/a>.<\/p>\n<\/div>\n<p>To get started, we provide tutorials and background information on our <a href=\"https:\/\/wealthapi.atlassian.net\/wiki\/spaces\/PD\">confluence developer page<\/a>. These tutorials provide you with a technical first-steps guide from user creation to importing your first bank connection. It also provides important background information on user management and on keeping your user credentials secure.[\/vc_column_text][vc_button button_color=&#8221;color-135990&#8243; radius=&#8221;btn-circle&#8221; border_width=&#8221;0&#8243; button_color_type=&#8221;uncode-palette&#8221; uncode_shortcode_id=&#8221;736550&#8243; icon=&#8221;fa fa-code&#8221; link=&#8221;url:https%3A%2F%2Fsandbox.wealthapi.eu%2FapiDocumentation%2Fpartners%2Fswagger|&#8221;]wealthAPI PURE core API[\/vc_button][vc_column_text uncode_shortcode_id=&#8221;197284&#8243;]The wealthAPI PURE core API provides endpoints for account, investment and transaction management and analytics. This is what you would typically refer to as the &#8220;Portfolio manager&#8221;.[\/vc_column_text][vc_button button_color=&#8221;color-217939&#8243; radius=&#8221;btn-circle&#8221; border_width=&#8221;0&#8243; button_color_type=&#8221;uncode-palette&#8221; uncode_shortcode_id=&#8221;180733&#8243; icon=&#8221;fa fa-code&#8221; link=&#8221;url:https%3A%2F%2Fsandbox.wealthapi.eu%2Fapi-docs%2Findex.html|&#8221;]wealthAPI brokerage API[\/vc_button][vc_column_text uncode_shortcode_id=&#8221;135677&#8243;]The wealthAPI brokerage API provides access to our in-house brokerage connections such as Trade Republic or Scalable Capital. Please note that this currently is a read-only API; i.e. we provide a powerful data import data but do not execute trades.<\/p>\n<p>Please see the following <a href=\"https:\/\/wealthapi.atlassian.net\/wiki\/spaces\/PD\/pages\/85458945\/Multibanking+providers+FIN+API+and+WEALTH+API\">background article<\/a> listing the different multi-banking \/ multi-brokerage options that we are providing.[\/vc_column_text][vc_button radius=&#8221;btn-circle&#8221; border_width=&#8221;0&#8243; button_color_type=&#8221;uncode-solid&#8221; uncode_shortcode_id=&#8221;687312&#8243; icon=&#8221;fa fa-code&#8221; link=&#8221;url:https%3A%2F%2Fwealthapi.eu%2Fpdf-parser-v2%2Fswagger-ui%2Findex.html|&#8221; button_color_solid=&#8221;#263240&#8243;]PDF parsing API[\/vc_button][vc_column_text uncode_shortcode_id=&#8221;839014&#8243;]This service allows to seemingly parse order and SEPA-transaction data from your banks PDF statements. We provide additional documentation on <a href=\"https:\/\/wealthapi.atlassian.net\/wiki\/spaces\/PD\/pages\/198049793\">PDF and CSV import here<\/a>.[\/vc_column_text][vc_column_text uncode_shortcode_id=&#8221;183020&#8243;]<\/p>\n<h3>Changelog<\/h3>\n<p>Take a look at the changes we&#8217;ve made to our API over the last week.[\/vc_column_text][vc_button button_color=&#8221;color-217939&#8243; radius=&#8221;btn-circle&#8221; border_width=&#8221;0&#8243; button_color_type=&#8221;uncode-palette&#8221; uncode_shortcode_id=&#8221;161068&#8243; icon=&#8221;fa fa-code&#8221; link=&#8221;url:%23|target:_blank|&#8221; el_id=&#8221;changelogLink&#8221;]API Change Log[\/vc_button][vc_column_text uncode_shortcode_id=&#8221;263942&#8243; el_id=&#8221;link&#8221;]<\/p>\n<h2>How to start using the API<\/h2>\n<div>\n<p class=\"MuiTypography-root MuiTypography-body1 css-4xbftp\">wealthAPI uses a mandator based approach to securely separate user information from different domains (usually there is one mandator per SaaS customer). To start using the wealthAPI API please request a mandator account from our support. If you would just like to try the API, we will create an account on our Sandbox environment free of charge. Please include your companies&#8217; information and a short description of your planned project in the request.<\/p>\n<\/div>\n<div>\n<h2 id=\"environments\" class=\"MuiTypography-root MuiTypography-h2 css-bwwcbh\">Environments<\/h2>\n<p>API Sandbox: <a href=\"http:\/\/sandbox.wealthapi.eu\">sandbox.wealthapi.eu<\/a><\/p>\n<p>API Production: <a href=\"http:\/\/wealthapi.eu\">wealthapi.eu<\/a><\/p>\n<\/div>\n<div>\n<h2 id=\"uri-info\" class=\"MuiTypography-root MuiTypography-h2 css-bwwcbh\">URI Information<\/h2>\n<div class=\"MuiBox-root css-16ltkz0\">\n<h3 class=\"MuiTypography-root MuiTypography-h3 css-1dgcucz\">URI format<\/h3>\n<\/div>\n<p class=\"MuiTypography-root MuiTypography-body1 css-4xbftp\">The API endpoint format is https:\/\/{environment}\/api\/{version}\/{resource}{additional-parameters}. The endpoints are versioned; versions will be upgraded in case of breaking changes or major functionality upgrades. The version will always be a full number. Example: <a href=\"https:\/\/sandbox.wealthapi.eu\/api\/v1\/funds?isin=DE0009848119&amp;isin=LU0323578657\">https:\/\/sandbox.wealthapi.eu\/api\/v1\/funds?isin=DE0009848119&amp;isin=LU0323578657<\/a><\/p>\n<div class=\"MuiBox-root css-16ltkz0\">\n<h3 class=\"MuiTypography-root MuiTypography-h3 css-1dgcucz\">URI parameters<\/h3>\n<\/div>\n<p class=\"MuiTypography-root MuiTypography-body1 css-1er3lke\">An endpoint may support one or many query parameters. For each parameter, the API defines if it may occur only once, or if multiple occurrences (e.g. multiple IDs) are allowed. In case multiple occurrences are allowed, the parameter may be submitted multiple times. The API supports the &#8216;array&#8217; as well as the &#8216;plain&#8217; syntax. Array syntax: https:\/\/sandbox.wealthapi.eu\/api\/v1\/accounts?id[]=1&amp;id[]=2&amp;id[]=3 Plain syntax: https:\/\/sandbox.wealthapi.eu\/api\/v1\/accounts?id=1&amp;id=2&amp;id=3<\/p>\n<\/div>\n<div>\n<h2 id=\"request-types\" class=\"MuiTypography-root MuiTypography-h2 css-bwwcbh\">Request Types<\/h2>\n<p class=\"MuiTypography-root MuiTypography-body1 css-10h9wy9\">wealthAPI uses the request method GET, POST, PUT and DELETE. The API documentation clearly states which request type must be used. Submitting an invalid request type will result in an &#8216;invalid request type&#8217; error.<\/p>\n<p><img decoding=\"async\" src=\"https:\/\/wealthapi.eu\/wp-content\/uploads\/2024\/02\/apiRequestType.png\" width=\"598\"><\/p>\n<p class=\"MuiTypography-root MuiTypography-body1 css-t2edhl\">Required request type in the API documentation<\/p>\n<p class=\"MuiTypography-root MuiTypography-body1 css-1er3lke\">GET: is used to get data; query parameters are part of the URL; does not contain a request body. POST: is used to create data. Usually no query parameters are supported; the payload is contained as JSON body. PUT: is used to modify existing data. Usually only the ID of the entity to be modified is included in the URL path and no further query parameters are given. The payload is contained as JSON body. DELETE: is used to delete or invalidate existing data. The ID of the entity to be deleted is included in the URL path; does not contain a request body.<\/p>\n<\/div>\n<div>\n<h2 id=\"status-codes\" class=\"MuiTypography-root MuiTypography-h2 css-bwwcbh\">Status codes<\/h2>\n<p class=\"MuiTypography-root MuiTypography-body1 css-4xbftp\">A successful request will return a success (200 or 202) status code. Any other status code indicates request error. The respective status codes for each operation are given in the API documentation.<\/p>\n<p><img decoding=\"async\" src=\"https:\/\/wealthapi.eu\/wp-content\/uploads\/2024\/02\/apiErrorResponse.png\" width=\"598\"><\/p>\n<p class=\"MuiTypography-root MuiTypography-body1 css-4xbftp\">Response codes including a short description are given in the API documentation<\/p>\n<\/div>\n<div>\n<h2 id=\"accept-and-content-types\" class=\"MuiTypography-root MuiTypography-h2 css-bwwcbh\">Accept and Content Types<\/h2>\n<p class=\"MuiTypography-root MuiTypography-body1 css-4xbftp\">The API only supports JSON request types. The standard response type is also JSON. A few methods support PDF as response type.<\/p>\n<\/div>\n<div>\n<h2 id=\"response-format\" class=\"MuiTypography-root MuiTypography-h2 css-bwwcbh\">Response format<\/h2>\n<p class=\"MuiTypography-root MuiTypography-body1 css-4xbftp\">All responses returned simple or complex JSON types or objects, if not specified otherwise. In many cases, you will find a pagination option in the API parameters. The response will then contain the respective pagination setting.<\/p>\n<p><img decoding=\"async\" src=\"https:\/\/wealthapi.eu\/wp-content\/uploads\/2024\/02\/apiResponse.png\" width=\"598\"><\/p>\n<p class=\"MuiTypography-root MuiTypography-body1 css-4xbftp\">The API documentation comes with example responses<\/p>\n<p class=\"MuiTypography-root MuiTypography-body1 css-1mjmmig\">See the <a class=\"MuiTypography-root MuiTypography-inherit MuiLink-root MuiLink-underlineAlways css-1x75ti6\" href=\"https:\/\/sandbox.wealthapi.eu\/apiDocumentation\/swagger\" target=\"_blank\" rel=\"noopener noreferrer\">API Reference Documentation<\/a> for more examples on response types.<\/p>\n<\/div>\n<div>\n<h2 id=\"date-time-format\" class=\"MuiTypography-root MuiTypography-h2 css-bwwcbh\">Date &amp; Time format<\/h2>\n<p class=\"MuiTypography-root MuiTypography-body1 css-4xbftp\">Date and time format for request parameters is specified in the respective endpoint documentation, but will typically follow the format &#8216;yyyy-MM-dd&#8217; (US Format). All response date formats follow the ISO 8601 format and is thus directly understood by most JS libraries.<\/p>\n<\/div>\n<div>\n<h2 id=\"authentication\" class=\"MuiTypography-root MuiTypography-h2 css-bwwcbh\">Authentication<\/h2>\n<p class=\"MuiTypography-root MuiTypography-body1 css-1er3lke\">The wealthAPI API is end-user centric. It is intended to be used directly by a frontend library, e.g. the Javascript code running in the users browser or mobile device. When a user authenticates, a successful request will yield an auth token and a refresh token (see <a class=\"MuiTypography-root MuiTypography-inherit MuiLink-root MuiLink-underlineAlways css-1x75ti6\" href=\"https:\/\/sandbox.wealthapi.eu\/apiDocumentation#operation\/login\" target=\"_blank\" rel=\"noopener noreferrer\">https:\/\/sandbox.wealthapi.eu\/apiDocumentation#operation\/login)<\/a>. The auth token is then included in the Authorization header of the http request (Authorization: Bearer auth_token). Auth tokens expire after one hour; as wealthAPI uses JWT an explicit &#8220;logout&#8221; is not possible. To logout simply delete the token. A refresh token may be used to obtain a new token using <a class=\"MuiTypography-root MuiTypography-inherit MuiLink-root MuiLink-underlineAlways css-1x75ti6\" href=\"https:\/\/sandbox.wealthapi.eu\/apiDocumentation#operation\/refreshToken\" target=\"_blank\" rel=\"noopener noreferrer\">https:\/\/sandbox.wealthapi.eu\/apiDocumentation#operation\/refreshToken<\/a>.<\/p>\n<div class=\"MuiBox-root css-16ltkz0\">\n<h3 class=\"MuiTypography-root MuiTypography-h3 css-1dgcucz\">Mandator-level authentication<\/h3>\n<\/div>\n<p class=\"MuiTypography-root MuiTypography-body1 css-4xbftp\">In some cases, operations must be performed on mandator level and not on user level. An example could be to perform a support request for a user being unable to access his account. Thus, for some endpoints authentication as mandator is available. Use the header fields &#8220;X-Mandator-Client-Id&#8221; and &#8220;X-Mandator-Client-Secret&#8221; to submit the credentials.<\/p>\n<div class=\"MuiBox-root css-16ltkz0\">\n<h3 class=\"MuiTypography-root MuiTypography-h3 css-1dgcucz\">User creation and mandators<\/h3>\n<\/div>\n<p class=\"MuiTypography-root MuiTypography-body1 css-4xbftp\">A user is always attached to a mandator. Which mandator that is, is decided once at user creation time. Switching mandators is forbidden. When creating a user, make sure to provide your mandators public ID in order to have full access to the user later on. Note that users that were created using the mandator public ID always must confirm their email address. To skip email confirmation use the mandators private ID (see below).<\/p>\n<div class=\"MuiBox-root css-16ltkz0\">\n<h3 class=\"MuiTypography-root MuiTypography-h3 css-1dgcucz\">Your mandator account<\/h3>\n<\/div>\n<p class=\"MuiTypography-root MuiTypography-body1 css-4xbftp\">Your mandator account comes with two IDs, a private and a public ID. The public ID is used to perform non-sensitive mandator specific operations. E.g. you will provide the mandators public ID when creating a new user; or you will need the ID if you allowed anonymous users to comment on your site. Your mandators private ID is used to perform sensitive tasks and must always be kept secret. E.g. it allows creating users without the need to confirm their email address. Be aware that unconfirmed email addresses pose a security thread and that you thus always keep your mandators private ID save.<\/p>\n<\/div>\n<div>\n<h2 id=\"authorization\" class=\"MuiTypography-root MuiTypography-h2 css-bwwcbh\">Authorization<\/h2>\n<div class=\"MuiBox-root css-16ltkz0\">\n<h3 class=\"MuiTypography-root MuiTypography-h3 css-1dgcucz\">Roles<\/h3>\n<\/div>\n<p class=\"MuiTypography-root MuiTypography-body1 css-4xbftp\">wealthAPI uses a role concept to limit access to certain API endpoints. Most endpoints require ROLE_USER, and thus allow access to the currently logged in users&#8217; data. Each endpoint may define one or many roles governing access. The respective role permissions are documentation via each endpoints API documentation. Note that while administrative roles may have access to a wide range of user data, their access is always limited to users belonging to this administrators mandator. wealthAPI defines the following roles: ROLE_USER: A normal user; this is the default role. ROLE_STATS: Allows view access to aggregated statistics. ROLE_USER_MANAGEMENT: Allows to change user data. ROLE_ROLE_MANAGEMENT: Allows to assign and remove roles for users belonging to the administrators mandator. ROLE_SUBSCRIPTION_MANAGEMENT: Allows to manage subscriptions for the administrators mandator. ROLE_BI: Allows read and write access to aggregated statistical and business analytics data. ROLE_ACCOUNTING: Accountants may modify subscriptions and govern subscription billing cycles. ROLE_B2B_ADMIN: May create or update Business-to-Business users (a feature for bloggers). ROLE_APPLICATION_PROPERTY_ADMIN: May create or update application properties. ROLE_INSURANCE_ADMIN: May create or update insurance related master data. This role is only available to wealthAPI internal developers.<\/p>\n<div class=\"MuiBox-root css-16ltkz0\">\n<h3 class=\"MuiTypography-root MuiTypography-h3 css-1dgcucz\">Assigning roles<\/h3>\n<\/div>\n<p class=\"MuiTypography-root MuiTypography-body1 css-4xbftp\">Roles may be assigned by a role manager (ROLE_ROLE_MANAGEMENT) to individual users using the &#8216;\/api\/v1\/roles&#8217; endpoint. By default, each newly created user has role ROLE_USER assigned.<\/p>\n<div class=\"MuiBox-root css-16ltkz0\">\n<h3 class=\"MuiTypography-root MuiTypography-h3 css-1dgcucz\">Anonymous access<\/h3>\n<\/div>\n<p class=\"MuiTypography-root MuiTypography-body1 css-4xbftp\">Some endpoints allow anonymous access. Such endpoints have the &#8216;x-roles: IS_AUTHENTICATED_ANONYMOUSLY&#8217; annotation.<\/p>\n<p><img decoding=\"async\" src=\"https:\/\/wealthapi.eu\/wp-content\/uploads\/2024\/02\/apiAnonymousAccess.png\" width=\"598\"><\/p>\n<p class=\"MuiTypography-root MuiTypography-body1 css-4xbftp\">x-roles: IS_AUTHENTICATED_ANONYMOUSLY annotation.<\/p>\n<\/div>\n<p>[\/vc_column_text][\/vc_column][\/vc_row]<\/p>\n<\/div>","protected":false},"excerpt":{"rendered":"<p>[vc_row row_height_percent=&#8221;0&#8243; override_padding=&#8221;yes&#8221; h_padding=&#8221;2&#8243; top_padding=&#8221;4&#8243; bottom_padding=&#8221;4&#8243; overlay_alpha=&#8221;50&#8243; gutter_size=&#8221;3&#8243; column_width_percent=&#8221;100&#8243; shift_y=&#8221;0&#8243; z_index=&#8221;0&#8243; uncode_shortcode_id=&#8221;381303&#8243;][vc_column column_width_percent=&#8221;60&#8243; align_horizontal=&#8221;align_center&#8221; gutter_size=&#8221;2&#8243; expand_height=&#8221;yes&#8221; overlay_alpha=&#8221;50&#8243; shift_x=&#8221;0&#8243; shift_y=&#8221;0&#8243; shift_y_down=&#8221;0&#8243;&hellip; <a class=\"continue\" href=\"https:\/\/wealthapi.eu\/en\/api-documentation\/\">Continue Reading<span> API Documentation<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":693,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"inline_featured_image":false,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"class_list":["post-809","page","type-page","status-publish","has-post-thumbnail","hentry"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.5 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>wealthAPI \u25b7 API documentation<\/title>\n<meta name=\"description\" content=\"Find all information about Request Types, Status Codes, Accept and Content Types, Response formats and more. \u25baRead more now\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/wealthapi.eu\/en\/api-documentation\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"wealthAPI \u25b7 API documentation\" \/>\n<meta property=\"og:description\" content=\"Find all information about Request Types, Status Codes, Accept and Content Types, Response formats and more. \u25baRead more now\" \/>\n<meta property=\"og:url\" content=\"https:\/\/wealthapi.eu\/en\/api-documentation\/\" \/>\n<meta property=\"og:site_name\" content=\"wealthAPI - Smart Financial Decisions\" \/>\n<meta property=\"article:modified_time\" content=\"2025-07-08T12:20:35+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/wealthapi.eu\/wp-content\/uploads\/2024\/01\/wealthAPI-1000x1000-1.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"1000\" \/>\n\t<meta property=\"og:image:height\" content=\"1000\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"10 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/wealthapi.eu\\\/en\\\/api-documentation\\\/\",\"url\":\"https:\\\/\\\/wealthapi.eu\\\/en\\\/api-documentation\\\/\",\"name\":\"wealthAPI \u25b7 API documentation\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/wealthapi.eu\\\/en\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/wealthapi.eu\\\/en\\\/api-documentation\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/wealthapi.eu\\\/en\\\/api-documentation\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/wealthapi.eu\\\/wp-content\\\/uploads\\\/2024\\\/01\\\/wealthAPI-1000x1000-1.jpg\",\"datePublished\":\"2023-10-18T06:34:06+00:00\",\"dateModified\":\"2025-07-08T12:20:35+00:00\",\"description\":\"Find all information about Request Types, Status Codes, Accept and Content Types, Response formats and more. \u25baRead more now\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/wealthapi.eu\\\/en\\\/api-documentation\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/wealthapi.eu\\\/en\\\/api-documentation\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/wealthapi.eu\\\/en\\\/api-documentation\\\/#primaryimage\",\"url\":\"https:\\\/\\\/wealthapi.eu\\\/wp-content\\\/uploads\\\/2024\\\/01\\\/wealthAPI-1000x1000-1.jpg\",\"contentUrl\":\"https:\\\/\\\/wealthapi.eu\\\/wp-content\\\/uploads\\\/2024\\\/01\\\/wealthAPI-1000x1000-1.jpg\",\"width\":1000,\"height\":1000,\"caption\":\"wealthAPI-Logo\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/wealthapi.eu\\\/en\\\/api-documentation\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/wealthapi.eu\\\/en\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Documentation\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/wealthapi.eu\\\/en\\\/#website\",\"url\":\"https:\\\/\\\/wealthapi.eu\\\/en\\\/\",\"name\":\"wealthapi\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\\\/\\\/wealthapi.eu\\\/en\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/wealthapi.eu\\\/en\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/wealthapi.eu\\\/en\\\/#organization\",\"name\":\"wealthAPI GmbH\",\"alternateName\":\"wealthAPI\",\"url\":\"https:\\\/\\\/wealthapi.eu\\\/en\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/wealthapi.eu\\\/en\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/wealthapi.eu\\\/wp-content\\\/uploads\\\/2024\\\/01\\\/wealthAPI-1000x1000-1.jpg\",\"contentUrl\":\"https:\\\/\\\/wealthapi.eu\\\/wp-content\\\/uploads\\\/2024\\\/01\\\/wealthAPI-1000x1000-1.jpg\",\"width\":1000,\"height\":1000,\"caption\":\"wealthAPI GmbH\"},\"image\":{\"@id\":\"https:\\\/\\\/wealthapi.eu\\\/en\\\/#\\\/schema\\\/logo\\\/image\\\/\"},\"sameAs\":[\"https:\\\/\\\/www.linkedin.com\\\/company\\\/wealthapi\\\/\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"wealthAPI \u25b7 API documentation","description":"Find all information about Request Types, Status Codes, Accept and Content Types, Response formats and more. \u25baRead more now","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/wealthapi.eu\/en\/api-documentation\/","og_locale":"en_US","og_type":"article","og_title":"wealthAPI \u25b7 API documentation","og_description":"Find all information about Request Types, Status Codes, Accept and Content Types, Response formats and more. \u25baRead more now","og_url":"https:\/\/wealthapi.eu\/en\/api-documentation\/","og_site_name":"wealthAPI - Smart Financial Decisions","article_modified_time":"2025-07-08T12:20:35+00:00","og_image":[{"width":1000,"height":1000,"url":"https:\/\/wealthapi.eu\/wp-content\/uploads\/2024\/01\/wealthAPI-1000x1000-1.jpg","type":"image\/jpeg"}],"twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"10 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/wealthapi.eu\/en\/api-documentation\/","url":"https:\/\/wealthapi.eu\/en\/api-documentation\/","name":"wealthAPI \u25b7 API documentation","isPartOf":{"@id":"https:\/\/wealthapi.eu\/en\/#website"},"primaryImageOfPage":{"@id":"https:\/\/wealthapi.eu\/en\/api-documentation\/#primaryimage"},"image":{"@id":"https:\/\/wealthapi.eu\/en\/api-documentation\/#primaryimage"},"thumbnailUrl":"https:\/\/wealthapi.eu\/wp-content\/uploads\/2024\/01\/wealthAPI-1000x1000-1.jpg","datePublished":"2023-10-18T06:34:06+00:00","dateModified":"2025-07-08T12:20:35+00:00","description":"Find all information about Request Types, Status Codes, Accept and Content Types, Response formats and more. \u25baRead more now","breadcrumb":{"@id":"https:\/\/wealthapi.eu\/en\/api-documentation\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/wealthapi.eu\/en\/api-documentation\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/wealthapi.eu\/en\/api-documentation\/#primaryimage","url":"https:\/\/wealthapi.eu\/wp-content\/uploads\/2024\/01\/wealthAPI-1000x1000-1.jpg","contentUrl":"https:\/\/wealthapi.eu\/wp-content\/uploads\/2024\/01\/wealthAPI-1000x1000-1.jpg","width":1000,"height":1000,"caption":"wealthAPI-Logo"},{"@type":"BreadcrumbList","@id":"https:\/\/wealthapi.eu\/en\/api-documentation\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/wealthapi.eu\/en\/"},{"@type":"ListItem","position":2,"name":"API Documentation"}]},{"@type":"WebSite","@id":"https:\/\/wealthapi.eu\/en\/#website","url":"https:\/\/wealthapi.eu\/en\/","name":"wealthapi","description":"","publisher":{"@id":"https:\/\/wealthapi.eu\/en\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/wealthapi.eu\/en\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/wealthapi.eu\/en\/#organization","name":"wealthAPI GmbH","alternateName":"wealthAPI","url":"https:\/\/wealthapi.eu\/en\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/wealthapi.eu\/en\/#\/schema\/logo\/image\/","url":"https:\/\/wealthapi.eu\/wp-content\/uploads\/2024\/01\/wealthAPI-1000x1000-1.jpg","contentUrl":"https:\/\/wealthapi.eu\/wp-content\/uploads\/2024\/01\/wealthAPI-1000x1000-1.jpg","width":1000,"height":1000,"caption":"wealthAPI GmbH"},"image":{"@id":"https:\/\/wealthapi.eu\/en\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.linkedin.com\/company\/wealthapi\/"]}]}},"_links":{"self":[{"href":"https:\/\/wealthapi.eu\/en\/wp-json\/wp\/v2\/pages\/809","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/wealthapi.eu\/en\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/wealthapi.eu\/en\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/wealthapi.eu\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/wealthapi.eu\/en\/wp-json\/wp\/v2\/comments?post=809"}],"version-history":[{"count":18,"href":"https:\/\/wealthapi.eu\/en\/wp-json\/wp\/v2\/pages\/809\/revisions"}],"predecessor-version":[{"id":5189,"href":"https:\/\/wealthapi.eu\/en\/wp-json\/wp\/v2\/pages\/809\/revisions\/5189"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/wealthapi.eu\/en\/wp-json\/wp\/v2\/media\/693"}],"wp:attachment":[{"href":"https:\/\/wealthapi.eu\/en\/wp-json\/wp\/v2\/media?parent=809"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}