Skip to main content

KYB API

The KYB API lets you search for a legal entity and retrieve structured company data directly from official registers and aggregated sources. Three endpoints cover the full workflow:
  • Authentication (/auth) — Obtain a Bearer token using your Api-Key and Customer-Id. Required before any other call.
  • Search (/kyb/search) — Find a company by name or registration number. Returns a companyId and transactionId required for the next step.
  • Company Details (/kyb/company/details) — Retrieve the full company record. The include parameter controls which data packages are returned; each package is priced separately. Document and transparency packages return a list of available items with linkToken values.
  • Document Retrieval (/kyb/company/document/retrieve) — Fetch an individual document or transparency register entry using a linkToken from the details response.
Where available, structured fields are returned in two forms: native (verbatim from the register, in the original language) and modeled (normalised to a common English scheme via idcanopy). All other data is passed through as-is from the source.
Try the search endpoint here.

Authentication

POST /auth All KYB API requests require a Bearer token. Obtain one by calling the authentication endpoint with your credentials. Tokens are valid for 60 minutes and must be refreshed after expiration.

Required Headers

HeaderValue
Content-Typeapplication/x-www-form-urlencoded
Api-KeyYour API key (UUID)
Customer-IdYour customer ID (UUID)

Example Request

curl -X POST https://api-umbrella.io/api/services/auth \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -H "Api-Key: 40ab0d69-fc3e-5fea-bfa8-b94e93462ad9" \
  -H "Customer-Id: 16a6c3e7-7a76-4714-9b34-97135ab4bdcd"

Response

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_in": 3600,
  "token_type": "Bearer"
}
Use the access_token value in the Authorization header of all subsequent requests:
Authorization: Bearer <access_token>

Base URLs

EnvironmentURL
Productionhttps://api-umbrella.io/api/services
Sandboxhttps://sandbox-umbrella-api.azurewebsites.net/api/services

1. Search Company

POST /kyb/search Searches for a legal entity by name (fuzzy) or registration number (exact). Exactly one of name or companyNo must be provided — not both.

Required Headers

HeaderValue
Content-Typeapplication/json
AuthorizationBearer <access_token>

Request Body

FieldTypeRequiredDescription
namestringXORCompany name. Fuzzy matching is applied; quality depends on the underlying source.
companyNostringXOROfficial registration number (exact match).
countrystringYesISO 3166-1 alpha-2 country code (e.g. GB, AT, DE).
localitystringNoCity or locality to narrow results.
name and companyNo are mutually exclusive. Providing both will return a validation error.

Example Request — by name

{
  "name": "IDCanopy Group Ltd",
  "country": "GB",
  "locality": "London"
}

Example Request — by registration number

{
  "companyNo": "16262990",
  "country": "GB"
}

Response

The response is an array of matches. Multiple results may be returned for name-based searches.
FieldTypeDescription
statusbooleantrue on success.
data[]arrayList of matched companies.
data[].transactionIdstringSession token — pass to /kyb/company/details.
data[].companyIdstringUmbrella company identifier — pass to /kyb/company/details.
data[].namestringRegistered legal name.
data[].statusstringCompany status (e.g. active, dissolved).
data[].registrationNumberstringOfficial registration number.
data[].addressLinestringRegistered address, single line.
data[].countrystringISO alpha-2 country code.

Example Response

{
  "status": true,
  "data": [
    {
      "transactionId": "a8b89ef3-9d93-4d96-a495-be605fd1b2fe",
      "companyId": "223c8dde-9c82-4811-ba3c-4f9fe648c2da",
      "name": "IDCANOPY GROUP LTD",
      "status": "active",
      "registrationNumber": "16262990",
      "addressLine": "71-75 Shelton Street, Covent Garden, London, United Kingdom, WC2H 9JQ",
      "country": "GB"
    }
  ]
}

2. Company Details

POST /kyb/company/details Retrieves the full company record for a previously resolved entity. Use the transactionId and companyId returned by /kyb/search. The include object controls which data packages are returned. Only requested packages are fetched and billed.

Required Headers

HeaderValue
Content-Typeapplication/json
AuthorizationBearer <access_token>

Request Body

FieldTypeRequiredDescription
transactionIdstringYesFrom the search response.
companyIdstringYesFrom the search response.
includeobjectNoData packages to retrieve. All default to false.
timeoutMsintegerNoRequest timeout in milliseconds.

include Packages

PackageTypeDescription
officersbooleanDirectors, managing partners, and authorised signatories with roles, tenure, and signature rights.
addressesbooleanAll registered and business addresses (structured and single-line).
ownershipsbooleanShareholder and UBO data including holding percentages, capital, and voting rights.
transparencybooleanTransparency register entries. Returns a list of available entries with linkToken values for retrieval via /kyb/company/document/retrieve.
documentsbooleanOfficial company documents (e.g. articles of association, register extracts). Returns a list of available documents with linkToken values for retrieval via /kyb/company/document/retrieve.
financialsbooleanAvailable financial data such as balance sheet and revenue figures.

