Skip to main content
GET
/
kyb
/
info
Retrieve KYB session info
curl --request GET \
  --url https://ivs.idenfy.com/kyb/info/ \
  --header 'Authorization: Bearer <token>'
{
  "locale": "en",
  "theme": {
    "companyName": "<string>",
    "logo": "<string>",
    "font": "<string>",
    "colors": {
      "primary": "<string>",
      "secondary": "<string>",
      "primaryBackground": "<string>",
      "secondaryBackground": "<string>",
      "hoveredButton": "<string>",
      "disabledIconButton": "<string>",
      "disabledButtonTypography": "<string>",
      "disabledButton": "<string>",
      "typography": "<string>",
      "success": "<string>",
      "successBackground": "<string>",
      "error": "<string>",
      "errorBackground": "<string>",
      "warning": "<string>",
      "warningBackground": "<string>",
      "info": "<string>",
      "infoBackground": "<string>",
      "border": "<string>"
    },
    "supportEmail": "jsmith@example.com"
  },
  "flow": {
    "fields": [
      {
        "field": "COMPANY_NAME",
        "required": false,
        "order": 1,
        "readOnly": false,
        "changeFrom": "<unknown>",
        "changeRequired": true
      }
    ],
    "fieldsCustom": [
      {
        "field": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "key": "<string>",
          "title": "<string>",
          "type": "CHECKBOX",
          "description": "",
          "choices": [
            {
              "key": "<string>",
              "title": "<string>"
            }
          ]
        },
        "required": false,
        "order": 2147483647,
        "readOnly": false,
        "changeFrom": "<unknown>",
        "changeRequired": true
      }
    ],
    "documents": [
      {
        "docType": "<string>",
        "description": "<string>",
        "required": false
      }
    ],
    "beneficiaries": [
      {
        "beneficiaryType": "CEO",
        "applicants": [
          {
            "applicantType": "INDIVIDUAL",
            "fields": [
              {
                "field": "NAME",
                "required": false,
                "order": 1
              }
            ],
            "required": false,
            "fieldsCustom": [
              {
                "field": {
                  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                  "key": "<string>",
                  "title": "<string>",
                  "type": "CHECKBOX",
                  "description": "",
                  "choices": [
                    {
                      "key": "<string>",
                      "title": "<string>"
                    }
                  ]
                },
                "required": false,
                "order": 2147483647
              }
            ],
            "documents": [
              {
                "docType": "<string>",
                "description": "<string>",
                "required": false
              }
            ]
          }
        ],
        "required": false,
        "fields": [
          {
            "field": "OWNERSHIP_PERCENTAGE",
            "required": false
          }
        ],
        "description": "<string>",
        "readOnly": false
      }
    ],
    "companySearch": true,
    "bankVerification": true,
    "emailVerification": true,
    "ownershipFullStructure": true,
    "ownershipPercentageThreshold": 50,
    "description": "<string>",
    "questionnaireDescription": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://documentation.idenfy.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

Response

​
locale
enum<string>
required

Default locale to use when user opens the KYB form for the first time.

Available options:
en,
es,
fr,
ru,
de,
it,
pl,
lt,
lv,
et,
cs,
ro,
hu,
ja,
bg,
nl,
pt
​
theme
object
required

Indicates the visual customization of the KYB form.

​
flow
object
required

Indicates which fields/objects should be present in the KYB form.
If this field is null, then all possible fields/objects are present in this KYB form.