Skip to main content
GET
/
orders
Get List of Orders
curl --request GET \
  --url https://api.kyckr.com/v2/orders \
  --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": [
    {
      "orderId": "12345",
      "orderDate": "2023-01-01T00:00:00Z",
      "customerReference": "<string>",
      "cost": {
        "type": "credit",
        "value": 3
      },
      "user": "/users/12345",
      "productDetails": {
        "productName": "Annual Accounts 2021-22",
        "productId": "ROWOFF_SVRBX0VDUF8wMQ==_RXh0ZW5kZWQgUHJvZmlsZQ==",
        "productCategory": "Financial Information"
      },
      "companyDetails": {
        "companyName": "Kyckr Limited",
        "companyNumber": "R123456",
        "kyckrID": "IE|UjEyMzQ1Ng=="
      },
      "links": {
        "data": "/orders/12345/download?format=json",
        "document": "/orders/12345/download?format=pdf"
      }
    }
  ]
}

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.

Query Parameters

startDate
string

Earliest date to fetch orders for in ISO-8601

endDate
string

Latest date to fetch orders for in ISO-8601

isoCode
string

Jurisdiction code in ISO 3166 alpha-2

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

data
OrderDetails · object[]