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 | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| ResponseLookupRoutingInformation | ResponseLookupRoutingInformationType | 1 | Y/Y | Root element |
| ResponseItem | ResponseItemType | 1..n | Y/Y | Contains a list of available sources obtained. |
| Error | ErrorType | 1..n | Y/Y | Contains the response error. |
Schema XSD
ResponseItemType
Location: //ResponseLookupRoutingInformation/ResponseItemType
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| ResponsePerCountry | ResponsePerCountryType | 1..n | Y/Y | Contains the data for each source obtained. |
ResponsePerCountryType
Location: //ResponseLookupRoutingInformation/ResponseItemType/ResponsePerCountryType
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| CountryCode | String | 1 | Y/Y | The two-letter code of the DP country.
Format: ISO 3166-1 alfa-2 |
| Provision | ProvisionType | 1..n | Y/Y | Contains the data of each possible provision. |
ProvisionType
Location: //ResponseLookupRoutingInformation/ResponseItemType/ResponsePerCountryType/Provision
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| AtuLevel | String | 1 | N/Y | Level of Administrative Territorial Unit.
Allowed values:
|
| AtuCode | String | 1 | N/Y | Code of the Administrative Territorial Unit.
Allowed values:
|
| AtuLatinName | String | 1 | N/Y | Name of the Administrative Territorial Unit. |
| DataOwnerId | anyURI | 1 | N/Y | Identifies the Data Owner in iso6523 format. It defines Party Id for all participants. It 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}
Example of the Spanish Municipality of San Sebastian with LAU code 20069: ES990020069 Example of the Dutch Province of Groningen with NUTS code NL11: NL990000011 For further information on the Domain Scheme values, see the codelists on the WP5 GitHub. |
| DataOwnerPrefLabel | String | 1 | N/Y | Name of the issuing DO from which the evidence is obtained. |
| ParameterSet | ParameterSetType | 0..n | Y/Y | Contains a list of necessary parameters for the requested evidence. |
ParameterSetType
Location: //ResponseLookupRoutingInformation/ResponseItemType/ResponsePerCountryType/Provision/ProvisionType
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| Title | String | 1 | Y/Y | Name of the required set of parameters for the requested evidence. |
| Parameter | ParameterType | 1..n | Y/Y | Contains the data for each necessary parameter of the requested evidence. |
ParameterType
Location: //ResponseLookupRoutingInformation/AvailableSources/Source/ProvisionItems/ProvisionItem/ParameterSet
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| Name | String | 1 | Y/Y | Name of the parameter |
| Optional | Boolean | 1 | Y/Y | Indicates whether the parameter is optional or not |
ErrorType
Location: //ResponseLookupRoutingInformation
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| Code | String | 1 | Y/Y | Code of the error occurred. See [FIX TABLE/DOCUMENT ERRORS] |
| Text | String | 1 | Y/Y | Text defining the above code. See [FIX TABLE/DOCUMENT ERRORS] |
RequestExtractMultiEvidenceIMType
Location: //RequestExtractMultiEvidenceIMType
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestExtractMultiEvidenceIMType | RequestExtractMultiEvidenceIMType | 1 | Y/Y | Root element |
| RequestId | String | 1 | Y/Y | Request identifier (UUID format). It is going to be the same during all interactions of this request. |
| SpecificationId | String | 1 | Y/Y | IEM version used |
| Timestamp | Date | 1 | Y/Y | Date and time when the message is created. |
| ProcedureId | String | 1 | N/Y | Metadata about the procedure or public service the justifies the use of the DE4A OOTS. |
| DataEvaluator | AgentType | 1 | Y/Y | Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator. |
| DataOwner | AgentType | 1 | Y/Y | Identifies the Data Owner to whom the request for evidence is sent. |
| RequestEvidenceIMItem | RequestEvidenceItemType | 1..n | Y/Y | Evidence item list requested. |
Schema XSD
AgentType
Location: //RequestExtractMultiEvidenceIMType/AgentType
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| AgentUrn | anyURI | 1 | Y/Y | Identifies the DE4A participant (Data Evaluator or Data Owner) in iso6523 format. It defines Party Id for all participants. It 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}
Example of the Spanish Municipality of San Sebastian with LAU code 20069: ES990020069 Example of the Dutch Province of Groningen with NUTS code NL11: NL990000011 For further information on the Domain Scheme values, see the codelists on the WP5 GitHub. |
| AgentName | String | 1 | Y/N | Name of the DE4A participant (Data Evaluator or Data Owner). |
| RedirectUrl | String | 0..1 | N/Y | Redirect URL to Data Owner. |
RequestEvidenceItemType
Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestItemId | String | 1 | Y/Y | Unique evidence request ID (UUID format) |
| DataRequestSubject | DataRequestSubjectCVType | 1 | Y/Y | Contains the identifying details of the person, company or representative to obtain the evidence. |
| CanonicalEvidenceTypeId | String | 1 | Y/Y | Identifier of the canonical evidence type. Format: urn:dea4-eu:CanonicalEvidenceType::<canonical-evidence-type-idtoken> Allowed values for <canonical-evidence-type-idtoken>:
See codelists in github for additional information. |
| RequestGrounds | RequestGroundsType | 1 | Y/Y | Request grounds to request evidence. |
| AdditionalParameter | AdditionalParameterType | 0..n | N/Y | Contains each additional parameter necessary to request the evidence. |
DataRequestSubjectCVType
Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/DataRequestSubject
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| DataSubjectPerson | NaturalPersonIdentifierType | 1 | Y/Y | Contains the identifying details of the person to obtain the evidence. |
| DataSubjectCompany | LegalPersonIdentifierType | 1 | Y/Y | Contains the identifying details of the company to obtain the evidence. |
| DataSubjectRepresentative | NaturalPersonIdentifierType | 0..1 | N/Y | Contains the identifying details of the representative to obtain the evidence. |
NaturalPersonIdentifierType
Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/DataRequestSubject/NaturalPersonIdentifierType
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| PersonIdentifier | String | 1 | Y/N | Unique identifier for the natural person as defined by the eIDAS Regulation. |
| FirstName | String | 1 | Y/N | Current given names of the natural person. |
| FamilyName | String | 1 | Y/N | Current family name of the natural person. |
| DateOfBirth | Date | 1 | Y/Y | Date of birth for the natural person.
Format: YYYY-MM-DD |
| Gender | String | 0..1 | N/Y | Gender of the natural person.
Allowed values:
See codelists in github for additional information. |
| BitrhName | String | 0..1 | N/N | First name(s) and family name(s) of the natural person at birth. |
| PlaceOfBirth | String | 0..1 | N/N | Place of birth for a natural person. |
| CurrentAddress | String | 0..1 | N/N | Current address of the natural person as a base64 encoded string. |
LegalPersonIdentifierType
Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/DataRequestSubject/LegalPersonIdentifierType
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| LegalPersonIdentifier | String | 1 | Y/N | Unique identifier for the legal person as defined by the eIDAS Regulation. |
| LegalName | String | 1 | Y/N | Current legal name for the legal person or organisation. |
| LegalAddress | String | 0..1 | N/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 | 0..1 | N/N | VAT - VAT registration number. |
| TaxReference | String | 0..1 | N/N | TAX-Ref - tax reference number. |
| D-2012-17-EUIdentifier | String | 0..1 | N/N | D-2012/17/EU - the identifier used under directive 2012/17/EU |
| LEI | String | 0..1 | N/N | Legal Entity Identifier. |
| EORI | String | 0..1 | N/N | Economic Operator Registration and Identification. |
| SEED | String | 0..1 | N/N | System for Exchange of Excise Data. |
| SIC | String | 0..1 | N/N | Standard Industrial Classification. |
RequestGroundsType
Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/RequestGrounds
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| LawELIPermanentLink | anyURI | 1 | Y/Y | Permanent link allowing access to the system. |
| ExplicitRequest | token | 1 | Y/Y | Consent allowing access to the system.
Allowed values: SDGR14 See codelists in github for additional information. |
AdditionalParameterType
Location: //RequestExtractMultiEvidenceIMType/RequestEvidenceItemType/AdditionalPatameter
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| Label | String | 1 | Y/Y | Label identifying the required parameter. |
| Type | String | 1 | Y/Y | Type of the required parameter.
Allowed values:
See codelists in github for additional information. |
| Value | String | 1 | Y/Y | Value of the required parameter. |
ResponseExtractMultiEvidenceType
Location: //ResponseExtractMultiEvidenceType
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestExtractMultiEvidenceIMType | ResponseExtractMultiEvidenceType | 1 | Y/Y | Root element |
| RequestId | String | 1 | Y/Y | Request identifier (UUID format). It is going to be the same during all interactions of this request. |
| Timestamp | Date | 1 | Y/Y | Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created. |
| DataEvaluator | AgentType | 1 | Y/Y | Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator. |
| DataOwner | AgentType | 1 | N/Y | Identifies the Data Owner to whom the request for evidence is sent. |
| ResponseExtractEvidenceItem | ResponseExtractEvidenceItemType | 1..n | Y/Y | Evidence item list requested. |
Schema XSD
ResponseExtractEvidenceItemType
Location: //ResponseExtractMultiEvidenceType/ResponseExtractEvidenceItem
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestItemId | String | 1 | Y/Y | Unique evidence request ID (UUID format) |
| DataRequestSubject | DataRequestSubjectCVType | 1 | Y/Y | Contains the identifying details of the person, company or representative to obtain the evidence. |
| CanonicalEvidenceTypeId | String | 1 | Y/Y | Identifier of the canonical evidence type.
Format: urn:dea4-eu:CanonicalEvidenceType::<canonical-evidence-type-idtoken> Allowed values for <canonical-evidence-type-idtoken>:
See codelists in github for additional information. |
| CanonicalEvidence | CanonicalEvidenceType | 1 | Y/Y | Canonical Evidence obtained. |
| DomesticEvidence | DomesticEvidenceType | 0..n | Y/Y | Contains the data of each domestic evidences obtained. |
| Error | ErrorType | 1..n | N/Y | Contains the data for each error that occurred. |
CanonicalEvidenceType
Location: //ResponseExtractMultiEvidenceType/ResponseExtractEvidenceItem/CanonicalEvidence
DomesticEvidenceType
Location: //ResponseExtractMultiEvidenceType/ResponseExtractEvidenceItem/DomesticEvidence
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| IssuingType | Token | 1 | Y/Y | Indicates what type of evidence it is:
OriginalIssuing: Original Evidence MultinlingualFormIssuing: Multilingual evidence |
| MimeType | normalizedString | 1 | Y/Y | Contains the MIME Type of the canonical evidence. https://docs.oasis-open.org/ubl/os-UBL-2.1/cva/UBL-DefaultDTQ-2.1.html#d4e1 |
| DataLanguage | language | 1 | Y/N | Contains the language of the canonical evidence. Values conform to RFC 3066, allowed values: Conformity to ISO 639 Conformity to ISO 3166 Languages registered by the Internet Assigned Numbers Authority (IANA) Expression pattern: [a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})* See codelists in github for additional information. |
| EvidenceData | base64Binary | 1 | Y/Y | Contains the domestic that the Data Owner system returns (in formats like XML, PDF, etc.) codified in B64. |
| AdditionalInfo | TextType | 0..1 | N/N | Contains additional information about domestic evidence. |
TextType
Location: //ResponseExtractMultiEvidenceType/ResponseExtractEvidenceItem/DomesticEvidence/AdditionalInfo
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| languageID | language | 0..1 | N/Y | The identifier of the language used in the content. |
| languageLocaleID | normalizedString | 0..1 | N/Y | The identification of the locale of the language. |
RequestExtractMultiEvidenceUSIType
Location: //ResponseExtractMultiEvidenceUSIType
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestExtractMultiEvidenceUSIType | RequestExtractMultiEvidenceType | 1 | Y/Y | Root element |
| RequestId | String | 1 | Y/Y | Request identifier (UUID format). It is going to be the same during all interactions of this request. |
| SpecificationId | String | 1 | Y/Y | IEM version used. |
| Timestamp | Date | 1 | Y/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 | 0..1 | N/Y | Metadata about the procedure or public service the justifies the use of the DE4A OOTS. |
| DataEvaluator | AgentType | 1 | Y/Y | Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator. |
| DataOwner | AgentType | 1 | Y/Y | Identifies the Data Owner to whom the request for evidence is sent. |
| RequestEvidenceUSIItem | RequestEvidenceUSIItemType | 1..n | Y/Y | Evidence item list requested |
Schema XSD
RequestExtractMultiEvidenceType
Location: //ResponseExtractMultiEvidenceUSIType/RequestEvidenceUSIItem
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestItemId | String | 1 | Y/Y | Unique evidence request ID (UUID format) |
| DataRequestSubject | DataRequestSubjectCVType | 1 | Y/Y | Contains the identifying details of the person, company or representative to obtain the evidence. |
| CanonicalEvidenceTypeId | String | 1 | Y/Y | Identifier of the canonical evidence type.
Format: urn:dea4-eu:CanonicalEvidenceType::<canonical-evidence-type-idtoken>
See codelists in github for additional information. |
| RequestGrounds | RequestGrounds | 1 | Y/Y | Request grounds to request evidence. |
| AdditionalParameter | AdditionalParameterType | 0..n | N/Y | Contains each additional parameter necessary to request the evidence. |
| DataEvaluatorURL | anyUri | 1 | Y/Y | Indicates the redirection url to return the user to the e-procedure portal of the data evaluator |
RedirectUserType
Location: //RedirectUserType
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RedirectUserType | RedirectUserType | 1 | Y/Y | Root element |
| RequestId | String | 1 | Y/Y | Request identifier (UUID format). It is going to be the same during all interactions of this request. |
| SpecificationId | String | 1 | Y | IEM version used |
| Timestamp | Date | 1 | Y/Y | Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created. |
| DataEvaluator | AgentType | 1 | Y/Y | Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator. |
| DataOwner | AgentType | 1 | Y/Y | Identifies the Data Owner to whom the request for evidence is sent. |
| CanonicalEvidenceTypeId | String | 1 | Y/Y | Identifier of the canonical evidence type.
Format: urn:dea4-eu:CanonicalEvidenceType::<canonical-evidence-type-idtoken> Allowed values for <canonical-evidence-type-idtoken>:
See codelists in github for additional information. |
| RedirectURL | anyURI | 1 | Y/Y | Indicates the redirection url for the user to choose and preview the evidence. |
| Error | ErrorType | 0..n | N/Y | Contains the response error. |
Schema XSD
RequestEventSubscriptionType
Location: //RequestEventSubscriptionType
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestEventSubscriptionType | RequestEventSubscriptionType | 1 | Y/Y | Root element |
| RequestId | String | 1 | Y/Y | Request identifier (UUID format). It is going to be the same during all interactions of this request. |
| SpecificationId | String | 1 | Y/Y | IEM version used |
| Timestamp | Date | 1 | Y/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 | 0..1 | N/Y | Metadata about the procedure or public service the justifies the use of the DE4A OOTS. |
| DataEvaluator | AgentType | 1 | Y/Y | Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator. |
| DataOwner | AgentType | 1 | Y/Y | Identifies the Data Owner to whom the request for evidence is sent. |
| EventSubscripRequestItem | EventSubscripRequestItemType | 1..n | Y/Y | Subscription item list requested. |
Schema XSD
EventSubscripRequestItemType
Location: //RequestEventSubscriptionType/EventSubscripRequestItem
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestItemId | string | 1 | Y/Y | Unique evidence request ID (UUID format) |
| DataRequestSubject | DataRequestSubjectCVType | 1 | Y/Y | Contains the identifying details of the person, company or representative to obtain the evidence. |
| CanonicalEventCatalogUri | anyUri | 1 | Y/Y | |
| SubscriptionPeriod | TimePeriodType | 0..1 | Y/Y | Period dates of the subscription |
TimePeriodType
Location: //RequestEventSubscriptionType/EventSubscripRequestItem/SubscriptionPeriod
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| StartDate | dateTime | 1 | Y/Y | Subscription Start Date |
| EndDate | dateTime | 0..1 | N/Y | Subscription End Date |
ResponseEventSubscriptionType
Location: //ResponseEventSubscriptionType
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| ResponseEventSubscriptionType | ResponseEventSubscriptionType | 1 | Y | Root element |
| RequestId | String | 1 | Y | Request identifier (UUID format). It is going to be the same during all interactions of this request. |
| Timestamp | Date | 1 | Y | Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created. |
| DataEvaluator | AgentType | 1 | Y | Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator. |
| DataOwner | AgentType | 1 | Y | Identifies the Data Owner to whom the request for evidence is sent. |
| ResponseEventSubscriptionItem | ResponseEventSubscriptionItemType | 1..n | Y | Subscription item list requested. |
Schema XSD
ResponseEventSubscriptionItemType
Location: //ResponseEventSubscriptionType/ResponseEventSubscriptionItem
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestItemId | string | 1 | Y | Unique evidence request ID (UUID format) |
| CanonicalEventCatalogUri | anyUri | 1 | Y | |
| SubscriptionPeriod | TimePeriodType | 1 | Y | Period dates of the subscription |
EventNotificationType
Location: //EventNotificationType
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| EventNotificationType | EventNotificationType | 1 | Y | Root element |
| NotificationId | String | 1 | Y | Request notification identifier |
| Timestamp | Date | 1 | Y | Date and time when the message is created. Its value will not be changed when subsequent messages having this timestamp attribute are created. |
| DataEvaluator | AgentType | 1 | Y | Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator. |
| DataOwner | AgentType | 1 | Y | Identifies the Data Owner to whom the request for evidence is sent. |
| EventNotificationItem | EventNotificationItemType | 1..n | Y | Evidence item list requested. |
Schema XSD
EventNotificationItemType
Location: //EventNotificationType/EventNotificationItem
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| NotificationItemId | string | 1 | Y | Unique notification ID |
| EventId | string | 1 | Y | Unique event ID |
| EventSubject | DataRequestSubjectCVType | 1 | Y | Contains the identifying details of the person, company or representative to obtain the evidence. |
| CanonicalEventCatalogUri | anyUri | 1 | Y | |
| EventDate | Datetime | 1 | Y | Date of the event notification |
| RelatedEventSubject | DataRequestSubjectCVType | 0..n | Y |
RequestExtractMultiEvidenceLUType
Location: //RequestExtractMultiEvidenceLUType
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestExtractMultiEvidenceLUType | RequestExtractMultiEvidenceLUType | 1 | Y | Root element |
| RequestId | String | 1 | Y | Request identifier (UUID format). It is going to be the same during all interactions of this request. |
| SpecificationId | String | 1 | Y | IEM version used |
| Timestamp | Date | 1 | 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 | 0..1 | N | Metadata about the procedure or public service the justifies the use of the DE4A OOTS. |
| DataEvaluator | AgentType | 1 | Y | Identifies the Data Evaluator who is making the request for evidence. This information is also used to route the responses from the Data Owner to the Data Evaluator. |
| DataOwner | AgentType | 1 | Y | Identifies the Data Owner to whom the request for evidence is sent. |
| RequestEvidenceLUItem | RequestEvidenceLUItemType | 1..n | Y | Evidence item list requested. |
Schema XSD
RequestEvidenceLUItemType
Location: //RequestExtractMultiEvidenceLUType/RequestEvidenceLUItem
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| RequestItemId | String | 1 | Y | Unique evidence request ID (UUID format) |
| DataRequestSubject | DataRequestSubjectCVType | 1 | Y | Contains the identifying details of the person, company or representative to obtain the evidence. |
| CanonicalEvidenceTypeId | String | 1 | Y | Identifier of the canonical evidence type.
Format: urn:dea4-eu:CanonicalEvidenceType::<canonical-evidence-type-idtoken>
See codelists in github for additional information. |
| RequestGrounds | RequestGrounds | 1 | Y | Request grounds to request evidence. |
| AdditionalParameter | AdditionalParameterType | 0..n | N/Y | Contains each additional parameter necessary to request the evidence. |
| EventNotificationRef | String | 1 | Y | Reference of the notification event |
ResponseErrorType
Location: //ResponseErrorType
| Name | Type | Cardinality | Mandatory Field / Label | Description |
|---|---|---|---|---|
| Ack | boolean | 1 | Y/Y | |
| Error | ErrorType | 0..n | N/Y | Error |





























