Company API

Many businesses and organizations face issues with company onboarding processes as they require a lot of effort and pose significant barriers to implementing truly digital solutions.

Company API is designed with flexibility in mind to provide information on the onboarded company relative to a specific use case in a structured format. The information is retrieved using multiple data sources (such as countries registries (where available),regional data sources (that provide access to registries data through API for the countries where API is not available). Information available on the company is split into Data Groups each one of them has a specific use case it is applicable to.

Currently following Data Groups are available:

• Basic. Allows to check company status (Active / Inactive / Unknown) and sub-status (e.g. In process of liquidation).

• Contact. Provides information on Addresses, phone numbers, website, email of the company.

• Business Activity. Provides information on general company details (legal form, legal name), company ids (VAT number, LEI, TIN), Industry and activities of the company, company Managers.

• Ownership. Provides information on Shareholders of the company.

• Ownership extended. Provides information on UBOs of the company

• Screening. Provides information on screening results for the company.

Company API

GEThttps://kyb.uqudo.io/api/v1/companies

Query parameters

Header parameters

Response

200400401403405500

Company content details

Headers

Body

application/json

searchSummaryobject

dataGroupsInquiryarray of enum

contentobject

Request

JavaScriptCurl

const response = await fetch('https://kyb.uqudo.io/api/v1/companies', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "searchSummary": {
    "name": "text",
    "governmentId": "text",
    "countryOfRegistration": "ABW",
    "dataGroups": [
      "BASIC"
    ]
  },
  "dataGroupsInquiry": [
    "BASIC"
  ],
  "content": {
    "basic": {
      "companyName": "text",
      "companyStatus": "ACTIVE",
      "companySubStatuses": [
        "DEFAULT_PAYMENT"
      ],
      "companyGovernmentId": "text",
      "lastUpdated": "2024-04-28T14:57:02.305Z",
      "transientIdNumber": "text"
    },
    "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": "2024-04-28T14:57:02.305Z"
    },
    "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": false,
          "lastUpdated": "2024-04-28T14:57:02.305Z"
        }
      ],
      "registeredActivities": [
        {
          "code": "text",
          "name": "text"
        }
      ],
      "registeredActivitiesSecondaryCode": [
        {
          "code": "text",
          "name": "text"
        }
      ],
      "lastUpdated": "2024-04-28T14:57:02.305Z"
    },
    "ownership": {
      "independenceIndicator": "text",
      "shareholders": [
        {
          "fullName": "text",
          "entityType": "CORPORATE",
          "entityTypeDescription": "text",
          "country": "ABW",
          "directPct": 0,
          "totalPct": 0,
          "informationSource": "text",
          "informationDate": "text"
        }
      ],
      "lastUpdated": "2024-04-28T14:57:02.305Z"
    },
    "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": "2024-04-28T14:57:02.305Z"
    },
    "screening": {
      "summary": {
        "sanction": {
          "match": false,
          "categoryCodes": [
            "ABU"
          ]
        }
      },
      "entries": [
        {
          "companyName": "text",
          "companyAliases": [
            "text"
          ],
          "events": [
            {
              "categoryCode": "ABU",
              "categoryDescription": "text",
              "subCategoryCode": "ACC",
              "subCategoryDescription": "text",
              "eventDescription": "text",
              "eventDate": "2024-04-28",
              "sourceName": "text"
            }
          ]
        }
      ]
    }
  }
}

Rules:

1. If startSession query string is defined and it is true the company API will return a session id and create a record in the cache valid for two weeks. TBD if the session id is returned in a response header or as part of the body response.

2. If UQ-Session-ID is passed the API will check if an existing record in the cache exists (session id + client id). If the record doesn’t exist a 400 status code is returned with a specific error message accordingly. If the record exists and the searchSummary doesn’t match, again an error is returned. Otherwise the content is merged and the cache refreshed. Note: if startSession above is passed to the API with value true this header is ignored.

You can find the full YAML swagger specification here

48KB

kyb_company.yml

You can find the full JSON swagger specification here

343KB

kyb_company.json