Register a new NEST employer
curl --request POST \
--url https://preview.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/setup \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"scheme_id": "<string>",
"staging_date": "2023-12-25",
"pay_group_id": "<string>",
"first_eped": "2023-12-25",
"contact_forename": "<string>",
"contact_surname": "<string>",
"contact_email": "jsmith@example.com",
"contact_phone": "<string>",
"contact_address_line1": "<string>",
"contact_town_or_city": "<string>",
"contact_post_code": "<string>"
}
'import requests
url = "https://preview.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/setup"
payload = {
"scheme_id": "<string>",
"staging_date": "2023-12-25",
"pay_group_id": "<string>",
"first_eped": "2023-12-25",
"contact_forename": "<string>",
"contact_surname": "<string>",
"contact_email": "jsmith@example.com",
"contact_phone": "<string>",
"contact_address_line1": "<string>",
"contact_town_or_city": "<string>",
"contact_post_code": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
scheme_id: '<string>',
staging_date: '2023-12-25',
pay_group_id: '<string>',
first_eped: '2023-12-25',
contact_forename: '<string>',
contact_surname: '<string>',
contact_email: 'jsmith@example.com',
contact_phone: '<string>',
contact_address_line1: '<string>',
contact_town_or_city: '<string>',
contact_post_code: '<string>'
})
};
fetch('https://preview.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/setup', 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://preview.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/setup",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'scheme_id' => '<string>',
'staging_date' => '2023-12-25',
'pay_group_id' => '<string>',
'first_eped' => '2023-12-25',
'contact_forename' => '<string>',
'contact_surname' => '<string>',
'contact_email' => 'jsmith@example.com',
'contact_phone' => '<string>',
'contact_address_line1' => '<string>',
'contact_town_or_city' => '<string>',
'contact_post_code' => '<string>'
]),
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://preview.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/setup"
payload := strings.NewReader("{\n \"scheme_id\": \"<string>\",\n \"staging_date\": \"2023-12-25\",\n \"pay_group_id\": \"<string>\",\n \"first_eped\": \"2023-12-25\",\n \"contact_forename\": \"<string>\",\n \"contact_surname\": \"<string>\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_phone\": \"<string>\",\n \"contact_address_line1\": \"<string>\",\n \"contact_town_or_city\": \"<string>\",\n \"contact_post_code\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://preview.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/setup")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scheme_id\": \"<string>\",\n \"staging_date\": \"2023-12-25\",\n \"pay_group_id\": \"<string>\",\n \"first_eped\": \"2023-12-25\",\n \"contact_forename\": \"<string>\",\n \"contact_surname\": \"<string>\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_phone\": \"<string>\",\n \"contact_address_line1\": \"<string>\",\n \"contact_town_or_city\": \"<string>\",\n \"contact_post_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://preview.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/setup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scheme_id\": \"<string>\",\n \"staging_date\": \"2023-12-25\",\n \"pay_group_id\": \"<string>\",\n \"first_eped\": \"2023-12-25\",\n \"contact_forename\": \"<string>\",\n \"contact_surname\": \"<string>\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_phone\": \"<string>\",\n \"contact_address_line1\": \"<string>\",\n \"contact_town_or_city\": \"<string>\",\n \"contact_post_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"submission_id": "<string>",
"status": "PENDING"
}NEST
Register a new NEST employer
Registers the organisation as a new employer with NEST (Set Up New Employer). The scheme in the body must have provider=NEST and submission method API; it defines the employer’s first NEST group. On success the connection is AWAITING_EMPLOYER: NEST emails the primary contact, who must accept NEST’s terms and create a payment source in NEST before a verify reports READY. Returns 202 with a submission ID; poll /nest/status for the outcome.
POST
/
gb
/
organizations
/
{organization_id}
/
pension
/
nest
/
setup
Register a new NEST employer
curl --request POST \
--url https://preview.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/setup \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"scheme_id": "<string>",
"staging_date": "2023-12-25",
"pay_group_id": "<string>",
"first_eped": "2023-12-25",
"contact_forename": "<string>",
"contact_surname": "<string>",
"contact_email": "jsmith@example.com",
"contact_phone": "<string>",
"contact_address_line1": "<string>",
"contact_town_or_city": "<string>",
"contact_post_code": "<string>"
}
'import requests
url = "https://preview.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/setup"
payload = {
"scheme_id": "<string>",
"staging_date": "2023-12-25",
"pay_group_id": "<string>",
"first_eped": "2023-12-25",
"contact_forename": "<string>",
"contact_surname": "<string>",
"contact_email": "jsmith@example.com",
"contact_phone": "<string>",
"contact_address_line1": "<string>",
"contact_town_or_city": "<string>",
"contact_post_code": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
scheme_id: '<string>',
staging_date: '2023-12-25',
pay_group_id: '<string>',
first_eped: '2023-12-25',
contact_forename: '<string>',
contact_surname: '<string>',
contact_email: 'jsmith@example.com',
contact_phone: '<string>',
contact_address_line1: '<string>',
contact_town_or_city: '<string>',
contact_post_code: '<string>'
})
};
fetch('https://preview.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/setup', 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://preview.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/setup",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'scheme_id' => '<string>',
'staging_date' => '2023-12-25',
'pay_group_id' => '<string>',
'first_eped' => '2023-12-25',
'contact_forename' => '<string>',
'contact_surname' => '<string>',
'contact_email' => 'jsmith@example.com',
'contact_phone' => '<string>',
'contact_address_line1' => '<string>',
'contact_town_or_city' => '<string>',
'contact_post_code' => '<string>'
]),
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://preview.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/setup"
payload := strings.NewReader("{\n \"scheme_id\": \"<string>\",\n \"staging_date\": \"2023-12-25\",\n \"pay_group_id\": \"<string>\",\n \"first_eped\": \"2023-12-25\",\n \"contact_forename\": \"<string>\",\n \"contact_surname\": \"<string>\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_phone\": \"<string>\",\n \"contact_address_line1\": \"<string>\",\n \"contact_town_or_city\": \"<string>\",\n \"contact_post_code\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://preview.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/setup")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scheme_id\": \"<string>\",\n \"staging_date\": \"2023-12-25\",\n \"pay_group_id\": \"<string>\",\n \"first_eped\": \"2023-12-25\",\n \"contact_forename\": \"<string>\",\n \"contact_surname\": \"<string>\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_phone\": \"<string>\",\n \"contact_address_line1\": \"<string>\",\n \"contact_town_or_city\": \"<string>\",\n \"contact_post_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://preview.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/setup")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scheme_id\": \"<string>\",\n \"staging_date\": \"2023-12-25\",\n \"pay_group_id\": \"<string>\",\n \"first_eped\": \"2023-12-25\",\n \"contact_forename\": \"<string>\",\n \"contact_surname\": \"<string>\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_phone\": \"<string>\",\n \"contact_address_line1\": \"<string>\",\n \"contact_town_or_city\": \"<string>\",\n \"contact_post_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"submission_id": "<string>",
"status": "PENDING"
}Authorizations
Get token from Auth0 and paste it here
Path Parameters
Body
application/json
NEST scheme whose provider_config defines the employer's first NEST group
The employer's auto-enrolment duties start date
NEST band for the size of the workforce
Available options:
A, B, C Pay group whose frequency defines the NEST group
End date of the first earnings period NEST should schedule contributions for; must be today or later. Supplied explicitly because pay calendars are organisation-wide and cannot tell which pay group a period belongs to
Title values NEST accepts, case-sensitive.
Available options:
Mr, Mrs, Miss, Ms, Dr Was this page helpful?