Helse Uføreopplysninger

API change history

For å kunne benytte tjenesten må konsumenten autentisere seg gjennom ID-porten Virksomhet og ha avtale med NAV. I tillegg må konsumenten ha samtykke fra bruker og hente et samtykketoken fra Altinns Samtykkeløsning. Disse to tokenene sendes sammen med brukers Fnr/Dnr, fra-og-med dato, samt til-og-med dato som inn-parametere til tjenesten. Tjenesten returnerer uføreopplysninger for ønsket periode så fremt samtykket gjelder for perioden Hva, når og hvem som har hentet ut uføreopplysninger vil bli logget i en database. Bruker kan logge seg inn på nav.no for å lese av disse hendelsene.

Påkrevd scope-verdi for bruk av API'et er nav:helse/v1/uforeopplysninger.

Samtykke hos Altinn identifiseres med tjenestekode og tjenesteutgavekode 5252_X, der X er 2 eller 3.

Returnerer periodisert uføreopplysninger for en person representert med fnr eller dnr

Returnerer periodisert uføreopplysninger for en person representert med fnr eller dnr

Try it

Request

Request URL

Request parameters

  • (optional)
    string

    Format - date (as full-date in RFC3339). Fra-og-med-dato på ISO-8601 format for vedtak som ønskes returnert. Dersom parameteren ikke er spesifisert, brukes samtykkeperiodens startdato.

  • (optional)
    string

    Format - date (as full-date in RFC3339). Til-og-med-dato på ISO-8601 format for vedtak som ønskes returnert. Dersom parameteren ikke er spesifisert, brukes samtykkeperiodens sluttdato.

Request headers

  • string

    Fødselsnummer eller Dnr til brukeren som det spørres på.

  • string

    Standard Authorization header som inneholder et Base64-kodet Bearer-token (JWT-aksesstoken) utstedt av ID-Porten (Difi)

  • string

    Base64-kodet JWT-samtykketoken utstedt av Altinn.

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Returnerer vedtakene som ble funnet. Returneres også dersom brukeren ikke finnes i fagsystemet (så lenge det er et gyldig fnr/dnr).

Representations

{
  "beregningsperioder": [
    {
      "ferdiglignetInntekt": true,
      "fom": "string",
      "ifu": 0,
      "inntektBruktIAvkortingen": 0,
      "klagebehandles": true,
      "tom": "string",
      "uforegrad": 0,
      "uforetidspunkt": "string"
    }
  ],
  "forsteVirkningstidspunkt": "string",
  "status": "IKKE_SOKT"
}
{
  "type": "object",
  "properties": {
    "beregningsperioder": {
      "type": "array",
      "description": "En tabell med beregningsperioder. Se modell for BeregningsperiodeProdusentDTO for beskrivelse av felter",
      "items": {
        "type": "object",
        "properties": {
          "ferdiglignetInntekt": {
            "type": "boolean",
            "description": "Hvis inntekt brukt i avkortingen er hentet fra Skatt og gjelder hele året = sann, ellers usann Dersom denne = sann betyr det at det er denne inntekten NAV har brukt i beregningen av etteroppgjøret for perioden."
          },
          "fom": {
            "type": "string",
            "format": "date",
            "description": "Starttidspunktet for beregningsperiode, dvs. tidspunktet fra når uføretrygden trer i kraft eller endres."
          },
          "ifu": {
            "type": "integer",
            "format": "int32",
            "description": "Inntekt før uførhet. Tilsvarer det det den uføre ville ha tjent i full stilling før uføretidspunktet. (Vi viser her IFU og ikke oppjustert IFU som er inntekt før uførhet oppjustert til dagens nivå)."
          },
          "inntektBruktIAvkortingen": {
            "type": "integer",
            "format": "int32",
            "description": "Oppgitt som et summert beløp som brukes til å redusere utbetaling av uføretrygd dersom inntekten er større enn inntektsgrensen. Kilden kan være bruker selv, a-ordningen eller Skatteetaten."
          },
          "klagebehandles": {
            "type": "boolean",
            "description": "Hvis vedtaket er under klagebehandling = sann, ellers usann. Kun aktuelt dersom klagen gjelder avslag på søknad om uføretrygd."
          },
          "tom": {
            "type": "string",
            "format": "date",
            "description": "Til og med dato for beregningsperioden. Når den siste vedtaksperioden har en TOM-dato er ytelsen opphør."
          },
          "uforegrad": {
            "type": "integer",
            "format": "int32",
            "description": "Prosentvis andel av arbeidsuførhet. Fastsettes ved å sammenligne inntektsevne før og etter uførhet."
          },
          "uforetidspunkt": {
            "type": "string",
            "format": "date",
            "description": "Uføretidspunktet brukt i beregningen angir tidspunktet bruker vurderes å ha fått sin inntektsevne redusert med minst 30, 40 eller 50 %."
          }
        },
        "title": "BeregningsperiodeProdusentDTO"
      }
    },
    "forsteVirkningstidspunkt": {
      "type": "string",
      "format": "date",
      "description": "Første virkningstidspunkt på saken. Dersom saken er en konvertert uføretrygd benyttes første virkningstidspunkt for uførepensjonen."
    },
    "status": {
      "type": "string",
      "description": "Tjenesten returnerer et statusfelt som beskriver nå-situasjonen samt en tabell med beregningsvetakshistorikk\"\nStatusfeltet kan ha følgende verdier: \n\"IKKE_SOKT: Dersom det ikke er mottatt søknad om uføretrygd\"\n\"AVSLAG: Dersom det er søkt om uføretrygd og søknaden har blitt avslått. Gjelder ikke avslag på søknad om endring.\"\n\"REKONSTRUKSJON: Det foreligger et åpent krav under rekonstruksjon på saken (ingen historikk kan vises, prøv igjen siden)\"\n\"KLAGE_PA_AVSLAG: Dersom søknad om uføretrygd har blitt avslått, og det foreligger en klage under behandling. Gjelder ikke avslag på søknad om endring.\"\n\"LOPENDE: Dersom det finnes minst et løpende vedtak hvor det ikke er satt tom-dato.\":\n\"OPPHORT: Dersom det eksisterer løpende vedtak og alle vedtak har løpende tom satt (ikke null) på saken\"\n\"UNDER_BEHANDLING: Dersom det foreligger et åpent krav på saken som ikke gjelder rekonstruksjon eller klage på avslag\":",
      "enum": [
        "IKKE_SOKT",
        "AVSLAG",
        "KLAGE_PA_AVSLAG",
        "REKONSTRUKSJON",
        "LOPENDE",
        "OPPHORT",
        "UNDER_BEHANDLING",
        "UKJENT_STATUS",
        "EKSPORT"
      ]
    }
  },
  "title": "UforedataProdusentDTO"
}

