Get a User Profile using POST

Descrizione

Questa API permette di controllare che il cittadino identificato tramite Codice Fiscale sia iscritto a IO, e che il servizio possa inviare comunicazioni al cittadino stesso.

Il Codice Fiscale del cittadino andrà inserito nel body della post request.

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 using POST

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

POSThttps://api.io.pagopa.it/api/v1/profiles

Authorization

SubscriptionKey

Body

application/json

fiscal_code*FiscalCode (string (FiscalCode))

User's fiscal code.

Response

200401403404429

Found.

Body

application/json

sender_allowed*boolean

True in case the service that made the request can send messages to the user identified by this profile (false otherwise).

preferred_languagesarray of string

Indicates the User's preferred written or spoken languages in order of preference. Generally used for selecting a localized User interface. Valid values are concatenation of the ISO 639-1 two letter language code, an underscore, and the ISO 3166-1 2 letter country code; e.g., 'en_US' specifies the language English and country US.

Request

JavaScriptCurl

const response = await fetch('https://api.io.pagopa.it/api/v1/profiles', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "fiscal_code": "SPNDNL80R13C555X"
    }),
});
const data = await response.json();

Response

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

Esempi

### REQUEST
curl --location --request POST 'https://api.io.pagopa.it/api/v1/profiles' \
--header 'Content-Type: application/json' \
--header 'Ocp-Apim-Subscription-Key: __YOUR_API_KEY__' \
--data-raw '{
"fiscal_code": "AAAAAA00A00A000A"
}'

### RESPONSE
{
"sender_allowed": true
}

Risorse utili

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