Preview Questionnaire

Retrieves the preview structure of a specific questionnaire. Returns the versioned identifier, subject-level questions, and declared entity groups with their associated questions. This is useful for rendering questionnaire forms before submission.

Request

https://openapi.advance.ai/v1/business/questionnaires/{questionnaireId}
GET

Request Header Parameters

Parameter

Description

Authorization

string Please use Token Authentication API to get your access token.
Format: Bearer {token}

Path Parameters

ParameterRequiredDescription
questionnaireIdTruestring The unique identifier of the questionnaire to preview.

Request Examples

curl -X GET "https://openapi.advance.ai/v1/business/questionnaires/QNRE-2026052200001" \
  -H "Authorization: Bearer {Your Access Token}"

Success Response

Returns the questionnaire preview structure with the following fields:

FieldDescription
qnreIdentifierVersionstring The versioned identifier of the questionnaire.
subjectQuestionsarray List of subject-level question objects.
declaredGroupsarray List of declared entity group objects.

Response.declaredGroups[]

Question Group Preview Object

FieldDescription
groupIdstring The unique identifier of the group.
groupNamestring The display name of the group.
groupTypeenum The entity type of the group. See ProfileSectionGroupType
declaredQuestionsarray List of question objects within this group.

Response.subjectQuestions[] / Response.declaredGroups[].declaredQuestions[]

Question Preview Item Object

FieldDescription
questionIdstring The unique identifier of the question.
questionTitlestring The display title of the question.
questionTypeenum The input type of the question. See QuestionTypeEnum.
optionCodesarray List of option codes for select-type questions. Empty for free-text types.

Enumerations

QuestionType

ValueDescription
NUMBERNumber - Numeric input field.
ATTACHMENTAttachment - File upload field.
DATEDate - Date picker field (date only).
DATE_TIMEDate Time - Date and time picker field.
CONSENT_AGREEMENTConsent Agreement - Consent or agreement checkbox.
ADDRESSAddress - Address input field.
CURRENCYCurrency - Currency input field.
EMAILEmail - Email address input field.
LINKLink - URL input field.
PHONEPhone - Phone number input field.
SINGLE_SELECTSingle Select - Single-choice selection field.

ProfileSectionGroupType

ValueDescription
COMPANYCompany - Declared related company entity group.
INDIVIDUALIndividual - Declared associated individual entity group.

Response Examples

{
  "qnreIdentifierVersion": "qnre_abc123_v2",
  "subjectQuestions": [
    {
      "questionId": "q_001",
      "questionTitle": "Company Registration Number",
      "questionType": "NUMBER"
    },
    {
      "questionId": "q_002",
      "questionTitle": "Business License",
      "questionType": "ATTACHMENT"
    }
  ],
  "declaredGroups": [
    {
      "groupId": "g_001",
      "groupName": "Related Companies",
      "groupType": "COMPANY",
      "declaredQuestions": [
        {
          "questionId": "q_101",
          "questionTitle": "Company Email",
          "questionType": "EMAIL"
        }
      ]
    },
    {
      "groupId": "g_002",
      "groupName": "Associated Individuals",
      "groupType": "INDIVIDUAL",
      "declaredQuestions": [
        {
          "questionId": "q_201",
          "questionTitle": "Role",
          "questionType": "SINGLE_SELECT",
          "optionCodes": ["DIRECTOR", "SHAREHOLDER", "UBO"]
        }
      ]
    }
  ]
}

Error Response

HTTP Status CodeError CodeDescription
400Bad RequestThe request parameters are invalid.
401UnauthorizedThe access token is missing or invalid.
404Not FoundThe questionnaire with the specified ID does not exist.