Create Core Edition

curl --request PUT \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/core \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Mr",
  "first_name": "Sarah",
  "middle_name": "Anne",
  "last_name": "van der Vaart",
  "maiden_name": "<string>",
  "birth_date": "2023-12-25",
  "personal_email": "jsmith@example.com",
  "work_email": "jsmith@example.com",
  "phone_numbers": [
    {
      "phone_number": "<string>",
      "is_primary": true
    }
  ],
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25"
}
'

import requests

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

payload = {
    "title": "Mr",
    "first_name": "Sarah",
    "middle_name": "Anne",
    "last_name": "van der Vaart",
    "maiden_name": "<string>",
    "birth_date": "2023-12-25",
    "personal_email": "jsmith@example.com",
    "work_email": "jsmith@example.com",
    "phone_numbers": [
        {
            "phone_number": "<string>",
            "is_primary": True
        }
    ],
    "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({
    title: 'Mr',
    first_name: 'Sarah',
    middle_name: 'Anne',
    last_name: 'van der Vaart',
    maiden_name: '<string>',
    birth_date: '2023-12-25',
    personal_email: 'jsmith@example.com',
    work_email: 'jsmith@example.com',
    phone_numbers: [{phone_number: '<string>', is_primary: true}],
    valid_from: '2023-12-25',
    valid_to: '2023-12-25'
  })
};

fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/core', 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}/core",
  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([
    'title' => 'Mr',
    'first_name' => 'Sarah',
    'middle_name' => 'Anne',
    'last_name' => 'van der Vaart',
    'maiden_name' => '<string>',
    'birth_date' => '2023-12-25',
    'personal_email' => 'jsmith@example.com',
    'work_email' => 'jsmith@example.com',
    'phone_numbers' => [
        [
                'phone_number' => '<string>',
                'is_primary' => true
        ]
    ],
    '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}/core"

	payload := strings.NewReader("{\n  \"title\": \"Mr\",\n  \"first_name\": \"Sarah\",\n  \"middle_name\": \"Anne\",\n  \"last_name\": \"van der Vaart\",\n  \"maiden_name\": \"<string>\",\n  \"birth_date\": \"2023-12-25\",\n  \"personal_email\": \"jsmith@example.com\",\n  \"work_email\": \"jsmith@example.com\",\n  \"phone_numbers\": [\n    {\n      \"phone_number\": \"<string>\",\n      \"is_primary\": true\n    }\n  ],\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}/core")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"Mr\",\n  \"first_name\": \"Sarah\",\n  \"middle_name\": \"Anne\",\n  \"last_name\": \"van der Vaart\",\n  \"maiden_name\": \"<string>\",\n  \"birth_date\": \"2023-12-25\",\n  \"personal_email\": \"jsmith@example.com\",\n  \"work_email\": \"jsmith@example.com\",\n  \"phone_numbers\": [\n    {\n      \"phone_number\": \"<string>\",\n      \"is_primary\": true\n    }\n  ],\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}/core")

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  \"title\": \"Mr\",\n  \"first_name\": \"Sarah\",\n  \"middle_name\": \"Anne\",\n  \"last_name\": \"van der Vaart\",\n  \"maiden_name\": \"<string>\",\n  \"birth_date\": \"2023-12-25\",\n  \"personal_email\": \"jsmith@example.com\",\n  \"work_email\": \"jsmith@example.com\",\n  \"phone_numbers\": [\n    {\n      \"phone_number\": \"<string>\",\n      \"is_primary\": true\n    }\n  ],\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>",
  "title": "<string>",
  "first_name": "",
  "middle_name": "<string>",
  "last_name": "",
  "maiden_name": "<string>",
  "gender": "M",
  "marital_status": "SINGLE",
  "birth_date": "2023-12-25",
  "personal_email": "jsmith@example.com",
  "work_email": "jsmith@example.com",
  "phone_numbers": [
    {
      "phone_number": "<string>",
      "phone_type": "MOBILE",
      "is_primary": false
    }
  ]
}

PUT

organizations

{organization_id}

employees

{employee_id}

core

Create Core Edition

curl --request PUT \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/core \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Mr",
  "first_name": "Sarah",
  "middle_name": "Anne",
  "last_name": "van der Vaart",
  "maiden_name": "<string>",
  "birth_date": "2023-12-25",
  "personal_email": "jsmith@example.com",
  "work_email": "jsmith@example.com",
  "phone_numbers": [
    {
      "phone_number": "<string>",
      "is_primary": true
    }
  ],
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25"
}
'

import requests

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

payload = {
    "title": "Mr",
    "first_name": "Sarah",
    "middle_name": "Anne",
    "last_name": "van der Vaart",
    "maiden_name": "<string>",
    "birth_date": "2023-12-25",
    "personal_email": "jsmith@example.com",
    "work_email": "jsmith@example.com",
    "phone_numbers": [
        {
            "phone_number": "<string>",
            "is_primary": True
        }
    ],
    "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({
    title: 'Mr',
    first_name: 'Sarah',
    middle_name: 'Anne',
    last_name: 'van der Vaart',
    maiden_name: '<string>',
    birth_date: '2023-12-25',
    personal_email: 'jsmith@example.com',
    work_email: 'jsmith@example.com',
    phone_numbers: [{phone_number: '<string>', is_primary: true}],
    valid_from: '2023-12-25',
    valid_to: '2023-12-25'
  })
};

fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/core', 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}/core",
  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([
    'title' => 'Mr',
    'first_name' => 'Sarah',
    'middle_name' => 'Anne',
    'last_name' => 'van der Vaart',
    'maiden_name' => '<string>',
    'birth_date' => '2023-12-25',
    'personal_email' => 'jsmith@example.com',
    'work_email' => 'jsmith@example.com',
    'phone_numbers' => [
        [
                'phone_number' => '<string>',
                'is_primary' => true
        ]
    ],
    '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}/core"

	payload := strings.NewReader("{\n  \"title\": \"Mr\",\n  \"first_name\": \"Sarah\",\n  \"middle_name\": \"Anne\",\n  \"last_name\": \"van der Vaart\",\n  \"maiden_name\": \"<string>\",\n  \"birth_date\": \"2023-12-25\",\n  \"personal_email\": \"jsmith@example.com\",\n  \"work_email\": \"jsmith@example.com\",\n  \"phone_numbers\": [\n    {\n      \"phone_number\": \"<string>\",\n      \"is_primary\": true\n    }\n  ],\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}/core")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"Mr\",\n  \"first_name\": \"Sarah\",\n  \"middle_name\": \"Anne\",\n  \"last_name\": \"van der Vaart\",\n  \"maiden_name\": \"<string>\",\n  \"birth_date\": \"2023-12-25\",\n  \"personal_email\": \"jsmith@example.com\",\n  \"work_email\": \"jsmith@example.com\",\n  \"phone_numbers\": [\n    {\n      \"phone_number\": \"<string>\",\n      \"is_primary\": true\n    }\n  ],\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}/core")

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  \"title\": \"Mr\",\n  \"first_name\": \"Sarah\",\n  \"middle_name\": \"Anne\",\n  \"last_name\": \"van der Vaart\",\n  \"maiden_name\": \"<string>\",\n  \"birth_date\": \"2023-12-25\",\n  \"personal_email\": \"jsmith@example.com\",\n  \"work_email\": \"jsmith@example.com\",\n  \"phone_numbers\": [\n    {\n      \"phone_number\": \"<string>\",\n      \"is_primary\": true\n    }\n  ],\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>",
  "title": "<string>",
  "first_name": "",
  "middle_name": "<string>",
  "last_name": "",
  "maiden_name": "<string>",
  "gender": "M",
  "marital_status": "SINGLE",
  "birth_date": "2023-12-25",
  "personal_email": "jsmith@example.com",
  "work_email": "jsmith@example.com",
  "phone_numbers": [
    {
      "phone_number": "<string>",
      "phone_type": "MOBILE",
      "is_primary": false
    }
  ]
}

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

title

string | null

required

Title, at most 4 characters (P11D limit); null when none

Required string length: 1 - 4

Pattern: ^[A-Za-z]([A-Za-z'-]*[A-Za-z'-])?$

Example:

"Mr"

first_name

string

required

First forename, no spaces

Required string length: 1 - 35

Pattern: ^[A-Za-z]([A-Za-z'-]*[A-Za-z'-])?$

Example:

"Sarah"

middle_name

string | null

required

Second forename, no spaces; null when none

Required string length: 1 - 35

Pattern: ^[A-Za-z]([A-Za-z'-]*[A-Za-z'-])?$

Example:

"Anne"

last_name

string

required

Surname

Required string length: 1 - 35

Pattern: ^[A-Za-z]([A-Za-z' -]*[A-Za-z'-])?$

Example:

"van der Vaart"

maiden_name

string | null

required

Surname before marriage; null when none

Required string length: 1 - 35

Pattern: ^[A-Za-z]([A-Za-z' -]*[A-Za-z'-])?$

gender

enum<string>

required

Gender

Available options:

M,

F

marital_status

enum<string> | null

required

Marital status; null when unknown

Available options:

SINGLE,

MARRIED

birth_date

string<date>

required

Birth date

personal_email

string<email> | null

required

Personal email; null when none. Required by pension provider as contact option after employment ends.

work_email

string<email> | null

required

Work email; null when none. Required by pension provider.

phone_numbers

Phones · object[]

required

Phone numbers; empty when none. Required by pension provider.

Show child attributes

valid_from

string<date>

required

valid_to

string<date>

required

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.

title

string | null

Title

first_name

string

default:""

First forename

middle_name

string | null

Second forename

last_name

string

default:""

Surname

maiden_name

string | null

Surname before marriage

gender

enum<string> | null

Gender

Available options:

M,

F

marital_status

enum<string> | null

Marital status

Available options:

SINGLE,

MARRIED

birth_date

string<date> | null

Birth date

personal_email

string<email> | null

work_email

string<email> | null

phone_numbers

GBPhonesRead · object[]

Phone numbers

Show child attributes