Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.kyckr.com/llms.txt

Use this file to discover all available pages before exploring further.

Basic company details are verified by ordering a Lite Profile. The Lite Profile includes (where present at the registry):
  • Company Name
  • Company Number
  • Registered Address
  • Registration Status
  • Legal Form
  • Company Activity
  • Registration Authority
The first step is to search the registry to find the entity. The search response will confirm whether the entity is active and provide a unique identifier for that company in codeField. This identifier is used in the Lite Profile API request. Some search responses will also contain a Registration Authority Code registrationAuthorityField, which if present, is required for the subsequent Lite Profile API request. Search guide

​
Order a Lite Profile

To order a Lite Profile from a registry, the following variables are needed:
  • codeField
  • 2 digit ISO code
  • Registration Authority Code (if provided in search)
Lite Profile API reference

​
Example

Below is an example of a Lite Profile for Kyckr pulled live from the registry. The Lite Profile was retrieved using the following URL GET request: 
curl --location 'https://rest.kyckr.com/lite/profile/GB/11655290' \
--header 'Authorization: {{apiKey}}'

​
Response

"companyProfileField": {
        "activityField": [
            {
                "codeField": "63120",
                "descriptionField": "Web portals"
            }
        ],
        "addressesField": [
            {
                "countryField": "United Kingdom",
                "lineField": [
                    {
                        "lineField": "",
                        "typeField": "",
                        "typeCodeField": ""
                    }
                ],
                "addressInOneLineField": "Kemp House, 160 City Road, EC1V 2NX, London",
                "addressLine1Field": "Kemp House",
                "addressLine2Field": "160 City Road",
                "addressLine3Field": "",
                "addressLine4Field": "",
                "cityTownField": "London",
                "regionStateField": "",
                "postcodeField": "EC1V 2NX"
            }
        ],
        "codeField": "11655290",
        "dateField": "2023-02-20T17:06:26.2028259Z",
        "foundationDateField": "2018-11-01",
        "legalFormField": "ltd",
        "legalStatusField": "active",
        "nameField": "KYCKR UK LIMITED",
        "officialField": false,
        "registrationAuthorityField": "Companies House, United Kingdom"
    },
    "transactionIdField": "9030922",
    "retrievalLocationField": "",
    "responseCodeField": "100"
}

​
Video tutorial - Retrieve a Lite Profile

Watch: Retrieve a Lite Profile