Sign in

v1

latestOpenAPI 3.0.3Kyckr API License2026-07-2293773.2 KB
Companies

Lite Profile

Basic company details are verified by ordering a Lite Profile. The Lite Profile includes (where present at the registry):

  • Company Name
  • Company Number
  • Registered Address
  • Registration or Foundation Date
  • Registration Status
  • Legal Form
  • Company Activity
  • Registration Authority
get/companies/{kyckrId}/lite

Query parameters

customerReferencestring

Optional reference supplied by customer for tracking purposes

Response

OK

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": {
    "address": {
      "identifier": "IE-Wo0Fri41lHuGoElhaChY3-iXz6Gx6h2rHdw7LqC4Tok",
      "isoCode": "GB"
    },
    "otherIdentifiers": [
      {
        "value": "NA0091712",
        "type": "IT_REA_CD"
      }
    ]
  }
}