400 Bad Request

Ugyldig input i forespørselen.

Representations

401 Unauthorized

Konsumenten mangler gyldig aksesstoken.

Representations

403 Forbidden

Konsumenten har ikke tilgang til vedtaksinformasjon. Situasjoner som kan gi feilen er som følger.

  • Scope til aksesstoken gir ikke tilgang til vedtaksdata.
  • Konsumenten mangler gyldig samtykketoken.
  • Samtykketokenet er ikke utstedt av altinn.no (iss).
  • Samtykket har passert utløpstidspunktet (ValidToDate).
  • Organisasjonsnummer som samtykket er i gitt til er ikke i overensstemmelse med organisasjonsnummeret som aksesstokenet er utstedt til.
  • Fødselsnummeret som har gitt samtykket er ikke i overensstemmelse med fødselsnummeret det spørres på.
  • Forespurt periode ligger utenfor samtykkeperioden.

Representations

500 Internal Server Error

Intern feil i tjenesten.

Representations

Code samples

@ECHO OFF

curl -v -X GET "https://api.nav.no/helse/v1/uforeopplysninger/uforeinformasjon?fomDato={string}&tomDato={string}"
-H "fnr: "
-H "Authorization: "
-H "NAV-Samtykke-Token: "
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("fnr", "");
            client.DefaultRequestHeaders.Add("Authorization", "");
            client.DefaultRequestHeaders.Add("NAV-Samtykke-Token", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["fomDato"] = "{string}";
            queryString["tomDato"] = "{string}";
            var uri = "https://api.nav.no/helse/v1/uforeopplysninger/uforeinformasjon?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.nav.no/helse/v1/uforeopplysninger/uforeinformasjon");

            builder.setParameter("fomDato", "{string}");
            builder.setParameter("tomDato", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("fnr", "");
            request.setHeader("Authorization", "");
            request.setHeader("NAV-Samtykke-Token", "");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "fomDato": "{string}",
            "tomDato": "{string}",
        };
      
        $.ajax({
            url: "https://api.nav.no/helse/v1/uforeopplysninger/uforeinformasjon?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("fnr","");
                xhrObj.setRequestHeader("Authorization","");
                xhrObj.setRequestHeader("NAV-Samtykke-Token","");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.nav.no/helse/v1/uforeopplysninger/uforeinformasjon";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"fomDato={string}",
                         @"tomDato={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"fnr"];
    [_request setValue:@"" forHTTPHeaderField:@"Authorization"];
    [_request setValue:@"" forHTTPHeaderField:@"NAV-Samtykke-Token"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.nav.no/helse/v1/uforeopplysninger/uforeinformasjon');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'fnr' => '',
    'Authorization' => '',
    'NAV-Samtykke-Token' => '',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'fomDato' => '{string}',
    'tomDato' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'fnr': '',
    'Authorization': '',
    'NAV-Samtykke-Token': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'fomDato': '{string}',
    'tomDato': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.nav.no')
    conn.request("GET", "/helse/v1/uforeopplysninger/uforeinformasjon?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'fnr': '',
    'Authorization': '',
    'NAV-Samtykke-Token': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'fomDato': '{string}',
    'tomDato': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.nav.no')
    conn.request("GET", "/helse/v1/uforeopplysninger/uforeinformasjon?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.nav.no/helse/v1/uforeopplysninger/uforeinformasjon')

query = URI.encode_www_form({
    # Request parameters
    'fomDato' => '{string}',
    'tomDato' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['fnr'] = ''
# Request headers
request['Authorization'] = ''
# Request headers
request['NAV-Samtykke-Token'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body