KYkyckr
Companies

Enhanced Profile

Changed on

Retrieve an enhanced company profile. The server holds the connection open while the registry fulfils the request. If the profile is ready in time, it is returned with HTTP 200. If not, HTTP 202 is returned with an orderId in the response body; 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

Request

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, apart from the shareholdingSummary errors described below. Additional extension types will be added as they become available.

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.
  • shareholdingSummary: populates additionalInformation.shareholdingSummary with each owner's combined shareholding across every share class and a beneficialOwnershipResolution for one ownership threshold. shareholdingSummary alone uses a threshold of 25. shareholdingSummary:<n> uses <n>, which is 5, 10, 15, 20 or 25, for example extend=shareholdingSummary:10. Names are case-insensitive. Each request carries one threshold. Extension types combine, for example extend=geocoding,shareholdingSummary:5.

An unsupported threshold, such as shareholdingSummary:30, returns HTTP 400 with the detail shareholdingSummary threshold must be one of 5, 10, 15, 20, 25. More than one shareholdingSummary entry returns HTTP 400 with the detail shareholdingSummary may only be requested once. A 400 does not place an order and does not incur a charge.

Response

OK

orderIdstring

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.

Changes

  • b5008b331ed7Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added to the ///////// response property anyOf list for the response status

    • info

      removed from the ///////// response property anyOf list for the response status

    • info

      mapped value for discriminator key Corporation changed from to for ///////// response property for the response status

  • f7cb3dcbfb13Revision changes
    • warning

      added the new NACErev2 enum value to the ///// response property for the response status

    • warning

      added the new NACErev2.1 enum value to the ///// response property for the response status