Skip to main content

Attributes reference

You use SPID to verify the the identity of end-users and obtain relevant personal information.

This page shows what end-user information you can request and receive for the following authentication protocols:

OIDC scopes and claims​

You can use the following OIDC scopes to request personal information from an end-user using SPID. The claims column shows the data fields returned in the response.

Include claims in ID token

By default, all claims listed below are returned in the UserInfo endpoint.

In addition, you can configure which user data claims you want to receive in the ID token object. To set this up, go to the Products > eID and Wallet Hub > OIDC Clients page in the Dashboard, choose your client, and edit the claims under Advanced Security > ID Token User data.

SPID attributes table

For further details about attributes and data formats, see the official SPID documentation.

OIDC response example​

Below, you find examples of responses returned from an identity verification flow with SPID.

This section shows response examples for the UserInfo endpoint.

Example of natural person​

Examples for the test user Ada Lovelace:

Scopes in the request: spid.

{
  "idp_id": "SPID-002",
  "spid_place_of_birth": "G702",
  "spid_county_of_birth": "PI",
  "spid_id_card": "passaporto KK1234567 questuraLivorno 2016-09-04 2026-09-03",
  "given_name": "Ada",
  "family_name": "Lovelace",
  "birthdate": "1985-12-10",
  "gender": "F",
  "sub": "HIDhYNt8ZaSa8dtg-hrljCnhiMXYhF54gFudp-warQM=",
  "idp_issuer": "https://demo.spid.gov.it"
}

Scopes in the request: spid, nin, spid-extra.

{
  "idp_id": "SPID-0020020020",
  "nin": "TINIT-LVLDAA85T50G702B",
  "nin_type": "TAX",
  "nin_issuing_country": "IT",
  "spid_place_of_birth": "G702",
  "spid_county_of_birth": "PI",
  "spid_id_card": "passaporto KK1234567 questuraLivorno 2016-09-04 2026-09-03",
  "given_name": "Ada",
  "family_name": "Lovelace",
  "birthdate": "1985-12-10",
  "gender": "F",
  "phone_number": "3939393939",
  "spid_expiration_date": "02/02/2018 00:00:00",
  "address": {
    "formatted": "Via Listz 21, Roma, RM, 00144, IT",
    "street_address": "Via Listz 21",
    "locality": "Roma",
    "region" : "RM",
    "postal_code": "00144",
    "country": "IT"
  },
  "email": "aabyron@hotmail.com",
  "sub": "HIDhYNt8ZaSa8dtg-hrljCnhiMXYhF54gFudp-warQM=",
  "idp_issuer": "https://demo.spid.gov.it"
}

Example of organisation​

Example of a response containing the organisation claim:

{
    "spid_place_of_birth": "Roma",
    "spid_county_of_birth": "RM",
    "organisation": "Agenzia per l'Italia Digitale",
    "spid_registered_office": "Via Listz 21 00144 Roma",
    "spid_company_fiscal_number": "TINIT-GDASDV00A01H501J",
    "spid_iva_code": "VATIT-97735020584",
    "spid_id_card": "CartaIdentità AA00000000 ComuneRoma 2018-01-01 2028-01-01",
    "given_name": "SpidValidator",
    "family_name": "AgID",
    "birthdate": "2000-01-01",
    "gender": "M",
    "phone_number": "+393331234567",
    "spid_digital_address": "pec@pecagid.gov.it",
    "spid_expiration_date": "2028-01-01",
    "address":
    {
        "formatted": "Via Listz 21, Roma, RM, 00144, IT",
        "street_address": "Via Listz 21",
        "locality": "Roma",
        "region" : "RM",
        "postal_code": "00144",
        "country": "IT"
    },
    "email": "spid.tech@agid.gov.it",
    "sub": "ZZ0eRjWltcKswng6W-6....y-DDc1AwSEUP7C2aMZtw=",
    "sub_legacy": "z507Ae7ecG282uDCSHiYa1Evt-Ryvq0ymKJqcdnzcTk=",
    "idp_issuer": "https://demo.spid.gov.it/validator "
}

Signicat Authentication REST API attributes​

The Signicat Authentication REST API supports the following request attributes for SPID:

SPID code in idpId

The Authentication REST API returns idpId by default. You do not need to specify this attribute in your request.

idpId returns the SPID code of the user. Format is <code_IdP><N_DIGITS> where code_IdP is a four characters code unique for the identity provider. An example is ABCD-123456789A.

Authentication API request example​

To create a session using the Authentication REST API, you send a POST request to the Create a new session endpoint of the Authentication REST API. This is https://api.signicat.com/auth/rest/sessions.

You define the parameters of the session in the payload of the request. For example:

{
    "allowedProviders": [
        "spid"
    ],
    "flow": "redirect",
    "requestedAttributes": [
      "address",
      "companyFiscalNumber",
      "countryOfBirth",
      "dateOfBirth",
      "digitalAddress",
      "email",
      "expirationDate",
      "firstName",
      "gender",
      "idCard",
      "ivaCode",
      "lastName",
      "name",
      "nin",
      "organisationName",
      "phoneNumber",
      "placeOfBirth",
      "registeredOffice"
	],
    "callbackUrls": {
        "success": "https://example.com/success",
        "abort": "https://example.com/abort",
        "error": "https://example.com/error"
	}
}

Authentication API response example​

Example for the test user Lucrezia Borgia.

Response object (subject field):

{
  "id": "51F6wWfm0jAIHYtoJpAViZ3cKp-Q3t9i2ZfmR0YHgHs=",
  "idpId": "SPID-004",
  "name": "Lucrezia Borgia",
  "firstName": "Lucrezia",
  "lastName": "Borgia",
  "dateOfBirth": "1980-04-18",
  "email": "luborgia@msn.com",
  "nin": {
    "value": "TINIT-BRGLRZ80D58H501Q",
    "issuingCountry": "IT",
    "type": "TAX"
  },
  "placeOfBirth": "H501",
  "organisationName": "",
  "registeredOffice": "",
  "companyFiscalNumber": "",
  "ivaCode": "",
  "idCard": "cartaIdentita AK987654 comuneFerrara 2012-11-28 2023-04-18",
  "digitalAddress": "",
  "expirationDate": "2019-01-01",
  "phoneNumber": "3495555555",
  "gender": "F",
  "address": "Via Listz 21, Roma, RM, 00144, IT",
  "addressFormatted": {
    "FullAddress": "Via Listz 21, Roma, RM, 00144, IT",
    "Street": "Via Listz 21",
    "City": "Roma",
    "Region": "RM",
    "PostalCode": "00144",
    "Country": "IT"
   }
}
On this page