Example Request

{
  "transactionId": "a8b89ef3-9d93-4d96-a495-be605fd1b2fe",
  "companyId": "223c8dde-9c82-4811-ba3c-4f9fe648c2da",
  "include": {
    "officers": true,
    "addresses": true,
    "ownerships": true,
    "transparency": true,
    "documents": true,
    "financials": false
  }
}

Response Structure

FieldTypeDescription
statusbooleantrue on success.
data.company.legalNamestringOfficial registered legal name.
data.company.tradingNames[]arrayTrading or alternative names.
data.company.statusstringCurrent status (e.g. active, dissolved).
data.company.companyTypeobjectCompany type with native (register text) and modeled (idcanopy scheme) values.
data.company.incorporationDatestringISO 8601 incorporation date.
data.company.registrationDatestringISO 8601 registration date, if available.
data.company.countrystringISO alpha-2 country code.
data.company.registeredAddress.singleLinestringFull registered address, single line.
data.company.registeredAddress.structuredobjectStructured address: line1, line2, city, postalCode, region, country.
data.company.businessAddressobjectBusiness address, same structure. May be null.
data.company.identifiers[]arrayIdentifiers across schemes. Each entry: scheme (e.g. REGISTRATION_NUMBER, VAT, LEI), value, country.
data.company.industryCodes[]arrayIndustry codes: scheme (e.g. NACE), code, label.
data.company.websitestringOfficial website, if available.
metadata.confidencenumberMatch confidence score (0–1).
metadata.completenessnumberData completeness score (0–1).
metadata.sourcestringName of the data source (e.g. Companies House).
metadata.sourceTststringISO 8601 timestamp of source data retrieval.
Returned under data.company.officers[].
FieldTypeDescription
typestringindividual or company.
officerIDstringUmbrella officer identifier.
officerData.firstNamestringFirst name.
officerData.lastNamestringLast name.
officerData.DOBstringDate of birth (ISO 8601).
officerData.nationalitystringISO alpha-2 nationality code.
officerData.address.singleLinestringOfficer address.
activity.roleobjectRole with native and modeled values.
activity.statusstringactive or inactive.
activity.from / activity.tostringTenure start and end dates.
activity.signatureRightsobjectSignatory rights with native, modeled, and signatureQuality (individual or joint).
Returned under data.company.ownership[].
FieldTypeDescription
typestringindividual or company.
ownerIDstringUmbrella owner identifier.
ownerData.firstName / lastNamestringOwner name.
ownerData.address.singleLinestringOwner address.
ownerData.shareholding.holdingPct.sharesstringShare percentage.
ownerData.shareholding.holdingPct.capitalstringCapital amount.
ownerData.shareholding.holdingPct.votingRightsstringVoting rights percentage.
ownerData.shareholding.verbalholding[]arrayVerbal holding description with native and modeled values.
ownerData.isUBOstringWhether the owner is a UBO (yes / no).
When documents or transparency is included, the response contains a list of available items. Pass the linkToken for each item to /kyb/company/document/retrieve to obtain the actual file.
FieldTypeDescription
typestringDocument type (e.g. excerpt, articles, transparency_entry).
descriptionstringHuman-readable description of the document.
datestringDate of the document, if available.
linkTokenstringOpaque token used to retrieve the document.

Example Response

{
  "status": true,
  "data":[ {
    "company": {
      "legalName": "IDCANOPY GROUP LTD",
      "tradingNames": [],
      "status": "active",
      "companyType": {},
      "incorporationDate": "2025-02-19T00:00:00.000Z",
      "registrationDate": null,
      "country": "GB",
      "registeredAddress": {
        "singleLine": "71-75 Shelton Street, WC2H 9JQ London, United Kingdom",
        "structured": {
          "line1": "71-75 Shelton Street",
          "line2": null,
          "city": "London",
          "postalCode": "WC2H 9JQ",
          "region": null,
          "country": "GB"
        }
      },
      "businessAddress": {
        "singleLine": null,
        "structured": {
          "line1": null,
          "line2": null,
          "city": null,
          "postalCode": null,
          "region": null,
          "country": "GB"
        }
      },
      "identifiers": [
        {
          "scheme": "REGISTRATION_NUMBER",
          "value": "16262990",
          "country": "GB"
        }
      ],
      "industryCodes": [],
      "website": null
    }
  },
  ]
  "metadata": {
    "confidence": 0.85,
    "completeness": 0.71,
    "source": "Companies House",
    "sourceTst": "2025-06-01T10:00:00.000Z"
  }
}

