ovip-0013.md

OVIP: 13
Title: OpenVASP Core Data Types
Author: David Riegelnig <[email protected]>
Discussions-To: https://community.openvasp.org/#narrow/stream/21-protocol-.2F.20ovip
Status: Accepted
Type: Standard
Created: 2020-06-14

Abstract

This OVIP defines core data types for the OpenVASP protocol containing a hierarchical element structure, logical rules and data formats.

Specification

1. Core Data Types (Top Level Element Structure)

1.1. VASP

Level 1	Name	Type	Mult.	Rules	IVMS101 Ref.
VASP Identifier	vaspid	String(12)	1..1	1
Natural person	natural	see 2.1	0..1	2	naturalPerson
Legal person	legal	see 2.2	0..1	2, 3	legalPerson
Address	address	see 2.3	1..1		geographicAddress
National identification	id	see 2.4	1..*	3	nationalIdentification

Rules:

1. vaspid must be a VASP Identifier as specified in ovip-0002.
2. Either natural or legal must be present, but not both.
3. If legal is present, id must contain at least one sub element where id_type (see 2.4) has one of the following values: RAID, LEIX, TXID or MISC.

1.2. Originator

Level 1	Name	Type	Mult.	Rules	IVMS101 Ref.
Natural person	natural	see 2.1	0..1	1, 2	naturalPerson
Legal person	legal	see 2.2	0..1	1, 3	legalPerson
Address	address	see 2.3	0..1	2	geographicAddress
National identification	id	see 2.4	0..*	2, 3	nationalIdentification
Customer identification	cid	see 2.5	0..*	2

Rules:

1. Either natural or legal must be present, but not both.
2. Either address or id or cid or birth (sub element of natural, see 2.1) must be present. More than one can be present.
3. If legal and id are both present, id must contain at least one sub element where id_type (see 2.4) has one of the following values: RAID, LEIX, TXID or MISC.

1.3. Beneficiary

Level 1	Name	Type	Mult.	Rules	IVMS101 Ref.
Natural person	natural	see 2.1	0..1	1	naturalPerson
Legal person	legal	see 2.2	0..1	1	legalPerson
Address	adress	see 2.3	0..1		geographicAddress
National identification	id	see 2.4	0..*		nationalIdentification
Customer identification	cid	see 2.5	0..*

Rules:

1. Either natural or legal must be present, but not both.

2. Sub Elements

2.1. Natural Person

Level 2	Name	Type	Mult.	Rules	IVMS101 Ref.
Name	name	see 2.1.1	1..*	1	nameIdentifier
Name local	name_local	see 2.1.1	0..*		localNameIdentifier
Name phonetic	name_phonetic	see 2.1.1	0..*		phoneticNameIdentifier
Date/place of birth	birth	see 2.1.2	0..1		dateAndPlaceOfBirth
Country of residence	ctry_residence	String(2)	0/1..1	2	countryOfResidence

Rules:

1. name must have at least one sub element where name_type (see 2.1.1) has the value LEGL.
2. ctry_residence must be formatted as per ISO 3166-1 alpha-2.

2.1.1. Natural Person Name

Level 3	Name	Type	Mult.	Rules	IVMS101 Ref.
Primary name	name_primary	String(100)	1..1		primaryIdentifier
Secondary name	name_secondary	String(100)	0..1		secondaryIdentifier
Natural person name type	name_type	see 3.1	1..1		nameIdentifierType

2.1.2 Daten and Place of Birth

Level 3	Name	Type	Mult.	Rules	IVMS101 Ref.
Date of birth	birthdate	String(10)	1..1	1	dateOfBirth
Place of birth	birthplace	String(70)	1..1		placeOfBirth

Rules:

1. birthdate must be a date prior to the current date and formatted as per ISO 8601 (YYYY-MM-DD).

2.2. Legal Person

Level 2	Name	Type	Mult.	Rules	IVMS101 Ref.
Name	name	see 2.2.1	1..*	1	nameIdentifier
Name local	name_local	see 2.2.1	0..*		localNameIdentifier
Name phonetic	name_phonetic	see 2.2.1	0..*		phoneticNameIdentifier
Country of registration	ctry_reg	String(2)	0/1..1	2	countryOfRegistration

Rules:

1. name must have at least one sub element where leg_nametype (see 2.2.1) has the value LEGL.
2. ctry_reg must be formatted as per ISO 3166-1 alpha-2.

2.2.1. Legal Person Name

Level 3	Name	Type	Mult.	Rules	IVMS101 Ref.
Legal person name	leg_name	String(100)	1..1		legalPersonName
Legal person name type	leg_nametype	see 3.2	1..1		legalPersonNameIdentifierType

