GET
/
KYB
/
companies
/
read
curl --request GET \
  --url https://api-umbrella.io/api/services/KYB/companies/read \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "registrationNumber": "<string>",
  "registrationDate": "<string>",
  "companyRegistrationPeriod": "<string>",
  "status": "<string>",
  "type": "<string>",
  "countryName": "<string>",
  "description": "<string>",
  "countryFlag": "<string>",
  "jurisdictionCode": "<string>",
  "incorporationDate": "<string>",
  "companyIncorporationPeriod": "<string>",
  "industries": "<string>",
  "taxNumber": "<string>",
  "dissolutionDate": "<string>",
  "yearsSinceDissolution": "<string>",
  "inactiveDate": "<string>",
  "jurisdiction": "<string>",
  "primarySource": true,
  "secondarySource": true,
  "companyFetchedDataStatus": "<string>",
  "metaDetail": {},
  "companyAmlRequestId": "<string>",
  "companyAmlRequestStatus": "<string>",
  "companyAmlStatus": "<string>"
}

For a usage description of the KYB Companies Read Service, please refer to the KYB page.

​
Endpoint

GET /KYB/companies/read

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
companyId
string
required

Unique identifier for the company.

​
requestId
string
required

Unique identifier for the request.

Response

200
application/json
Successfully retrieved company details.
​
id
string
​
name
string
​
registrationNumber
string
​
registrationDate
string
​
companyRegistrationPeriod
string
​
status
string
​
type
string
​
countryName
string
​
description
string
​
countryFlag
string
​
jurisdictionCode
string
​
incorporationDate
string
​
companyIncorporationPeriod
string
​
industries
string
​
taxNumber
string
​
dissolutionDate
string
​
yearsSinceDissolution
string
​
inactiveDate
string
​
jurisdiction
string
​
primarySource
boolean
​
secondarySource
boolean
​
companyFetchedDataStatus
string
​
metaDetail
object
​
companyAmlRequestId
string
​
companyAmlRequestStatus
string
​
companyAmlStatus
string