20.3. PDND e-Service Template

The PDND provides a specialized tool that enhances API co-design processes by optimizing e-service publication and reuse. This functionality is defined in this document.

  • "Linee Guida sull'infrastruttura tecnologica della Piattaforma Digitale Nazionale Dati per l'interoperabilità dei sistemi informativi e delle basi di dati" (PDND).

The template e-service serves as a standardized blueprint containing all necessary technical and descriptive metadata for an e-service. API Managers, who can be either Providers or Consumers within the PDND ecosystem, MAY create and maintain these templates.

Once a template e-service is published, it is accessible through the PDND Template Catalog, a centralized repository that facilitates discovery and reuse. This catalog enables any authorized PDND Participant to browse available templates and instantiate new e-services based on existing designs.

20.3.1. PDND Template e-service definition and guidelines

The PDND infrastructure supports the lifecycle management of Template E-Services, similar to that of traditional e-services. The lifecycle states include: Draft, Active, Suspended, and Deprecated. As with traditional e-services, PDND enforces role-based access control to govern status transitions.

20.3.1.1. Templates e-service Management

20.3.1.1.1. Template E-Service Creation

Participants are enabled to create Templates E-Service via a guided wizard accessible through the PDND Web GUI (APIs will be available in the future). The creation workflow closely mirrors that of standard e-service creation, with the following distinctions:

  • An additional field identifies the intended recipient of the template.

  • The "Audience" field is omitted.

  • Thresholds are optional and serve as recommendations for Participants implementing the template.

Participants are prohibited from creating multiple templates with the same name: template names MUST be unique per participant. Upon creation, a template is initially set to the Draft state. Templates can then be published to the Template Catalog, thereby making them accessible to all Participants.

20.3.1.1.2. Template E-Service Modification

Participants who have created a template may edit it. The scope of editable fields depends on the template’s lifecycle state:

  • If the template is in Draft state, all fields are editable.

  • For templates in other states, only a restricted subset of fields can be modified directly.

  • Fields that cannot be modified in published templates require the creation of a new template version to apply changes.

Template versioning operates similarly to that of e-services, given that changes to the blueprint can impact instantiated services and then the Participants who consume that instance.

The following fields may be edited without triggering a new template version:

  • Name

  • Intended Recipient

  • Description

  • Voucher Time Limit

  • Documentation (excluding the OpenAPI specification)

  • Attributes

20.3.1.1.3. Template E-Service Suspension

Templates, like e-services, can be Suspended. When suspended:

  • The template is removed from the templates public catalog.

  • Instantiation of new instances from the suspended template is disabled.

  • Previously instantiated instances remain unaffected.

  • Templates may be reactivated at any time.

  • Templates cannot be deleted.

20.3.1.1.4. Template E-Service Instantiation

Participants MAY instantiate a Template E-Service by browsing the Template Catalog and selecting a template. This process generates a new e-service.

Instantiation constraints include:

  • Only templates in the Active state are eligible for instantiation.

  • The instantiation is facilitated through a guided wizard in the PDND Web GUI.

  • Due to the standardization objective of templates, most fields are pre-populated and immutable during instantiation.

  • The following information cannot be modified during instantiation:

    • Documentation upload

    • Token expiration time

    • Name, description, and attributes

Instead, the following fields must be specified during instantiation:

  • Audience

  • Thresholds

  • Automatic/Manual Approval Policy

Additionally, although the OpenAPI specification is fixed, the following metadata fields can be provided so that PDND can automatically update the YAML specification:

  • Contacts (name, email, URL, Terms and Conditions URL)

  • Server URLs

Each instantiated e-service maintains an independent lifecycle analogous to standard e-services.

20.3.1.2. Version Management

Template versioning follows a controlled process:

  • Publishing a new template version sets it to Active.

  • The previously Active version is automatically transitioned to Deprecated.

  • Only one Active version per template is allowed at any time.

  • Templates may also have a single Draft version coexisting with the Active version.

Instances derived from templates maintain independent versioning since Participants may update instance-specific fields (e.g., server URLs) multiple times, while the instance remains linked to the originating template version.

Consequently, template versions and instance versions are independent and not directly correlated.

