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.

Company API

GEThttps://kyb.uqudo.io/api/v1/session/{sessionId}

Path parameters

sessionId*string

Header parameters

Response

200401403404500

Session data

Body

application/json

companyobject

matchingarray of object

screeningIndividualsarray of object

Request

JavaScriptCurlPython

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

Response

200

{
  "company": {
    "searchSummary": {
      "name": "text",
      "governmentId": "text",
      "countryOfRegistration": "ABW",
      "dataGroups": [
        "BASIC"
      ]
    },
    "dataGroupsInquiry": [
      "BASIC"
    ],
    "content": {
      "basic": {
        "companyName": "text",
        "companyStatus": "ACTIVE",
        "companySubStatuses": [
          "DEFAULT_PAYMENT"
        ],
        "companyGovernmentId": "text",
        "lastUpdated": "2024-12-21T11:36:03.253Z",
        "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-12-21T11:36:03.253Z"
      },
      "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-12-21T11:36:03.253Z"
          }
        ],
        "registeredActivities": [
          {
            "code": "text",
            "name": "text"
          }
        ],
        "registeredActivitiesSecondaryCode": [
          {
            "code": "text",
            "name": "text"
          }
        ],
        "lastUpdated": "2024-12-21T11:36:03.253Z"
      },
      "ownership": {
        "shareholdersCount": 0,
        "independenceIndicator": "text",
        "shareholders": [
          {
            "fullName": "text",
            "entityType": "CORPORATE",
            "entityTypeDescription": "text",
            "country": "ABW",
            "directPct": 0,
            "totalPct": 0,
            "informationSource": "text",
            "informationDate": "text"
          }
        ],
        "lastUpdated": "2024-12-21T11:36:03.253Z"
      },
      "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-12-21T11:36:03.253Z"
      },
      "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-12-21",
                "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": false
          }
        ]
      }
    }
  ],
  "screeningIndividuals": [
    {
      "screenings": [
        {
          "inquiry": {
            "fullName": "text",
            "nationality": "ABW",
            "dateOfBirth": "2024-12-21",
            "roles": [
              "MANAGER"
            ]
          },
          "riskEventCategories": [
            "ABU"
          ]
        }
      ]
    }
  ]
}

You can find the full YAML swagger specification here

60KB

kyb_session.yml

You can find the full JSON swagger specification here

520KB

kyb_session.json