Advanced

Retrieves the list of supported entities

This endpoint is optional and not required for standard integrations. Use only if explicitly instructed by Wealth Reader. Retrieves the list of supported entities and the information needed to draw the entity's login form.

get/entities/

Request

  • Base URL: https://api.wealthreader.com
  • URL: https://api.wealthreader.com/entities/
  • Auth: none declared

Query parameters

show_only_tested0 | 1

Indicates whether to show only tested entities. Default value is 0. In production environments, always use 1.

Response

list of entities

codestring required

The institution code

namestring required

The institution name

logostring required

Logo

colorstring required

Predominant color in the logo

Example response

[
  {
    "code": "bancamarch",
    "name": "Bancamarch",
    "logo": "https://cdn.wealthreader.com/bancamarch.svg",
    "color": "#e23e4d",
    "inputs": {
      "document_type": {
        "name": "DNI;Pasaporte"
      },
      "user": {
        "required": true,
        "name": "Username"
      },
      "password": {
        "required": true,
        "name": "Access key"
      }
    },
    "statistics": {
      "execution_time": 0.958119869232178,
      "warnings": [
        {
          "code": 1000,
          "message": "No contracted funds",
          "product_type": "portfolios"
        }
      ],
      "operation_id": "1827C79229",
      "token": "FRJ0mHlaqZwLzu"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.