Tabella dei contenuti

API

Attestazione - Verifica indirizzo digitale: List

Endpoint URL:

1POST /digital-address-verification/list
2

Descrizione:

Recupera informazioni per verificare la presenza e la correttezza per più indirizzi digitali.

Authentication:

Richiede un Bearer Token in the Authorization header.

Request Headers:

Header	Type	Required	Descr
Authorization	String	Yes	Bearer token per autenticazione.
X-Correlation-ID	String	Yes	Id unico random (di tipo UUID) generato a cura del chiamante, utile per verificare il flusso di chiamate effettuato.

Body:

1{
2  "idSubjects": [
3    "VRANGL74M28R701X"
4  ],
5  "idRequest": "abc123"
6}
7

Status Codes:

Code	Descr
200	Request succeeded.
400	Invalid user_id or bad request.
401	Unauthorized.
403	Forbidden.
404	User not found
500	Internal server error.
503	Service unavailable

Response:

200:

1{
2  "state": "PRESA_IN_CARICO",
3  "message": "List request",
4  "id": "d9c3de3d-1fea-4f5c-a8b0-29f63c4c3455",
5  "requestTimestamp": "2017-07-21T17:32:28Z"
6}
7

400, 401, 403, 404, 500, 503:

1{
2  "status": "<HTTP_CODE>",
3  "type": "<HTTP_STATUS>",
4  "detail": "<detail_error>"
5}
6

Esempio:

→ Richiediamo informazioni sull'indirizzo digitale

Attestazione - Verifica indirizzo digitale: State

Endpoint URL:

1GET  /digital-address-verification/list/state/{id_subject}
2

Descrizione:

Recupera informazioni per verificare la presenza e la correttezza di un determinato indirizzo digitale.

Authentication:

Richiede un Bearer Token in the Authorization header.

Request Headers:

Header	Type	Required	Descr
Authorization	String	Yes	Bearer token per autenticazione.
X-Correlation-ID	String	Yes	Id unico random (di tipo UUID) generato a cura del chiamante, utile per verificare il flusso di chiamate effettuato.

Query Parameters:

Name	Type	Required	Descr
id_subject	String	Yes	Subject id per cui si fa la richiesta

Status Codes:

Code	Descr
200	Request succeeded.
303	Available
400	Invalid user_id or bad request.
401	Unauthorized.
403	Forbidden.
404	User not found
500	Internal server error.
503	Service unavailable

Response:

200:

1{
2  "state": "IN_ELABORAZIONE",
3  "message": "List request in progress state"
4}
5

303:

1{
2  "state": "DISPONIBILE",
3  "message": "Request list available"
4}
5

400, 401, 403, 404, 500, 503:

1{
2  "status": "<HTTP_CODE>",
3  "type": "<HTTP_STATUS>",
4  "detail": "<detail_error>"
5}
6

Esempio:

→ Richiediamo informazioni sull'indirizzo digitale

Attestazione - Verifica indirizzo digitale: Response

Endpoint URL:

1GET  /digital-address-verification/list/response/{id_subject}
2

Descrizione:

Recupera informazioni per verificare la presenza e la correttezza di un determinato indirizzo digitale.

Authentication:

Richiede un Bearer Token in the Authorization header.

Request Headers:

Header	Type	Required	Descr
Authorization	String	Yes	Bearer token per autenticazione.
X-Correlation-ID	String	Yes	Id unico random (di tipo UUID) generato a cura del chiamante, utile per verificare il flusso di chiamate effettuato.

Query Parameters:

Name	Type	Required	Descr
id_subject	String	yes	Subject id per cui si fa la richiesta

Status Codes:

Code	Descr
200	Request succeeded.
400	Invalid user_id or bad request.
401	Unauthorized.
403	Forbidden.
404	User not found.
500	Internal server error.
503	Service unavailable.

Response:

200:

1{
2  "list": [
3    {
4      "idSubject": "VRANGL74M28R701X",
5      "from": "2017-07-21T17:32:28Z",
6      "digitalAddress": [
7        {
8          "digitalAddress": "example@pec.it",
9          "profession": "Doctor",
10          "information": {
11            "reason": "CESSAZIONE_VOLONTARIA",
12            "endDate": "2017-07-21T17:32:28Z"
13          }
14        }
15      ]
16    }
17  ]
18}
19

400, 401, 403, 404, 500, 503:

1{
2  "status": "<HTTP_CODE>",
3  "type": "<HTTP_STATUS>",
4  "detail": "<detail_error>"
5}
6

Esempio:

→ Richiediamo informazioni sull'indirizzo digitale

Attestazione - Verifica identificativo organizzazione

1POST /organization-id-verification/check
2

Descrizione:

Recupera informazioni per verificare la presenza e la correttezza di un determinato Organization Id.

