Skip to content
Compliance Questionnaires

Get Questionnaire Questions

Gets the questions provided by the server for a questionnaire token. The Broker App uses it to render dynamic questionnaires whose template_source is custom, and on the result page to match and show submitted answers.

Only items whose type is question are questions. question.content and question.options are JSON strings that must be parsed again. Questions whose is_kyc_field is true can be prefilled from the Client KYC profile. When options come from a remote data source, fetch them separately by ref. If the request fails, tell the Client and allow a retry; do not show an empty questionnaire.

When you call this operation through WhaleCore requestService(), you do not need to set requiresTradeToken to true.

GEThttps://api.lbkrs.com/v1/kyc/questionnaire/token_exchange_questions

Parameters

tokenstringqueryRequired

token from the questionnaire link

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Questionnaire Questions” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
itemsarray<object>

Questionnaire items in display order

Child attributes
typestring

Item type. Only question is a question; skip other types.

requiredboolean

Whether the question must be answered

questionobject

Question definition

Child attributes
idstring

Question ID

question_typestring

Question type. Skip questions of any other type:

  • string - Text
  • number - Number
  • select, radio - Single choice
  • multiple_select, checkbox - Multiple choice
  • date - Date
  • image - Image upload
  • file - File upload
field_keystring

Field identifier. When is_kyc_field is true, it maps to a field in the Client KYC profile and can be used for prefilling and submission.

is_kyc_fieldboolean

Whether the question maps to a KYC profile field

contentstring

Question text as a JSON string that must be parsed again, for example {"text": {"en": "..."}}. text holds the question text keyed by language code.

optionsstring

Options as a JSON string that must be parsed again. Inline options look like {"array": [{"key": "<OPTION_KEY>", "text": {"en": "..."}}]}. Options from a remote data source look like {"type": "ref", "ref": "<REF_ID>"}.

Whale Docs