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.

ES · Wealth API · 2026-04-01

TwoFactorAuthenticationInstruction

Instructions for two factor authentication. Add supplemental information to a collection if the responseType is not NO_RESPONSE.

authenticationInstructionstringrequired

Instructions text

responseTypestringrequired

Expected response type

Possible Enum values are NUMBER_CODE, NO_RESPONSE, PHONE_NUMBER, QR_CODE or TEXT_ANSWER.

Example

{
  "authenticationInstruction": "Please authenticate with the following device: <name>'s IPHONE 13",
  "responseType": "NUMBER_CODE"
}

{  "authenticationInstruction": "Please authenticate with the following device: <name>'s IPHONE 13",  "responseType": "NUMBER_CODE"}