---
title: "Retrieve KYB session info"
method: GET
path: "/kyb/info/"
tags: ["KYB Token"]
---

# Retrieve KYB session info

`GET /kyb/info/`

Various info for KYB session.

## Response `200`

- KybInfo
  - `locale` 'en' | 'es' | 'fr' | 'ru' | 'de' | 'it' | 'pl' | 'lt' | 'lv' | 'et' | 'cs' | 'ro' | 'hu' | 'ja' | 'bg' | 'nl' | 'pt', required
  - `theme` ThemeCore, required
    - `companyName` string, nullable
    - `logo` string, uri, nullable
    - `font` string, uri, nullable
    - `colors` ThemeColor
      - `primary` string, nullable
      - `secondary` string, nullable
      - `primaryBackground` string, nullable
      - `secondaryBackground` string, nullable
      - `hoveredButton` string, nullable
      - `disabledIconButton` string, nullable
      - `disabledButtonTypography` string, nullable
      - `disabledButton` string, nullable
      - `typography` string, nullable
      - `success` string, nullable
      - `successBackground` string, nullable
      - `error` string, nullable
      - `errorBackground` string, nullable
      - `warning` string, nullable
      - `warningBackground` string, nullable
      - `info` string, nullable
      - `infoBackground` string, nullable
      - `border` string, nullable
    - `supportEmail` string, email, nullable
  - `flow` KybFormUnifiedFlow, required
    - `fields` CompanyFieldUnified[], nullable
      - `required` boolean
      - `field` 'COMPANY_NAME' | 'REGISTRATION_NUMBER' | 'COUNTRY' | 'REGION' | 'TYPE' | 'PHONE' | 'WEBSITE' | 'EMAIL' | 'BRAND_NAMES' | 'ACTIVITY_CODE' | 'TIN' | 'OPERATING_ADDRESS' | 'POSTAL_ADDRESS' | 'POSTCODE' | 'STREET' | 'CITY', required
      - `order` integer, nullable
      - `readOnly` boolean
      - `changeFrom` unknown
      - `changeRequired` boolean
    - `fieldsCustom` CustomFieldAssignmentUnified[], nullable
      - `field` CustomField, required
        - `id` string, uuid, required
        - `key` string, required
        - `title` string, required
        - `description` string, nullable
        - `type` 'CHECKBOX' | 'COUNTRY' | 'COUNTRY_MULTI' | 'DATE' | 'INTEGER' | 'SELECT' | 'SELECT_MULTI' | 'TEXT', required
        - `choices` Choice[]
          - `key` string, required
          - `title` string, required
      - `required` boolean
      - `order` integer, nullable
      - `readOnly` boolean
      - `changeFrom` unknown
      - `changeRequired` boolean
    - `documents` CompanyDocType[], nullable
      - `description` string, nullable
      - `required` boolean
      - `docType` string, required
    - `beneficiaries` BeneficiaryUnifiedFlow[], nullable
      - `beneficiaryType` 'CEO' | 'REPRESENTATIVE' | 'SHAREHOLDER' | 'UBO' | 'ABO', required
      - `required` boolean
      - `fields` BeneficiaryField[], nullable
        - `required` boolean
        - `field` 'OWNERSHIP_PERCENTAGE', required
      - `applicants` ApplicantFlow[], required
        - union
          - IndividualFlow
            - `required` boolean
            - `applicantType` 'INDIVIDUAL' | 'COMPANY', required
            - `fieldsCustom` CustomFieldAssignment[], nullable
              - …
            - `fields` IndividualField[], required
              - …
            - `documents` IndividualDocType[], nullable
              - …
          - CompanyFlow
            - `required` boolean
            - `applicantType` 'INDIVIDUAL' | 'COMPANY', required
            - `fieldsCustom` CustomFieldAssignment[], nullable
              - …
            - `fields` CompanyField[], required
              - …
            - `documents` CompanyDocType[], nullable
              - …
      - `description` string — Note for the user to guide them on how the beneficiaries information (including documents uploading) should be filled/edited.
      - `readOnly` boolean
    - `companySearch` boolean, nullable
    - `bankVerification` boolean, nullable
    - `emailVerification` boolean, nullable
    - `ownershipFullStructure` boolean — Indicates that the KYB form must contain at least one beneficiary (of any kind) and every company beneficiary of `SHAREHOLDER`, `UBO` and `ABO` type must have at least one individual beneficiary. This is validated when submitting the KYB form.
    - `ownershipPercentageThreshold` number, double, nullable — Threshold to not require to add shareholders that are below this number.
    - `description` string, nullable — Note for the user to guide them on how the company information (including documents uploading) should be filled/edited.
    - `questionnaireDescription` string, nullable — Note for the user to guide them on how the questionnaire should be filled/edited.

## Other responses

- `401`

---

[API](https://skmtc.net/idenfy/apis/idenfy-ivs-core-api.md) · [All operations](https://skmtc.net/idenfy/apis/idenfy-ivs-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/idenfy/idenfy-ivs-core-api/revisions/3540d9ee5506/schema)