Skip to main content
GET
/
companies
/
{kyckrId}
/
documents
Documents
curl --request GET \
  --url https://api.kyckr.com/v2/companies/{kyckrId}/documents \
  --header 'Authorization: Bearer <token>'
{
  "orderId": 12345,
  "correlationId": "<string>",
  "customerReference": "<string>",
  "timeStamp": "2023-11-07T05:31:56Z",
  "details": "<string>",
  "cost": {
    "type": "credit",
    "value": 3
  },
  "links": {
    "self": "/orders/12345"
  },
  "data": [
    {
      "id": "<string>",
      "cost": {
        "type": "credit",
        "value": 3
      },
      "name": "Form 15 - Annual Accounts 2021/22",
      "documentDate": "2023-12-25",
      "category": "Annual Accounts",
      "deliveryTimeMinutes": 15,
      "documentFormat": [
        "application/pdf"
      ],
      "documentDatapoints": {
        "companyDetails": true,
        "directors": true,
        "shareholders": true,
        "declaredBeneficialOwners": true
      }
    }
  ],
  "continuationKey": "<string>"
}

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.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
kyckrId
string
required

Kyckr company reference, a shared format, usable across our V2 APIs

Query Parameters

​
continuationKey
string

Opaque token returned in the previous response. When provided, the API returns the next page of documents (e.g. next 100 filings). When the previous response had no continuationKey, there are no more pages.

​
customerReference
string

Optional reference supplied by customer for tracking purposes

Response

OK

​
orderId
number

The related orderId.

Example:

12345

​
correlationId
string

The related correlationId to this request, for support purposes.

​
customerReference
string

A customer provided reference, which appears in the order list.

​
timeStamp
string<date-time>

The UTC time at which the request occurred.

​
details
string

The response status details for the current request.

​
cost
object

Cost of an item

​
links
object
​
data
DocumentDescription · object[]
​
continuationKey
string | null

When present, pass this value as the continuationKey query parameter on the next request to retrieve the next page of documents. When absent, there are no more pages.