See a list of available extracts and filings for a company
Search
You will first need to search the registry to find the entity. the search will confirm that the entity is active and provide a unique identifier for that company in codeField
. You will need this value to retrieve a list of available fillings from the registry
Filling Search
To retrieve a list of available fillings from the registry you need to provide the following variables:
- Code Field
- 2 digit ISO code
Example response
You can see below examples of two available Fillings. These were retrieved using the following URL GET request:
curl --location 'https://rest.kyckr.com/core/filing/search/GB/11655290' \
--header 'Authorization: {{apiKey}}' \
"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"
Each document will have the following information:
Field | Meaning |
---|---|
idField | Unique product Key for this document |
productCodeField | Code from registry |
companyCodeField | Company Code |
productFormatField | Confirmation of the format of the document |
productTitleField | detail from the registry on what the document is |
tierValueField | The cost in Kyckr Credits to order the Document |
Continuation Key
If a value is supplied in the field (continuationKeyField
) then you can pass this value as a parameter to load the next page of results.
Delivery times for documents & filings
When ordering documents & 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"
Updated 9 months ago