Enhanced Profile

curl --request GET \
  --url https://api.kyckr.com/v2/companies/{kyckrId}/enhanced \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.kyckr.com/v2/companies/{kyckrId}/enhanced', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kyckr.com/v2/companies/{kyckrId}/enhanced",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kyckr.com/v2/companies/{kyckrId}/enhanced"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.kyckr.com/v2/companies/{kyckrId}/enhanced")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "orderId": 12345,
  "correlationId": "string",
  "customerReference": "string",
  "timeStamp": "2019-08-24T14:15:22Z",
  "details": "string",
  "cost": {
    "type": "credit",
    "value": 1
  },
  "links": {
    "self": "../dictionary"
  },
  "data": {
    "activities": [
      {
        "code": "string",
        "description": "string",
        "classificationScheme": "NACE",
        "type": "Primary"
      }
    ],
    "activityDeclarations": [
      {
        "declaration": "string",
        "declarationDescription": "string",
        "language": "string"
      }
    ],
    "addresses": [
      {
        "type": "string",
        "fullAddress": "string",
        "rawAddressLines": [
          "string"
        ],
        "buildingName": "string",
        "streetNumber": "string",
        "streetName": "string",
        "city": "string",
        "postcode": "string",
        "municipality": "string",
        "region": "string",
        "country": "string",
        "secondaryPostalCode": "string"
      }
    ],
    "capital": [
      {
        "type": "string",
        "description": "string",
        "classCode": "string",
        "classDescription": "string",
        "quantity": 0,
        "unitNominalValue": 0,
        "totalNominalValue": 0,
        "currency": "string",
        "shareholdings": [
          {
            "percentage": "string",
            "count": 0,
            "totalNominalValue": 0,
            "shareholders": {
              "corporations": [
                {
                  "type": "Corporation",
                  "idNumber": "string",
                  "name": "string",
                  "address": {
                    "type": "string",
                    "fullAddress": "string",
                    "rawAddressLines": [
                      "string"
                    ],
                    "buildingName": "string",
                    "streetNumber": "string",
                    "streetName": "string",
                    "city": "string",
                    "postcode": "string",
                    "municipality": "string",
                    "region": "string",
                    "country": "string",
                    "secondaryPostalCode": "string"
                  },
                  "registrationNumber": "string",
                  "registrationDate": {
                    "original": "string",
                    "normalized": "2019-08-24"
                  },
                  "registrationAuthority": "string",
                  "registeredAddress": {
                    "type": "string",
                    "fullAddress": "string",
                    "rawAddressLines": [
                      "string"
                    ],
                    "buildingName": "string",
                    "streetNumber": "string",
                    "streetName": "string",
                    "city": "string",
                    "postcode": "string",
                    "municipality": "string",
                    "region": "string",
                    "country": "string",
                    "secondaryPostalCode": "string"
                  }
                }
              ],
              "individuals": [
                {
                  "type": "Person",
                  "idNumber": "string",
                  "name": "string",
                  "address": {
                    "type": "string",
                    "fullAddress": "string",
                    "rawAddressLines": [
                      "string"
                    ],
                    "buildingName": "string",
                    "streetNumber": "string",
                    "streetName": "string",
                    "city": "string",
                    "postcode": "string",
                    "municipality": "string",
                    "region": "string",
                    "country": "string",
                    "secondaryPostalCode": "string"
                  },
                  "birthdate": {
                    "original": "string",
                    "normalized": "2019-08-24"
                  },
                  "nationality": "string",
                  "placeOfBirth": {
                    "type": "string",
                    "fullAddress": "string",
                    "rawAddressLines": [
                      "string"
                    ],
                    "buildingName": "string",
                    "streetNumber": "string",
                    "streetName": "string",
                    "city": "string",
                    "postcode": "string",
                    "municipality": "string",
                    "region": "string",
                    "country": "string",
                    "secondaryPostalCode": "string"
                  },
                  "placeOfResidence": {
                    "type": "string",
                    "fullAddress": "string",
                    "rawAddressLines": [
                      "string"
                    ],
                    "buildingName": "string",
                    "streetNumber": "string",
                    "streetName": "string",
                    "city": "string",
                    "postcode": "string",
                    "municipality": "string",
                    "region": "string",
                    "country": "string",
                    "secondaryPostalCode": "string"
                  }
                }
              ]
            }
          }
        ]
      }
    ],
    "representatives": {
      "corporations": [
        {
          "type": "Corporation",
          "idNumber": "string",
          "name": "string",
          "address": {
            "type": "string",
            "fullAddress": "string",
            "rawAddressLines": [
              "string"
            ],
            "buildingName": "string",
            "streetNumber": "string",
            "streetName": "string",
            "city": "string",
            "postcode": "string",
            "municipality": "string",
            "region": "string",
            "country": "string",
            "secondaryPostalCode": "string"
          },
          "registrationNumber": "string",
          "registrationDate": {
            "original": "string",
            "normalized": "2019-08-24"
          },
          "registrationAuthority": "string",
          "registeredAddress": {
            "type": "string",
            "fullAddress": "string",
            "rawAddressLines": [
              "string"
            ],
            "buildingName": "string",
            "streetNumber": "string",
            "streetName": "string",
            "city": "string",
            "postcode": "string",
            "municipality": "string",
            "region": "string",
            "country": "string",
            "secondaryPostalCode": "string"
          },
          "role": {
            "original": "string",
            "normalized": "string"
          },
          "startDate": {
            "original": "string",
            "normalized": "2019-08-24"
          },
          "endDate": {
            "original": "string",
            "normalized": "2019-08-24"
          },
          "isActive": true,
          "directorships": [
            {
              "companyNumber": "string",
              "companyName": "string",
              "role": "string",
              "startDate": {
                "original": "string",
                "normalized": "2019-08-24"
              },
              "endDate": {
                "original": "string",
                "normalized": "2019-08-24"
              },
              "isActive": true
            }
          ],
          "powers": [
            "string"
          ]
        }
      ],
      "individuals": [
        {
          "type": "Person",
          "idNumber": "string",
          "name": "string",
          "address": {
            "type": "string",
            "fullAddress": "string",
            "rawAddressLines": [
              "string"
            ],
            "buildingName": "string",
            "streetNumber": "string",
            "streetName": "string",
            "city": "string",
            "postcode": "string",
            "municipality": "string",
            "region": "string",
            "country": "string",
            "secondaryPostalCode": "string"
          },
          "birthdate": {
            "original": "string",
            "normalized": "2019-08-24"
          },
          "nationality": "string",
          "placeOfBirth": {
            "type": "string",
            "fullAddress": "string",
            "rawAddressLines": [
              "string"
            ],
            "buildingName": "string",
            "streetNumber": "string",
            "streetName": "string",
            "city": "string",
            "postcode": "string",
            "municipality": "string",
            "region": "string",
            "country": "string",
            "secondaryPostalCode": "string"
          },
          "placeOfResidence": {
            "type": "string",
            "fullAddress": "string",
            "rawAddressLines": [
              "string"
            ],
            "buildingName": "string",
            "streetNumber": "string",
            "streetName": "string",
            "city": "string",
            "postcode": "string",
            "municipality": "string",
            "region": "string",
            "country": "string",
            "secondaryPostalCode": "string"
          },
          "role": {
            "original": "string",
            "normalized": "string"
          },
          "startDate": {
            "original": "string",
            "normalized": "2019-08-24"
          },
          "endDate": {
            "original": "string",
            "normalized": "2019-08-24"
          },
          "isActive": true,
          "directorships": [
            {
              "companyNumber": "string",
              "companyName": "string",
              "role": "string",
              "startDate": {
                "original": "string",
                "normalized": "2019-08-24"
              },
              "endDate": {
                "original": "string",
                "normalized": "2019-08-24"
              },
              "isActive": true
            }
          ],
          "powers": [
            "string"
          ]
        }
      ]
    },
    "ultimateBeneficialOwners": {
      "individuals": [
        {
          "natureOfControl": [
            "string"
          ],
          "type": "Person",
          "idNumber": "string",
          "name": "string",
          "address": {
            "type": "string",
            "fullAddress": "string",
            "rawAddressLines": [
              "string"
            ],
            "buildingName": "string",
            "streetNumber": "string",
            "streetName": "string",
            "city": "string",
            "postcode": "string",
            "municipality": "string",
            "region": "string",
            "country": "string",
            "secondaryPostalCode": "string"
          },
          "birthdate": {
            "original": "string",
            "normalized": "2019-08-24"
          },
          "nationality": "string",
          "placeOfBirth": {
            "type": "string",
            "fullAddress": "string",
            "rawAddressLines": [
              "string"
            ],
            "buildingName": "string",
            "streetNumber": "string",
            "streetName": "string",
            "city": "string",
            "postcode": "string",
            "municipality": "string",
            "region": "string",
            "country": "string",
            "secondaryPostalCode": "string"
          },
          "placeOfResidence": {
            "type": "string",
            "fullAddress": "string",
            "rawAddressLines": [
              "string"
            ],
            "buildingName": "string",
            "streetNumber": "string",
            "streetName": "string",
            "city": "string",
            "postcode": "string",
            "municipality": "string",
            "region": "string",
            "country": "string",
            "secondaryPostalCode": "string"
          }
        }
      ]
    },
    "contactDetails": {
      "email": "string",
      "fax": "string",
      "telNumber": "string",
      "website": "string"
    },
    "identifiers": {
      "primaryRegistrationNumber": "string",
      "taxNumber": "string",
      "secondaryRegistrationNumber": "string",
      "otherIdentifiers": [
        {
          "type": "array",
          "description": "Additional identifiers with their standardized type codes",
          "items": {
            "$ref": "#/components/schemas/Identifier"
          }
        }
      ]
    },
    "companyName": "string",
    "tradingName": "string",
    "englishName": "string",
    "aliases": [
      {
        "name": "string",
        "type": "string"
      }
    ],
    "previousNames": [
      {
        "name": "string",
        "startDate": {
          "original": "string",
          "normalized": "2019-08-24"
        },
        "endDate": {
          "original": "string",
          "normalized": "2019-08-24"
        }
      }
    ],
    "registrationAuthority": "string",
    "source": {
      "notices": [
        {
          "text": "This extract contains information derived from the register. Please advise the register of any error or omission which you may identify.",
          "origin": "ASIC",
          "displayRequired": true
        }
      ],
      "extractedAt": "2019-08-24T14:15:22Z",
      "dataAsOfDate": "2019-08-24"
    },
    "lastUpdated": "2019-08-24T14:15:22Z",
    "foundationDate": {
      "original": "string",
      "normalized": "2019-08-24"
    },
    "registrationDate": {
      "original": "string",
      "normalized": "2019-08-24"
    },
    "incorporationDate": {
      "original": "string",
      "normalized": "2019-08-24"
    },
    "dissolutionDate": {
      "original": "string",
      "normalized": "2019-08-24"
    },
    "status": {
      "original": "string",
      "normalized": "Active"
    },
    "legalForm": {
      "original": "string",
      "normalized": "string"
    }
  }
}

