Pensjon Simuler Alderspensjon

API change history

For å kunne bruke tjenesten må scope i autentiseringen mot Maskinporten settes til nav:pensjon/v3/alderspensjon. Dette er en simuleringstjeneste for tjenestepensjonsordninger i offentlig sektor, og benyttes for å kunne simulere alderspensjon fra folketrygden for brukere med TP-forhold.

ApiSimulerAlderspensjonV3Post

Try it

Request

Request URL

Request headers

  • string

    Format - byte. Standard Authorization header som inneholder et Base64-kodet Bearer-token (JWT-aksesstoken) utstedt av Maskinporten (Difi). Verdien må starte med "Bearer ", deretter følger tokenstrengen.

  • string
  • (optional)
    string

    true/false verdi som styrer om listen med AlderspensjonFraFolketrygden skal inneholde alle perioder eller bare for første uttaksdato/hel uttaksdato

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

{
  "fnr": "string",
  "forsteUttak": {
    "datoFom": "string",
    "grad": 0
  },
  "heltUttak": {
    "datoFom": "string",
    "grad": 0
  },
  "arIUtlandetEtter16": 0,
  "sivilstandVedPensjonering": "ENKE",
  "epsPensjon": true,
  "eps2G": true,
  "fremtidigInntektListe": [
    {
      "arligInntekt": 0,
      "fomDato": "string"
    }
  ],
  "simulerMedAfpPrivat": true
}
{
  "title": "SimulerAlderspensjonRequestV3",
  "type": "object",
  "properties": {
    "fnr": {
      "type": "string"
    },
    "forsteUttak": {
      "title": "UttaksperiodeV3",
      "description": "Dette er Uttaksperioden. Angir gradering for uttaksperioden.",
      "type": "object",
      "properties": {
        "datoFom": {
          "type": "string",
          "format": "date-time"
        },
        "grad": {
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "heltUttak": {
      "title": "UttaksperiodeV3",
      "description": "Dette er Uttaksperioden. Angir gradering for uttaksperioden.",
      "type": "object",
      "properties": {
        "datoFom": {
          "type": "string",
          "format": "date-time"
        },
        "grad": {
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "arIUtlandetEtter16": {
      "type": "integer",
      "description": "Settes for å kunne redusere trygdetid ved simulering.",
      "format": "int32"
    },
    "sivilstandVedPensjonering": {
      "title": "SivilstandVedPensjonering",
      "example": "ENKE",
      "type": "string",
      "enum": [
        "ENKE",
        "GIFT",
        "GJES",
        "GJPA",
        "GJSA",
        "GLAD",
        "PLAD",
        "REPA",
        "SAMB",
        "SEPA",
        "SEPR",
        "SKIL",
        "SKPA",
        "UGIF"
      ]
    },
    "epsPensjon": {
      "type": "boolean",
      "description": "Angir om ektefelle/partner/samboer mottar pensjon."
    },
    "eps2G": {
      "type": "boolean",
      "description": "Angir om ektefelle/partner/samboer har inntekt over 2G"
    },
    "fremtidigInntektListe": {
      "type": "array",
      "items": {
        "title": "FremtidigInntekt",
        "type": "object",
        "description": "Angir inntekt som benyttes som opptjeningsgrunnlag for perioden frem til neste angitte inntekt(fomdato), eller bruker når maks opptjeningsalder. Inntekter for år der bruker har blitt godskrevet opptjening fra skatteoppgjøret ignoreres. Siste gyldige opptjeningsår i responsen angir hvilket år dette gjelder.",
        "properties": {
          "arligInntekt": {
            "type": "integer",
            "format": "int32"
          },
          "fomDato": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    },
    "simulerMedAfpPrivat": {
      "type": "boolean",
      "description": "Angir "
    }
  }
}

Responses

200 OK

The response object

Representations

{
  "pensjonsperioder": [
    {
      "arligUtbetaling": 0,
      "datoFom": "string"
    }
  ],
  "simuleringsdataliste": [
    {
      "poengArTom1991": 0,
      "poengArFom1992": 0,
      "sluttpoengtall": 0.0,
      "anvendtTrygdetid": 0,
      "basisgp": 0.0,
      "basistp": 0.0,
      "basispt": 0.0,
      "forholdstallUttak": 0.0,
      "delingstallUttak": 0.0,
      "skjermingstillegg": 0.0,
      "uforegradVedOmregning": 0,
      "datofom": "string"
    }
  ],
  "pensjonsbeholdningsperioder": [
    {
      "pensjonsbeholdning": 0.0,
      "garantipensjonsbeholdning": 0.0,
      "garantitilleggsbeholdning": 0.0,
      "datoFom": "string",
      "garantipensjonsniva": {}
    }
  ],
  "alderspensjonFraFolketrygden": [
    {
      "datoFom": "string",
      "delytelser": [
        {
          "pensjonstype": "string",
          "belop": 0
        }
      ],
      "uttaksgrad": 0
    }
  ],
  "harUttak": true,
  "harTidligereUttak": true,
  "afpPrivatBeholdningVedUttak": 0,
  "sisteGyldigeOpptjeningsAr": 0
}
{
  "title": "SimulerAlderspensjonResponseV3",
  "type": "object",
  "properties": {
    "pensjonsperioder": {
      "type": "array",
      "items": {
        "title": "Pensjonsperiode",
        "type": "object",
        "properties": {
          "arligUtbetaling": {
            "type": "integer",
            "format": "int32"
          },
          "datoFom": {
            "type": "string"
          }
        }
      }
    },
    "simuleringsdataliste": {
      "type": "array",
      "items": {
        "title": "Simuleringsdata",
        "type": "object",
        "properties": {
          "poengArTom1991": {
            "type": "integer",
            "format": "int32"
          },
          "poengArFom1992": {
            "type": "integer",
            "format": "int32"
          },
          "sluttpoengtall": {
            "type": "number",
            "format": "double"
          },
          "anvendtTrygdetid": {
            "type": "integer",
            "format": "int32"
          },
          "basisgp": {
            "type": "number",
            "format": "double"
          },
          "basistp": {
            "type": "number",
            "format": "double"
          },
          "basispt": {
            "type": "number",
            "format": "double"
          },
          "forholdstallUttak": {
            "type": "number",
            "format": "double"
          },
          "delingstallUttak": {
            "type": "number",
            "format": "double"
          },
          "skjermingstillegg": {
            "type": "number",
            "format": "double"
          },
          "uforegradVedOmregning": {
            "type": "integer",
            "format": "int32"
          },
          "datofom": {
            "type": "string"
          }
        }
      }
    },
    "pensjonsbeholdningsperioder": {
      "type": "array",
      "items": {
        "title": "PensjonsbeholdningPeriode",
        "type": "object",
        "properties": {
          "pensjonsbeholdning": {
            "type": "number",
            "format": "double"
          },
          "garantipensjonsbeholdning": {
            "type": "number",
            "format": "double"
          },
          "garantitilleggsbeholdning": {
            "type": "number",
            "format": "double"
          },
          "datoFom": {
            "type": "string"
          },
          "garantipensjonsniva": {
            "type": "object",
            "items": {
              "title": "Garantipensjonsnivå",
              "type": "object",
              "properties": {
                "belop": {
                  "type": "number",
                  "format": "double"
                },
                "sats": {
                  "type": "number",
                  "format": "double"
                },
                "satsType": {
                  "type": "string"
                },
                "tt_anv": {
                  "type": "integer",
                  "format": "int32"
                }
              }
            }
          }
        }
      }
    },
    "alderspensjonFraFolketrygden": {
      "type": "array",
      "items": {
        "title": "AlderspensjonFraFolketrygden",
        "type": "object",
        "properties": {
          "datoFom": {
            "type": "string"
          },
          "delytelser": {
            "type": "array",
            "items": {
              "title": "Delytelse",
              "type": "object",
              "properties": {
                "pensjonstype": {
                  "type": "string"
                },
                "belop": {
                  "type": "integer",
                  "format": "int32"
                }
              }
            }
          },
          "uttaksgrad": {
            "type": "integer",
            "format": "int32"
          }
        }
      }
    },
    "harUttak": {
      "type": "boolean"
    },
    "harTidligereUttak": {
      "type": "boolean"
    },
    "afpPrivatBeholdningVedUttak": {
      "type": "integer",
      "format": "int32"
    },
    "sisteGyldigeOpptjeningsAr": {
      "type": "integer",
      "format": "int32"
    }
  }
}

400 Bad Request

Bad request

Representations

401 Unauthorized

Unauthorized

Representations

500 Internal Server Error

Internal server error

Representations

Code samples

@ECHO OFF

curl -v -X POST "https://api-preprod.nav.no/pensjon/v3/alderspensjon/simuler"
-H "Authorization: "
-H "tp-nr: "
-H "hentFullAPListe: False"
-H "Content-Type: application/json"
-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("Authorization", "");
            client.DefaultRequestHeaders.Add("tp-nr", "");
            client.DefaultRequestHeaders.Add("hentFullAPListe", "False");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://api-preprod.nav.no/pensjon/v3/alderspensjon/simuler?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // 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-preprod.nav.no/pensjon/v3/alderspensjon/simuler");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Authorization", "");
            request.setHeader("tp-nr", "");
            request.setHeader("hentFullAPListe", "False");
            request.setHeader("Content-Type", "application/json");
            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
        };
      
        $.ajax({
            url: "https://api-preprod.nav.no/pensjon/v3/alderspensjon/simuler?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization","");
                xhrObj.setRequestHeader("tp-nr","");
                xhrObj.setRequestHeader("hentFullAPListe","False");
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // 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-preprod.nav.no/pensjon/v3/alderspensjon/simuler";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"Authorization"];
    [_request setValue:@"" forHTTPHeaderField:@"tp-nr"];
    [_request setValue:@"False" forHTTPHeaderField:@"hentFullAPListe"];
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_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-preprod.nav.no/pensjon/v3/alderspensjon/simuler');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Authorization' => '',
    'tp-nr' => '',
    'hentFullAPListe' => 'False',
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

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

// 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
    'Authorization': '',
    'tp-nr': '',
    'hentFullAPListe': 'False',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api-preprod.nav.no')
    conn.request("POST", "/pensjon/v3/alderspensjon/simuler?%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
    'Authorization': '',
    'tp-nr': '',
    'hentFullAPListe': 'False',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api-preprod.nav.no')
    conn.request("POST", "/pensjon/v3/alderspensjon/simuler?%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-preprod.nav.no/pensjon/v3/alderspensjon/simuler')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Authorization'] = ''
# Request headers
request['tp-nr'] = ''
# Request headers
request['hentFullAPListe'] = 'False'
# Request headers
request['Content-Type'] = 'application/json'
# 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