v1

latestOpenAPI 3.0.3Kyckr API License2026-07-2293773.2 KB

Orders

Get Single Order

Retrieve a single order and retrieval details

get/orders/{orderId}

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.

Example response

{
  "orderId": 12345,
  "cost": {
    "type": "credit",
    "value": 3
  },
  "links": {
    "self": "/orders/12345"
  },
  "data": {
    "orderId": "12345",
    "orderDate": "2023-01-01T00:00:00Z",
    "cost": {
      "type": "credit",
      "value": 3
    },
    "user": "/users/12345",
    "productDetails": {
      "productName": "Annual Accounts 2021-22",
      "productId": "ROWOFF_SVRBX0VDUF8wMQ==_RXh0ZW5kZWQgUHJvZmlsZQ==",
      "productCategory": "Financial Information",
      "productType": "BO_PROFILE",
      "schemaVersion": "2.0"
    },
    "companyDetails": {
      "companyName": "Kyckr Limited",
      "companyNumber": "R123456",
      "kyckrID": "IE|UjEyMzQ1Ng=="
    },
    "links": {
      "data": "/orders/12345/download?format=json",
      "document": "/orders/12345/download?format=pdf"
    }
  }
}