---
title: "Get questionnaire definition"
method: GET
path: "/platform/v1/customers/questionnaire/definitions"
tags: ["Onboarding"]
---

# Get questionnaire definition

`GET /platform/v1/customers/questionnaire/definitions`

## Request

- Base URL: `https://api.sandbox.bvnk.com`
- URL: `https://api.sandbox.bvnk.com/platform/v1/customers/questionnaire/definitions`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/docs/platform/v1/customers/questionnaire/definitions/get.ts> (a function with typed inputs; its response is checked against the schema)

:::info Customers API v2
The [new customer onboarding flow](../../../get-started/create-embedded-partner-customer/create-customers-com) is recommended for all new integrations.

If you already have an existing integration with Customers API v1, you can continue using it. BVNK will continue to support this API going forward.
:::

Fetches quiestionnaire schemas with questions, answer types, option lists. You can render the questionnaire in  your UI. 

 Questionnaires include the following sections:<ul><li>**Nature of Business**: mandatory details related to company operations)</li><li>**Document Requirements**: key compliance documents</li></ul>

## Query parameters

- `codes` string[]

## Response `200`

Array of questionnaire schema objects.

- object[]
  - `code` 'financialServicesQuestionnaireFull' | 'amlCryptoComplianceQuestionnaireFull' | 'gamblingQuestionnaireFull' | 'fintechsQuestionnaireFull' | 'otherQuestionnaireFull' | 'eddQuestionnaire', required: Questionnaire identifier
  - `title` string, required: Title of the questionnaire
  - `description` string: What this questionnaire is about
  - `sections` object[], required: Questionnaire section
    - `code` string, required: Section reference
    - `title` string, required: Section title
    - `items` object[], required
      - `code` string, required: Question reference code
      - `title` string, required: Title of the question
      - `type` 'textArea' | 'textInput' | 'selectDropdown' | 'fileAttachment', required: Answer text, selected option
      - `required` boolean, required: Shows whether the question is mandatory or optional
      - `options` object[]: Answer options
        - `value` string, required
        - `title` string, required
        - `score` number

## Other responses

- `400`: Invalid or missing `codes` parameter.

---

[API](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints.md) - [All operations](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/bvnk/apis/bvnk-api-endpoints/revisions/c386d436bf2c?raw)