Lettura di un singolo SPID

Dato l'identificativo univoco di una sessione di riconoscimento SPID, è possibile recuperarne i dati tramite l'API

[GET] /api/v1/spid/{spidId}

Header

Gli header richiesti dalla chiamata sono gli header standard di TSDigital.

Il Content-Type deve essere application/json

Path parameter

• spidId: identificativo univoco della richiesta SPID

Body

La richiesta non ha body.

Risposte

Successo

In caso di successo, l'API risponde con il codice HTTP 200 con il seguente body:

{
  "id": "string",
  "itemId": "string",
  "type": "INDIVIDUAL",
  "status": "PENDING",
  "requestedAt": "2022-04-14T10:58:13.409Z",
  "updatedAt": "2022-04-14T10:58:13.409Z",
  "user": {
    "id": "string",
    "name": "string",
    "surname": "string",
    "email": "string",
    "taxId": "string",
    "ncsId": "string"
  },
  "slotId": 0,
  "videoSlotId": 0,
  "sessionId": "string",
  "sessionLink": "string",
  "cie": true,
  "cns": true,
  "feq": true,
  "video": true,
  "rao": true,
  "sessionExpirationDate": "2022-04-14T10:58:13.409Z",
  "raoId": "string",
  "level": "SPID_LEVEL_1"
}

• id: identificativo univoco della richiesta SPID
• itemId: identificativo univoco dell'item associato alla richiesta
• type: tipologia della richiesta SPID
• status: stato attuale della richiesta SPID
• requestedAt: stringa che esprime data e ora della richiesta
• updatedAt: string che esprime data e ora dell'ultimo aggiornamento della richiesta
• user: dati sulla persona censita nella richiesta SPID
  • id: identificativo univoco della persona
  • name: nome della persona
  • surname: cognome della persona
  • email: indirizzo email della persona
  • taxId: codice fiscale della persona
  • ncsId: identificativo univoco dell'utente lato NCS
• slotId: identificativo univoco dello slot occupato lato metering dalla richiesta. Nullo nel caso di richieste di tipo INDIVIDUAL
• videoSlotId: identificativo univoco dello slot occupato lato metering dalla richiesta. Valorizzato solo nel caso di canale di riconoscimento video
• sessionId: identificativo univoco della sessione di riconoscimento SPID. Nullo in caso di richieste il cui unico canale di riconoscimento è RAO.
• sessionLink: URL verso cui reindirizzare l'utente per iniziare la sessione di riconoscimento. Coincide con la URL inviata via mail quando viene inoltrata la richiesta. Nullo in caso di richieste il cui unico canale di riconoscimento è RAO.
• cie/cns/feq/video/rao: booleani che indicano se uno specifico canale di riconoscimento è stato selezionato
• sessionExpirationDate: data di scadenza del link di sessione. Nullo in caso di richieste il cui unico canale di riconoscimento è RAO.
• raoId: identificativo anagrafico univoco del RAO scelto per il riconoscimento. Valorizzato solo se il canale RAO è stato selezionato.
• level: livello della richiesta SPID. Attualmente sono disponibili i livelli 1 e 2

Errore

In caso di errore, l'API risponde con un body JSON avente il seguente formato:

{
  "code": "string",
  "timestamp": "2022-04-13T13:35:16.678Z",
  "message": "string",
  "subErrors": [
    {}
  ]
}

• code: rappresentazione sotto forma di stringa del codice d'errore HTTP. Coincide con l'errore HTTP ritornato
• tiemstamp: data e ora della risposta, espresso sotto forma di stringa
• message: messaggio che esprime l'errore

Gli errori possibili sono:

• 400: la richiesta è malformata (parametri con formato errato, parametri invalidi o inconsistenti fra loro)
• 401: non è stato fornito un token autorizzativo o il token autorizzativo fornito non è valido (es: è scaduto)
• 403: il token fornito è valido, ma l'utente non è autorizzato ad effettuare l'operazione
• 404: richiesta SPID con l'ID fornito non trovata
• 500: si è verificato un errore inaspettato