Data Dictionary

This document contains a basic detail about the messages exchanged in every step of the patterns for this iteration. More detailed information is available in the schema definition files.

RequestLookupRoutingInformationType

All the necessary parameters will be in the URL. It will be a comma-separated canonical evidence identifier collection (up to 20) followed by the AtuCode.

Detailed information is available in ‘IAL Technical Design’ Document.

ResponseLookupRoutingInformationType

Name	Type	Format	Mandatory	Description
ResponseLookupRoutingInformation	ResponseLookupRoutingInformationType	Not apply	Y	Root element
ResponseItem	ResponseItemType	Not apply	Y	Contains a list of available sources obtained.
Error	ErrorType	Cardinality 1..∞	Y	Contains the response error.

ResponseItemType

Location: //ResponseLookupRoutingInformation/ResponseItemType

Name	Type	Format	Mandatory	Description
ResponsePerCountry	ResponsePerCountryType	Cardinality 1..∞	Y	Contains the data for each source obtained.

ResponsePerCountryType

Location: //ResponseLookupRoutingInformation/ResponseItemType/ResponsePerCountryType

Name	Type	Format	Mandatory	Description
CountryCode	String	Attribute	Y	The two-letter code of the DP country. Format: ISO 3166-1 alfa-2 https://www.iso.org/obp/ui/
Provision	ProvisionType	Cardinality 1..∞	Y

ProvisionType

Location: //ResponseLookupRoutingInformation/ResponseItemType/ResponsePerCountryType/Provision

Name	Type	Format	Mandatory	Description
AtuLevel	String	Enumerated	N	Level of administration territorial unit. Allowed values: nuts0 à National level nuts1 à Regional/Province level nuts2 à Regional/Province level nuts3 à Regional/Province level lau à Local level edu à Educational level
AtuCode	String	Not apply	N	Code of the administrative territory unit.   Allowed values: ISO 3166-1 alfa-2 à For nuts0 Region à For nuts1-3 Municipality à For lau Educational Organization à For edu
AtuLatinName	String	Not apply	N	Name of the administrative territorial unit.
DataOwnerId	anyURI	Not apply	N	Identifies DataOwner in format iso6523. It defines Party ID for all participants MUST be UNIQUE Format: {PEPPOL ParticipantIdentifierScheme}::{Domain Scheme}:{Party Id} iso6523-actorid-upis::[0-9][0-9][0-9][0-9]:[A-Z0-9]{1,15} {PEPPOL ParticipantIdentifierScheme} à Must be a constant “iso6523-actorid-upis” {Domain Scheme} à Identifies ICD value, must be 4 UNIQUE digits in PEPPOL {Party Id} à Identifies DE4A Partner, consisting of: 2 letters country 2 digits entity type à 00 if entity is a DE4A partner, 88 if not 7 digits DE4A Partner For regional or local administrations, the entity type is 99 and the 7 digit number is the NUTS/LAU code without country letters and starting with as many zeros on the left as necessary until 7 digits. Example Spanish Municipality of San Sebastian with LAU code 20069: ES990020069 Example of Dutch Province of Groningen with NUTS code NL11: NL990000011 https://docs.peppol.eu/edelivery/policies/PEPPOL-EDN-Policy-for-use-of-identifiers-4.0-2019-01-28.pdf
DataOwnerPrefLabel	String	Not apply	N	Name of the issuing DO from which the evidence is obtained.
ParameterSet	ParameterSetType	Not apply	Y	Contains a list of necessary parameters for the requested evidence.

ParameterSetType

Location: //ResponseLookupRoutingInformation/ResponseItemType/ResponsePerCountryType/Provision/ProvisionType

Name	Type	Format	Mandatory	Description
Title	String	Not apply	Y	Name of the required parameter for the requested evidence.
Parameter	ParameterType	Cardinality 1..∞	Y	Contains the data for each necessary parameter of the requested evidence.

ParameterType

Location: //ResponseLookupRoutingInformation/ AvailableSources/Source/ProvisionItems/ProvisionItem/ParameterSet 

Name	Type	Format	Mandatory	Description
Name	String	Not apply	Y	Name of the parameter
Optional	Boolean	Not apply	Y	Indicates if the parameter is optional of not

ErrorType

Location: //ResponseLookupRoutingInformation

Name	Type	Format	Mandatory	Description
Code	String	Not apply	Y	Error code occurred. See [FIX TABLE/DOCUMENT ERRORS]
Text	String	Not apply	Y	Text defining the above code. See [FIX TABLE/DOCUMENT ERRORS]

RequestExtractMultiEvidenceIMType

Location: //RequestExtractMultiEvidenceIMType

Name	Type	Format	Mandatory	Description
RequestExtractMultiEvidenceIMType	RequestExtractMultiEvidenceIMType	Not apply	Y	Root element
RequestId	String	Not apply	Y	Request message identifier
SpecificationId	String	Not apply	Y	Version used and it will define the message structure.
Timestamp	Date	Not apply	Y	Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created.
ProcedureId	String	Not apply	N	Metadata about a procedure or public service.
DataEvaluator	AgentType	Not apply	Y	Identifier will be used to address the evidence back from the DataOwner.
DataOwner	AgentType	Not apply	Y	Indentifier indicates the component responsible of issuing the evidence.
RequestEvidenceIMItem	RequestEvidenceItemType	Cardinality 1..∞	Y	Cardinality 1..∞

AgentType

