This is a preview version of the API intended for early testing and integration. Preview versions are not stable and may include breaking changes before general availability.

UK · Wealth API · 2026-04-01

ApiKeyParameter

Input for the API_KEY login method: an API key the user created in their account at the company, plus its secret for companies that issue one. Encrypt both like a password.

apiKeystringrequired

API key created by the user in their account at the company.

apiSecretstring

Secret issued together with the API key, for companies that use one.

typestring

Possible Enum values are API_KEY.

Properties inherited from: CollectionParameter

typestringrequired

Example

{
  "apiKey": "53cr3t_4P1_K3Y",
  "apiSecret": "53cr3t_4P1_53cr3t",
  "type": "API_KEY"
}

{  "apiKey": "53cr3t_4P1_K3Y",  "apiSecret": "53cr3t_4P1_53cr3t",  "type": "API_KEY"}