⚠️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

Questa API 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

get

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.

Authorizations

Path parameters

fiscal_codeanyRequired

The fiscal code of the user, all upper case.

Responses

200

Found.

application/json

401

Unauthorized

403

Forbidden.

404

No user found for the provided fiscal code.

application/json

429

Too many requests

get

HTTPcURLJavaScriptPython

GET /api/v1/profiles/{fiscal_code} HTTP/1.1
Host: api.io.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: */*

{
  "sender_allowed": true,
  "preferred_languages": [
    "it_IT"
  ]
}

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