OVIP: 17
Title: Increase InterVASP IVMS101 compatibility
Author: Lucas Betschart <[email protected]>
Discussions-To: https://github.com/OpenVASP/ovips/issues/27
Status: Accepted
Type: Standard
Created: 2021-07-17
This OVIP adjusts the naming of the core data types for the OpenVASP protocol to increase compatibility with InterVASP IVMS101. It supersedes OVIP 13.
Level 1 | Name | Type | Mult. | Rules |
---|---|---|---|---|
VASP Identifier | vaspid |
String(12) | 1..1 | 1 |
Natural person | naturalPerson |
see 2.1 | 0..1 | 2 |
Legal person | legalPerson |
see 2.2 | 0..1 | 2, 3 |
Address | geographicAddress |
see 2.3 | 1..1 | |
National identification | nationalIdentification |
see 2.4 | 1..* | 3 |
Rules:
vaspid
must be a VASP Identifier as specified in OVIP 2.- Either
naturalPerson
orlegalPerson
must be present, but not both. - If
legalPerson
is present,nationalIdentification
must contain at least one sub element wherenationalIdentifierType
(see 2.4) has one of the following values:RAID
,LEIX
,TXID
orMISC
.
Level 1 | Name | Type | Mult. | Rules |
---|---|---|---|---|
Natural person | naturalPerson |
see 2.1 | 0..1 | 1, 2 |
Legal person | legalPerson |
see 2.2 | 0..1 | 1, 3 |
Address | geographicAddress |
see 2.3 | 0..1 | 2 |
National identification | nationalIdentification |
see 2.4 | 0..* | 2, 3 |
Customer identification | cid |
see 2.5 | 0..* | 2 |
Rules:
- Either
naturalPerson
orlegalPerson
must be present, but not both. - Either
geographicAddress
ornationalIdentification
orcid
ordateAndPlaceOfBirth
(sub element ofnatural
, see 2.1) must be present. More than one can be present. - If
legalPerson
andnationalIdentification
are both present,nationalIdentification
must contain at least one sub element wherenationalIdentifierType
(see 2.4) has one of the following values:RAID
,LEIX
,TXID
orMISC
.
Level 1 | Name | Type | Mult. | Rules |
---|---|---|---|---|
Natural person | naturalPerson |
see 2.1 | 0..1 | 1 |
Legal person | legalPerson |
see 2.2 | 0..1 | 1 |
Address | geographicAddress |
see 2.3 | 0..1 | |
National identification | nationalIdentification |
see 2.4 | 0..* | |
Customer identification | cid |
see 2.5 | 0..* |
Rules:
- Either
naturalPerson
orlegalPerson
must be present, but not both.
Level 2 | Name | Type | Mult. | Rules |
---|---|---|---|---|
Name | nameIdentifier |
see 2.1.1 | 1..* | 1 |
Name local | localNameIdentifier |
see 2.1.1 | 0..* | |
Name phonetic | phoneticNameIdentifier |
see 2.1.1 | 0..* | |
Date/place of birth | dateAndPlaceOfBirth |
see 2.1.2 | 0..1 | |
Country of residence | countryOfResidence |
String(2) | 0/1..1 | 2 |
Rules:
nameIdentifier
must have at least one sub element wherenameIdentifierType
(see 2.1.1) has the valueLEGL
.countryOfResidence
must be formatted as per ISO 3166-1 alpha-2.
Level 3 | Name | Type | Mult. | Rules |
---|---|---|---|---|
Primary name | primaryIdentifier |
String(100) | 1..1 | |
Secondary name | secondaryIdentifier |
String(100) | 0..1 | |
Natural person name type | nameIdentifierType |
see 3.1 | 1..1 |
Level 3 | Name | Type | Mult. | Rules |
---|---|---|---|---|
Date of birth | dateOfBirth |
String(10) | 1..1 | 1 |
Place of birth | placeOfBirth |
String(70) | 1..1 |
Rules:
dateOfBirth
must be a date prior to the current date and formatted as per ISO 8601 (YYYY-MM-DD).
Level 2 | Name | Type | Mult. | Rules |
---|---|---|---|---|
Name | nameIdentifier |
see 2.2.1 | 1..* | 1 |
Name local | name_local |
see 2.2.1 | 0..* | |
Name phonetic | name_phonetic |
see 2.2.1 | 0..* | |
Country of registration | countryOfRegistration |
String(2) | 0/1..1 | 2 |
Rules:
nameIdentifier
must have at least one sub element wherelegalPersonNameIdentifierType
(see 2.2.1) has the valueLEGL
.countryOfRegistration
must be formatted as per ISO 3166-1 alpha-2.
Level 3 | Name | Type | Mult. | Rules |
---|---|---|---|---|
Legal person name | legalPersonName |
String(100) | 1..1 | |
Legal person name type | legalPersonNameIdentifierType |
see 3.2 | 1..1 |
Level 2 | Name | Type | Mult. | Rules |
---|---|---|---|---|
Address type | addressType |
see 3.3 | 1..1 | |
Department | department |
String(50) | 0..1 | |
Sub department | subDepartment |
String(70) | 0..1 | |
Street name | streetName |
String(70) | 0..1 | 1 |
Building number | buildingNumber |
String(16) | 0..1 | 1 |
Building name | buildingName |
String(35) | 0..1 | 1 |
Floor | floor |
String(70) | 0..1 | |
Post office box | postBox |
String(16) | 0..1 | |
Room | room |
String(70) | 0..1 | |
Post code | postcode |
String(16) | 0..1 | |
Town | townName |
String(35) | 1..1 | |
Town location | townLocationName |
String(35) | 0..1 | |
District | district |
String(35) | 0..1 | |
Country subdivision | country_sub |
String(35) | 0..1 | |
Address line | addressLine |
String(70) | 0..7 | 1 |
Country | country |
String(2) | 1..1 | 2 |
Rules:
- One of the following combinations of elements must be present:
streetName
/buildingNumber
orstreetName
/buildingName
or at least one occurrence ofaddressLine
. country
must be formatted as per ISO 3166-1 alpha-2.
Level 2 | Name | Type | Mult. | Rules |
---|---|---|---|---|
National Identifier | nationalIdentifier |
String(35) | 1..1 | |
National Identifier Type | nationalIdentifierType |
see 3.4 | 1..1 | 2, 3 |
Country of issue | countryOfIssue |
String(2) | 0..1 | 1, 4 |
Registration Authority | registrationAuthority |
String(8) | 0..1 | 2, 3, 5 |
Rules:
- If
legalPerson
is present in the parent element on level 1,countryOfIssue
must not be present. - If
legalPerson
is present in the parent element on level 1 and the value ofnationalIdentifierType
is notLEIX
(see 3.4),registrationAuthority
must be present. - If the value of
nationalIdentifierType
isLEIX
(see 3.4),registrationAuthority
must not be present. countryOfIssue
must be formatted as per ISO 3166-1 alpha-2.registrationAuthority
must be a valid GLEIF Registration Authority Code (see: https://www.gleif.org/en/about-lei/code-lists/gleif-registration-authorities-list).
Level 2 | Name | Type | Mult. | Rules |
---|---|---|---|---|
VAAN | vaan |
String(24) | 0..1 | 1, 2 |
Generic identifier | customerIdentification |
String(50) | 0..1 | 1 |
Rules:
- Either
vaan
orcustomerIdentification
must be present, or both. vaan
must be a VAAN as specified in OVIP 2.
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 |
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 |
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 |
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 |
The specification proposed in this OVIP is not backwards compatible.