2.3. Address

Level 2	Name	Type	Mult.	Rules	IVMS101 Ref.
Address type	adr_type	see 3.3	1..1		addressType
Department	dep	String(50)	0..1		department
Sub department	dep_sub	String(70)	0..1		subDepartment
Street name	street	String(70)	0..1	1	streetName
Building number	bldg_no	String(16)	0..1	1	buildingNumber
Building name	bldg	String(35)	0..1	1	buildingName
Floor	floor	String(70)	0..1		floor
Post office box	box	String(16)	0..1		postBox
Room	room	String(70)	0..1		room
Post code	postcode	String(16)	0..1		postcode
Town	town	String(35)	1..1		townName
Town location	location	String(35)	0..1		townLocationName
District	district	String(35)	0..1		districtName
Country subdivision	country_sub	String(35)	0..1		countrySubDivision
Address line	adr_line	String(70)	0..7	1	addressLine
Country	ctry	String(2)	1..1	2	country

Rules:

1. One of the following combinations of elements must be present: street/bldg_no or street/bldg or at least one occurrence of adr_line.
2. ctry must be formatted as per ISO 3166-1 alpha-2.

2.4. National Identification Type

Level 2	Name	Type	Mult.	Rules	IVMS101 Ref.
National Identifier	id_id	String(35)	1..1		nationalIdentifier
National Identifier Type	id_type	see 3.4	1..1	2, 3	nationalIdentifierType
Country of issue	id_ctry	String(2)	0..1	1, 4	countryOfIssue
Registration Authority	id_reg	String(8)	0..1	2, 3, 5	registrationAuthority

Rules:

1. If legal is present in the parent element on level 1, id_ctry must not be present.
2. If legal is present in the parent element on level 1 and the value of id_type is not LEIX (see 3.4), id_reg must be present.
3. If the value of id_type is LEIX (see 3.4), id_reg must not be present.
4. id_ctry must be formatted as per ISO 3166-1 alpha-2.
5. id_reg must be a valid GLEIF Registration Authority Code (see: https://www.gleif.org/en/about-lei/code-lists/gleif-registration-authorities-list).

2.5. Customer Identification Type

Level 2	Name	Type	Mult.	Rules	IVMS101 Ref.
VAAN	vaan	String(24)	0..1	1, 2
Generic identifier	cid_id	String(50)	0..1	1	customerIdentification

Rules:

1. Either vaan or cid_id must be present, or both.
2. vaan must be a VAAN as specified in ovip-0002.

3. Code Tables

3.1. Natural Person Name Type

Identifies the nature of the name being specified for a natural person (IVMS Ref. NaturalPersonNameTypeCode).

Code	Name	Description
ALIA	Alias name	A name other than the legal name by which a natural person is also known
BIRT	Name at birth	The name given to a natural person at birth
MAID	Maiden name	The original name of a natural person who has changed their name after marriage
LEGL	Legal name	The name that identifies a natural person for legal, official or administrative purposes
MISC	Unspecified	A name by which a natural person may be known but cannot otherwise be categorized

3.2. Legal Person Name Type

Identifies the nature of the name being specified for a legal person (IVMS Ref. LegalPersonNameTypeCode).

Code	Name	Description
LEGL	Legal name	Official name under which an organization is registered
SHRT	Short name	Short name of the organization
TRAD	Trading name	Name used by the organization for commercial purposes

3.3. Address Type Values

Identifies the nature of the address (IVMS Ref. AddressTypeCode).

Code	Name	Description
HOME	Residential	Home address
BIZZ	Business	Business address
GEOG	Geographic	Unspecified physical address

3.4. National Identifier Type Values

Identifies the national identification type (IVMS Ref. NationalIdentifierTypeCode).

Code	Name	Description
ARNU	Alien registration number	Number assigned by a government agency to identify foreign nationals
CCPT	Passport number	Number assigned by a passport authority
RAID	Registration authority identifier	Identifier of a legal entity as maintained by a registration entity
DRLC	Driver license number	Number assigned to a driver's license
FIIN	Foreign investment identity number	Number assigned to a foreign investor (other than the alien number)
TXID	Tax identification number	Number assigned by a tax authority to an entity
SOCS	Social security number	Number assigned by a social security agency
IDCD	Identity card number	Number assigned by a national authority to an identity card
LEIX	Legal Entity Identifier	Legal Entity Identifier (LEI) as per ISO 17442
MISC	Unspecified	A national identifier which is known but cannot be categorized by the sender

Backwards Compatibility

The specification proposed in this OVIP is not backwards compatible.