v1

latestOpenAPI 3.0.3Kyckr API License2026-07-2293773.2 KB
Companies

Enhanced Profile

Convenience pattern: retrieve an enhanced company profile with a synchronous-feel interface. The server holds the connection for up to approximately 40 seconds. If the profile is ready within that time, it is returned with HTTP 200. If not, HTTP 202 is returned with an orderId and Location header — poll GET /orders/{orderId} to retrieve the profile when complete. For production and high-volume integrations, POST is preferred: it returns an orderId immediately with no server-side connection hold, avoiding infrastructure cost at scale.

The profile includes (where filed in structured form at the registry):

  • Registration Information (Lite Profile + expanded details where available)
  • Share capital structure
  • Company Officials (incl. Directors) – including function, date of birth and address.
  • Shareholders (Beneficial owners) – including share count, share percentage and ID information.
  • Ultimate Beneficial Owners – where filed in structured form.
get/companies/{kyckrId}/enhanced

Query parameters

showDirectorshipsboolean

Where supported (currently GB/UK only), includes additional directorship information for each director, showing other companies where the director holds positions. When set to true, the directorships array will be populated for each representative.

customerReferencestring

Optional reference supplied by customer for tracking purposes

extendstring
Example:geocoding

Comma-separated list of profile extension types to include in the response. Extension data is returned in the additionalInformation object on the EnhancedProfile. Each extension type may be subject to per-account entitlements and additional cost. Unrecognised or unauthorised values are silently ignored. Additional extension types will be added as they become available. This parameter and its extension types are currently in beta trial and subject to change.

Available extension types:

  • geocoding — Populates additionalInformation.addressInformation with parsed and geocoded address variants for all addresses in the profile. Each entry in addressInformation.addresses[] is linked to its source address via the Address.identifier field. Contact your account manager to enable.

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.