Skip to main content
GET
/
kyb
/
forms
/
{companyId}
/
questionnaires
/
{id}
Retrieve questionnaire
curl --request GET \
  --url https://api.example.com/kyb/forms/{companyId}/questionnaires/{id}/ \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "key": "<string>",
  "name": "<string>",
  "title": "<string>",
  "sections": [
    {
      "key": "<string>",
      "title": "<string>",
      "questions": [
        {
          "key": "<string>",
          "title": "<string>",
          "type": "CHECKBOX",
          "description": "",
          "choices": [
            {
              "key": "<string>",
              "title": "<string>"
            }
          ],
          "required": false,
          "placeholder": "<string>",
          "condition": "<string>"
        }
      ],
      "description": "",
      "condition": "<string>"
    }
  ],
  "description": "",
  "type": "KYC"
}

Authorizations

Authorization
string
header
required

Authentication for actions with all operations associated with KYB form.
Token obtained from KYB form token generation endpoint as tokenString value.

Path Parameters

companyId
string
required
id
string
required

A unique value identifying this questionnaire.

Response

200 - application/json
id
string
required
key
string
required

Used for token creation to identify this questionnaire.

Maximum string length: 32
Pattern: ^[\w_*-]+$
name
string
required
Maximum string length: 32
title
string
required
Maximum string length: 512
sections
object[]
required
description
string | null
default:""
Maximum string length: 512
type
enum<string>
Available options:
KYC,
KYB