Location: //RequestExtractMultiEvidenceIMType/AgentType

Name	Type	Format	Mandatory	Description
AgentUrn	anyURI	Not apply	Y	Identifies DataOwner in format iso6523. Define Party ID for all participants MUST be UNIQUE Format: {PEPPOL ParticipantIdentifierScheme}::{Domain Scheme}:{Party Id} iso6523-actorid-upis::[0-9][0-9][0-9][0-9]:[A-Z0-9]{1,15} {PEPPOL ParticipantIdentifierScheme} à Must be a constant “iso6523-actorid-upis” {Domain Scheme} à Identifies ICD value, must be 4 UNIQUE digits in PEPPOL {Party Id} à Identifies DE4A Partner, consisting of: 2 letters country 2 digits entity type à 00 if entity is a DE4A partner, 88 if not 7 digits DE4A Partner For regional or local administrations, the entity type is 99 and the 7 digit number is the NUTS/LAU code without country letters and starting with as many zeros on the left as necessary until 7 digits. Example Spanish Municipality of San Sebastian with LAU code 20069: ES990020069 Example of Dutch Province of Groningen with NUTS code NL11: NL990000011 https://docs.peppol.eu/edelivery/policies/PEPPOL-EDN-Policy-for-use-of-identifiers-4.0-2019-01-28.pdf
AgentName	String	Not apply	Y	Name of the agent Data Owner.
RedirectUrl	String	Not apply	Y	Redirect URL to Data Owner.

RequestEvidenceItemType

Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType

Name	Type	Format	Mandatory	Description
RequestItemId	String	Not apply	Y	Evidence request unique id
DataRequestSubject	DataRequestSubjectCVType	Not apply	Y	Contains the identifying details of the person, company or representative to obtain the evidence.
CanonicalEvidenceTypeId	String	Not apply	Y	Identifier of the canonical evidence type. Format: urn:dea4-eu:CanonicalEvidenceType::<canonical-evidence-type-idtoken> Allowed values for <canonical-evidence-type-idtoken>: HigherEducationDiploma DomicileRegistrationEvidence BirthCertificate MarriageCertificate CompanyRegistration
RequestGrounds	RequestGrounds	Not apply	Y	Request grounds to request evidence.
AdditionalParameter	AdditionalParameterType	Cardinality 1..∞	N	Contains each additional parameter necessary to request the evidence.

DataRequestSubjectCVType

Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/DataRequestSubject

Name	Type	Format	Mandatory	Description
DataSubjectPerson	NaturalPersonIdentifierType	Not apply	Y	Contains the identifying details of the person to obtain the evidence.
DataSubjectCompany	LegalPersonIdentifierType	Not apply	Y	Contains the identifying details of the company to obtain the evidence.
DataSubjectRepresentative	NaturalPersonIdentifierType	Not apply	N	Contains the identifying details of the representative to obtain the evidence.

NaturalPersonIdentifierType

Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/DataRequestSubject/NaturalPersonIdentifierType

Name	Type	Format	Mandatory	Description
PersonIdentifier	String	Not apply	Y	Unique identifier for the natural person as defined by the eIDAS Regulation.
FirstName	String	Not apply	Y	Current given names of the natural person.
FamilyName	String	Not apply	Y	Current family name of the natural person.
DateOfBirth	Date	Not apply	Y	Date of birth for the natural person. Format: YYYY-MM-DD
Gender	String	Enumetared	Y	Gender of the natural person. Allowed values: Male Female Unspecified
BitrhName	String	Not apply	N	First name(s) and family name(s) of the natural person at birth.
PlaceOfBirth	String	Not apply	N	Place of birth for a natural person.
CurrentAddress	String	Not apply	N	Current address of the natural person as a base64 encoded string.

LegalPersonIdentifierType

Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/DataRequestSubject/LegalPersonIdentifierType

Name	Type	Format	Mandatory	Description
LegalPersonIdentifier	String	Not apply	Y	Unique identifier for the legal person as defined by the eIDAS Regulation.
LegalName	String	Not apply	Y	Current legal name for the legal person or organisation.
LegalAddress	String	Not apply	N	The address the legal person has registered with the MS authority or operating address if not registered.   For a company this should be the registered address within the MS issuing the eID as a base64 encoded string.
VATRegistration	String	Not apply	N	VAT - VAT registration number.
TaxReference	String	Not apply	N	TAX-Ref - tax reference number.
D-2012-17-EUIdentifier	String	Not apply	N	D-2012/17/EU - the identifier used under directive 2012/17/EU
LEI	String	Not apply	N	Legal Entity Identifier.
EORI	String	Not apply	N	Economic Operator Registration and Identification.
SEED	String	Not apply	N	System for Exchange of Excise Data.
SIC	String	Not apply	N	Standard Industrial Classification.

RequestGroundsType

Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/RequestGrounds

Name	Type	Format	Mandatory	Description
LawELIPermanentLink	anyURI	Not apply	Y	Permanent link allowing access to the system.
ExplicitRequest	token	Enumerated	Y	Consent allowing access to the system. Allowed values: SDGR14

AdditionalParameterType

Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/AdditionalPatameter

Name	Type	Format	Mandatory	Description
Label	String	Not apply	Y	Label identifying the required parameter.
Type	String	Enumerated	Y	Type of the required parameter. Allowed values: Date à Date tye InputText à Input Text type YesNo à Selector Yes/No type
Value	String	Not apply	Y	Value of the required parameter.