User Input Types
| User Input Type | Definition | Query format | Used in following regions |
|---|---|---|---|
| otp | Either the OTP sent to the end user's device by the bank or an in app token in the user's bank app | The query field in the API response will include text instructing the user to provide the OTP | - MENA - United States |
| secret_question | A set of questions set by the end user on a bank account | The query field in the API response will include text instructing the user to provide the secret question answer | - MENA - United States |
| captcha | A captcha shown by the bank during bank operation | The query field in the API response will include a base64 string that needs to be converted to an image for display | - MENA - United States |
| pin | Some bank accounts have hardware based device used to generate tokens for some bank operations | The query field in the API response will include text instructing the user to provide the PIN | - MENA - United States |
| confirmation | Usually, the user needs to open his app or receive a call to confirm an operation | The query field in the API response will include text instructing the user to provide the conformation | - MENA - United States |
| token | An 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_choice | A 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 |
Updated 6 months ago