Session API

Companies need to analyze onboarding companies data for risk, compliance purposes and present information to authorities as per requests.

This API allows customers to receive information on the boarding in a single call, so it can be uploaded to risk management solutions, CRMs or displayed on the portal in accordance with company policies.

As well as to provide a convenient tool to monitor changes done by the customer be it valid or not.

get

Company API

Path parameters

sessionIdstringRequired

Header parameters

AuthorizationstringRequired

Bearer token

Responses

200

Session data

application/json

401

Unauthorized: No valid access token has been provided

403

Forbidden: Access token doesn't have permission to use the requested feature

404

Session not found

500

Internal Server Error: Unexpected error

get

/v1/session/{sessionId}

HTTPcURLJavaScriptPython

GET /api/v1/session/{sessionId} HTTP/1.1
Host: kyb.uqudo.io
Authorization: text
Accept: */*

{
  "company": {
    "searchSummary": {
      "name": "text",
      "governmentId": "text",
      "countryOfRegistration": "ABW",
      "dataGroups": [
        "BASIC"
      ]
    },
    "dataGroupsInquiry": [
      "BASIC"
    ],
    "content": {
      "basic": {
        "companyName": "text",
        "companyStatus": "ACTIVE",
        "companySubStatuses": [
          "DEFAULT_PAYMENT"
        ],
        "companyGovernmentId": "text",
        "lastUpdated": "2025-12-12T21:44:18.884Z"
      },
      "contact": {
        "addresses": [
          {
            "addressType": "REGISTERED_ADDRESS",
            "poBox": "text",
            "country": "ABW",
            "region": "text",
            "city": "text",
            "area": "text",
            "street": "text",
            "building": "text",
            "apartment": "text",
            "postCode": "text",
            "singleLineAddress": "text"
          }
        ],
        "phoneNumbers": [
          "text"
        ],
        "email": "text",
        "website": "text",
        "lastUpdated": "2025-12-12T21:44:18.884Z"
      },
      "businessActivity": {
        "entityType": "CORPORATE",
        "entityTypeDescription": "text",
        "legalType": "PRIVATE_LIMITED_COMPANY",
        "legalTypeDescription": "text",
        "legalTypeDescriptionLocale": "text",
        "incorporationDate": "text",
        "industry": "text",
        "industryCode": "text",
        "registrationIds": [
          {
            "idNumber": "text",
            "idDescription": "text",
            "idType": "LICENSE_NUMBER"
          }
        ],
        "managers": [
          {
            "fullName": "text",
            "country": "text",
            "functionDescription": "text",
            "functionDescriptionLocale": "text",
            "email": "text",
            "shareholder": true,
            "lastUpdated": "2025-12-12T21:44:18.884Z"
          }
        ],
        "registeredActivities": [
          {
            "code": "text",
            "name": "text"
          }
        ],
        "registeredActivitiesSecondaryCode": [
          {
            "code": "text",
            "name": "text"
          }
        ],
        "lastUpdated": "2025-12-12T21:44:18.884Z"
      },
      "ownership": {
        "shareholdersCount": 1,
        "independenceIndicator": "text",
        "shareholders": [
          {
            "fullName": "text",
            "entityType": "CORPORATE",
            "entityTypeDescription": "text",
            "country": "ABW",
            "directPct": 1,
            "totalPct": 1,
            "informationSource": "text",
            "informationDate": "text"
          }
        ],
        "lastUpdated": "2025-12-12T21:44:18.884Z"
      },
      "ownershipExtended": {
        "uboStatus": "text",
        "ubos": [
          {
            "fullName": "text",
            "firstName": "text",
            "lastName": "text",
            "entityType": "CORPORATE",
            "entityTypeDescription": "text",
            "country": "ABW",
            "phoneNumber": "text",
            "email": "text",
            "uboDistance": "text"
          }
        ],
        "otherUbos": [
          {
            "fullName": "text",
            "entityType": "CORPORATE",
            "entityTypeDescription": "text",
            "country": "ABW"
          }
        ],
        "lastUpdated": "2025-12-12T21:44:18.884Z"
      },
      "screening": {
        "summary": {
          "sanction": {
            "match": true,
            "categoryCodes": [
              "ABU"
            ]
          }
        },
        "entries": [
          {
            "companyName": "text",
            "companyAliases": [
              "text"
            ],
            "events": [
              {
                "categoryCode": "ABU",
                "categoryDescription": "text",
                "subCategoryCode": "ACC",
                "subCategoryDescription": "text",
                "eventDescription": "text",
                "eventDate": "2025-12-12",
                "sourceName": "text"
              }
            ]
          }
        ]
      }
    }
  },
  "matching": [
    {
      "request": {
        "document": "text",
        "documentType": "BUSINESS_LICENSE",
        "fields": [
          {
            "fieldId": "text",
            "fieldValue": "text",
            "ignoreSeparator": false,
            "caseInsensitive": false,
            "dateField": false
          }
        ]
      },
      "result": {
        "fields": [
          {
            "fieldId": "text",
            "match": true
          }
        ]
      }
    }
  ],
  "screeningIndividuals": [
    {
      "screenings": [
        {
          "inquiry": {
            "fullName": "text",
            "nationality": "ABW",
            "dateOfBirth": "2025-12-12",
            "roles": [
              "MANAGER"
            ]
          },
          "riskEventCategories": [
            "ABU"
          ]
        }
      ]
    }
  ]
}

You can find the full YAML swagger specification here

60KB

kyb_session.yml

Open

You can find the full JSON swagger specification here

520KB

kyb_session.json

Open