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}
GETRequest Header Parameters
Parameter | Description |
|---|---|
Authorization |
|
Path Parameters
| Parameter | Required | Description |
|---|---|---|
| questionnaireId | True | string 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:
| Field | Description |
|---|---|
| qnreIdentifierVersion | string The versioned identifier of the questionnaire. |
| subjectQuestions | array List of subject-level question objects. |
| declaredGroups | array List of declared entity group objects. |
Response.declaredGroups[]
Question Group Preview Object
| Field | Description |
|---|---|
| groupId | string The unique identifier of the group. |
| groupName | string The display name of the group. |
| groupType | enum The entity type of the group. See ProfileSectionGroupType |
| declaredQuestions | array List of question objects within this group. |
Response.subjectQuestions[] / Response.declaredGroups[].declaredQuestions[]
Question Preview Item Object
| Field | Description |
|---|---|
| questionId | string The unique identifier of the question. |
| questionTitle | string The display title of the question. |
| questionType | enum The input type of the question. See QuestionTypeEnum. |
| optionCodes | array List of option codes for select-type questions. Empty for free-text types. |
Enumerations
QuestionType
| Value | Description |
|---|---|
| NUMBER | Number - Numeric input field. |
| ATTACHMENT | Attachment - File upload field. |
| DATE | Date - Date picker field (date only). |
| DATE_TIME | Date Time - Date and time picker field. |
| CONSENT_AGREEMENT | Consent Agreement - Consent or agreement checkbox. |
| ADDRESS | Address - Address input field. |
| CURRENCY | Currency - Currency input field. |
| Email - Email address input field. | |
| LINK | Link - URL input field. |
| PHONE | Phone - Phone number input field. |
| SINGLE_SELECT | Single Select - Single-choice selection field. |
ProfileSectionGroupType
| Value | Description |
|---|---|
| COMPANY | Company - Declared related company entity group. |
| INDIVIDUAL | Individual - 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 Code | Error Code | Description |
|---|---|---|
| 400 | Bad Request | The request parameters are invalid. |
| 401 | Unauthorized | The access token is missing or invalid. |
| 404 | Not Found | The questionnaire with the specified ID does not exist. |
