Skip to main content
POST
/
kyb
/
company
/
details
Advanced Company Details
curl --request POST \
  --url https://sandbox-umbrella-api.azurewebsites.net/api/services/kyb/company/details \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "companyId": "123xyz"
}'
{
  "status": "success",
  "requestId": "client-req-987",
  "companyId": "umb-7c9a-...",
  "timestamp": "2025-08-25T08:00:00Z",
  "data": {
    "company": {
      "legalName": "ACME GmbH",
      "tradingNames": [
        "ACME"
      ],
      "status": "active",
      "companyType": {
        "native": {
          "value": "Gesellschaft mit beschränkter Haftung",
          "language": "de",
          "source": "register"
        },
        "modeled": {
          "value": "Limited Liability Company",
          "scheme": "idcanopy",
          "source": "modeled"
        }
      },
      "incorporationDate": "2019-07-01",
      "registrationDate": "2019-06-15",
      "country": "AT",
      "registeredAddress": {
        "singleLine": "Musterstraße 1, 1010 Wien, AT",
        "structured": {
          "line1": "Musterstraße 1",
          "city": "Wien",
          "postalCode": "1010",
          "country": "AT"
        }
      },
      "businessAddress": {
        "singleLine": "Musterstraße 1, 1010 Wien, AT",
        "structured": {
          "line1": "Musterstraße 1",
          "city": "Wien",
          "postalCode": "1010",
          "country": "AT"
        }
      },
      "identifiers": [
        {
          "scheme": "REGISTRATION_NUMBER",
          "value": "FN 123456x",
          "country": "AT"
        }
      ],
      "industryCodes": [
        {
          "scheme": "NACE",
          "code": "62.01",
          "label": "Computer programming activities"
        }
      ],
      "companyContacts": [
        {
          "website": "https://acme.example",
          "phone": "0049123455",
          "fax": "0049123456789",
          "email": "office@acme.com",
          "linkedin": "https://linkedin.com/acme",
          "scheme": "homepage"
        }
      ],
      "GlobalsignatoryRules": {
        "native": {
          "value": "Jeder Partner vertritt die Gesellschaft allein.",
          "language": "de",
          "source": "register"
        },
        "modeled": {
          "value": "Every partner has sole representation rights",
          "scheme": "idcanopy",
          "source": "modeled"
        }
      },
      "companyResources": [
        {
          "financials": "umbrelladetailuuid",
          "compliance": "umbrelladetailuuid",
          "ubo": "umbrelladetailuuid",
          "sanctionPeP": "umbrelladetailuuid",
          "description": "financials reference"
        }
      ],
      "officers": [
        {
          "type": "individual",
          "officerID": "uuid",
          "officerData": {
            "firstName": "John",
            "lastName": "Doe",
            "DOB": "2000-01-01",
            "birthplace": "Berlin",
            "countryOfBirth": "DE",
            "nationality": "DE",
            "address": {
              "singleLine": "Musterstraße 1, 1010 Wien, AT"
            },
            "identityData": {
              "PersonalNumber": {
                "identifier": "asdfghj",
                "country": "PL",
                "scheme": "PESEL"
              }
            }
          },
          "activity": {
            "role": {
              "native": {
                "value": "Geschäftsführer",
                "language": "de",
                "source": "register"
              },
              "modeled": {
                "value": "Managing Director",
                "scheme": "idcanopy",
                "source": "modeled"
              }
            },
            "status": "active",
            "from": "2000-01-01",
            "to": "2000-01-01",
            "signatureRights": {
              "native": {
                "value": "Einzelvertretungsberechtigt",
                "language": "de",
                "source": "register"
              },
              "modeled": {
                "value": "Individual Representation",
                "scheme": "idcanopy",
                "source": "modeled"
              },
              "signatureQuality": "individual"
            }
          }
        }
      ],
      "ownership": [
        {
          "type": "individual",
          "ownerID": "uuid",
          "ownerData": {
            "firstName": "John",
            "lastName": "Doe",
            "address": {
              "singleLine": "Musterstraße 1, 1010 Wien, AT"
            },
            "shareholding": {
              "holdingPct": {
                "shares": "49.9%",
                "capital": "EUR 12500",
                "votingRights": "99%"
              },
              "verbalholding": [
                {
                  "type": "shares",
                  "native": {
                    "value": "holds more than 25% but less than 50% of shares",
                    "language": "en",
                    "source": "register"
                  },
                  "modeled": {
                    "value": "SHARE 25-50",
                    "scheme": "idcanopy",
                    "source": "modeled"
                  }
                }
              ]
            },
            "isUBO": "yes"
          }
        }
      ],
      "relationships": {
        "ultimateBeneficialOwners": [
          "loremIpsum"
        ],
        "transparencyRegister": [],
        "familyTree": [
          "loremIpsum"
        ],
        "isHeadquarter": "Yes",
        "isGlobalUltimate": "Yes",
        "isDomesticUltimate": "Yes",
        "isSubsidiary": "Yes"
      }
    }
  },
  "metadata": {
    "confidence": 0.93,
    "completeness": 0.92,
    "source": "Deutsches Handelsregister",
    "sourceTst": "2025-08-25T08:00:00Z",
    "cacheAge": "3h"
  }
}
For a usage description of the KYB Advanced Company Details, please refer to the KYB page.

​
Endpoint

POST /kyb/company/details

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
companyId
string
required

Unique identifier assigned to the company.

Example:

"123xyz"

Response

Successfully retrieved company details.

​
status
string
required

Status of the request (e.g., success).

Example:

"success"

​
requestId
string
required

Client-provided request identifier.

Example:

"client-req-987"

​
companyId
string
required

Unique company identifier assigned by the platform.

Example:

"umb-7c9a-..."

​
timestamp
string<date-time>
required

RFC 3339 timestamp when the response was generated.

Example:

"2025-08-25T08:00:00Z"

​
data
object
required
​
metadata
object