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.

The first step to find available documents for a company is 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 id. The id will be used to identify the company in the Filing Search request. 
curl --location 'https://api.kyckr.com/v2/companies/GB|MTE2NTUyOTA/documents' \
--header 'Authorization: {{apiKey}}'
Filing search API reference

​
Example response

"correlationId": "1de5297f6aaa48c99b56f42b78dc622b",
    "customerReference": "",
    "timeStamp": "2024-01-17T14:45:19.5400916Z",
    "details": "Success",
    "data": [
        {
            "id": "Q0hPTl9RMGhmUTI5dGNHRnVlVTF2Y25SbllXZGxjMTh4X01URTJOVFV5T1RBPQ==",
            "cost": {
                "type": "credit",
                "value": 1.00
            },
            "name": "Company Mortgages",
            "deliveryTimeMinutes": 0,
            "documentFormat": [
                "application/pdf"
            ]
        },
        {
            "id": "Q0hPTl9RMGhmUTI5dGNHRnVlVTltWm1samFXRnNjMTh4X01URTJOVFV5T1RBPQ==",
            "cost": {
                "type": "credit",
                "value": 1.00
            },
            "name": "Company Officials",
            "deliveryTimeMinutes": 0,
            "documentFormat": [
                "application/pdf"
            ]
        },
Each document will have the following information:
FieldMeaning
idUnique value for this document
Valuecost in Kyckr Credits
nameName of document
deliveryTimeMinutesExpected time to retrieve the document
documentFormatThe file format of the document that will be delivered

​
Delivery times for 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. Expected delivery times can be found on the FilingSearch API call, in the response you’ll find deliveryTimeMinutes for each document and filings. Close to 90% of available documents are delivered within 15 minutes or less.