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.

​
Search for the entity (company)

Follow the search guide to find the entity. A valid search confirms whether the entity is active and provides a unique identifier for the company in codeField. The codeField can then be used to perform a filing search. To retrieve a list of available filings from the registry, the following variables are needed: Filing search API reference

​
Example

Below are examples of two filings for a company found using the following search filings request. 
curl --location 'https://rest.kyckr.com/core/filing/search/GB/11655290' \
--header 'Authorization: {{apiKey}}'

​
Response

This is a list of documents that can then be ordered from the API. 
"productsField": [
        {
            "idField": "CHON_Q0hfQ29tcGFueU1vcnRnYWdlc18x_MTE2NTUyOTA=",
            "priceTagField": "CH_CM",
            "priceField": "0",
            "vatChargeField": "0",
            "currencyField": "€",
            "productCodeField": "CH_CompanyMortgages_1",
            "companyCodeField": "11655290",
            "productFormatField": "PDF",
            "productTitleField": "Company Mortgages",
            "tierCodeField": "A",
            "tierValueField": "1.00"
        },
        {
            "idField": "CHON_Q0hfQ29tcGFueU9mZmljaWFsc18x_MTE2NTUyOTA=",
            "priceTagField": "CH_CO",
            "priceField": "0",
            "vatChargeField": "0",
            "currencyField": "€",
            "productCodeField": "CH_CompanyOfficials_1",
            "companyCodeField": "11655290",
            "productFormatField": "PDF",
            "productTitleField": "Company Officials",
            "tierCodeField": "A",
            "tierValueField": "1.00"
        }
        ... rest of response ...
Each document will have the following information:
FieldMeaning
idFieldUnique product key for this document
productCodeFieldCode from registry
companyCodeFieldCompany Code
productFormatFieldConfirmation of the format of the document
productTitleFieldDetail from the registry on what the document is
tierValueFieldThe cost in Kyckr Credits to order the Document

​
Continuation key

The continuationKeyField is supplied when there are multiple pages of results. This key can be passed in as a parameter to load the next page. 
curl --location 'https://rest.kyckr.com/core/filing/search/GB/11655290?ContinuationKey=FILL_IN_KEY_HERE' \
--header 'Authorization: {{apiKey}}'

​
Delivery times for documents and filings

When ordering documents and filings, some documents, such as company profile, can be retrieved in real-time. However, documents requiring manual retrieval by the Kyckr operations team are subject to a slight delay between order and delivery. Delivery times can be found on the FilingSearch API call, in the response you’ll find deliveryTimeMinutesField for each document and filings. Close to 90% of available documents are delivered within 15 minutes or less. 
{
            "idField": "CHOFF_R0JfQ0hfRE9D_KipEaXJlY3RvcidzIGRldGFpbHMgY2hhbmdlZCoqIGZvciBNcyBKZWthdGVyaW5hIE1hbG92IG9uIDIwMjItMTEtMTE=_MTE2NTUyOTA=_UjZ3ai1LWFUwRnN2bER6OEEzWmRPN2pYalROX1lxdTlHczlpX2Z0ZGJEYw==",
            "priceTagField": "GB_CH_DOC",
            "priceField": "0",
            "vatChargeField": "0",
            "currencyField": "€",
            "companyCodeField": "11655290",
            "productDetailsField": [
                {
                    "keyField": "EFFECTIVE_DATE",
                    "valueField": "2022-11-11",
                    "documentCountField": 0
                }
            ],
            "productFormatField": "PDF",
            "productTitleField": "**Director's details changed** for Ms Jekaterina Malov on 2022-11-11",
            "displayDateField": "2022-11-11",
            "typeField": "CH01",
            "deliveryTimeMinutesField": "5",
            "tierCodeField": "A",
            "tierValueField": "1.00"
            ... rest of response ...