v1

latestOpenAPI 3.0.3Kyckr API License2026-07-2293773.2 KB

Companies

Documents

Retrieve a list of available documents for a company. After finding a document of interest, use the Create Order API to order a copy of the document.

get/companies/{kyckrId}/documents

Query parameters

continuationKeystring

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.

Response

orderIdnumber

The related orderId.

correlationIdstring

The related correlationId to this request, for support purposes.

customerReferencestring

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

timeStampstring date-time

The UTC time at which the request occurred.

detailsstring

The response status details for the current request.

continuationKeystring nullable

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.

Example response

{
  "orderId": 12345,
  "cost": {
    "type": "credit",
    "value": 3
  },
  "links": {
    "self": "/orders/12345"
  },
  "data": [
    {
      "cost": {
        "type": "credit",
        "value": 3
      },
      "name": "Form 15 - Annual Accounts 2021/22",
      "category": "Annual Accounts",
      "deliveryTimeMinutes": 15,
      "documentFormat": [
        "application/pdf"
      ]
    }
  ]
}