Authentication:

Richiede un Bearer Token in the Authorization header.

Request Headers:

Header	Type	Required	Descr
Authorization	String	Yes	Bearer token per autenticazione.
X-Correlation-ID	String	Yes	Id unico random (di tipo UUID) generato a cura del chiamante, utile per verificare il flusso di chiamate effettuato.

Body:

1{
2  "organizationId": "Org-1"
3}
4

Status Codes:

Code	Description
200	Request succeeded.
400	Bad request
401	Unauthorized.
403	Forbbidden

Response:

1{
2  "organizationId": "Org-1",
3  "valid": true,
4  "status": "ATTIVA",
5  "denomination": "Organizzazione 1",
6  "dateStartActivity": "2001-01-02"
7}
8

Esempio:

→ Verifichiamo la correttezza dell'identificativo organizzazione

Attestazione - Verifica identificativo utente

1POST /subject-id-verification/check
2

Descrizione:

Recupera informazioni per verificare la presenza e la correttezza di un determinato identificativo utente.

Authentication:

Richiede un Bearer Token in the Authorization header.

Request Headers:

Header	Type	Required	Descr
Authorization	String	Yes	Bearer token per autenticazione.
X-Correlation-ID	String	Yes	Id unico random (di tipo UUID) generato a cura del chiamante, utile per verificare il flusso di chiamate effettuato.

Body:

1{
2  "idSubject": "RSSMRA80A01H501U"
3}
4

Status Codes:

Code	Descr
200	Request succeeded.
400	Invalid user_id or bad request.
401	Unauthorized.
403	Forbidden

Response:

1{
2  "idSubject": "RSSMRA80A01H501U",
3  "valid": true,
4  "message": "Valid id subject"
5}
6

Esempio:

→ Verifichiamo la correttezza dell'identificativo utente

Attestazione - Demo portachiavi: Signature

1GET /keychain-mock/signature
2

Descrizione:

Offre un servizio mediante il quale è possibile vedere in azione la funzione del portachiavi. L'erogatore invia in risposta non solo il body della response, ma anche degli header aggiuntivi calcolati sulla base della chiave pubblica collegata al portachiavi.

Request Headers:

Header	Type	Required	Descr
Authorization	String	Yes	Bearer token per autenticazione.
X-Correlation-ID	String	Yes	Id unico random (di tipo UUID) generato a cura del chiamante, utile per verificare il flusso di chiamate effettuato.

Status Codes:

Code	Descr
200	Request succeeded.
400	Invalid user_id or bad request.
401	Unauthorized.
403	Forbidden.
500	Internal server error.

Response Headers:

Header	Type	Descr
x-payload-signature	String	Signature
x-payload-signature-kid	String	Key-id
x-payload-signature-algorythm	String	Alghoritm

Response body:

1{
2    "message": "risposta generata con successo"
3}
4

Attestazione - Demo portachiavi: Get Key

1GET /keys/:kid
2

Descrizione:

Valorizzando il parametro :kid con il valore ottenuto nell'header x-payload-signature-kid della chiamata Signature. L'API risponderà con la chiave pubblica associata.

Per la verifica è necessario recuperare il valore associato a x-payload-signature e applicare l'algoritmo indicato in x-payload-signature-algorythm sulla signature.

Attestazione - Demo portachiavi: Verify

1POST /keychain-mock/verify
2

Descrizione:

L'e-service espone un'ulteriore API che permette di inviare verso l'erogatore il feedback a seguito della verifica della signature.

Request Headers:

Header	Type	Required	Descr
X-Correlation-ID	String	Yes	Id unico random (di tipo UUID) generato a cura del chiamante, utile per verificare il flusso di chiamate effettuato.
x-payload-signature	String	Yes	Signature

Status Codes:

Code	Descr
200	Request succeeded.
400	Invalid user_id or bad request.
401	Unauthorized.
403	Forbidden.
500	Internal server error.

Response:

1{
2    "status": "OK",
3    "message": "X-Payload-Signature verificata"
4}
5

Esempio:

→ E-Service con funzionalità "portachiavi"

In questa pagina

Attestazione - Verifica indirizzo digitale: List

Attestazione - Verifica indirizzo digitale: State

Attestazione - Verifica indirizzo digitale: Response

Attestazione - Verifica identificativo organizzazione

Attestazione - Verifica identificativo utente

Attestazione - Demo portachiavi: Signature

Attestazione - Demo portachiavi: Get Key

Attestazione - Demo portachiavi: Verify

Hai bisogno di aiuto?

Apri un ticket utilizzando l’apposita funzione all’interno della tua Area Riservata

Dicci cosa ne pensi

Per segnalare problemi o dare feedback, puoi aprire una segnalazione su Github