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

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

objectoptional

Describes the citizen's profile, mostly interesting for preferences attributes.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/profiles HTTP/1.1
Host: api.io.pagopa.it
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "fiscal_code": "SPNDNL80R13C555X"
}

{
  "sender_allowed": true,
  "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