# Glossary
Here you will find data dictionaries with attributes used in the context of InstantKYB along with a description of each attribute.
Page contents
# KYB data dictionary
| Area | Attribute | Description |
|---|---|---|
basicInfo | name | Company name |
basicInfo | organizationNumber | Organisation number |
basicInfo | vatNumber | VAT number |
basicInfo | registrationDate | Company registration date |
basicInfo | legalStatus | Legal status of company |
basicInfo | employees | Number of employees at company |
basicInfo/names | name | Company name |
basicInfo/names | type | Company type |
basicInfo/names | start | Start date of name |
basicInfo/names | end | End date of name |
basicInfo/country | alpha2 | Alpha 2 country code of business |
basicInfo/country | alpha3 | Alpha 3 country code of business |
basicInfo/country | numeric | Numeric country code of business |
basicInfo/businessAddress | street | Street of business address |
basicInfo/businessAddress | postalCode | Postal code of business address |
basicInfo/businessAddress | city | City of business address |
basicInfo/businessAddress/country | alpha2 | Alpha 2 country code of business address |
basicInfo/businessAddress/country | alpha3 | Alpha 3 country code of business address |
basicInfo/businessAddress/country | numeric | Numeric country code of business address |
basicInfo/addresses | type | Address type |
basicInfo/addresses | startDate | Start date of address |
basicInfo/addresses | endDate | End date of address |
basicInfo/addresses | isActive | Is the address active |
basicInfo/addresses | street | Street of the address |
basicInfo/addresses | postalCode | Postal code of the address |
basicInfo/addresses | city | City of the address |
basicInfo/addresses/country | alpha2 | Alpha 2 country code of the address |
basicInfo/addresses/country | alpha3 | Alpha 3 country code of the address |
basicInfo/addresses/country | numeric | Numeric country code of the address |
basicInfo/organizationType | name | Name of the organisation type |
basicInfo/organizationType | code | Code for the organisation type |
basicInfo/organizationType | url | URL containing possible organisation codes |
basicInfo/industries | code | NACE Rev. 2 code for the industry |
basicInfo/industries | description | Description of the industry |
basicInfo/industries | section | Section of the industry |
basicInfo/industries | level | Level of the industry |
basicInfo/contact | email | Contact email address for the company |
basicInfo/contact/phone | nationalNumber | National contact phone number for the company |
basicInfo/contact/phone | countryCode | Country code for the valid national phone number for the company |
basicInfo/contact/phone | intlFormat | Contact phone number for the company formatted according to locale |
basicInfo/metadata | sources | List of data sources |
basicInfo/metadata | urls | List of URLs to data sources |
basicInfo/metadata | lastChanged | Date the source information was last updated |
basicInfo/metadata | rawJson | Raw Json response from the source |
basicInfo/metadata | isCache | Is the data from cache |
Authorizationkyb/signature | status | Status of authorisation response |
Authorizationkyb/signature | description | Description of those with the ability to sign on behalf of the business |
Authorizationkyb/signature/combinations | description | Description of the combination |
Authorizationkyb/signature/combinations/signers | dateOfBirth | Date of birth of signer |
Authorizationkyb/signature/combinations/signers/name | status | Status of name returned |
Authorizationkyb/signature/combinations/signers/name | full | Full name |
Authorizationkyb/signature/combinations/signers/name | first | First name |
Authorizationkyb/signature/combinations/signers/name | last | Last name |
Authorizationkyb/signature/combinations/signers/name | middle | Middle name |
Authorizationkyb/signature/combinations/signers/role | code | Role of signer |
Authorizationkyb/signature/combinations/signers/role | description | Description of role |
Authorizationkyb/signature/basis/people | dateOfBirth | Date of birth of person forming basis |
Authorizationkyb/signature/basis/people/name | status | Status of person's name |
Authorizationkyb/signature/basis/people/name | full | Full name of person |
Authorizationkyb/signature/basis/people/name | first | First name of person |
Authorizationkyb/signature/basis/people/name | last | Last name of person |
Authorizationkyb/signature/basis/people/name | middle | Middle name of person |
Authorizationkyb/signature/basis/people/role | code | Role of person |
Authorizationkyb/signature/basis/people/role | description | Description of role of person |
Authorizationkyb/signature/basis/people/roles | code | Role of person |
Authorizationkyb/signature/basis/people/roles | description | Description of role |
Authorizationkyb/powerOfProcuration | status | Status of authorisation response |
Authorizationkyb/powerOfProcuration | description | Description of those with the partial ability to sign on behalf of the business |
Authorizationkyb/powerOfProcuration/combinations | description | Description of combination |
Authorizationkyb/powerOfProcuration/combinations/signers | dateOfBirth | Date of birth of signer |
Authorizationkyb/powerOfProcuration/combinations/signers/name | status | Status of name of signer |
Authorizationkyb/powerOfProcuration/combinations/signers/name | full | Full name of signer |
Authorizationkyb/powerOfProcuration/combinations/signers/name | first | First name of signer |
Authorizationkyb/powerOfProcuration/combinations/signers/name | last | Last name of signer |
Authorizationkyb/powerOfProcuration/combinations/signers/name | middle | Middle name of signer |
Authorizationkyb/powerOfProcuration/combinations/signers/role | code | Role of signer |
Authorizationkyb/powerOfProcuration/combinations/signers/role | description | Description of role |
Authorizationkyb/powerOfProcuration/basis/people | dateOfBirth | Date of birth of person forming basis |
Authorizationkyb/powerOfProcuration/basis/people/name | status | Status of person name |
Authorizationkyb/powerOfProcuration/basis/people/name | full | Full name of person |
Authorizationkyb/powerOfProcuration/basis/people/name | first | First name of person |
Authorizationkyb/powerOfProcuration/basis/people/name | last | Last name of person |
Authorizationkyb/powerOfProcuration/basis/people/name | middle | Middle name of person |
Authorizationkyb/powerOfProcuration/basis/people/role | code | Role of person |
Authorizationkyb/powerOfProcuration/basis/people/role | description | Description of role |
Authorizationkyb/powerOfProcuration/basis/people/roles | code | Role of person |
Authorizationkyb/powerOfProcuration/basis/people/roles | description | Description of role |
Authorizationkyb/metadata | sources | Sources |
Authorizationkyb/metadata | urls | URLs |
Authorizationkyb/metadata | lastChanged | Last changed date of the data |
Authorizationkyb/metadata | rawJson | Raw Json from the source |
Authorizationkyb/metadata | isCache | Is the data from cache |
ubo/ultimateBeneficiaryOwners | gender | Gender of UBO |
ubo/ultimateBeneficiaryOwners | role | UBO role |
ubo/ultimateBeneficiaryOwners/ownership | directOwnership | Percentage of shares held |
ubo/ultimateBeneficiaryOwners/ownership | indirectOwnership | Indirect ownership |
ubo/ultimateBeneficiaryOwners/ownership | integratedOwnership | Direct and indirect ownership |
ubo/ultimateBeneficiaryOwners/ownership | votingRights | Percent voting right of person |
ubo/ultimateBeneficiaryOwners/ownership | votingPower | Percent voting power |
ubo/ultimateBeneficiaryOwners/ownership/directOwnershipRange | from | Shareholder percentage greater than or equal to |
ubo/ultimateBeneficiaryOwners/ownership/directOwnershipRange | to | Shareholder percentage less than or equal to |
ubo/ultimateBeneficiaryOwners/ownership/indirectOwnershipRange | from | Indirect ownership range greater than or equal to |
ubo/ultimateBeneficiaryOwners/ownership/indirectOwnershipRange | to | Indirect ownership range less than or equal to |
ubo/ultimateBeneficiaryOwners/ownership/integratedOwnershipRange | from | Direct and indirect ownership range greater than or equal to |
ubo/ultimateBeneficiaryOwners/ownership/integratedOwnershipRange | to | Direct and indirect ownership range less than or equal to |
ubo/ultimateBeneficiaryOwners/ownership/votingRightsRange | from | Voting rights greater than or equal to |
ubo/ultimateBeneficiaryOwners/ownership/votingRightsRange | to | Voting rights less than or equal to |
ubo/ultimateBeneficiaryOwners/ownership/votingPowerRange | from | Percent voting power greater than or equal to |
ubo/ultimateBeneficiaryOwners/ownership/votingPowerRange | to | Percent voting power less than or equal to |
ubo/ultimateBeneficiaryOwners/name | status | Status of name returned |
ubo/ultimateBeneficiaryOwners/name | full | Full name of UBO |
ubo/ultimateBeneficiaryOwners/name | first | First name of UBO |
ubo/ultimateBeneficiaryOwners/name | last | Last name of UBO |
ubo/ultimateBeneficiaryOwners/name | middle | Middle name of UBO |
ubo/ultimateBeneficiaryOwners/address | street | Street address of UBO |
ubo/ultimateBeneficiaryOwners/address | postalCode | Postal code of UBO |
ubo/ultimateBeneficiaryOwners/address | city | City of UBO |
ubo/ultimateBeneficiaryOwners/address/country | alpha2 | Alpha 2 country code of UBO address |
ubo/ultimateBeneficiaryOwners/address/country | alpha3 | Alpha 3 country code of UBO address |
ubo/ultimateBeneficiaryOwners/address/country | numeric | Numeric country code of UBO address |
ubo/ultimateBeneficiaryOwners/birth | monthOfBirth | Month of birth of UBO |
ubo/ultimateBeneficiaryOwners/birth | yearOfBirth | Year of birth of UBO |
ubo/ultimateBeneficiaryOwners/birth | dateOfBirth | Date of birth of UBO |
ubo/ultimateBeneficiaryOwners/birth/country | alpha2 | Alpha 2 country code of birth country of UBO |
ubo/ultimateBeneficiaryOwners/birth/country | alpha3 | Alpha 3 country code of birth country of UBO |
ubo/ultimateBeneficiaryOwners/birth/country | numeric | Numeric country code of birth country of UBO |
ubo/ultimateBeneficiaryOwners/identityNumber | idNumber | Identity number of UBO |
ubo/ultimateBeneficiaryOwners/identityNumber | type | Type of ID number |
ubo/ultimateBeneficiaryOwners/identityNumber/country | alpha2 | Alpha 2 country code of ID country |
ubo/ultimateBeneficiaryOwners/identityNumber/country | alpha3 | Alpha 3 country code of ID country |
ubo/ultimateBeneficiaryOwners/identityNumber/country | numeric | Numeric country code of ID country |
ubo/ultimateBeneficiaryOwners/nationality | alpha2 | Alpha 2 country code of UBO nationality |
ubo/ultimateBeneficiaryOwners/nationality | alpha3 | Alpha 3 country code of UBO nationality |
ubo/ultimateBeneficiaryOwners/nationality | numeric | Numeric country code of UBO nationality |
ubo/metadata | sources | Sources of the data |
ubo/metadata | urls | URLs of the data |
ubo/metadata | lastChanged | Last changed date of data |
ubo/metadata | rawJson | Raw Json from the source |
ubo/metadata | isCache | Is the data from cache |
Roles/persons | role | Role of person |
Roles/persons | dateOfBirth | Date of birth of person |
Roles/persons/roles | role | Role of person |
Roles/persons/roles | startDate | Start date of person's role |
Roles/persons/roles | endDate | End date of person's role |
Roles/persons/name | status | Which attributes are set |
Roles/persons/name | full | Full name of person |
Roles/persons/name | first | First name of person |
Roles/persons/name | last | Last name of person |
Roles/persons/name | middle | Middle name of person |
Roles/persons/address | street | Street of persons address |
Roles/persons/address | postalCode | Postal code of persons address |
Roles/persons/address | city | City of persons address |
Roles/persons/address/country | alpha2 | Alpha 2 country code of persons address |
Roles/persons/address/country | alpha3 | Alpha 3 country code of persons address |
Roles/persons/address/country | numeric | Numeric country code of persons address |
Roles/persons/nationality | alpha2 | Alpha 2 country code of person's nationality |
Roles/persons/nationality | alpha3 | Alpha 3 country code of person's nationality |
Roles/persons/nationality | numeric | Numeric country code of person's nationality |
Roles/persons/identityNumber | idNumber | Identity number of person |
Roles/persons/identityNumber | type | Identity number of person type |
Roles/persons/identityNumber/country | alpha2 | Alpha 2 country code of persons identity number |
Roles/persons/identityNumber/country | alpha3 | Alpha 3 country code of persons identity number |
Roles/persons/identityNumber/country | numeric | Numeric country code of persons identity number |
Roles/companies | role | Role of company |
Roles/companies | name | Name of company |
Roles/companies/roles | role | Role of company |
Roles/companies/roles | startDate | Start date of role of company |
Roles/companies/roles | endDate | End date of role of company |
Roles/companies/organizationNumber | domestic | Domestic organisation number of the company |
Roles/companies/organizationNumber | dunsNumber | Data Universal Numbering System for the company |
Roles/companies/organizationNumber | legalEntityIdentifier | Legal Entity Identifier of company |
Roles/others | role | Role of other entity |
Roles/others | name | Name of other entity |
Roles/others | id | Id of other entity |
Roles/others/roles | role | Role of other entity |
Roles/others/roles | startDate | Start date of role of other entity |
Roles/others/roles | endDate | End date of role of other entity |
Roles/metadata | sources | Sources |
Roles/metadata | urls | URLs of sources |
Roles/metadata | lastChanged | Last changed date of data |
Roles/metadata | rawJson | Raw Json response from the source |
Roles/metadata | isCache | Is the data from cache |
kyb | workflowStatus | Does the workflow exit early or not |
kyb | statusReason | Justification for the above status |
# Screening data dictionary
| Area | Attribute | Description |
|---|---|---|
UboPepData | pageOffset | Offset of the current page |
UboPepData | responseSize | Total size of the collection (irrespective of any paging options). |
UboPepData | pageLimit | Limit of the current paging options |
UboPepData/links | self | |
UboPepData/links | next | URL of the next page |
UboPepData/links | previous | URL of the previous page |
UboPepData/links | first | URL of the first page |
UboPepData/data | entityType | Type of entity |
UboPepData/data | listType | The type of list |
UboPepData/data | sourceName | string or null Name of the source the item was found in |
UboPepData/data | gender | Gender of the UBO |
UboPepData/data/matchStrength | score | A score from 0 - 100 where higher values are more relevant |
UboPepData/data/matchStrength | certainty | Level of certainty on whether the individual is a match or not. |
UboPepData/data/name | status | A hint to which attributes are set. partial : only full name, all : all attributes. |
UboPepData/data/name | full | Full name of the UBO |
UboPepData/data/name | first | First/given name of the UBO |
UboPepData/data/name | last | Last/surname of the UBO |
UboPepData/data/name | middle | Middle name of the UBO |
UboPepData/data/aliases | status | A hint to which attributes are set. partial : only full name, all : all attributes. |
UboPepData/data/aliases | full | Full name of the UBO |
UboPepData/data/aliases | first | First name of the UBO |
UboPepData/data/aliases | last | Last name of the UBO |
UboPepData/data/aliases | middle | Middle name of the UBO |
UboPepData/data/associates | name | Name of the associate |
UboPepData/data/associates | association | Type of association |
UboPepData/data/associates | comments | Additional information / Detailed description |
UboPepData/data/datesOfBirth | monthOfBirth | Month Of Birth |
UboPepData/data/datesOfBirth | yearOfBirth | Year of Birth |
UboPepData/data/datesOfBirth | dateOfBirth | DOB. Format: yyyy-MM-dd |
UboPepData/data/datesOfBirth | isApproximate | Whether the DOB is approximate or not |
UboPepData/data/datesOfBirth/country | alpha2 | Two-digit country code |
UboPepData/data/datesOfBirth/country | alpha3 | Three-digit country code |
UboPepData/data/datesOfBirth/country | numeric | Numeric country code |
UboPepData/data/addresses | Street | Street |
UboPepData/data/addresses | Postcode | Postcode |
UboPepData/data/addresses | City | City |
UboPepData/data/addresses/country | alpha2 | Two-digit country code |
UboPepData/data/addresses/country | alpha3 | Three-digit country code |
UboPepData/data/addresses/country | numeric | Numeric country code |
UboPepData/data/addresses/count | commentName | |
UboPepData/data/Comments | value | |
UboPepData/data/functions | startDate | |
UboPepData/data/functions | endDate | |
UboPepData/data/functions | name | |
UboPepData/data/functions | function | |
UboPepData/data/media | title | Title of the content |
UboPepData/data/media | excerpt | Excerpt of the content |
UboPepData/data/media | url | URL to the content |
UboPepData/data/media | date | Date of the content |
UboPepData/data/roles | roleType | Screening type of role |
UboPepData/data/roles | organization | Screening organization |
UboPepData/data/roles | description | Screening description |
UboPepData/data/roles | startDate | Screening role start date |
UboPepData/data/roles | endDate | Screening role end date |
UboPepData/metadata | sources | List of sources for the data |
UboPepData/metadata | urls | Public URLs to the sources |
UboPepData/metadata | lastChanged | Date the data was last changed |
UboPepData/metadata | isCache | Whether data is retrieved from cache |
UboPepData/metadata | rawJson | The raw JSON if it was requested and supported by the source |