KYB Search Service - IdCanopy API Documentation

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",
  "locality": "London",
  "registrationNumber": ""
}
'

{
  "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"
  }
}

POST

kyb

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",
  "locality": "London",
  "registrationNumber": ""
}
'

{
  "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

Show child attributes

data.company

object

Show child attributes

data.company.legalName

string

Official registered legal name of the company.

Example:

"ACME GmbH"

data.company.tradingNames

string[]

List of trading or alternative names.

Example:

["ACME"]

data.company.status

string

Current company status.

Example:

"active"

data.company.companyType

object

Show child attributes

data.company.companyType.native

object

Show child attributes

data.company.companyType.native.value

string

Example:

"Gesellschaft mit beschränkter Haftung"

data.company.companyType.native.language

string

Example:

"de"

data.company.companyType.native.source

string

Example:

"register"

data.company.companyType.modeled

object

Show child attributes

data.company.companyType.modeled.value

string

Example:

"Limited Liability Company"

data.company.companyType.modeled.scheme

string

Example:

"idcanopy"

data.company.companyType.modeled.source

string

Example:

"modeled"

data.company.incorporationDate

string<date>

Official incorporation date (YYYY-MM-DD).

Example:

"2019-07-01"

data.company.registrationDate

string<date>

Date of registration (YYYY-MM-DD).

Example:

"2019-06-15"

data.company.country

string

Two-letter ISO country code of incorporation.

Example:

"AT"

data.company.registeredAddress

object

Show child attributes

data.company.registeredAddress.singleLine

string

Full formatted address string.

Example:

"Musterstraße 1, 1010 Wien, AT"

data.company.registeredAddress.structured

object

Show child attributes

data.company.registeredAddress.structured.line1

string

Example:

"Musterstraße 1"

data.company.registeredAddress.structured.city

string

Example:

"Wien"

data.company.registeredAddress.structured.postalCode

string

Example:

"1010"

data.company.registeredAddress.structured.country

string

Example:

"AT"

data.company.businessAddress

object

Show child attributes

data.company.businessAddress.singleLine

string

Full business/trading address string.

Example:

"Musterstraße 1, 1010 Wien, AT"

data.company.businessAddress.structured

object

Show child attributes

data.company.businessAddress.structured.line1

string

Example:

"Musterstraße 1"

data.company.businessAddress.structured.city

string

Example:

"Wien"

data.company.businessAddress.structured.postalCode

string

Example:

"1010"

data.company.businessAddress.structured.country

string

Example:

"AT"

data.company.identifiers

object[]

Show child attributes

data.company.identifiers.scheme

string

Identifier scheme (e.g., REGISTRATION_NUMBER, VAT, LEI).

Example:

"REGISTRATION_NUMBER"

data.company.identifiers.value

string

Example:

"FN 123456x"

data.company.identifiers.country

string | null

Country associated with the identifier.

Example:

"AT"

data.company.industryCodes

object[]

Show child attributes

data.company.industryCodes.scheme

string

Example:

"NACE"

data.company.industryCodes.code

string

Example:

"62.01"

data.company.industryCodes.label

string

Example:

"Computer programming activities"

data.company.website

string<uri>

Example:

"https://acme.example"

metadata

object

Show child attributes

metadata.confidence

number<double>

Confidence score for the company match (0–1).

Example:

0.93

metadata.completeness

number<double>

Completeness score for available company data (0–1).

Example:

0.92

metadata.cacheAge

string

Age of cached response.

Example:

"3h"

Identity Verification Service KYB Advanced Company Details

⌘I

Endpoints

​Endpoint

Authorizations

Body

Response

Endpoint