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.

Il codice fiscale del cittadino andrà inserito nel body della post request.

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

1. lo status code della risposta è 200

2. nel body di risposta il campo sender_allowed=true

Get a User Profile using POST

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.

Authorizations

Body

fiscal_codestring · FiscalCoderequired

User's fiscal code.

Example: SPNDNL80R13C555X

Responses

application/json

application/json

post

cURLJavaScriptPythonHTTP

curl -L \
  --request POST \
  --url 'https://api.io.pagopa.it/api/v1/profiles' \
  --header 'Ocp-Apim-Subscription-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "fiscal_code": "SPNDNL80R13C555X"
  }'

200

401

403

404

429

200

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

Found.

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