Objects

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

LoginMethodParameter

Selects which login method the collector should trigger.

loginMethodstringrequired

Identifier of the login method supported by the availability endpoint.

Possible Enum values are UK_DOB_USERNAME, UK_DOB_USERNAME_PASSWORD, UK_LASTNAME_MEMBERSHIP_NUMBER, UK_USERNAME_POSTCODE, USERNAME_AND_PASSWORD, EMAIL, AUTHENTICATION_APP_URL or API_KEY.
typestring
Possible Enum values are LOGIN_METHOD.
Properties inherited from: CollectionParameter
typestringrequired
Example
{  "loginMethod": "UK_DOB_USERNAME",  "type": "LOGIN_METHOD"}