Participants instantiating a template may then update either the specific instance or, if available, upgrade to a newer template version.

20.3.1.3. Authentic Source Template

The template e-service functionality is employed to standardize data transmission from Authentic Sources to Credential Issuers. The template e-service SHOULD be published within PDND by the Credential Issuer and is accessible through the PDND Template Catalog.

20.3.1.3.1. Authentic Source Template Parameters

The template e-service MUST adhere to the following specifications:

  • Name: IT Wallet - Authentic Source - <Credential name>

  • Intended Recipients: IT Wallet - Authentic Source - <Authentic Source domain>

  • Description: Description text useful to the Credential Issuer about the new Credential <Credential name>

  • Technology: REST

  • Data variation via Signal Hub: True

  • Version changelog: Authentic Source e-service via template implementation

  • Voucher Time Limit: 20

  • Suggest custom threshold: False

  • Suggest manual agreement approval policy: False

  • Attributes: <Offcial name of the Credential Issuer Public Authority>

20.3.1.3.2. Authentic Source Template Instantiation

Each Authentic Source SHOULD instantiate the IT Wallet - Authentic Source template e-service in PDND. The instantiation process will result in a new e-service that MUST satisfy the following requirements:

  • Signal Hub: True

  • Manual agreement approval policy: False

  • Daily API calls threshold for each provider: greater than 10000

  • Daily API calls threshold: greater than 10000

Additional information required during the creation process is provider-dependent.

20.3.1.3.3. Authentic Source PDND OpenAPI Specification

Below is the complete Open API Specification for the Authentic Source PDND e-services:

  1openapi: 3.0.1
  2info:
  3  title: IT Wallet API - AS web services
  4  version: 0.2.0
  5  description: |
  6    # IT Wallet Authentic Source e-Service exposed via PDND.
  7    ### ModI patterns to be used:
  8      - <b>ID_AUTH_CHANNEL_01</b>: Direct Trust TLS (HTTPS)
  9      - <b>ID_AUTH_REST_01</b>: Authorization via PDND token
 10      - <b>INTEGRITY_REST_02</b>: Requests and responses are signed
 11      - <b>AUDIT_REST_02</b>: Additional properties (the pattern is optional if DPoP Token is used)
 12      - <b>DPoP Token</b>: Used as an alternative to a Bearer Token (optional)
 13  termsOfService: "https://authentic-source.example.it/tos/"
 14  contact:
 15    name: IT-Wallet <credential_name> <credential_provider>
 16    url: https://github.com/italia/eid-wallet-it-docs
 17  x-api-id: ASITW-01
 18  x-summary: IT-Wallet Authentic Source API.
 19servers:
 20  - url: https://test.authentic-source.example.it/v0.2.0
 21    description: Authentic Source API test server
 22  - url: https://authentic-source.example.it/v0.2.0
 23    description: Authentic Source API production server
 24security:
 25  - BearerAuth: []
 26  - DPoPAuth: []
 27paths:
 28  /status:
 29    get:
 30      tags:
 31        - status
 32      summary: Get Authentic Source API status.
 33      description: Health-check endpoint that returns the operational status of the Authentic Source API.
 34      operationId: authenticSourceStatus
 35      parameters:
 36        - name: DPoP
 37          in: header
 38          description: Use only if the DPoP voucher has been requested from PDND.
 39          schema:
 40            type: string
 41            format: JWT
 42          required: false
 43      responses:
 44        "200":
 45          description: Service available
 46          content:
 47            application/problem+json:
 48              schema:
 49                $ref: "#/components/schemas/ProblemDetails"
 50          headers:
 51            Cache-Control:
 52              $ref: "#/components/headers/CacheControlHeader"
 53            X-RateLimit-Limit:
 54              $ref: "#/components/headers/RateLimitLimitHeader"
 55            X-RateLimit-Remaining:
 56              $ref: "#/components/headers/RateLimitRemainingHeader"
 57            X-RateLimit-Reset:
 58              $ref: "#/components/headers/RateLimitResetHeader"
 59        "429":
 60          description: Too Many Requests
 61          content:
 62            application/problem+json:
 63              schema:
 64                $ref: "#/components/schemas/ProblemDetails"
 65          headers:
 66            # RFC 6585 defines Retry-After. X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset are not required because redundant along with Retry-After.
 67            Retry-After:
 68              $ref: "#/components/headers/RetryAfterHeader"
 69        "503":
 70          description: Service Unavailable
 71          content:
 72            application/problem+json:
 73              schema:
 74                $ref: "#/components/schemas/ProblemDetails"
 75          headers:
 76            Retry-After:
 77              $ref: "#/components/headers/RetryAfterHeader"
 78
 79  /attribute-claims/{datasetId}:
 80    post:
 81      tags:
 82        - credential
 83      summary: Get Attribute Claims
 84      description: >-
 85        This service provides the Credential Issuer with all attribute claims necessary for the issuance of a Digital Credential
 86      operationId: attributeClaims
 87      parameters:
 88        - in: path
 89          name: datasetId
 90          schema:
 91            type: string
 92          required: true
 93          description: Identifier of the dataset as registered in the Authentic Source Registry
 94        - name: DPoP
 95          in: header
 96          description: Use only if the DPoP voucher has been requested from PDND.
 97          schema:
 98            type: string
 99            format: JWT
