⚠️Get a User Profile

Attenzione: la seguente API sarà a breve deprecata, pertanto se ne sconsiglia l’uso. Utilizzare Get a User Profile using POST

Descrizione

API che permette di controllare che il cittadino identificato tramite codice fiscale sia iscritto ad IO e che il servizio possa inviare comunicazioni al cittadino stesso.

La risposta è ritenuta positiva se sono verificate entrambe queste condizioni:

  1. lo status code della risposta è 200

  2. nel body di risposta il campo sender_allowed=true

Get a User Profile

Returns the preferences for the user identified by the provided fiscal code. The field sender_allowed is set fo false in case the service which is calling the API has been disabled by the user.

get

/profiles/{fiscal_code}

Authorizations
Path parameters
fiscal_codestring · min: 16 · max: 16required

The fiscal code of the user, all upper case.

Example: SPNDNL80R13C555X
Pattern: [A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]
Responses
curl -L \
  --url 'https://api.io.pagopa.it/api/v1/profiles/{fiscal_code}' \
  --header 'Ocp-Apim-Subscription-Key: YOUR_API_KEY'
{
  "email": "foobar@example.com",
  "version": 1
}

Esempi

### REQUEST
curl --location --request GET 'https://api.io.pagopa.it/api/v1/profiles/AAAAAA00A00A000A' \
--header 'Ocp-Apim-Subscription-Key: __YOUR_API_KEY__'
### RESPONSE
{
"sender_allowed": true
}

Risorse utili

https://developer.io.italia.it/openapi.html#operation/getProfile

Last updated