Unwrap an ownership structure and automatically calculate UBOs
What is UBO Verify?
UBO Verify automates the analysis of corporate ownership structures and calculates ultimate beneficial ownership at the click of a button, meaning accurate UBO identification in minutes not hours. It’s a software tool which sits on top of the Kyckr registry network, retrieving profile information across jurisdictions and automatically analysing it to calculate ownership.
When will UBO Verify be available to consume via API?
UBO Verify is available now and able to find Ultimate Beneficial Owners in 15 different countries.
Search
You will first need to search the registry to find the entity. The search will confirm that the entity is active and provide a unique identifier for that company in codeField . You will need this value to unwrap an ownership structure alongside the jurisdiction ISO of where that entity is based.
Request a Report
To order a UBO report from Kyckr using Registry data you need to provide the following variables:
- Code Field of the Primary Entity
- 2 digit ISO code
- RegAuth - If a registration authority is returned in the Search API
- maxCreditCost - To specify the maximum credits you wish to spend on this transaction.
- uboThreshold (Optional, if not provided defaults to 25) - can be set to any value between 1 and 100 . You can configure a UBO Threshold which will be used in the final calculation of what percentage you deem a UBO to have of the root company.
- maxLayers (Optional, minimum value 3) Restricts the number of layers that are unwraped
Example Request
curl --location 'https://rest.kyckr.com/test/core/uboverify/create/GB/09657876?uboThreshold=25&maxCreditCost=50&maxLayers=5' \
--header 'Authorization: {{apiKey}}' \
Response
{
"ownershipTreeField": {
"statusField": "SUCCESS",
"orderIdField": "2614793"
},
"responseCodeField": "201"
}
In the response you will receive an unique Order ID in the orderIdField
Registration Authority
In some Jurisdictions, the search will return additional fields for Registration Authority:
"registrationAuthorityField": and "registrationAuthorityCodeField":
If these fields are provided then you will need to use the value supplied in registrationAuthorityCodeField as a parameter to order a UBO Report.
Retrieve the Report
Once the report is generated, you retrieve your report using the Order ID. The service is asynchronous which means the retrieval of the response is not dependant to the initial request. A request will call our company data to recursively check for ownership relationships, in the future this can be across several registries; meaning that the time to complete can be unknown. We recommend polling this endpoint until it is completed.
Example Request
curl --location 'https://rest.kyckr.com/test/core/uboverify/list/2614793'
--header 'Authorization: {{apiKey}}' \
Response
{
"ownershipTreeField": {
"idField": "09657876",
"nameField": "ANTHOLOGY THEATRE PRODUCTIONS LIMITED",
"addressField": "Elsley Court 4th Floor, 20-22 Great Titch Street, London, United Kingdom, W1W 8BE",
"nodesField": [
{
"levelField": 1,
"entityField": {
"idField": "f5ccce8f-9716-44fc-8a60-ad13164d5ef1",
"typeField": "COMPANY",
"nameField": "ANTHOLOGY THEATRE PRODUCTIONS LIMITED",
"nameInEnglishField": "ANTHOLOGY THEATRE PRODUCTIONS LIMITED",
"countryISOField": "GB",
"companyCodeField": "09657876",
"linksField": {
"enhancedProfileField": "https://download.kyckr.com/file/json/994864035-0"
},
"registrationAuthorityField": "Companies House, United Kingdom"
},
"edgesField": [
{
"nodeIdField": "5476035c-f5b1-4169-aec8-b82b7d14b0d7",
"typeField": "SHAREHOLDER",
"percentageField": 75.0,
"isCircularField": false
},
{
"nodeIdField": "fe211e6a-c8b2-4173-80ea-d6c3934643a5",
"typeField": "SHAREHOLDER",
"percentageField": 13.75,
"isCircularField": false
},
{
"nodeIdField": "1693af40-b7e7-4485-8930-fa261830cb4c",
"typeField": "SHAREHOLDER",
"percentageField": 5.0,
"isCircularField": false
},
{
"nodeIdField": "7549cd86-a904-49cb-8873-b65945da8b55",
"typeField": "SHAREHOLDER",
"percentageField": 5.0,
"isCircularField": false
},
{
"nodeIdField": "89da1bb0-b726-4b19-8baa-632926e40877",
"typeField": "SHAREHOLDER",
"percentageField": 1.25,
"isCircularField": false
},
{
"nodeIdField": "e6bdff13-c431-471d-aa38-4060de7df1f5",
"typeField": "REPRESENTATIVE",
"roleField": "Director",
"isCircularField": false
},
{
"nodeIdField": "64f7bf75-8d54-492d-8693-067620f985ca",
"typeField": "REPRESENTATIVE",
"roleField": "Director",
"isCircularField": false
},
{
"nodeIdField": "61ae329e-24d9-481c-8a39-74fdd2d3d00d",
"typeField": "REPRESENTATIVE",
"roleField": "Director",
"isCircularField": false
},
{
"nodeIdField": "70d2508a-3a22-4792-a302-2f71d54d9221",
"typeField": "REPRESENTATIVE",
"roleField": "Director",
"isCircularField": false
},
{
"nodeIdField": "7f4cf799-e374-4859-ac37-1842ed25fc78",
"typeField": "REPRESENTATIVE",
"roleField": "Director",
"isCircularField": false
}
]
},
{
"levelField": 2,
"entityField": {
"idField": "1693af40-b7e7-4485-8930-fa261830cb4c",
"typeField": "PERSON",
"nameField": "ROBERT JOHN BENTON",
"nameInEnglishField": "ROBERT JOHN BENTON"
},
"edgesField": [],
"rollupPercentageField": 5.0
},
{
"levelField": 2,
"entityField": {
"idField": "7549cd86-a904-49cb-8873-b65945da8b55",
"typeField": "PERSON",
"nameField": "LAURA ABIGAIL LAMBLEY",
"nameInEnglishField": "LAURA ABIGAIL LAMBLEY"
},
"edgesField": [],
"rollupPercentageField": 5.0
},
{
"levelField": 2,
"entityField": {
"idField": "89da1bb0-b726-4b19-8baa-632926e40877",
"typeField": "PERSON",
"nameField": "MARK BENTLEY",
"nameInEnglishField": "MARK BENTLEY"
},
"edgesField": [],
"rollupPercentageField": 1.25
},
{
"levelField": 2,
"entityField": {
"idField": "e6bdff13-c431-471d-aa38-4060de7df1f5",
"typeField": "PERSON",
"nameField": "Robert John Benton",
"nameInEnglishField": "Robert John Benton"
},
"edgesField": []
},
{
"levelField": 2,
"entityField": {
"idField": "64f7bf75-8d54-492d-8693-067620f985ca",
"typeField": "PERSON",
"nameField": "Carolyn Jane Bennett",
"nameInEnglishField": "Carolyn Jane Bennett"
},
"edgesField": []
},
{
"levelField": 2,
"entityField": {
"idField": "61ae329e-24d9-481c-8a39-74fdd2d3d00d",
"typeField": "PERSON",
"nameField": "Richard Charles Bridges",
"nameInEnglishField": "Richard Charles Bridges"
},
"edgesField": []
},
{
"levelField": 2,
"entityField": {
"idField": "70d2508a-3a22-4792-a302-2f71d54d9221",
"typeField": "PERSON",
"nameField": "Frederick William Ryecart",
"nameInEnglishField": "Frederick William Ryecart"
},
"edgesField": []
},
{
"levelField": 2,
"entityField": {
"idField": "7f4cf799-e374-4859-ac37-1842ed25fc78",
"typeField": "PERSON",
"nameField": "Laura Abigail Lambley",
"nameInEnglishField": "Laura Abigail Lambley"
},
"edgesField": []
},
{
"levelField": 2,
"entityField": {
"idField": "5476035c-f5b1-4169-aec8-b82b7d14b0d7",
"typeField": "COMPANY",
"nameField": "ANTHOLOGY THEATRE LTD",
"nameInEnglishField": "ANTHOLOGY THEATRE LTD",
"countryISOField": "GB",
"companyCodeField": "06914155",
"linksField": {
"enhancedProfileField": "https://download.kyckr.com/file/json/994864035-0"
},
"registrationAuthorityField": "Companies House, United Kingdom"
},
"edgesField": [
{
"nodeIdField": "ae942100-4948-4dab-b8f5-05b778ad9c8c",
"typeField": "SHAREHOLDER",
"percentageField": 76.23,
"isCircularField": false
},
{
"nodeIdField": "cb691fa4-7ff0-40e4-9ce7-787ab671b802",
"typeField": "SHAREHOLDER",
"percentageField": 6.76,
"isCircularField": false
},
{
"nodeIdField": "3efb74ca-b05e-46ca-b6ab-c284f720a66f",
"typeField": "SHAREHOLDER",
"percentageField": 6.76,
"isCircularField": false
},
{
"nodeIdField": "cbad9ba3-fdc5-4a6e-9c81-adfd44aaa8d7",
"typeField": "SHAREHOLDER",
"percentageField": 6.76,
"isCircularField": false
},
{
"nodeIdField": "d69806c8-df7a-42e6-9ba4-527175765953",
"typeField": "SHAREHOLDER",
"percentageField": 3.5,
"isCircularField": false
},
{
"nodeIdField": "6d4d4a30-f1dc-4e06-9622-f8fe43af2a0f",
"typeField": "REPRESENTATIVE",
"roleField": "Director",
"isCircularField": false
},
{
"nodeIdField": "954ea743-a3f7-44d2-8d56-56fa74040467",
"typeField": "REPRESENTATIVE",
"roleField": "Director",
"isCircularField": false
},
{
"nodeIdField": "022ffeb0-8618-491b-b2d8-17f48831b419",
"typeField": "REPRESENTATIVE",
"roleField": "Director",
"isCircularField": false
},
{
"nodeIdField": "0af7c41f-7be7-49be-a3ca-b73a4551d8be",
"typeField": "REPRESENTATIVE",
"roleField": "Director",
"isCircularField": false
}
],
"rollupPercentageField": 75.0
},
{
"levelField": 3,
"entityField": {
"idField": "cb691fa4-7ff0-40e4-9ce7-787ab671b802",
"typeField": "PERSON",
"nameField": "RICHARD BRIDGES",
"nameInEnglishField": "RICHARD BRIDGES"
},
"edgesField": [],
"rollupPercentageField": 7.7799765
},
{
"levelField": 3,
"entityField": {
"idField": "3efb74ca-b05e-46ca-b6ab-c284f720a66f",
"typeField": "PERSON",
"nameField": "ROBERT BENTON",
"nameInEnglishField": "ROBERT BENTON"
},
"edgesField": [],
"rollupPercentageField": 29.3454435
},
{
"levelField": 3,
"entityField": {
"idField": "cbad9ba3-fdc5-4a6e-9c81-adfd44aaa8d7",
"typeField": "PERSON",
"nameField": "CAROLYN BENNETT",
"nameInEnglishField": "CAROLYN BENNETT"
},
"edgesField": [],
"rollupPercentageField": 5.07
},
{
"levelField": 3,
"entityField": {
"idField": "d69806c8-df7a-42e6-9ba4-527175765953",
"typeField": "PERSON",
"nameField": "FREDERICK RYECART",
"nameInEnglishField": "FREDERICK RYECART"
},
"edgesField": [],
"rollupPercentageField": 2.625
},
{
"levelField": 3,
"entityField": {
"idField": "6d4d4a30-f1dc-4e06-9622-f8fe43af2a0f",
"typeField": "PERSON",
"nameField": "Robert John Benton",
"nameInEnglishField": "Robert John Benton"
},
"edgesField": []
},
{
"levelField": 3,
"entityField": {
"idField": "954ea743-a3f7-44d2-8d56-56fa74040467",
"typeField": "PERSON",
"nameField": "Carolyn Jane Bennett",
"nameInEnglishField": "Carolyn Jane Bennett"
},
"edgesField": []
},
{
"levelField": 3,
"entityField": {
"idField": "022ffeb0-8618-491b-b2d8-17f48831b419",
"typeField": "PERSON",
"nameField": "Richard Charles Bridges",
"nameInEnglishField": "Richard Charles Bridges"
},
"edgesField": []
},
{
"levelField": 3,
"entityField": {
"idField": "0af7c41f-7be7-49be-a3ca-b73a4551d8be",
"typeField": "PERSON",
"nameField": "Frederick William Ryecart",
"nameInEnglishField": "Frederick William Ryecart"
},
"edgesField": []
},
{
"levelField": 2,
"entityField": {
"idField": "fe211e6a-c8b2-4173-80ea-d6c3934643a5",
"typeField": "COMPANY",
"nameField": "YTD (HK) PTY LTD",
"nameInEnglishField": "YTD (HK) PTY LTD",
"countryISOField": "HK",
"reasonForNonContinuationField": {
"detailsField": "Jurisdiction used: Hong Kong, China HK",
"typeField": "INVALID_JURISDICTION",
"candidatesField": []
}
},
"edgesField": [],
"rollupPercentageField": 13.75
},
{
"levelField": 3,
"entityField": {
"idField": "ae942100-4948-4dab-b8f5-05b778ad9c8c",
"typeField": "COMPANY",
"nameField": "ANTHOLOGY MEDIA LTD",
"nameInEnglishField": "ANTHOLOGY MEDIA LTD",
"countryISOField": "GB",
"companyCodeField": "11433987",
"linksField": {
"enhancedProfileField": "https://download.kyckr.com/file/json/994864035-0"
},
"registrationAuthorityField": "Companies House, United Kingdom"
},
"edgesField": [
{
"nodeIdField": "3efb74ca-b05e-46ca-b6ab-c284f720a66f",
"typeField": "SHAREHOLDER",
"percentageField": 42.46,
"isCircularField": false
},
{
"nodeIdField": "3675e1d2-68de-4c2a-a5be-e40757372ac8",
"typeField": "SHAREHOLDER",
"percentageField": 24.19,
"isCircularField": false
},
{
"nodeIdField": "2e6a9f8b-7837-43cc-a166-b3d3b716e63a",
"typeField": "SHAREHOLDER",
"percentageField": 14.6,
"isCircularField": false
},
{
"nodeIdField": "676a944f-f3ae-4ba8-8609-726f601b34bc",
"typeField": "SHAREHOLDER",
"percentageField": 9.99,
"isCircularField": false
},
{
"nodeIdField": "cb691fa4-7ff0-40e4-9ce7-787ab671b802",
"typeField": "SHAREHOLDER",
"percentageField": 4.74,
"isCircularField": false
},
{
"nodeIdField": "90dd0112-2886-41fb-bd40-b5bc9b3ec808",
"typeField": "SHAREHOLDER",
"percentageField": 2.76,
"isCircularField": false
},
{
"nodeIdField": "c92860d1-4a3d-4151-83e1-407ecfcea0b8",
"typeField": "SHAREHOLDER",
"percentageField": 0.71,
"isCircularField": false
},
{
"nodeIdField": "3f5b1386-b4c6-4ff5-a5b4-0095c16643dd",
"typeField": "SHAREHOLDER",
"percentageField": 0.43,
"isCircularField": false
},
{
"nodeIdField": "48a816b3-0036-44ae-b62e-61a0b6ac8ceb",
"typeField": "SHAREHOLDER",
"percentageField": 0.14,
"isCircularField": false
},
{
"nodeIdField": "97ca41e6-90dd-4ccf-9d1c-5318e2e5cc46",
"typeField": "REPRESENTATIVE",
"roleField": "Director",
"isCircularField": false
},
{
"nodeIdField": "a0c71392-2599-4361-a421-881e8ae1551d",
"typeField": "REPRESENTATIVE",
"roleField": "Director",
"isCircularField": false
}
],
"rollupPercentageField": 57.1725
},
{
"levelField": 4,
"entityField": {
"idField": "3675e1d2-68de-4c2a-a5be-e40757372ac8",
"typeField": "PERSON",
"nameField": "CAROLYN JANE BENNETT",
"nameInEnglishField": "CAROLYN JANE BENNETT"
},
"edgesField": [],
"rollupPercentageField": 13.83002775
},
{
"levelField": 4,
"entityField": {
"idField": "676a944f-f3ae-4ba8-8609-726f601b34bc",
"typeField": "PERSON",
"nameField": "HILARY STRONG",
"nameInEnglishField": "HILARY STRONG"
},
"edgesField": [],
"rollupPercentageField": 5.71153275
},
{
"levelField": 4,
"entityField": {
"idField": "90dd0112-2886-41fb-bd40-b5bc9b3ec808",
"typeField": "PERSON",
"nameField": "SIMON FLAMANK",
"nameInEnglishField": "SIMON FLAMANK"
},
"edgesField": [],
"rollupPercentageField": 1.577961
},
{
"levelField": 4,
"entityField": {
"idField": "c92860d1-4a3d-4151-83e1-407ecfcea0b8",
"typeField": "PERSON",
"nameField": "EMMA WEIR",
"nameInEnglishField": "EMMA WEIR"
},
"edgesField": [],
"rollupPercentageField": 0.40592475
},
{
"levelField": 4,
"entityField": {
"idField": "3f5b1386-b4c6-4ff5-a5b4-0095c16643dd",
"typeField": "PERSON",
"nameField": "JONATHAN EVANS",
"nameInEnglishField": "JONATHAN EVANS"
},
"edgesField": [],
"rollupPercentageField": 0.24584175
},
{
"levelField": 4,
"entityField": {
"idField": "48a816b3-0036-44ae-b62e-61a0b6ac8ceb",
"typeField": "PERSON",
"nameField": "CAITLIN FERRARA",
"nameInEnglishField": "CAITLIN FERRARA"
},
"edgesField": [],
"rollupPercentageField": 0.0800415
},
{
"levelField": 4,
"entityField": {
"idField": "97ca41e6-90dd-4ccf-9d1c-5318e2e5cc46",
"typeField": "PERSON",
"nameField": "Carolyn Jane Bennett",
"nameInEnglishField": "Carolyn Jane Bennett"
},
"edgesField": []
},
{
"levelField": 4,
"entityField": {
"idField": "a0c71392-2599-4361-a421-881e8ae1551d",
"typeField": "PERSON",
"nameField": "Robert John Benton",
"nameInEnglishField": "Robert John Benton"
},
"edgesField": []
},
{
"levelField": 4,
"entityField": {
"idField": "2e6a9f8b-7837-43cc-a166-b3d3b716e63a",
"typeField": "COMPANY",
"nameField": "NORTHCROFT FILMS LIMITED",
"nameInEnglishField": "NORTHCROFT FILMS LIMITED",
"countryISOField": "GB",
"companyCodeField": "04108993",
"linksField": {
"enhancedProfileField": "https://download.kyckr.com/file/json/994864035-0"
},
"registrationAuthorityField": "Companies House, United Kingdom"
},
"edgesField": [
{
"nodeIdField": "aa4473ff-5d22-49ee-b5ca-8aa14bb541e3",
"typeField": "SHAREHOLDER",
"percentageField": 100.0,
"isCircularField": false
},
{
"nodeIdField": "406c87a7-758a-446d-84f3-cf5fa7bfd18a",
"typeField": "REPRESENTATIVE",
"roleField": "Director",
"isCircularField": false
},
{
"nodeIdField": "1a44fb69-bd7d-4e05-85b4-52f8f2ea8cad",
"typeField": "REPRESENTATIVE",
"roleField": "Director",
"isCircularField": false
},
{
"nodeIdField": "1a44fb69-bd7d-4e05-85b4-52f8f2ea8cad",
"typeField": "REPRESENTATIVE",
"roleField": "Company Secretary",
"isCircularField": false
}
],
"rollupPercentageField": 8.347185
},
{
"levelField": 5,
"entityField": {
"idField": "aa4473ff-5d22-49ee-b5ca-8aa14bb541e3",
"typeField": "PERSON",
"nameField": "COLIN AINSLIE MATTHISSEN & JOHN HENRY BENNETT & RICHARD BENNETT",
"nameInEnglishField": "COLIN AINSLIE MATTHISSEN & JOHN HENRY BENNETT & RICHARD BENNETT"
},
"edgesField": [],
"rollupPercentageField": 8.347185
},
{
"levelField": 5,
"entityField": {
"idField": "406c87a7-758a-446d-84f3-cf5fa7bfd18a",
"typeField": "PERSON",
"nameField": "John Henry Bennett",
"nameInEnglishField": "John Henry Bennett"
},
"edgesField": []
},
{
"levelField": 5,
"entityField": {
"idField": "1a44fb69-bd7d-4e05-85b4-52f8f2ea8cad",
"typeField": "PERSON",
"nameField": "Carolyn Jane Bennett",
"nameInEnglishField": "Carolyn Jane Bennett"
},
"edgesField": []
}
],
"ultimateBeneficialOwnersField": [
{
"idField": "3efb74ca-b05e-46ca-b6ab-c284f720a66f",
"nameField": "ROBERT BENTON",
"nameInEnglishField": "ROBERT BENTON",
"percentageField": "29.3454435000",
"entityTypeField": "PERSON"
}
],
"statusField": "SUCCESS",
"uboThresholdField": 0.0,
"maxCreditCostField": 0,
"dateCreatedField": "0001-01-01T00:00:00",
"retrievalLocationField": "https://download.kyckr.com/sampledocument/ubo/Company%20A.pdf",
"totalCreditsSpentField": 0,
"unwrapFeeField": 0
},
"responseCodeField": "200"
}
What information is returned by UBO Verify?
- A list of UBO's in structured data format from a given root company.
- Clear Shareholder information that can be used to build a full ownership structure.
- Node ID – A unique ID of the shareholder which can be traced throughout the nodes.
- Type – The type of shareholder (PERSON, COMPANY and OTHER).
- Edge Percentage – The percentage ownership of the of the entity shareholder.
- Roll up Percentage – The calculated percentage owned of the root company.
- Enhanced Profiles – A URL link for each company in the ownership structure
- Company Code – Company Number
- Registration Authority – The Registry that the information is retrieved from
- Accompanying PDF report that can be retrieved via a URL link
Reasons for Non Continuation
It is not always possible to find the UBO using registry data. For example a shareholding company my exist under the exact same name in two different countries or the next level of ownership is in country that doesn't have director and shareholder information available at the registry.
The following reasons for non continuation will be returned to make it clear why the UBO couldn't be discovered and to help inform the next action taken. Any layers of Ownership already discovered will also be returned
- Multiple matches with the same name in the same jurisdiction ( includes a list of up to 10 candidates that have been discovered)
- Multiple matches with the same name in multiple jurisdictions ( includes a list of up to 10 candidates that have been discovered)
- Possible Trust/Trustee
- Enhanced profile failed
- Company name matches where lower than the matching threshold
- Shareholder data not sufficient to perform next recursion
- Insufficient max credit cost
- Registry not available
- Insufficient credits
- Jurisdiction not supported ( Confirms the Jurisdiction ISO and name)
| Reason | Response | Description |
|---|---|---|
| Not Found | COMPANY_NOT_FOUND | - Company could not be found - Company name matches were lower than the matching threshold - Enhanced profile failed - Multiple matches with the same name in multiple jurisdictions - Multiple matches with the same name in the same jurisdiction - Invalid Registration Authority - Possible TRUST / TRUSTEE |
| Enhanced profile does not have shareholder data | NO_SHAREHOLDERS | No shareholder data available to display ownership |
| Registry down, system down | REGISTRY_NOT_AVAILABLE | Registry not available |
| Not enough credits to complete enhanced profile | INSUFFICIENT_CREDITS | Not enough credits |
| Jurisdiction not supported for UBO | UNSUPPORTED_JURISDICTION | The next level of ownership is in a jurisdiction that is not supported |
| When your max credit is reached for the node to be searched | INSUFFICIENT_MAX_CREDIT_COST | Max credit cost reached |
Continuation Key's
You can use a continuation key to continue unwrapping an ownership structure that had stopped with a Reason of Non Continuation. For example if there are two possible next companies in two different countries, you would get a reason for non continuation: "Multiple matches with the same name in multiple jurisdictions".
Example
"reasonForNonContinuationField": {
"detailsField": "Multiple matches with the same name in multiple jurisdictions",
"typeField": "COMPANY_NOT_FOUND",
"candidatesField": [
{
"addressField": "Lutterstr.",
"companyIdField": "HRB 30017",
"companyNameField": "Dr. August Oetker Finanzierungs- und Beteiligungs-GmbH",
"countryIsoField": "DE",
"registrationAuthorityField": "Bielefeld",
"continuationKeyField": "a66610c8-0cce-4343-a1b4-ace05362b5c8"
},
{
"addressField": "Lutterstrasse 14, Bielefeld, D-33617",
"companyIdField": "0630898292",
"companyNameField": "Dr. August Oetker Finanzierungs- und Beteiligungs-GmbH",
"countryIsoField": "BE",
"continuationKeyField": "4291146e-17ef-4152-ae3f-059a37324897"
}
As per the above example, there is a continuation key for each match, allowing an end user to manually select the correct company. It is important to note that you can only select one candidate from the candidatesField
How to continue a UBO discovery using a Continuation Key
Use the original UBO create request and add the continuation key as a parameter, if you have more than one reason for non continuation then you can have multiple continuation keys.
Example request with Continuation Key
curl --location 'https://rest.kyckr.com/test/core/uboverify/create/GB/04293376?continuationKeys=a66610c8-0cce-4343-a1b4-ace05362b5c8&uboThreshold=25&maxCreditCost=3' \
--header 'Authorization: {{apiKey}}' \
Jointly held Ownership
In jurisdictions such as Australia and New Zealand, shareholding can be shared. To highlight jointly owned shares there is a flag, linked ID and breakdown of shareholding in the nodes EDGE to display this.
Example jointly held shares
"edgesField": [
{
"nodeIdField": "7255f0c6-e911-4161-8afc-a49065fe6e7a",
"typeField": "SHAREHOLDER",
"percentageField": 100.00,
"isCircularField": false,
"shareholdingsField": [
{
"isJointlyHeldField": true,
"jointHoldingGroupIdField": "64cb8fb8-0d07-4546-a92d-b200cd60a91c",
"percentageField": 17.13
},
{
"isJointlyHeldField": true,
"jointHoldingGroupIdField": "e79ac474-bf07-473d-856d-78090c995dc1",
"percentageField": 82.85
},
{
"isJointlyHeldField": false,
"percentageField": 0.02
}
]
},
{
"nodeIdField": "2a4083cb-bc50-4fd5-b65e-04d3c1801bef",
"typeField": "SHAREHOLDER",
"percentageField": 99.98,
"isCircularField": false,
"shareholdingsField": [
{
"isJointlyHeldField": true,
"jointHoldingGroupIdField": "64cb8fb8-0d07-4546-a92d-b200cd60a91c",
"percentageField": 17.13
},
{
"isJointlyHeldField": true,
"jointHoldingGroupIdField": "e79ac474-bf07-473d-856d-78090c995dc1",
"percentageField": 82.85
}
Cached Enhanced Profiles
Any Enhanced profiles that are ordered are cached by Kyckr for 24 hours so that you don't have to pay twice for the same profile. There are a few scenarios in which this could happen including:
- After ordering the root company Enhanced profile and finding there is an intermediate layer of ownership. A UBO unwrap will be required during the automated analysis the cached profiles will not be charged twice.
- The UBO unwrap couldn't complete due to the number of credits in your threshold, therefore you have to reorder the report but would only spend credits on the next level or levels of ownership.
Response Codes
CREATE
| Success/Error | Code | Message |
|---|---|---|
| Successful transaction | 201 | SUCCESS |
| UBO account toggle OFF | 403 | You have insufficient permissions to access UBO Verify |
| Missing ISO / CODE | 404 | Resource not found |
| Missing maxCreditCost param | 107 | MaxCreditCost is required |
| Invalid ISO | 107 | Invalid jurisdiction. |
| Invalid CODE | 105 | Company not found. |
| Code pre-check failed | 105 | Company not found. Company number not valid format. |
| Invalid maxCreditCost | 107 | MaxCreditCost must be an integer greater than 0 |
| Invalid uboThreshold | 107 | UboThreshold must be a whole number between 0 - 100 |
LIST
| Success/Error | Code | Message |
|---|---|---|
| Not enough credits | 200 | Company Ownership Tree not generated - Root profile not generated due to insufficient credits. |
| MaxCreditCost to low to run first enhanced profile | 200 | Company Ownership Tree not generated - Root profile not generated due to insufficient credits. |
| Transaction in progress | 200 | Company Ownership Tree generation in progress |
| Transaction completed | 200 | UBO Response |
| Registry not available (EP 104) | 200 | Company Ownership Tree not generated - Registry not available at this time. |
| Service down | 403 | Service unavailable |
| UBO account toggle OFF | 403 | Order not found |
| Invalid orderID | 403 | You have insufficient permissions to access UBO Verify |
Can I see an Example Schema?
Yes - UBO Verify API reference
Updated 7 days ago