100          required: false
101        - name: Agid-JWT-Signature
102          in: header
103          description: >-
104            JWT containing the signature of the message headers whose integrity
105            needs to be guaranteed, to comply with the INTEGRITY_REST_02
106            security pattern (see <a target="blank"
107            href="https://italia.github.io/eid-wallet-it-docs/versione-corrente/en/e-service-pdnd.html">e-Service PDND</a>). <br/><br/>
108
109            <a target="blank" href="https://jwt.io/#debugger-io?token=eyJhbGciOiJFUzI1NiIsImtpZCI6ImQ0YzNiMmExLTk4NzYtNTQzMi0xMGZlLWRjYmE5ODc2NTQzMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiI4MjkxNGIzZi02MGIyLTQ1MjktYjRkNi0zZDRlNjdmMGE5MzMiLCJzdWIiOiI4MjkxNGIzZi02MGIyLTQ1MjktYjRkNi0zZDRlNjdmMGE5MzMiLCJhdWQiOiJodHRwczovL2F1dGhlbnRpYy1zb3VyY2UuZXhhbXBsZS5pdCIsImlhdCI6MTczMzM5Nzg0MCwibmJmIjoxNzMzNDAxNjI4LCJleHAiOjE3MzM0MDE0NDAsImp0aSI6ImQzZjdiMmM5LTI3NGEtNDJiNy04ZjhkLTJlOWQ4YjE3MzRiMCIsInNpZ25lZF9oZWFkZXJzIjpbeyJkaWdlc3QiOiJTSEEtMjU2PTcyZTE4YmRkZGYxM2M5MTFiNGRkNTYyZWUyMTk3OWE1YzlmMjM1YzNhMDFiZDE0MjZlODU3ZDhjMWEyODJmNDEifSx7ImNvbnRlbnQtdHlwZSI6ImFwcGxpY2F0aW9uL2pzb24ifV19.tG5-P96CCA6N1IYC-xk4GumoVkA3NFolpbBn2vQ2e9vpWQ8f5Sm2l4-1VrXfKTx-CUVz_puiwqkBhulrNKj2fA">EXAMPLE
110            ON JWT.IO</a>
111          required: true
112          schema:
113            type: string
114            format: JWT
115            example: eyJhbGciOiJFUzI1NiIsImtpZCI6ImQ0YzNiMmExLTk4NzYtNTQzMi0xMGZlLWRjYmE5ODc2NTQzMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiI4MjkxNGIzZi02MGIyLTQ1MjktYjRkNi0zZDRlNjdmMGE5MzMiLCJzdWIiOiI4MjkxNGIzZi02MGIyLTQ1MjktYjRkNi0zZDRlNjdmMGE5MzMiLCJhdWQiOiJodHRwczovL2F1dGhlbnRpYy1zb3VyY2UuZXhhbXBsZS5pdCIsImlhdCI6MTczMzM5Nzg0MCwibmJmIjoxNzMzNDAxNjI4LCJleHAiOjE3MzM0MDE0NDAsImp0aSI6ImQzZjdiMmM5LTI3NGEtNDJiNy04ZjhkLTJlOWQ4YjE3MzRiMCIsInNpZ25lZF9oZWFkZXJzIjpbeyJkaWdlc3QiOiJTSEEtMjU2PTcyZTE4YmRkZGYxM2M5MTFiNGRkNTYyZWUyMTk3OWE1YzlmMjM1YzNhMDFiZDE0MjZlODU3ZDhjMWEyODJmNDEifSx7ImNvbnRlbnQtdHlwZSI6ImFwcGxpY2F0aW9uL2pzb24ifV19.tG5-P96CCA6N1IYC-xk4GumoVkA3NFolpbBn2vQ2e9vpWQ8f5Sm2l4-1VrXfKTx-CUVz_puiwqkBhulrNKj2fA
116        - name: Digest
117          in: header
118          description: >-
119            Digest of the message payload, to comply with the INTEGRITY_REST_02
120            security pattern. According to <a target="blank" href="https://www.rfc-editor.org/rfc/rfc3230.html#section-4.2">RFC
121            3230 §4.2</a>, the format MUST be the following: digest-algorithm=encoded
122            digest output.
123          required: true
124          schema:
125            type: string
126            example: SHA-256=72e18bdddf13c911b4dd562ee21979a5c9f235c3a01bd1426e857d8c1a282f41
127        - name: Agid-JWT-TrackingEvidence
128          in: header
129          description: >-
130            If the Voucher type is Bearer, this header represents a JWT acting as a proof of possession, to comply with the REST_JWS_2021_POP security
131            pattern using the POP_TPoP implementation. Otherwise, it is a JWT containing the data tracked in the Consumer's domain, to comply with AUDIT_REST_02 (see <a target="blank"
132            href="https://italia.github.io/eid-wallet-it-docs/versione-corrente/en/e-service-pdnd.html">e-Service PDND</a>). <br/><br/>
133            <a target="blank" href="https://jwt.io/#debugger-io?token=eyJhbGciOiJFUzI1NiIsImtpZCI6ImQ0YzNiMmExLTk4NzYtNTQzMi0xMGZlLWRjYmE5ODc2NTQzMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiI4MjkxNGIzZi02MGIyLTQ1MjktYjRkNi0zZDRlNjdmMGE5MzMiLCJhdWQiOiJodHRwczovL2F1dGhlbnRpYy1zb3VyY2UuZXhhbXBsZS5pdCIsImV4cCI6MTczMzA1MjYwMCwibmJmIjoxNzMzMDM2NDUwLCJpYXQiOjE3MzMwMzY0MDAsImp0aSI6ImE0YjVjNmQ3LWU4ZjktYWJjZC1lZjEyLTM0NTY3ODkwMTIzNCIsImRub25jZSI6NjUyODQyNDIxMzY4NSwicHVycG9zZUlkIjoiYjJjM2Q0ZTUtZjZnNy1oOGk5LWowazEtbG1ubzEyMzQ1Njc4IiwidXNlcklEIjoiYThiN2M2ZDUtZTRmMy1nMmgxLWk5ajAta2xtbm9wcXJzdHV2IiwibG9hIjoic3Vic3RhbnRpYWwifQ.y42yfMeW2H9h0b0j0BODUml8yF20stY9q3BwoVU5BB90afBj852Q0QlInncdhjXhUjLS1V76cGBxkutDNvxRNA">EXAMPLE
134            ON JWT.IO</a>
135          required: false
136          schema:
137            type: string
138            format: JWT
139            example: eyJhbGciOiJFUzI1NiIsImtpZCI6ImQ0YzNiMmExLTk4NzYtNTQzMi0xMGZlLWRjYmE5ODc2NTQzMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiI4MjkxNGIzZi02MGIyLTQ1MjktYjRkNi0zZDRlNjdmMGE5MzMiLCJhdWQiOiJodHRwczovL2F1dGhlbnRpYy1zb3VyY2UuZXhhbXBsZS5pdCIsImV4cCI6MTczMzA1MjYwMCwibmJmIjoxNzMzMDM2NDUwLCJpYXQiOjE3MzMwMzY0MDAsImp0aSI6ImE0YjVjNmQ3LWU4ZjktYWJjZC1lZjEyLTM0NTY3ODkwMTIzNCIsImRub25jZSI6NjUyODQyNDIxMzY4NSwicHVycG9zZUlkIjoiYjJjM2Q0ZTUtZjZnNy1oOGk5LWowazEtbG1ubzEyMzQ1Njc4IiwidXNlcklEIjoiYThiN2M2ZDUtZTRmMy1nMmgxLWk5ajAta2xtbm9wcXJzdHV2IiwibG9hIjoic3Vic3RhbnRpYWwifQ.y42yfMeW2H9h0b0j0BODUml8yF20stY9q3BwoVU5BB90afBj852Q0QlInncdhjXhUjLS1V76cGBxkutDNvxRNA
140      requestBody:
141        required: true
142        content:
143          application/json:
144            schema:
145              $ref: "#/components/schemas/CredentialClaimsRequest"
146      responses:
147        "200":
148          description: OK
149          headers:
150            Agid-JWT-Signature:
151              description: JWT containing the signature of the message headers whose integrity needs to be guaranteed, to comply with the INTEGRITY_REST_02 security pattern (see <a target="blank" href="https://italia.github.io/eid-wallet-it-docs/versione-corrente/en/e-service-pdnd.html">e-Service PDND</a>). <a target="blank" href="https://jwt.io/#debugger-io?token=ew0KICAiYWxnIjogIkVTMjU2IiwNCiAgImtpZCI6ICJhMWY1YzhkMi00YjM3LTRlOTEtYjBkMi03OWUzZjBjNGE4ZWYiLA0KICAidHlwIjogIkpXVCINCn0.ew0KICAiaXNzIjogIjEyMzRhYmNkLWVmNTYtZ2g3OC1pOWowLWtsbW5vcHFyc3R3eCIsDQogICJzdWIiOiAiMTIzNGFiY2QtZWY1Ni1naDc4LWk5ajAta2xtbm9wcXJzdHd4IiwNCiAgImF1ZCI6ICJodHRwczovL2ZydWl0b3JlLmV4YW1wbGUvZW50ZS1leGFtcGxlL3YxIiwNCiAgImlhdCI6IDE3MzMzOTc4NDAsDQogICJuYmYiOiAxNzMzNDAxNjI4LA0KICAiZXhwIjogMTczMzQwMTQ0MCwNCiAgImp0aSI6ICI4ZTEyZjRiNy05YzNhLTRmODMtOWI4ZC01MWEyYzdmNmU5ZDQiLA0KICAic2lnbmVkX2hlYWRlcnMiOiBbDQogICAgew0KICAgICAgImRpZ2VzdCI6ICJTSEEtMjU2PTc5YTIwYTc0NDMzNjQyMDMwMTgzMDYwMGFkOWJkY2E5OTM1OTNmODc2MjA5YTAwNGI1OTliNTgzMDk1YjBhNjEiDQogICAgfSwNCiAgICB7DQogICAgICAiY29udGVudC10eXBlIjogImFwcGxpY2F0aW9uL2pzb24iDQogICAgfQ0KICBdDQp9.DpuBNo2UgQhL7WLin4mpdZrbIpQq3tPvCX6HfktkxG7L5mk6a8OK1Hg0mQcZfFi3gelS-aL9kFS-6MoSy4csBg">EXAMPLE
152              required: true
153              schema:
154                type: string
155            Digest:
156              description: Digest of the message payload, to comply with the INTEGRITY_REST_02 security pattern. According to RFC 3230 Section 4.2 <a target="blank" href="https://www.rfc-editor.org/rfc/rfc3230.html#section-4.2">RFC 3230 §4.2</a>, the format MUST be the following digest-algorithm=encoded digest output.
157              required: true
158              schema:
159                type: string
160                example: SHA-256=79a20a744336420301830600ad9bdca993593f876209a004b599b583095b0a61
161            Cache-Control:
162              $ref: "#/components/headers/CacheControlHeader"
163            X-RateLimit-Limit:
164              $ref: "#/components/headers/RateLimitLimitHeader"
165            X-RateLimit-Remaining:
166              $ref: "#/components/headers/RateLimitRemainingHeader"
167            X-RateLimit-Reset:
168              $ref: "#/components/headers/RateLimitResetHeader"
169          content:
170            application/json:
171              schema:
172                $ref: "#/components/schemas/CredentialClaimsResponse"
173              example:
174                interval: 864000
175                userClaims:
176                  given_name: "Mario"
177                  family_name: "Rossi"
178                  birth_date: "1980-01-10"
179                  place_of_birth:
180                    country: "IT"
181                    region: "Roma"
182                    locality: "Roma"
183                  tax_id_code: "TINIT-RSSMRA80A01H501Z"
184                  personal_administrative_number: "12345A123A"
185                attributeClaims:
186                  - object_id: "6F9619FF-8B86-D011-B42D-00C04FC964FF"
187                    status: "VALID"
188                    last_updated: "2025-01-15T10:30:00Z"
189                    institute_name: "Nome Istituto Universitario"
190                    programme_type_name: "Laurea Magistrale"
191                    degree_course_name: "Computer Science - Informatica"
192                    academic_qualification_date: "2025-06-25"
193                  - object_id: "7A0720AB-9C97-E122-C53E-11D05FD075GG"
194                    status: "VALID"
195                    last_updated: "2025-01-10T08:00:00Z"
196                    institute_name: "Nome Istituto Universitario"
197                    programme_type_name: "Laurea Triennale"
198                    degree_course_name: "Informatica"
199                    academic_qualification_date: "2022-11-27"
200                metadataClaims:
201                  - object_id: "6F9619FF-8B86-D011-B42D-00C04FC964FF"
202                    issuance_date: "2025-06-25"
203                  - object_id: "7A0720AB-9C97-E122-C53E-11D05FD075GG"
204                    issuance_date: "2022-11-27"
205        "400":
206          description: Bad Request
207          content:
208            application/problem+json:
209              schema:
210                $ref: "#/components/schemas/ProblemDetails"
211          headers:
212            X-RateLimit-Limit:
213              $ref: "#/components/headers/RateLimitLimitHeader"
214            X-RateLimit-Remaining:
215              $ref: "#/components/headers/RateLimitRemainingHeader"
216            X-RateLimit-Reset:
217              $ref: "#/components/headers/RateLimitResetHeader"
218        "401":
219          description: Unauthorized
220          content:
221            application/problem+json:
222              schema:
223                $ref: "#/components/schemas/ProblemDetails"
224          headers:
225            X-RateLimit-Limit:
226              $ref: "#/components/headers/RateLimitLimitHeader"
227            X-RateLimit-Remaining:
228              $ref: "#/components/headers/RateLimitRemainingHeader"
229            X-RateLimit-Reset:
230              $ref: "#/components/headers/RateLimitResetHeader"
231            WWW-Authenticate:
232              $ref: "#/components/headers/WWWAuthenticateHeader"
233        "404":
234          description: Claims not found
235          content:
236            application/problem+json:
237              schema:
238                $ref: "#/components/schemas/ProblemDetails"
239          headers:
240            X-RateLimit-Limit:
241              $ref: "#/components/headers/RateLimitLimitHeader"
242            X-RateLimit-Remaining:
243              $ref: "#/components/headers/RateLimitRemainingHeader"
244            X-RateLimit-Reset:
245              $ref: "#/components/headers/RateLimitResetHeader"
246        "429":
247          description: Too Many Requests
248          content:
249            application/problem+json:
250              schema:
251                $ref: "#/components/schemas/ProblemDetails"
252          headers:
253            # RFC 6585 defines Retry-After. X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset are not required because redundant along with Retry-After.
254            Retry-After:
255              $ref: "#/components/headers/RetryAfterHeader"
256        "500":
257          description: Internal Server Error.
258          content:
259            application/problem+json:
260              schema:
261                $ref: "#/components/schemas/ProblemDetails"
262          headers:
263            Retry-After:
264              $ref: "#/components/headers/RetryAfterHeader"
265        "503":
266          description: Service Unavailable
267          content:
268            application/problem+json:
269              schema:
270                $ref: "#/components/schemas/ProblemDetails"
271          headers:
272            Retry-After:
273              $ref: "#/components/headers/RetryAfterHeader"
274
275tags:
276  - name: status
277    description: Endpoint di health check dell'API.
278  - name: credential
279    description: Retrieve information about the credential.
280
281components:
282  securitySchemes:
283    BearerAuth:
284      type: http
285      scheme: bearer
286      bearerFormat: JWT
287      description: PDND Bearer Token
288    DPoPAuth:
289      type: apiKey
290      in: header
291      name: DPoP
292      description: DPoP proof JWT (RFC 9449).
293
294  headers:
295    CacheControlHeader:
296      schema:
297        type: string
298        enum:
299          - no-store
300      description: no-store
301    RateLimitLimitHeader:
302      schema:
303        type: integer
304        format: int32
305        minimum: 0
306      description: Maximum number of requests within the time window.
307    RateLimitRemainingHeader:
308      schema:
309        type: integer
310        format: int32
311        minimum: 0
312      description: Remaining requests within the time window.
313    RateLimitResetHeader:
314      schema:
315        type: integer
316        format: int32
317        minimum: 0
318      description: UTC epoch in seconds, corresponding to when the window for the current rate limit will reset.
319    RetryAfterHeader:
320      schema:
321        type: integer
322        format: int32
323        minimum: 0
324      description: Seconds to wait before receiving another response.
325    WWWAuthenticateHeader:
326      schema:
327        type: string
328        example: >-
329          Bearer error="invalid_token", error_description="The access token expired"
330      description: The request cannot be fulfilled because the Voucher is expired, revoked or otherwise malformed. See <a target="blank" href="https://datatracker.ietf.org/doc/html/rfc6750.html#section-3">RFC6750</a> and <a target="blank" href="https://datatracker.ietf.org/doc/html/rfc9449.html#section-7.1-11">RFC9449</a> for details.
331
332  schemas:
333    CredentialClaimsResponse:
334      type: object
335      properties:
336        userClaims:
337          description: List of User Claims.
338          type: object
339          properties:
340            given_name:
341              description: Current First Name.
342              type: string
343              example: "Mario"
344            family_name:
345              description: Current Family Name.
346              type: string
347              example: "Rossi"
348            birth_date:
349              description: Date of Birth.
350              type: string
351              example: "1980-01-10"
352            place_of_birth:
353              $ref: "#/components/schemas/place_of_birth"
354            tax_id_code:
355              description: National tax identification number. REQUIRED if personal_administrative_number is absent.
356              type: string
357              example: "TINIT-XXXXXXXXXXXXXXXX"
358            personal_administrative_number:
359              description: National unique identifier of a natural person. REQUIRED if tax_id_code is absent.
360              type: string
361              example: "XX00000XX"
362        attributeClaims:
363          description: List of Datasets of Attribute.
364          type: array
365          items:
366            type: object
367            properties:
368              object_id:
369                description: Unique identifier of the Dataset. It MUST NOT contain personal data. Required also if additionalProperties are not present. This parameter MUST be used to notify through Signal Hub data updating or availability.
370                type: string
371                example: "6F9619FF-8B86-D011-B42D-00C04FC964FF"
372              issuance_date:
373                description: Administrative validity start date of the Dataset
374                type: string
375                example: "2025-01-01"
376              expiry_date:
377                description: Administrative expiry date of the Dataset.
378                type: string
379                example: "2025-12-31"
380            additionalProperties:
381              oneOf:
382                - type: string
383                - type: integer
384                  format: int32
385                - type: integer
386                  format: int64
387                - type: number
388                  format: float
389                - type: number
390                  format: double
391                - type: boolean
392                - type: array
393                  items:
394                    $ref: '#/components/schemas/additionalPropertiesArray'
395                - type: object
396                  additionalProperties:
397                    $ref: '#/components/schemas/additionalPropertiesObject'
398            required: [object_id]
399        metadataClaims:
400          description: List of Metadata of Attribute.
401          type: array
402          items:
403            type: object
404            properties:
405              object_id:
406                description: Unique identifier of the Dataset. It MUST NOT contain personal data.
407                type: string
408                example: "6F9619FF-8B86-D011-B42D-00C04FC964FF"
409              description:
410                description: Human-Readable description of the Dataset.
411                type: string
412                example: "Example: Master's Degree in Computer Science"
413              status:
414                description: |
415                  Status of the Dataset. REQUIRED if additionalProperties of attributeClaims are present. Issued and Expired datasets fall within VALID; expiry is verified
416                  via metadata claims (e.g. expiry_date, nbf/exp). INVALID indicates active revocation by the AS.
417                  For how this status affects the Digital Credential lifecycle managed by the Credential
418                  Issuer, see <a target="blank" href="https://italia.github.io/eid-wallet-it-docs/versione-corrente/en/credential-revocation.html#status-update-by-authentic-sources">Status Update by Authentic Sources</a>.
419                type: string
420                enum:
421                  - VALID
422                  - INVALID
423                  - SUSPENDED
424                x-enum-description:
425                  - VALID - Dataset is valid (includes Issued and Expired; expiry checked via metadata).
426                  - INVALID - Dataset has been actively revoked by the Authentic Source.
427                  - SUSPENDED - Dataset is temporarily invalid (typically reversible).
428                example: "VALID"
429              status_description:
430                description: Human-Readable description of the Status.
431                type: string
432                example: "Example: Master's Degree in Computer Science"
433              last_updated:
434                description: REQUIRED if additionalProperties of attributeClaims are present. Last time the status or attributes of the Dataset have been updated. Its format is `YYYY-MM-DDTHH:MM:SSZ`.
435                type: string
436                example: "2025-01-15T10:30:00Z"
437              interval:
438                description: Required if userClaims and additionalProperties of AttributeClaim parameters are not present. This represents the estimated amount of time (in seconds) required before making the request of the attribute claims again.
439                type: integer
440                format: int64
441                example: 864000
442            required: [object_id, description]
443      required: [attributeClaims, metadataClaims]
444    CredentialClaimsRequest:
445      required:
446        - unique_id
447      type: object
448      properties:
449        unique_id:
450          type: string
451          description: ID ANPR or Tax identification number
452        object_id:
453          type: string
454          description: Unique identifier of the Credential dataset. If this parameter is present only the indicated dataset is returned.
455    additionalPropertiesArray:
456      type: array
457      items:
458        oneOf:
459        - type: string
460        - type: integer
461          format: int32
462        - type: integer
463          format: int64
464        - type: number
465          format: float
466        - type: number
467          format: double
468        - type: boolean
469        - type: object
470          additionalProperties:
471            $ref: '#/components/schemas/additionalPropertiesObject'
472    additionalPropertiesObject:
473      type: object
474      oneOf:
475        - type: string
476        - type: integer
477          format: int32
478        - type: integer
479          format: int64
480        - type: number
481          format: float
482        - type: number
483          format: double
484        - type: boolean
485    place_of_birth:
486      description: Place of Birth.
487      type: object
488      properties:
489        country:
490          description: "alpha-2 country code as specified in ISO 3166-1"
491          type: string
492          example: "IT"
493        region:
494          description: "Name of a state, province, district, or local area"
495          type: string
496          example: "Roma"
497        locality:
498          description: "Name of a municipality, city, town, or village"
499          type: string
500          example: "Roma"
501      anyOf:
502        - required: [country]
503        - required: [region]
504        - required: [locality]
505    ProblemDetails:
506      type: object
507      description: RFC7807-compliant problem details object for error responses.
508      properties:
509        type:
510          type: string
511          format: uri
512          description: An absolute URI that identifies the problem type.
513        title:
514          type: string
515          description: A short, human-readable summary of the problem type.
516        status:
517          type: integer
518          format: int32
519          description: The HTTP status code generated by the origin server for this occurrence of the problem.
520        detail:
521          type: string
522          description: A human-readable explanation specific to this occurrence of the problem.
523        instance:
524          type: string
525          format: uri
526          description: An absolute URI that identifies the specific occurrence of the problem.
527      required: [title, status, detail]