Skip to main content
POST
/
kyb
/
search
Simple Search
curl --request POST \
  --url https://sandbox-umbrella-api.azurewebsites.net/api/services/kyb/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "IDCANOPY GROUP LTD",
  "country": "GB",
  "registrationNumber": "",
  "locality": "London"
}'
{
  "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"
        }
      ],
      "website": "https://acme.example"
    }
  },
  "metadata": {
    "confidence": 0.93,
    "completeness": 0.92,
    "cacheAge": "3h"
  }
}
For a usage description of the KYB Search Service, please refer to the KYB page.

​
Endpoint

POST /kyb/search

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
required

Registered name of the company.

Example:

"IDCANOPY GROUP LTD"

​
country
string
required

Two-letter ISO country code of company registration.

Example:

"GB"

​
locality
string
required

City or locality where the company is registered.

Example:

"London"

​
registrationNumber
string

Official company registration number (may be empty).

Example:

""

Response

Successfully retrieved search results.

​
status
string
required

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

Example:

"success"

​
requestId
string
required

Client-provided request identifier for traceability.

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
⌘I