Understanding Standardized Fields
There is a lot of variation in how information for businesses is stored in various datasources, countries and jurisdictions due to local norms. As a result, the information received by Trulioo and previously displayed to you could have a lot of variability and unpredictability which made it difficult for API programmers to consume these responses across multiple geographies.
With the launch of Standardized Fields in KYB, you can expect more predictable and uniform responses to your business verification requests, making it easier to interpret results across all countries and jurisdictions as well as build streamlined internal processes on top of.
Once your account configurations are updated to standardized datasource variants, you will be able to view the new responses across normalized API (NAPI) as well as on Customer Portal.
What are Standardized Complex Objects?
The new Standardized Complex Objects are JSON objects which allow for the information received to be stored in a structured format. A Standardized Complex Object will have a defined format in terms of one or more properties and their associated values. These are hierarchical, so properties fall under their parent Standardized Complex Object and can be repeated in case multiple records exist.
Example:
Complex Object “Super Heroes” defined as
Properties -
{
Name : “String”,
Age : Number,
Secret Identity : “Name”,
}
Example Response
"Super Heroes":
[
{
"Name":"Superman",
"Age":35,
"Secret Identity":"Clark Kent"
},
{
"Name":"Spiderman",
"Age":20,
"Secret Identity":"Peter Parker"
}
]
The details of the new standardized Complex Objects are outlined below. Please note, not all the properties mentioned below will be returned in every verification, this will depend on the configured country and underlying datasource.
Standardized Registration Numbers
| Property | Notes |
|---|---|
| RegistrationNumber | |
| RegistrationNumberType | Describes what kind of Registration Number it is - it could be Business Registration Number or Tax ID Number. In some countries, there are multiple numbers to identify a company. |
Example Response
[
{
"Number":"0000123456",
"Type":"USA SEC CIK NUMBER"
},
{
"Number":"C45678",
"Type":"USA FL DOCUMENT NO"
},
{
"Number":"975864",
"Type":"USA FEI NUMBER"
}
]
Standardized Business Names
| Property | Notes |
|---|---|
| Name | The actual name value. Eg. “John’s Doughnuts” or “1825 BC Ltd” |
| Type | The ‘type’ of Entity Name. Possible values are: - Input Business Name - Input Tradestyle Name - Returned Business Name - Returned Alternate Name - Translated Input Name - Transliterated Input Name - Translated Returned Name - Transliterated Returned Name - Returned Previous Name |
| UsedForMatching | A boolean field to indicate the name pairing that was used if there was a ‘match’ set on business name. |
Example Response
{
"StandardizedBusinessName":
[
{
"Name":"Footy FC",
"Type":"Returned Business Name",
"UsedForMatching":true
},
{
"Name":"FOOTYFCINSPANISH",
"Type":"Input Business Name",
"UsedForMatching":false
MATCH
},
{
"Name":"Footy FC",
"Type":"Translated Input Name",
"UsedForMatching":true
},
{
"Name":"Juve FC",
"Type":"Returned Alternate Name",
"UsedForMatching":false
},
{
"Name":"OlderName",
"Type":"Returned Previous Name",
"UsedForMatching":false
}
]
}
Standardized Locations
| Propery | Notes |
|---|---|
| LocationType | Could be Primary, Registered, Mailing, Operational addresses |
| Address1 | |
| BuildingName | |
| BuildingNumber | |
| UnitNumber | |
| StreetName | |
| StreetType | |
| City | |
| PostalCode | |
| StateProvinceCode | |
| CountryCode | |
| POBox |
Example Response
[
{
"LocationType":"registered",
"Address1":"1 SW Bow Street, Portland, OR 97005-6453",
"BuildingNumber":"1",
"StreetName":"SW Bow Street",
"StreetType":"Drive",
"City":"Portland",
"StateProvinceCode":"OR",
"PostalCode":"97005-6453",
"CountryCode":"US"
},
{
"LocationType":"mailing",
"Address1":"1 SW Bow Street, Portland, OR 97005-6453",
"BuildingNumber":"1",
"StreetName":"SW Bow Street",
"StreetType":"Drive",
"City":"Portland",
"StateProvinceCode":"OR",
"PostalCode":"97005-6453",
"CountryCode":"US"
}
]
Standardized Communication
| Property | Notes |
|---|---|
| CommunicationValue | Phone number, email, or website |
| CommunicationType | Description of above |
Example Response
[
{
"Value":"512346",
"Type":"Telephone"
},
{
"Value":"91827364",
"Type":"Telephone"
},
{
"Value":"[email protected]",
"Type":"email"
}
]
Standardized Industries
| Property | Notes |
|---|---|
| IndustryCode | |
| IndustryDescription | Literal description of the industry code |
| IndustryCodeType | Code system name, for example, North American Industry Classification System (NAICS) |
Example Response
[
{
"Code":"325510",
"CodeType":"Unknown",
"Description":"Paint and Coating Manufacturing"
},
{
"Code":"327110",
"CodeType":"NAICS",
"Description":"Pottery, Ceramics, and Plumbing Fixture Manufacturing”
}
]
Standardized Share Capital
| Property | Notes |
|---|---|
| CapitalAmount | The amount of the capital in the specified currency |
| CapitalType | The type of capital in question |
| Currency | Currency type (ex. USD, CNY, INR etc.) |
Example Response
[
{
"CapitalAmount":"10500",
"CapitalType":"Paid up",
"Currency":"USD"
},
{
"CapitalAmount":"20000",
"CapitalType":"Unknown",
"Currency":"INR”
}
]
Standardized Stock Exchanges
| Property | Notes |
|---|---|
| TickerName | The ticker symbol of the company, may include the stock exchange name where available |
| TickerExchange | |
| TickerCountry | Country of the stock exchange |
Example Response
[
{
"TickerName":"XYZ",
"TickerExchange":"NASDAQ",
"TickerCountry":"US"
},
{
"TickerName":"XYZA",
"TickerExchange":"TSX",
"TickerCountry":"CANADA"
}
]
Standardized Directors Officers
| Property | Notes |
|---|---|
| GivenName | This could be First + Middle Name |
| Surname | |
| FullName | |
| NationalIDNumber | |
| DateOfBirth | |
| FullAddress | |
| Position | |
| Designation | |
| Type | This could be Partner or Agent, (anything other than Shareholders and Beneficial Owners) |
| Status | Active, Resigned |
| BeginDate | |
| EndDate |
Example Response
[
{
"FullName":"Steve M.",
"FullAddress":[
"TEN CEDAR DRIVE, PORTLAND OR 97005"
],
"Type":"Individual",
"Status":"Active",
"BeginDate":"Unknown"
},
{
"FullName":"JOHN O’BRIEN",
"FullAddress":[
"1 SW Bow Street, Portland, OR 97005-6453"
],
"Position" :"President - Affiliates",
"Type":"Individual",
"Status": "Active",
"BeginDate": "Unknown"
},
{
"FullName": "MARK WILLIAMSON",
"FullAddress": [
"1 SW Bow Street, Portland, OR 97005-6453",
"22 CALGARY AVENUE,SEATTLE,WA"
],
"Position": "CHIEF OPERATING OFFICER",
"Type": "Individual",
"Status": "Active",
"BeginDate": "Unknown"
}
]
Standardized Company Ownership Hierarchy
The company ownership objects will be comprised of the following two objects:
| Object |
|---|
| Ownerships |
| Relationships |
Ownerships Object Field Mapping
| Property | Notes |
|---|---|
| UniqueID | Global Gateway generated ID |
| VendorID | ID assigned by Vendor |
| DUNSNumber | |
| NationalIDNumber | |
| FullName | |
| GivenName | This could be First + Middle Name |
| Surname | |
| BeneficiaryType | |
| BusinessEntityType | |
| FullAddress | |
| City | |
| StateProvinceCode | |
| PostalCode | |
| CountryCode | |
| Nationality | |
| DateOfBirth | |
| ResidenceCountry | |
| LegalAuthority | |
| LegalForm | |
| IsOutOfBusiness | |
| ControlOwnershipType | |
| ControlOwnershipConfidenceLevel | |
| DegreeOfSeparation | This is a measure of the distance between the company being verified and other entities in its ownership structure 0 for the company being verified, 1 for direct owners, 2 for entities owning direct owners and so on |
| Shares | This is for datasources that have discrete number of shares held by an entity |
| DirectOwnershipPercentage | |
| IndirectOwnershipPercentage | |
| BeneficialOwnershipPercentage | |
| InferredDirectOwnershipPercentage | |
| InferredIndirectOwnershipPercentage | |
| InferredBeneficialOwnershipPercentage | |
| OwernshipNotes | Some datasources may not return actual percentage and return a string similar to "Owns 75-100% of voting rights" and "Has right to appoint and remove directors" |
| OwnershipUnavailableReasons |
Example Response
[
{
"UniqueId":"2",
"VendorId":"Vihjbkj3JEewLqCcEQ",
"FullName":"Jill Stan",
"BeneficiaryType":"Class B Common Stock",
"BusinessEntityType":"person",
"FullAddress":[
"17 Autumn Avenue, BEAVERTON OR 96129"
],
"CountryCode":"USA",
"DegreeOfSeparation":1,
"Shares":3164.0
},
{
"UniqueId":"3",
"VendorId":"rzCYmGHUf42WXmJmd1aA",
"FullName":"JOHN ROGER A",
"BeneficiaryType":"Class B Common Stock",
"BusinessEntityType":"person",
"FullAddress":[
"35 NEW STREET, NW, WASHINGTON, DC, 2113"
],
"CountryCode":"USA",
"DegreeOfSeparation":1,
"Shares":26963.0
},
{
"UniqueId":"4",
"VendorId":"G8379wGHTOqka9Ho0Ig",
"FullName":"TOM BRYAN",
"BeneficiaryType":"Class B Common Stock",
"BusinessEntityType":"person",
"FullAddress":[
"15 COHO DRIVE, PORTLAND, OR, 90289"
],
"CountryCode":"USA",
"DegreeOfSeparation":1,
"Shares":109884.91
}
]
Ownership Summary Object Field Mapping
Summarized view of the company's ownership
| Property | Notes |
|---|---|
| Total Ownership Count | The total number of ownership entities identified |
| Maximum Degree of Separation | The highest ‘degree of separation’ identified |
| Organizations Count | The number of ownership entities identified that are organizations / businesses |
| Individuals Count | The number of ownership entities identified that are people |
| Unknowns Count | The number of ownership entities identified that we were unable to classify as an Individual or Organization |
| Total Allocated Ownership Percentage | The sum of all Ownership Percentages from the identified entities |
Example Response
"OwnershipSummary":
{
"TotalOwnershipCount":2,
"MaximumDegreeOfSeparation":1,
"TotalAllocatedOwnershipPercentage":75.0,
"OrganizationsCount":2,
"IndividualsCount":0,
"UnknownsCount":0
}
Relationships Object Field Mapping
For each company, there could be multiple ownership relationships. This Complex Object represents an array of relationships.
| Property | Notes |
|---|---|
| RelationshipID | GlobalGateway generated |
| ParentUniqueID | The is the entity owned by another entity |
| TargetUniqueID | This is the entity that owns the Parent ID |
| RelationshipTypeDescription | |
| SharePercentage | |
| InferredSharePercentage | |
| ControlTypeDescription | |
| ControlClassDescription | |
| ControlStartDate | |
| DirectControl | True / False |
| RelationshipNotes | Some datasources may not return actual percentage and return a string similar to "Owns 75-100% of voting rights" and "Has right to appoint and remove directors" |
Example Response
[
{
"RelationshipID":"1",
"ParentUniqueID":"2267180",
"TargetUniqueID":"267390",
"RelationshipTypeDescription":"Unknown",
"SharePercentage":5.6,
"ControlTypeDescription":"Owned",
"ControlClassDescription":"",
"ControlStartDate":"",
"RelationshipNotes":""
},
{
"RelationshipID":"1",
"ParentUniqueID":"2267180",
"TargetUniqueID":"267390",
"RelationshipTypeDescription":"Unknown",
"SharePercentage":0.001,
"ControlTypeDescription":"Owned",
"ControlClassDescription":"",
"ControlStartDate":"",
"RelationshipNotes":""
}
]
Standardized Metadata
| Property | Notes |
|---|---|
| Sources | This is an array to store names of underlying sources |
| CompanyProfileLastUpdate | Complex JSON object to store segmented Year, Month, Day when the Company profile information was last updated in the underlying source |
| DirectorsOfficersLastUpdate | Complex JSON object to store segmented Year, Month, Day when the Directors & Officers information was last updated in the underlying source |
| OwnershipLastUpdate | Complex JSON object to store segmented Year, Month, Day when the Ownership information was last updated in the underlying source |
| DataRetrievalDate | Complex JSON object to store segmented Year, Month, Day when the company information was retrieved from the underlying source |
Example Response
{
"Sources":[
"Companies House United Kingdom"
],
"UpdateData":[
{
"Type":"CompanyProfileLastUpdate",
"Date":{
"Day":"25",
"Month":"10",
"Year":"2022"
}
},
{
"Type":"DirectorsOfficersLastUpdate",
"Date":{
"Day":"25",
"Month":"10",
"Year":"2022"
}
},
{
"Type":"OwnershipLastUpdate",
"Date":{
"Day":"25",
"Month":"10",
"Year":"2022"
}
},
{
"Type":"DataRetrievalDate",
"Date":{
"Day":"25",
"Month":"10",
"Year":"2022"
}
},
]
}
In order to start using Standardized Fields on KYB, you will have to update your account configuration. Please reach out to your Customer Success Manager or email [email protected].
Updated 17 days ago