Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Schema: Edits to property titles and descriptions plus codelists, closes #480 #623

Merged
merged 10 commits into from
Apr 10, 2024
12 changes: 6 additions & 6 deletions schema/codelists/addressType.csv
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
code,title,description,technical note
placeOfBirth,Place of birth,The place where a person was born. This must only be used to describe natural persons. Only a town and country are required.,
residence,Residential address,An address where someone lives. This must only be used for natural persons.,
registered,Registered address,An official address for delivering statutory mail and legal notices which must be provided to company registers. This must only be used to describe entities.,
service,Service address,An address which can be used as an alternative to a residential address for the purpose of receiving post. This must only be used for natural persons.,
alternative,Alternative address,An address provided in addition to the primary address for this entity or person that is neither a service nor a registered address.,
business,Business address,A place where the entity conducts its business.,
placeOfBirth,Place of birth,"The place where a person was born. A town (in the `address` field) and `country` may be sufficient information.",
kd-ods marked this conversation as resolved.
Show resolved Hide resolved
residence,Residential address,"An address where someone lives. This MUST only apply to natural persons.",
registered,Registered address,"An official address for delivering statutory mail and legal notices which must be provided to company registers. This MUST only apply to entities.",
service,Service address,"An address which can be used as an alternative to a residential address for the purpose of receiving post. This MUST only apply to natural persons.",
alternative,Alternative address,"An address provided in addition to the primary address for this entity or person that is neither a service nor a registered address.",
business,Business address,"A place where the entity conducts its business.",
2 changes: 1 addition & 1 deletion schema/codelists/annotationMotivation.csv
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ commenting,Commenting,"The description field provides contextual comments for a
correcting,Correcting,"The value of this field, object or statement has been corrected, using the method in the description field and/or from the original value given in the description field.",
identifying,Identifying,"The value of this field, object or statement has been augmented or processed for the purpose of identifying natural persons or legal entities, using the method in the description field.",
linking,Linking,"The description explains how linked material relates to the field, object or statement. A URL to linked material MUST be provided in the `url` field.",
transformation,Transformation,"The values of this field, object or statement have been changed from their original form using the method in the description field. The transformed representation may be provided in the transformedContent field.",
transformation,Transformation,"The values of this field, object or statement have been changed from their original form using the method in the description field. The transformed representation may be provided in the `transformedContent` field.",
6 changes: 3 additions & 3 deletions schema/codelists/directOrIndirect.csv
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
code,title,description,technical note
direct,Direct,The interest is held directly.,
indirect,Indirect,The interest is held through one or more intermediate entities (including arrangements).,
unknown,Unknown,The interest may be direct or indirect.,
direct,Direct,"The interest is held directly.",
indirect,Indirect,"The interest is held through one or more intermediate entities (including arrangements).",
unknown,Unknown,"The interest may be direct or indirect.",
kd-ods marked this conversation as resolved.
Show resolved Hide resolved
10 changes: 5 additions & 5 deletions schema/codelists/entitySubtypeCategory.csv
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
code,title,description,technical note
governmentDepartment,Government department,"An element of government with executive responsibilities. Terms often used to designate such a body: ministry, department, bureau or office. This MUST be used with entityType `stateBody`.",
stateAgency,State Agency,A body overseeing or administering elements of public policy. State agencies may have responsiblities which are devolved from government departments or from the state's legislative body. This MUST be used with entityType `stateBody`.,
other,Other,Any other type of entity.,
trust,Trust,A trust or trust like arrangement. An arrangement where a settlor transfers ownership of assets to trustees to control for the benefit of beneficiaries. This MUST be used with entityType arrangement or legalEntity,
nomination,Nomination,An agreement where a nominator instructs a nominee to act on their behalf in a specified capacity. This MUST be used with entityType arrangement.,
governmentDepartment,Government department,"An element of government with executive responsibilities. Terms often used to designate such a body: ministry, department, bureau or office. This MUST be used with `entityType.type` 'stateBody'.",
kd-ods marked this conversation as resolved.
Show resolved Hide resolved
stateAgency,State Agency,"A body overseeing or administering elements of public policy. State agencies may have responsibilities which are devolved from government departments or from the state's legislative body. This MUST be used with `entityType.type` 'stateBody.",
other,Other,"Any other type of entity.",
trust,Trust,"A trust or trust like arrangement. An arrangement where a settlor transfers ownership of assets to trustees to control for the benefit of beneficiaries. This MUST be used with `entityType.type` 'arrangement' or 'legalEntity'.",
nomination,Nomination,"An agreement where a nominator instructs a nominee to act on their behalf in a specified capacity. This MUST be used with `entityType.type` 'arrangement'.",
10 changes: 5 additions & 5 deletions schema/codelists/entityType.csv
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
code,title,description,technical note
registeredEntity,Registered Entity,"Any legal entity created through an act of official registration. In most cases, registered entities will have an official issued identifier.",
registeredEntity,Registered Entity,"A legal entity created through an act of official registration. In most cases, registered entities have an officially issued identifier.",
legalEntity,Legal entity,"A body with distinct legal personality, such as an international institution or statutory corporation, but which is not otherwise uniquely identified in some official register.",
arrangement,Arrangement,"An artificial entity, created by agreements, contracts or other processes.",
anonymousEntity,Anonymous entity,"An entity that has been identified, but for which identifying information is being withheld. The reason for non-disclosure should be given in the accompanying `unspecifiedEntityDetails` field.",
unknownEntity,Unknown entity,An entity that has not been identified.,
arrangement,Arrangement,"A legal arrangement, agreement, contract or other mechanism via which one or more natural or legal persons can associate to exert ownership or control over an entity. Parties to an arrangement have no other form of collective legal identity.",
anonymousEntity,Anonymous entity,"An entity that has been identified, but for which identifying information is being withheld. The reason for non-disclosure should be given in the accompanying `unspecifiedEntityDetails` field.",
unknownEntity,Unknown entity,"An entity that has not been identified.",
state,State,"A country, nation or community with legal sovereignty within a territory.",
stateBody,State body,A core administrative or legislative unit within a state's apparatus.,
stateBody,State body,"A core administrative or legislative unit within a state's apparatus.",
30 changes: 15 additions & 15 deletions schema/codelists/interestType.csv
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
code,title,description,technical note
shareholding,Shareholding,An economic interest in an entity gained by holding shares.,
shareholding,Shareholding,"An economic interest in an entity gained by holding shares.",
votingRights,Voting rights,"A controlling interest in an entity gained by holding shares. Defined as the right of shareholders to vote on matters of corporate policy, including decisions on the makeup of the board of directors, issuing securities, initiating corporate actions and making substantial changes in the corporation's operations.",
appointmentOfBoard,Appointment of board,A controlling interest in an entity. Defined as the absolute right to appoint members of the board of directors.,
appointmentOfBoard,Appointment of board,"A controlling interest in an entity. Defined as the absolute right to appoint members of the board of directors.",
otherInfluenceOrControl,Other influence or control,"Any influence or control in an entity that is distinct from being a shareholder, having voting rights or having the absolute right to appoint to the board.",
seniorManagingOfficial,Senior managing official,A controlling interest in an entity gained by employment. Defined as the person who exercises control over the management of the entity.,
seniorManagingOfficial,Senior managing official,"A controlling interest in an entity gained by employment. Defined as the person who exercises control over the management of the entity.",
settlor,Settlor,"A settlor is a person who, either actually or by operation of law, creates a trust. A settlor of a trust is sometimes also known by other names such as a trustor, a grantor or a donor. Also to be used for a person with a settlor-equivalent role in any legal arrangement that is similar to a trust.",
kd-ods marked this conversation as resolved.
Show resolved Hide resolved
trustee,Trustee,A trustee is a person who administers the trust for the benefit of a third party and in whom the legal title of the trust property is vested either by declaration of the settlor or by operation of law. Also to be used for a person with a trustee-equivalent role in any legal arrangement that is similar to a trust.,
trustee,Trustee,"A trustee is a person who administers the trust for the benefit of a third party and in whom the legal title of the trust property is vested either by declaration of the settlor or by operation of law. Also to be used for a person with a trustee-equivalent role in any legal arrangement that is similar to a trust.",
kd-ods marked this conversation as resolved.
Show resolved Hide resolved
protector,Protector,"A protector is a person appointed to protect the interests or wishes of the settlor, providing influence and guidance to the trustee who administers the trust. Also to be used for a person with a protector-equivalent role in any legal arrangement that is similar to a trust.",
kd-ods marked this conversation as resolved.
Show resolved Hide resolved
beneficiaryOfLegalArrangement,Beneficiary of a legal arrangement,An economic interest in a trust or other legal arrangement. Defined as a person or legal entity who benefits from a trust or other legal arrangement's holdings or activities.,
rightsToSurplusAssetsOnDissolution,Rights to surplus assets on dissolution,The right to a share in the amount of an asset or resource that exceeds the portion that is utilized upon the winding up of an entity.,
rightsToProfitOrIncome,Rights to receive profits or income,An economic interest in an entity. Defined as beneficial ownership rights beyond those otherwise implied by ownership structures that are granted by contract.,
rightsGrantedByContract,Rights granted by contract,An interest that is granted by contract.,
conditionalRightsGrantedByContract,Conditional rights granted by contract,An interest that exists only if some contractual condition is met.,
controlViaCompanyRulesOrArticles,Control via company rules or articles,Control of an entity gained through a provision in company articles or by shareholder agreement.,
beneficiaryOfLegalArrangement,Beneficiary of a legal arrangement,"An economic interest in a trust or other legal arrangement. Defined as a person or legal entity who benefits from a trust or other legal arrangement's holdings or activities.",
kd-ods marked this conversation as resolved.
Show resolved Hide resolved
rightsToSurplusAssetsOnDissolution,Rights to surplus assets on dissolution,"The right to a share in the amount of an asset or resource that exceeds the portion that is utilized upon the winding up of an entity.",
rightsToProfitOrIncome,Rights to receive profits or income,"An economic interest in an entity. Defined as beneficial ownership rights beyond those otherwise implied by ownership structures that are granted by contract.",
rightsGrantedByContract,Rights granted by contract,"An interest that is granted by contract.",
conditionalRightsGrantedByContract,Conditional rights granted by contract,"An interest that exists only if some contractual condition is met.",
controlViaCompanyRulesOrArticles,Control via company rules or articles,"Control of an entity gained through a provision in company articles or by shareholder agreement.",
controlByLegalFramework,Control by legal framework,"Control of an entity gained through a legal framework, such as a combination of legislation (primary and secondary). This type of interest is created by governments and legislators in order to establish and guide agencies and entities linked to the state.",
boardMember,Board member,One of a group of people constituted as the strategic decision-making body of an organization.,
boardMember,Board member,"One of a group of people constituted as the strategic decision-making body of an organization.",
boardChair,Board chair,"The person holding the most power and authority on the board of directors. They also provide leadership to the firm's officers and executives, and ensure that the firm's duties to shareholders are being fulfilled by acting as a link between the board and upper management.",
kd-ods marked this conversation as resolved.
Show resolved Hide resolved
unknownInterest,Unknown interest,"The interestedParty is known to have an interest in the subject of this Ownership-or-control Statement, but the nature of the interest is unknown.",
unpublishedInterest,Unpublished interest,The nature of this interest is known but is not published.,
enjoymentAndUseOfAssets,Enjoyment and use of assets,A controlling interest in an asset owned by an entity. Defined as the right to make use of assets belonging to an entity.,
rightToProfitOrIncomeFromAssets,Right to profit or income from assets,An economic interest in an asset owned by an entity. Defined as the right to derive profits and/or income from assets belonging to an entity.,
unknownInterest,Unknown interest,"The interestedParty is known to have an interest in the subject of this Relationship Statement, but the nature of the interest is unknown.",
unpublishedInterest,Unpublished interest,"The nature of this interest is known but is not published.",
enjoymentAndUseOfAssets,Enjoyment and use of assets,"The use of assets belonging to an entity.",
rightToProfitOrIncomeFromAssets,Right to profit or income from assets,"The right to derive profits and/or income from assets belonging to an entity.",
kd-ods marked this conversation as resolved.
Show resolved Hide resolved
8 changes: 4 additions & 4 deletions schema/codelists/nameType.csv
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
code,title,description,technical note
legal,Legal name,"A name that identifies the person for legal, administrative and other official purposes. A person's legal name will usually be the one that is found on official government documents.",
translation,Translation of name,A translation of the person's legal name in a different language.,
transliteration,Transliteration of name,A transliteration of the person's legal name in a different script.,
former,Former name,A name that the person has used in the past.,
translation,Translation of name,"A translation of the person's legal name in a different language.",
transliteration,Transliteration of name,"A transliteration of the person's legal name in a different script.",
former,Former name,"A name that the person has used in the past.",
alternative,Alternative name,"Another name that the person is known by. This might be an alias, a nickname or a name that the person is also known as (aka).",
birth,Birth name,The legal name of the person at birth.,
birth,Birth name,"The legal name of the person at birth.",
6 changes: 3 additions & 3 deletions schema/codelists/personType.csv
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
code,title,description,technical note
knownPerson,Known person,"This person has been identified, and information such as names, identifiers or biographical information may be provided about them.",
anonymousPerson,Anonymous person,"This person has been identified, but identifying information is being withheld. The reason for non disclosure should be given in the accompanying `unspecifiedPersonDetails` field.",
unknownPerson,Unknown person,The identity of this person has not been discovered or confirmed.,
knownPerson,Known person,"A natural person who has been identified, and information such as names, identifiers or biographical information can be provided about them.",
anonymousPerson,Anonymous person,"A natural person who has been identified, but identifying information is being withheld. The reason for non-disclosure should be given in the accompanying `unspecifiedPersonDetails` field.",
unknownPerson,Unknown person,"A natural person whose identity has not been discovered or confirmed.",
6 changes: 3 additions & 3 deletions schema/codelists/recordStatus.csv
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
code,title,description,technical note
new,New Record,"This is a new record",
updated,Updated Record,"This is an update to an existing record",
closed,Closed Record,"This is a closed record",
new,New Record,"Indicates that this is the first Statement published pertaining to the record referenced by `recordId`.",
kd-ods marked this conversation as resolved.
Show resolved Hide resolved
updated,Updated Record,"Indicates that this Statement updates information published in a prior Statement pertaining to the record referenced by `recordId`.",
kd-ods marked this conversation as resolved.
Show resolved Hide resolved
closed,Closed Record,"Indicates that this is the final Statement published pertaining to the record referenced by `recordId`.",
6 changes: 3 additions & 3 deletions schema/codelists/recordType.csv
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
code,title,description,technical note
person,Person Record,"The record contains information known about a natural person at a particular point in time, or from a given submission of information.",The recordDetails object should be validated using the Person Record schema.
entity,Entity Record,"The record contains information that identifies and describes an entity at a particular point in time, or from a given submission of information.",The recordDetails object should be validated using the Entity Record schema.
relationship,Relationship Record,The record contains details of the interests held by an interested party in an entity at a particular point in time.,The recordDetails object should be validated using the Relationship Record schema.
person,Person,"The Record Details in this Statement contain information about a natural person at a particular point in time.",The recordDetails object should be validated using the Person Record schema.
entity,Entity,"The Record Details in this Statement contain information that identifies and describes an entity at a particular point in time.",The recordDetails object should be validated using the Entity Record schema.
relationship,Relationship,"The Record Details in this Statement describe the interests held by an interested party in a subject (an entity) at a particular point in time.",The recordDetails object should be validated using the Relationship Record schema.
Loading
Loading