BVbvnk
Onboarding

Get questionnaire definition

:::info Customers API v2 The new customer onboarding flow 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>

get/platform/v1/customers/questionnaire/definitions

Request

Query parameters

codesstring[]

One or several questionnaire identifiers. Each code covers Baseline and Industry-specific requirements.

Response

Array of questionnaire schema objects.

code'financialServicesQuestionnaireFull' | 'amlCryptoComplianceQuestionnaireFull' | 'gamblingQuestionnaireFull' | 'fintechsQuestionnaireFull' | 'otherQuestionnaireFull' | 'eddQuestionnaire' required

Questionnaire identifier

titlestring required

Title of the questionnaire

descriptionstring

What this questionnaire is about

Example response

[
  {
    "code": "amlCryptoComplianceQuestionnaireFull",
    "title": "Digital Assets (Crypto) Questionnaire",
    "description": "This questionnaire assesses AML/CFT and crypto compliance practices.",
    "sections": [
      {
        "code": "nature_of_business_section",
        "title": "Nature of Business",
        "items": [
          {
            "code": "products_services_offered",
            "title": "What products or services does your company offer?",
            "type": "selectDropdown",
            "required": true,
            "options": [
              {
                "value": "yes",
                "title": "Yes",
                "score": 10
              }
            ]
          }
        ]
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 3 revisions of this API.