Companies

Enhanced Profile

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/ 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

Enhanced Profile

curl --request GET \
  --url https://api.kyckr.com/v2/companies/{kyckrId}/enhanced \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.kyckr.com/v2/companies/{kyckrId}/enhanced', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kyckr.com/v2/companies/{kyckrId}/enhanced",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kyckr.com/v2/companies/{kyckrId}/enhanced"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.kyckr.com/v2/companies/{kyckrId}/enhanced")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "orderId": 12345,
  "correlationId": "string",
  "customerReference": "string",
  "timeStamp": "2019-08-24T14:15:22Z",
  "details": "string",
  "cost": {
    "type": "credit",
    "value": 1
  },
  "links": {
    "self": "../dictionary"
  },
  "data": {
    "activities": [
      {
        "code": "string",
        "description": "string",
        "classificationScheme": "NACE",
        "type": "Primary"
      }
    ],
    "activityDeclarations": [
      {
        "declaration": "string",
        "declarationDescription": "string",
        "language": "string"
      }
    ],
    "addresses": [
      {
        "type": "string",
        "fullAddress": "string",
        "rawAddressLines": [
          "string"
        ],
        "buildingName": "string",
        "streetNumber": "string",
        "streetName": "string",
        "city": "string",
        "postcode": "string",
        "municipality": "string",
        "region": "string",
        "country": "string",
        "secondaryPostalCode": "string"
      }
    ],
    "capital": [
      {
        "type": "string",
        "description": "string",
        "classCode": "string",
        "classDescription": "string",
        "quantity": 0,
        "unitNominalValue": 0,
        "totalNominalValue": 0,
        "currency": "string",
        "shareholdings": [
          {
            "percentage": "string",
            "count": 0,
            "totalNominalValue": 0,
            "shareholders": {
              "corporations": [
                {
                  "type": "Corporation",
                  "idNumber": "string",
                  "name": "string",
                  "address": {
                    "type": "string",
                    "fullAddress": "string",
                    "rawAddressLines": [
                      "string"
                    ],
                    "buildingName": "string",
                    "streetNumber": "string",
                    "streetName": "string",
                    "city": "string",
                    "postcode": "string",
                    "municipality": "string",
                    "region": "string",
                    "country": "string",
                    "secondaryPostalCode": "string"
                  },
                  "registrationNumber": "string",
                  "registrationDate": {
                    "original": "string",
                    "normalized": "2019-08-24"
                  },
                  "registrationAuthority": "string",
                  "registeredAddress": {
                    "type": "string",
                    "fullAddress": "string",
                    "rawAddressLines": [
                      "string"
                    ],
                    "buildingName": "string",
                    "streetNumber": "string",
                    "streetName": "string",
                    "city": "string",
                    "postcode": "string",
                    "municipality": "string",
                    "region": "string",
                    "country": "string",
                    "secondaryPostalCode": "string"
                  }
                }
              ],
              "individuals": [
                {
                  "type": "Person",
                  "idNumber": "string",
                  "name": "string",
                  "address": {
                    "type": "string",
                    "fullAddress": "string",
                    "rawAddressLines": [
                      "string"
                    ],
                    "buildingName": "string",
                    "streetNumber": "string",
                    "streetName": "string",
                    "city": "string",
                    "postcode": "string",
                    "municipality": "string",
                    "region": "string",
                    "country": "string",
                    "secondaryPostalCode": "string"
                  },
                  "birthdate": {
                    "original": "string",
                    "normalized": "2019-08-24"
                  },
                  "nationality": "string",
                  "placeOfBirth": {
                    "type": "string",
                    "fullAddress": "string",
                    "rawAddressLines": [
                      "string"
                    ],
                    "buildingName": "string",
                    "streetNumber": "string",
                    "streetName": "string",
                    "city": "string",
                    "postcode": "string",
                    "municipality": "string",
                    "region": "string",
                    "country": "string",
                    "secondaryPostalCode": "string"
                  },
                  "placeOfResidence": {
                    "type": "string",
                    "fullAddress": "string",
                    "rawAddressLines": [
                      "string"
                    ],
                    "buildingName": "string",
                    "streetNumber": "string",
                    "streetName": "string",
                    "city": "string",
                    "postcode": "string",
                    "municipality": "string",
                    "region": "string",
                    "country": "string",
                    "secondaryPostalCode": "string"
                  }
                }
              ]
            }
          }
        ]
      }
    ],
    "representatives": {
      "corporations": [
        {
          "type": "Corporation",
          "idNumber": "string",
          "name": "string",
          "address": {
            "type": "string",
            "fullAddress": "string",
            "rawAddressLines": [
              "string"
            ],
            "buildingName": "string",
            "streetNumber": "string",
            "streetName": "string",
            "city": "string",
            "postcode": "string",
            "municipality": "string",
            "region": "string",
            "country": "string",
            "secondaryPostalCode": "string"
          },
          "registrationNumber": "string",
          "registrationDate": {
            "original": "string",
            "normalized": "2019-08-24"
          },
          "registrationAuthority": "string",
          "registeredAddress": {
            "type": "string",
            "fullAddress": "string",
            "rawAddressLines": [
              "string"
            ],
            "buildingName": "string",
            "streetNumber": "string",
            "streetName": "string",
            "city": "string",
            "postcode": "string",
            "municipality": "string",
            "region": "string",
            "country": "string",
            "secondaryPostalCode": "string"
          },
          "role": {
            "original": "string",
            "normalized": "string"
          },
          "startDate": {
            "original": "string",
            "normalized": "2019-08-24"
          },
          "endDate": {
            "original": "string",
            "normalized": "2019-08-24"
          },
          "isActive": true,
          "directorships": [
            {
              "companyNumber": "string",
              "companyName": "string",
              "role": "string",
              "startDate": {
                "original": "string",
                "normalized": "2019-08-24"
              },
              "endDate": {
                "original": "string",
                "normalized": "2019-08-24"
              },
              "isActive": true
            }
          ],
          "powers": [
            "string"
          ]
        }
      ],
      "individuals": [
        {
          "type": "Person",
          "idNumber": "string",
          "name": "string",
          "address": {
            "type": "string",
            "fullAddress": "string",
            "rawAddressLines": [
              "string"
            ],
            "buildingName": "string",
            "streetNumber": "string",
            "streetName": "string",
            "city": "string",
            "postcode": "string",
            "municipality": "string",
            "region": "string",
            "country": "string",
            "secondaryPostalCode": "string"
          },
          "birthdate": {
            "original": "string",
            "normalized": "2019-08-24"
          },
          "nationality": "string",
          "placeOfBirth": {
            "type": "string",
            "fullAddress": "string",
            "rawAddressLines": [
              "string"
            ],
            "buildingName": "string",
            "streetNumber": "string",
            "streetName": "string",
            "city": "string",
            "postcode": "string",
            "municipality": "string",
            "region": "string",
            "country": "string",
            "secondaryPostalCode": "string"
          },
          "placeOfResidence": {
            "type": "string",
            "fullAddress": "string",
            "rawAddressLines": [
              "string"
            ],
            "buildingName": "string",
            "streetNumber": "string",
            "streetName": "string",
            "city": "string",
            "postcode": "string",
            "municipality": "string",
            "region": "string",
            "country": "string",
            "secondaryPostalCode": "string"
          },
          "role": {
            "original": "string",
            "normalized": "string"
          },
          "startDate": {
            "original": "string",
            "normalized": "2019-08-24"
          },
          "endDate": {
            "original": "string",
            "normalized": "2019-08-24"
          },
          "isActive": true,
          "directorships": [
            {
              "companyNumber": "string",
              "companyName": "string",
              "role": "string",
              "startDate": {
                "original": "string",
                "normalized": "2019-08-24"
              },
              "endDate": {
                "original": "string",
                "normalized": "2019-08-24"
              },
              "isActive": true
            }
          ],
          "powers": [
            "string"
          ]
        }
      ]
    },
    "ultimateBeneficialOwners": {
      "individuals": [
        {
          "natureOfControl": [
            "string"
          ],
          "type": "Person",
          "idNumber": "string",
          "name": "string",
          "address": {
            "type": "string",
            "fullAddress": "string",
            "rawAddressLines": [
              "string"
            ],
            "buildingName": "string",
            "streetNumber": "string",
            "streetName": "string",
            "city": "string",
            "postcode": "string",
            "municipality": "string",
            "region": "string",
            "country": "string",
            "secondaryPostalCode": "string"
          },
          "birthdate": {
            "original": "string",
            "normalized": "2019-08-24"
          },
          "nationality": "string",
          "placeOfBirth": {
            "type": "string",
            "fullAddress": "string",
            "rawAddressLines": [
              "string"
            ],
            "buildingName": "string",
            "streetNumber": "string",
            "streetName": "string",
            "city": "string",
            "postcode": "string",
            "municipality": "string",
            "region": "string",
            "country": "string",
            "secondaryPostalCode": "string"
          },
          "placeOfResidence": {
            "type": "string",
            "fullAddress": "string",
            "rawAddressLines": [
              "string"
            ],
            "buildingName": "string",
            "streetNumber": "string",
            "streetName": "string",
            "city": "string",
            "postcode": "string",
            "municipality": "string",
            "region": "string",
            "country": "string",
            "secondaryPostalCode": "string"
          }
        }
      ]
    },
    "contactDetails": {
      "email": "string",
      "fax": "string",
      "telNumber": "string",
      "website": "string"
    },
    "identifiers": {
      "primaryRegistrationNumber": "string",
      "taxNumber": "string",
      "secondaryRegistrationNumber": "string",
      "otherIdentifiers": [
        {
          "type": "array",
          "description": "Additional identifiers with their standardized type codes",
          "items": {
            "$ref": "#/components/schemas/Identifier"
          }
        }
      ]
    },
    "companyName": "string",
    "tradingName": "string",
    "englishName": "string",
    "aliases": [
      {
        "name": "string",
        "type": "string"
      }
    ],
    "previousNames": [
      {
        "name": "string",
        "startDate": {
          "original": "string",
          "normalized": "2019-08-24"
        },
        "endDate": {
          "original": "string",
          "normalized": "2019-08-24"
        }
      }
    ],
    "registrationAuthority": "string",
    "source": {
      "notices": [
        {
          "text": "This extract contains information derived from the register. Please advise the register of any error or omission which you may identify.",
          "origin": "ASIC",
          "displayRequired": true
        }
      ],
      "extractedAt": "2019-08-24T14:15:22Z",
      "dataAsOfDate": "2019-08-24"
    },
    "lastUpdated": "2019-08-24T14:15:22Z",
    "foundationDate": {
      "original": "string",
      "normalized": "2019-08-24"
    },
    "registrationDate": {
      "original": "string",
      "normalized": "2019-08-24"
    },
    "incorporationDate": {
      "original": "string",
      "normalized": "2019-08-24"
    },
    "dissolutionDate": {
      "original": "string",
      "normalized": "2019-08-24"
    },
    "status": {
      "original": "string",
      "normalized": "Active"
    },
    "legalForm": {
      "original": "string",
      "normalized": "string"
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

kyckrId

string

required

Kyckr company reference, a shared format, usable across our V2 APIs

Query Parameters

showDirectorships

boolean

default:false

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.

customerReference

string

Optional reference supplied by customer for tracking purposes

extend

string

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.

Example:

"geocoding"

Response

orderId

string

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

Show child attributes

links

object

Show child attributes

data

Company Profile · object

Basic company information

Show child attributes

About

Company V2 API

UBO Register API

Enhanced Profile

Authorizations

Path Parameters

Query Parameters

Response