3. Document Retrieval

POST /kyb/company/document/retrieve Retrieves a company document or transparency register entry using a linkToken from the /kyb/company/details response.

Required Headers

HeaderValue
Content-Typeapplication/json
AuthorizationBearer <access_token>

Request Body

FieldTypeRequiredDescription
transactionIdstringYesFrom the search response.
companyIdstringYesFrom the search response.
linkTokenstringYesToken from the documents or transparency list in the details response.

Example Request

{
  "transactionId": "a8b89ef3-9d93-4d96-a495-be605fd1b2fe",
  "companyId": "223c8dde-9c82-4811-ba3c-4f9fe648c2da",
  "linkToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response

Returns the document as a binary file stream. The Content-Type response header reflects the file format (typically application/pdf).
linkToken values are scoped to the originating transactionId and companyId. They cannot be reused across sessions.

Test Cases

The following test cases are organized by country. Each shows a search request, the response with available company IDs, and then the full company details call.

GB

{
  "name": "Waitrose",
  "country": "GB",
  "locality": "London"
}
{
    "status": true,
    "data": [
        {
            "transactionId": "9d53e4c6-53f3-45d6-8fe4-fdb6485fcaa8",
            "companyId": "35ca6d2b-a897-4604-9d2c-84889ce221a3",
            "name": "WAITROSE LIMITED",
            "status": "active",
            "registrationNumber": "00099405",
            "addressLine": "1 Drummond Gate, Pimlico, London, United Kingdom, SW1V 2QQ",
            "country": "GB"
        },
        {
            "transactionId": "9d53e4c6-53f3-45d6-8fe4-fdb6485fcaa8",
            "companyId": "97d03b00-2d2b-4cc8-af37-a2d1072a8e58",
            "name": "STARBUCKS COFFEE MCDONALD'S WAITROSE LIMITED",
            "status": "active",
            "registrationNumber": "07703544",
            "addressLine": "2 Vantage Court, Tickford Street, Newport Pagnell, Buckinghamshire, MK16 9EZ",
            "country": "GB"
        },
    ]
}

Company Details — WAITROSE LIMITED

{
    "transactionId": "9d53e4c6-53f3-45d6-8fe4-fdb6485fcaa8",
    "companyId": "35ca6d2b-a897-4604-9d2c-84889ce221a3",
    "include": {
        "officers": true,
        "addresses": true,
        "ownerships": true,
        "transparency": true,
        "documents": true,
        "financials": true
    }
}
{
    "status": true,
    "data": [
        {
            "company": {
                "legalName": "WAITROSE LIMITED",
                "tradingNames": [],
                "status": "active",
                "companyType": {},
            "incorporationDate": "1908-09-03T00:00:00.000Z",
            "registrationDate": null,
            "country": "GB",
            "registeredAddress": {
                "singleLine": "1 Drummond Gate, SW1V 2QQ London, GB",
                "structured": {
                    "line1": "1 Drummond Gate",
                    "line2": null,
                    "city": "London",
                    "postalCode": "SW1V 2QQ",
                    "region": null,
                    "country": "GB"
                }
            },
            "businessAddress": {
                "singleLine": null,
                "structured": {
                    "line1": null,
                    "line2": null,
                    "city": null,
                    "postalCode": null,
                    "region": null,
                    "country": "GB"
                }
            },
            "identifiers": [
                {
                    "scheme": "REGISTRATION_NUMBER",
                    "value": "00099405",
                    "country": "GB"
                }
            ],
            "industryCodes": [],
            "website": null,
            "contacts": [],
            "signatureRules": {
                "signatureQuality": null
            },
            "resources": [],
            "officers": [
                {
                    "type": "secretary",
                    "officerId": "230",
                    "officerData": {
                        "firstName": null,
                        "lastName": null,
                        "legalName": "CHEONG TUNG SING, Jane Christina",
                        "dob": null,
                        "birthplace": null,
                        "countryOfBirth": null,
                        "nationality": null,
                        "country": null,
                        "identifiers": [],
                        "address": {
                            "singleLine": null,
                            "structured": {
                                "line1": null,
                                "line2": null,
                                "city": null,
                                "postalCode": null,
                                "region": null,
                                "country": null
                            }
                        },
                        "identityData": {}
                    },
                    "activity": {
                        "role": {
                            "native": {
                                "value": "secretary",
                                "language": "en",
                                "source": null
                            }
                        },
                        "status": null,
                        "from": "2021-11-01T00:00:00.000Z",
                        "to": null,
                        "phone": null,
                        "email": null,
                        "signatureRights": {
                            "signatureQuality": null
                        }
                    }
                },
                {
                    "type": "director",
                    "officerId": "231",
                    "officerData": {
                        "firstName": null,
                        "lastName": null,
                        "legalName": "MOUNSEY, Andrew John",
                        "dob": null,
                        "birthplace": null,
                        "countryOfBirth": null,
                        "nationality": "British",
                        "country": null,
                        "identifiers": [],
                        "address": {
                            "singleLine": null,
                            "structured": {
                                "line1": null,
                                "line2": null,
                                "city": null,
                                "postalCode": null,
                                "region": null,
                                "country": null
                            }
                        },
                        "identityData": {}
                    },
                    "activity": {
                        "role": {
                            "native": {
                                "value": "director",
                                "language": "en",
                                "source": null
                            }
                        },
                        "status": null,
                        "from": "2024-09-06T00:00:00.000Z",
                        "to": null,
                        "phone": null,
                        "email": null,
                        "signatureRights": {
                            "signatureQuality": null
                        }
                    }
                },
                {
                    "type": "director",
                    "officerId": "232",
                    "officerData": {
                        "firstName": null,
                        "lastName": null,
                        "legalName": "TARRY, Jason Mark",
                        "dob": null,
                        "birthplace": null,
                        "countryOfBirth": null,
                        "nationality": "British",
                        "country": null,
                        "identifiers": [],
                        "address": {
                            "singleLine": null,
                            "structured": {
                                "line1": null,
                                "line2": null,
                                "city": null,
                                "postalCode": null,
                                "region": null,
                                "country": null
                            }
                        },
                        "identityData": {}
                    },
                    "activity": {
                        "role": {
                            "native": {
                                "value": "director",
                                "language": "en",
                                "source": null
                            }
                        },
                        "status": null,
                        "from": "2024-09-12T00:00:00.000Z",
                        "to": null,
                        "phone": null,
                        "email": null,
                        "signatureRights": {
                            "signatureQuality": null
                        }
                    }
                }
            ],
            "ownership": [
                {
                    "ownerName": "John Lewis Plc",
                    "ownershipPercentage": null,
                    "natureOfControl": "ownership-of-shares-75-to-100-percent, voting-rights-75-to-100-percent, right-to-appoint-and-remove-directors",
                    "country": null
                }
            ],
            "relationships": {
                "ultimateBeneficialOwners": [],
                "transparencyRegister": [],
                "familyTree": [],
                "isHeadquarter": null,
                "isGlobalUltimate": null,
                "isDomesticUltimate": null,
                "isSubsidiary": null
            }
        }
    }
    ]
}

Company Details — STARBUCKS COFFEE MCDONALD’S WAITROSE LIMITED

This entity appeared in the Waitrose search above. Same transactionId, different companyId.
{
    "transactionId": "9d53e4c6-53f3-45d6-8fe4-fdb6485fcaa8",
    "companyId": "97d03b00-2d2b-4cc8-af37-a2d1072a8e58",
    "include": {
        "officers": true,
        "addresses": true,
        "ownerships": true,
        "transparency": true,
        "documents": true,
        "financials": true
    }
}
{
    "status": true,
    "data":[ {
        "company": {
            "legalName": "STARBUCKS COFFEE MCDONALD'S WAITROSE LIMITED",
            "tradingNames": [],
            "status": "active",
            "companyType": {},
            "incorporationDate": "2011-07-13T00:00:00.000Z",
            "registrationDate": null,
            "country": "GB",
            "registeredAddress": {
                "singleLine": "2 Vantage Court, MK16 9EZ Newport Pagnell, GB",
                "structured": {
                    "line1": "2 Vantage Court",
                    "line2": "Tickford Street",
                    "city": "Newport Pagnell",
                    "postalCode": "MK16 9EZ",
                    "region": "Buckinghamshire",
                    "country": "GB"
                }
            },
            "businessAddress": {
                "singleLine": null,
                "structured": {
                    "line1": null,
                    "line2": null,
                    "city": null,
                    "postalCode": null,
                    "region": null,
                    "country": "GB"
                }
            },
            "identifiers": [
                {
                    "scheme": "REGISTRATION_NUMBER",
                    "value": "07703544",
                    "country": "GB"
                }
            ],
            "industryCodes": [],
            "website": null,
            "contacts": [],
            "signatureRules": {
                "signatureQuality": null
            },
            "resources": [],
            "officers": [
                {
                    "type": "director",
                    "officerId": "281",
                    "officerData": {
                        "firstName": null,
                        "lastName": null,
                        "legalName": "DIVINEY, John",
                        "dob": null,
                        "birthplace": null,
                        "countryOfBirth": null,
                        "nationality": "Irish",
                        "country": null,
                        "identifiers": [],
                        "address": {
                            "singleLine": null,
                            "structured": {
                                "line1": null,
                                "line2": null,
                                "city": null,
                                "postalCode": null,
                                "region": null,
                                "country": null
                            }
                        },
                        "identityData": {}
                    },
                    "activity": {
                        "role": {
                            "native": {
                                "value": "director",
                                "language": "en",
                                "source": null
                            },
                            "modeled": {
                                "value": "Director",
                                "scheme": "idcanopy",
                                "source": "modeled"
                            }
                        },
                        "status": null,
                        "from": "2018-11-29T00:00:00.000Z",
                        "to": null,
                        "phone": null,
                        "email": null,
                        "signatureRights": {
                            "signatureQuality": null
                        }
                    }
                },
                {
                    "type": "corporate-secretary",
                    "officerId": "282",
                    "officerData": {
                        "firstName": null,
                        "lastName": null,
                        "legalName": "HP SECRETARIAL SERVICES LIMITED",
                        "dob": null,
                        "birthplace": null,
                        "countryOfBirth": null,
                        "nationality": null,
                        "country": null,
                        "identifiers": [],
                        "address": {
                            "singleLine": null,
                            "structured": {
                                "line1": null,
                                "line2": null,
                                "city": null,
                                "postalCode": null,
                                "region": null,
                                "country": null
                            }
                        },
                        "identityData": {}
                    },
                    "activity": {
                        "role": {
                            "native": {
                                "value": "corporate-secretary",
                                "language": "en",
                                "source": null
                            }
                        },
                        "status": null,
                        "from": "2011-07-13T00:00:00.000Z",
                        "to": "2011-09-14T00:00:00.000Z",
                        "phone": null,
                        "email": null,
                        "signatureRights": {
                            "signatureQuality": null
                        }
                    }
                },
                {
                    "type": "director",
                    "officerId": "283",
                    "officerData": {
                        "firstName": null,
                        "lastName": null,
                        "legalName": "BELL, Robbie Ian",
                        "dob": null,
                        "birthplace": null,
                        "countryOfBirth": null,
                        "nationality": "British",
                        "country": null,
                        "identifiers": [],
                        "address": {
                            "singleLine": null,
                            "structured": {
                                "line1": null,
                                "line2": null,
                                "city": null,
                                "postalCode": null,
                                "region": null,
                                "country": null
                            }
                        },
                        "identityData": {}
                    },
                    "activity": {
                        "role": {
                            "native": {
                                "value": "director",
                                "language": "en",
                                "source": null
                            },
                            "modeled": {
                                "value": "Director",
                                "scheme": "idcanopy",
                                "source": "modeled"
                            }
                        },
                        "status": null,
                        "from": "2017-09-29T00:00:00.000Z",
                        "to": "2018-12-20T00:00:00.000Z",
                        "phone": null,
                        "email": null,
                        "signatureRights": {
                            "signatureQuality": null
                        }
                    }
                },
                {
                    "type": "director",
                    "officerId": "284",
                    "officerData": {
                        "firstName": null,
                        "lastName": null,
                        "legalName": "COULDRAKE, Gerald Mark",
                        "dob": null,
                        "birthplace": null,
                        "countryOfBirth": null,
                        "nationality": "British",
                        "country": null,
                        "identifiers": [],
                        "address": {
                            "singleLine": null,
                            "structured": {
                                "line1": null,
                                "line2": null,
                                "city": null,
                                "postalCode": null,
                                "region": null,
                                "country": null
                            }
                        },
                        "identityData": {}
                    },
                    "activity": {
                        "role": {
                            "native": {
                                "value": "director",
                                "language": "en",
                                "source": null
                            },
                            "modeled": {
                                "value": "Director",
                                "scheme": "idcanopy",
                                "source": "modeled"
                            }
                        },
                        "status": null,
                        "from": "2011-07-13T00:00:00.000Z",
                        "to": "2011-09-14T00:00:00.000Z",
                        "phone": null,
                        "email": null,
                        "signatureRights": {
                            "signatureQuality": null
                        }
                    }
                },
                {
                    "type": "director",
                    "officerId": "285",
                    "officerData": {
                        "firstName": null,
                        "lastName": null,
                        "legalName": "MCKIE, Roderick Wallace",
                        "dob": null,
                        "birthplace": null,
                        "countryOfBirth": null,
                        "nationality": "British",
                        "country": null,
                        "identifiers": [],
                        "address": {
                            "singleLine": null,
                            "structured": {
                                "line1": null,
                                "line2": null,
                                "city": null,
                                "postalCode": null,
                                "region": null,
                                "country": null
                            }
                        },
                        "identityData": {}
                    },
                    "activity": {
                        "role": {
                            "native": {
                                "value": "director",
                                "language": "en",
                                "source": null
                            },
                            "modeled": {
                                "value": "Director",
                                "scheme": "idcanopy",
                                "source": "modeled"
                            }
                        },
                        "status": null,
                        "from": "2011-09-14T00:00:00.000Z",
                        "to": "2018-05-31T00:00:00.000Z",
                        "phone": null,
                        "email": null,
                        "signatureRights": {
                            "signatureQuality": null
                        }
                    }
                },
                {
                    "type": "director",
                    "officerId": "286",
                    "officerData": {
                        "firstName": null,
                        "lastName": null,
                        "legalName": "WRIGHT, Nicholas David",
                        "dob": null,
                        "birthplace": null,
                        "countryOfBirth": null,
                        "nationality": "British",
                        "country": null,
                        "identifiers": [],
                        "address": {
                            "singleLine": null,
                            "structured": {
                                "line1": null,
                                "line2": null,
                                "city": null,
                                "postalCode": null,
                                "region": null,
                                "country": null
                            }
                        },
                        "identityData": {}
                    },
                    "activity": {
                        "role": {
                            "native": {
                                "value": "director",
                                "language": "en",
                                "source": null
                            },
                            "modeled": {
                                "value": "Director",
                                "scheme": "idcanopy",
                                "source": "modeled"
                            }
                        },
                        "status": null,
                        "from": "2011-09-14T00:00:00.000Z",
                        "to": "2017-09-29T00:00:00.000Z",
                        "phone": null,
                        "email": null,
                        "signatureRights": {
                            "signatureQuality": null
                        }
                    }
                },
                {
                    "type": "corporate-director",
                    "officerId": "287",
                    "officerData": {
                        "firstName": null,
                        "lastName": null,
                        "legalName": "HP DIRECTORS LIMITED",
                        "dob": null,
                        "birthplace": null,
                        "countryOfBirth": null,
                        "nationality": null,
                        "country": null,
                        "identifiers": [],
                        "address": {
                            "singleLine": null,
                            "structured": {
                                "line1": null,
                                "line2": null,
                                "city": null,
                                "postalCode": null,
                                "region": null,
                                "country": null
                            }
                        },
                        "identityData": {}
                    },
                    "activity": {
                        "role": {
                            "native": {
                                "value": "corporate-director",
                                "language": "en",
                                "source": null
                            }
                        },
                        "status": null,
                        "from": "2011-07-13T00:00:00.000Z",
                        "to": "2011-09-14T00:00:00.000Z",
                        "phone": null,
                        "email": null,
                        "signatureRights": {
                            "signatureQuality": null
                        }
                    }
                }
            ],
            "ownership": [
                {
                    "ownerName": "Welcome Break Group Limited",
                    "ownershipPercentage": null,
                    "natureOfControl": "ownership-of-shares-75-to-100-percent, voting-rights-75-to-100-percent, right-to-appoint-and-remove-directors, significant-influence-or-control",
                    "country": null
                }
            ],
            "relationships": {
                "ultimateBeneficialOwners": [],
                "transparencyRegister": [],
                "familyTree": [],
                "isHeadquarter": null,
                "isGlobalUltimate": null,
                "isDomesticUltimate": null,
                "isSubsidiary": null
            }
        }
    }
    ]
}

AT

Search

{
  "name": "IDCANOPY",
  "country": "AT",
  "locality": "Vienna"
}
{
    "status": true,
    "data": [
        {
            "transactionId": "02fbbcb4-2b21-49d7-87d7-0cfe0da63da5",
            "companyId": "ef9ba1cb-ca7e-4a55-b133-4e633ae92661",
            "name": "IDCANOPY FLEXCO",
            "status": "Active",
            "registrationNumber": "FN 628013Z",
            "addressLine": "DR.-KARL-LUEGER-PLATZ 5",
            "country": "AT"
        }
    ]
}

Company Details — IDCANOPY FLEXCO

{
    "transactionId": "02fbbcb4-2b21-49d7-87d7-0cfe0da63da5",
    "companyId": "ef9ba1cb-ca7e-4a55-b133-4e633ae92661",
    "include": {
        "officers": true,
        "addresses": true,
        "ownerships": true,
        "transparency": true,
        "documents": true,
        "financials": true
    }
}
{
    "status": true,
    "data":[{
        "company": {
            "status": "active",
            "country": "AT",
            "website": null,
            "contacts": [],
            "officers": [],
            "ownership": [
                {
                    "country": null,
                    "ownerName": "IDCANOPY GROUP LTD",
                    "natureOfControl": "unknown",
                    "ownershipPercentage": "100"
                }
            ],
            "resources": [],
            "legalName": "IDCANOPY FLEXCO",
            "identifiers": [
                {
                    "value": "FN 628013Z",
                    "scheme": "REGISTRATION_NUMBER",
                    "country": "AT"
                }
            ],
            "companyType": {},
            "relationships": {
                "familyTree": [],
                "isSubsidiary": null,
                "isHeadquarter": null,
                "isGlobalUltimate": null,
                "isDomesticUltimate": null,
                "transparencyRegister": [],
                "ultimateBeneficialOwners": []
            },
            "tradingNames": [],
            "industryCodes": [],
            "signatureRules": {
                "signatureQuality": null
            },
            "businessAddress": {
                "structured": {
                    "city": null,
                    "line1": null,
                    "line2": null,
                    "region": null,
                    "country": "AT",
                    "postalCode": null
                },
                "singleLine": null
            },
            "registrationDate": null,
            "incorporationDate": null,
            "registeredAddress": {
                "structured": {
                    "city": "WIEN",
                    "line1": "DR.-KARL-LUEGER-PLATZ 5",
                    "line2": null,
                    "region": "WIEN",
                    "country": "AT",
                    "postalCode": "1010"
                },
                "singleLine": "DR.-KARL-LUEGER-PLATZ 5, 1010 WIEN, AT"
            }
        }
    }
    ]
}

IT

Search

{
  "name": "WIND",
  "country": "IT",
  "locality": "Rome"
}
{
    "status": true,
    "data": [
        {
            "transactionId": "968b703b-54cd-4a7c-8fc4-9300f14b9255",
            "companyId": "c79bd0f4-b3ed-446b-8d47-e1a766feb307",
            "name": "WIND TELECOM S.P.A.",
            "status": "Active",
            "registrationNumber": null,
            "addressLine": "VIA CESARE GIULIO VIOLA, 48",
            "country": "IT"
        },
        {
            "transactionId": "968b703b-54cd-4a7c-8fc4-9300f14b9255",
            "companyId": "196946f2-02c1-45c3-9f7f-d0529544ef57",
            "name": "WIND NEGOZIO",
            "status": "Active",
            "registrationNumber": null,
            "addressLine": "VIA DI BOCCEA 126",
            "country": "IT"
        },
        {
            "transactionId": "968b703b-54cd-4a7c-8fc4-9300f14b9255",
            "companyId": "e7b6b29b-2f2c-438a-a62f-1485df17ff85",
            "name": "WIND 3 SPA",
            "status": "Active",
            "registrationNumber": null,
            "addressLine": "VIA CESARE GIULIO VIOLA 58",
            "country": "IT"
        },
        {
            "transactionId": "968b703b-54cd-4a7c-8fc4-9300f14b9255",
            "companyId": "679ad594-bb39-49a7-992f-de2127740d7e",
            "name": "WIND",
            "status": "Active",
            "registrationNumber": null,
            "addressLine": "PIAZZA CARITÀ'3",
            "country": "IT"
        },
        {
            "transactionId": "968b703b-54cd-4a7c-8fc4-9300f14b9255",
            "companyId": "1911d1bc-f597-49c7-befe-4221ea28215b",
            "name": "WIND S.R.L.",
            "status": "Active",
            "registrationNumber": null,
            "addressLine": "VIA LOMBARDIA 7/9",
            "country": "IT"
        },
        {
            "transactionId": "968b703b-54cd-4a7c-8fc4-9300f14b9255",
            "companyId": "b387f4c8-6bfe-4318-97b0-aa142a518cc7",
            "name": "WIND RETAIL S.R.L.",
            "status": "Active",
            "registrationNumber": null,
            "addressLine": "VIA CESARE GIULIO VIOLA 48",
            "country": "IT"
        },
        {
            "transactionId": "968b703b-54cd-4a7c-8fc4-9300f14b9255",
            "companyId": "6acdbf5b-5e75-4ff1-ac81-26dcc69fb1ed",
            "name": "WIND S.R.L.",
            "status": "Inactive",
            "registrationNumber": "PR257550",
            "addressLine": "VIA PARADIGNA 21/A",
            "country": "IT"
        }
    ]
}

Company Details — WIND TELECOM S.P.A.

{
    "transactionId": "968b703b-54cd-4a7c-8fc4-9300f14b9255",
    "companyId": "c79bd0f4-b3ed-446b-8d47-e1a766feb307",
    "include": {
        "officers": true,
        "addresses": true,
        "ownerships": true,
        "transparency": true,
        "documents": true,
        "financials": true
    }
}
{
    "status": true,
    "data":[ {
        "company": {
            "legalName": "WIND TELECOM S.P.A.",
            "tradingNames": [],
            "status": "active",
            "companyType": {},
            "incorporationDate": null,
            "registrationDate": null,
            "country": "IT",
            "registeredAddress": {
                "singleLine": "VIA CESARE GIULIO VIOLA, 48, 00148 ROME, IT",
                "structured": {
                    "line1": "VIA CESARE GIULIO VIOLA, 48",
                    "line2": null,
                    "city": "ROME",
                    "postalCode": "00148",
                    "region": "ROMA",
                    "country": "IT"
                }
            },
            "businessAddress": {
                "singleLine": null,
                "structured": {
                    "line1": null,
                    "line2": null,
                    "city": null,
                    "postalCode": null,
                    "region": null,
                    "country": "IT"
                }
            },
            "identifiers": [],
            "industryCodes": [],
            "website": null,
            "contacts": [],
            "signatureRules": {
                "signatureQuality": null
            },
            "resources": [],
            "officers": [],
            "ownership": [],
            "relationships": {
                "ultimateBeneficialOwners": [],
                "transparencyRegister": [],
                "familyTree": [],
                "isHeadquarter": null,
                "isGlobalUltimate": null,
                "isDomesticUltimate": null,
                "isSubsidiary": null
            }
        }
    }
    ]
}

DE

Search

{
  "name": "Bosch",
  "country": "DE",
  "locality": "Berlin"
}
{
    "status": true,
    "data": [
        {
            "transactionId": "134dbc33-10cd-41ad-a0d0-c5d6632de563",
            "companyId": "9288e6fb-cedb-4945-b080-2a5d63cd0fe5",
            "name": "Bosch GmbH",
            "status": "active",
            "registrationNumber": null,
            "addressLine": "Pestalozziring, Aldenhoven",
            "country": "DE"
        },
    ]
}

Company Details — Bosch GmbH

{
   "transactionId": "134dbc33-10cd-41ad-a0d0-c5d6632de563",
    "companyId": "9288e6fb-cedb-4945-b080-2a5d63cd0fe5",
    "include": {
        "officers": true,
        "addresses": true,
        "ownerships": true,
        "transparency": true,
        "documents": true,
        "financials": true
    }
}
{
    "status": true,
    "data":[ {
        "company": {
            "legalName": "Bosch GmbH",
            "tradingNames": [],
            "status": "active",
            "companyType": {},
            "incorporationDate": null,
            "registrationDate": null,
            "country": "DE",
            "registeredAddress": {
                "singleLine": "Pestalozziring, 52457 Aldenhoven, DE",
                "structured": {
                    "line1": "Pestalozziring, Aldenhoven",
                    "line2": null,
                    "city": "Aldenhoven",
                    "postalCode": "52457",
                    "region": null,
                    "country": "DE"
                }
            },
            "businessAddress": {
                "singleLine": "Pestalozziring, Aldenhoven, DE",
                "structured": {
                    "line1": "Pestalozziring, Aldenhoven",
                    "line2": null,
                    "city": "Aldenhoven",
                    "postalCode": null,
                    "region": null,
                    "country": "DE"
                }
            },
            "identifiers": [
                {
                    "scheme": "REGISTRATION_NUMBER",
                    "value": "HRB 4319",
                    "country": "DE"
                }
            ],
            "industryCodes": [],
            "website": null,
            "contacts": [],
            "signatureRules": {
                "signatureQuality": null
            },
            "resources": [],
            "officers": [
                {
                    "type": "director",
                    "officerId": "291",
                    "officerData": {
                        "firstName": "Rainer Norbert",
                        "lastName": "Bosch",
                        "legalName": "Rainer Norbert Bosch",
                        "dob": null,
                        "birthplace": null,
                        "countryOfBirth": null,
                        "nationality": null,
                        "country": null,
                        "identifiers": [],
                        "address": {
                            "singleLine": null,
                            "structured": {
                                "line1": null,
                                "line2": null,
                                "city": null,
                                "postalCode": null,
                                "region": null,
                                "country": null
                            }
                        },
                        "identityData": {}
                    },
                    "activity": {
                        "role": {
                            "native": {
                                "value": "director",
                                "language": "de",
                                "source": null
                            }
                        },
                        "status": null,
                        "from": null,
                        "to": null,
                        "phone": null,
                        "email": null,
                        "signatureRights": {
                            "signatureQuality": null
                        }
                    }
                }
            ],
            "ownership": [
                {
                    "ownerName": "Bosch GmbH",
                    "ownershipPercentage": null,
                    "natureOfControl": "unknown",
                    "country": null
                },
                {
                    "ownerName": "Fertigbeton Rheinland GmbH & Co. KG",
                    "ownershipPercentage": null,
                    "natureOfControl": "unknown",
                    "country": null
                }
            ],
            "relationships": {
                "ultimateBeneficialOwners": [],
                "transparencyRegister": [],
                "familyTree": [],
                "isHeadquarter": null,
                "isGlobalUltimate": null,
                "isDomesticUltimate": null,
                "isSubsidiary": null
            }
        }
    }
    ]
}

Error Cases

Calling /kyb/search without the required country field returns a 400 Bad Request.
{
  "name": "Bosch",
  "locality": "Berlin"
}
400 Bad Request
{
    "status": false,
    "error": "Validation failed: country: Required"
}