GET
/
KYB
/
companyProfile
curl --request GET \
  --url https://api-umbrella.io/api/services/KYB/companyProfile \
  --header 'Authorization: Bearer <token>'
{
  "error": true,
  "message": "<string>",
  "version": "<string>",
  "data": {
    "resolvedPercentage": 123,
    "resolvedCount": 123,
    "fetchedCountriesWithStates": [
      {
        "countryName": "<string>",
        "states": [
          "<string>"
        ]
      }
    ],
    "fetchedCountries": [
      "<string>"
    ],
    "secondarySource": true,
    "requestStatus": "<string>",
    "kybRequestData": [
      {
        "id": "<string>",
        "requestId": "<string>",
        "searchText": "<string>",
        "countryName": "<string>",
        "countryFlag": "<string>",
        "extensiveData": [
          "<string>"
        ],
        "name": "<string>",
        "registrationNumber": "<string>",
        "registrationDate": "<string>",
        "type": "<string>",
        "primarySource": true,
        "secondarySource": true,
        "status": "<string>",
        "metaDetail": {},
        "riskLevel": "<string>",
        "verificationStatus": "<string>",
        "companyFetchedDataStatus": "<string>"
      }
    ],
    "pagination": {
      "total": 123,
      "perPage": 123,
      "currentPage": 123,
      "lastPage": 123,
      "from": 123,
      "to": 123
    }
  }
}

For a usage description of the KYB Company Profile Service, please refer to the KYB page.

​
Endpoint

GET /KYB/companyProfile

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200
application/json
Successfully retrieved company profiles.
​
error
boolean

Indicates whether an error occurred.

​
message
string

A message describing the result of the request.

​
version
string | null

Reserved for future use.

​
data
object