Create Insurance Edition

curl --request PUT \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/insurance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "national_insurance_number": "<string>",
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25"
}
'

import requests

url = "https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/insurance"

payload = {
    "national_insurance_number": "<string>",
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    national_insurance_number: '<string>',
    valid_from: '2023-12-25',
    valid_to: '2023-12-25'
  })
};

fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/insurance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/insurance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'national_insurance_number' => '<string>',
    'valid_from' => '2023-12-25',
    'valid_to' => '2023-12-25'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/insurance"

	payload := strings.NewReader("{\n  \"national_insurance_number\": \"<string>\",\n  \"valid_from\": \"2023-12-25\",\n  \"valid_to\": \"2023-12-25\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/insurance")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"national_insurance_number\": \"<string>\",\n  \"valid_from\": \"2023-12-25\",\n  \"valid_to\": \"2023-12-25\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/insurance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"national_insurance_number\": \"<string>\",\n  \"valid_from\": \"2023-12-25\",\n  \"valid_to\": \"2023-12-25\"\n}"

response = http.request(request)
puts response.read_body

{
  "edition": 123,
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "national_insurance_number": "<string>",
  "nic_category": "A",
  "overseas_national_awaiting_nino": true
}

PUT

organizations

{organization_id}

employees

{employee_id}

insurance

Create Insurance Edition

curl --request PUT \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/insurance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "national_insurance_number": "<string>",
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25"
}
'

import requests

url = "https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/insurance"

payload = {
    "national_insurance_number": "<string>",
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    national_insurance_number: '<string>',
    valid_from: '2023-12-25',
    valid_to: '2023-12-25'
  })
};

fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/insurance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/insurance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'national_insurance_number' => '<string>',
    'valid_from' => '2023-12-25',
    'valid_to' => '2023-12-25'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/insurance"

	payload := strings.NewReader("{\n  \"national_insurance_number\": \"<string>\",\n  \"valid_from\": \"2023-12-25\",\n  \"valid_to\": \"2023-12-25\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/insurance")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"national_insurance_number\": \"<string>\",\n  \"valid_from\": \"2023-12-25\",\n  \"valid_to\": \"2023-12-25\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/insurance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"national_insurance_number\": \"<string>\",\n  \"valid_from\": \"2023-12-25\",\n  \"valid_to\": \"2023-12-25\"\n}"

response = http.request(request)
puts response.read_body

{
  "edition": 123,
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "national_insurance_number": "<string>",
  "nic_category": "A",
  "overseas_national_awaiting_nino": true
}

Authorizations

Authorization

string

header

required

Get token from Auth0 and paste it here

Headers

If-Match

string | null

If-None-Match

string | null

X-Acting-User

string | null

The person acting through the access credential, recorded as created_by of what the request writes. Audit only: access is checked on the credential.

Required string length: 1 - 255

Path Parameters

organization_id

string

required

employee_id

string

required

Body

application/json

national_insurance_number

string | null

required

National Insurance number; null when not known

Required string length: 9

nic_category

enum<string>

required

NIC category letter

Available options:

A,

B,

C,

D,

E,

F,

H,

I,

J,

K,

L,

M,

N,

S,

V,

X,

Z

valid_from

string<date>

required

valid_to

string<date>

required

overseas_national_awaiting_nino

boolean | null

Overseas national waiting for a National Insurance number; asked by NEST when there is no number, and decides whether NEST claims tax relief. Null when not answered

Response

Successful Response

edition

integer

required

read-only

valid_from

string<date>

required

valid_to

string<date>

required

created_at

string<date-time>

required

read-only

created_by

string

required

read-only

Who wrote the edition: the acting user (X-Acting-User, else the access credential), system for our own writes, or <authority>:<notice> for a write on an authority's behalf, e.g. hmrc:P6.

national_insurance_number

string | null

National Insurance number

nic_category

enum<string> | null

NIC Letter Categories

Available options:

A,

B,

C,

D,

E,

F,

H,

I,

J,

K,

L,

M,

N,

S,

V,

X,

Z

overseas_national_awaiting_nino

boolean | null

Overseas national waiting for a National Insurance number; asked by NEST when there is no number, and decides whether NEST claims tax relief. Null when not answered

Core

Great Britain

Create Insurance Edition

Authorizations

Headers

Path Parameters

Body

Response