User Input Types

User Input TypeDefinitionQuery formatUsed in following regions
otpEither the OTP sent to the end user's device by the bank or an in app token in the user's bank appThe query field in the API response will include text instructing the user to provide the OTP- MENA
- United States
secret_questionA set of questions set by the end user on a bank accountThe query field in the API response will include text instructing the user to provide the secret question answer- MENA
- United States
captchaA captcha shown by the bank during bank operationThe query field in the API response will include a base64 string that needs to be converted to an image for display- MENA
- United States
pinSome bank accounts have hardware based device used to generate tokens for some bank operationsThe query field in the API response will include text instructing the user to provide the PIN- MENA
- United States
confirmationUsually, the user needs to open his app or receive a call to confirm an operationThe query field in the API response will include text instructing the user to provide the conformation- MENA
- United States
tokenAn in-app token similar to OTP. Usually, the user needs to open his app on the device to confirm an operation.The query field in the API response will include text instructing the user to provide the token- MENA
- United States
multiple_choiceA user needs to answer a questions by selecting one of the available options. The question as well as options can both be either text or image based.In addition to query, there will also be `queryOptions. The answer field will need to include the index of the option that was chosen.- United States only