Generate a NEST enrol workers (ME) file

curl --request POST \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/files/me \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "overwrite_soft_validation": false
}
'

import requests

url = "https://dev.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/files/me"

payload = { "overwrite_soft_validation": False }
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({overwrite_soft_validation: false})
};

fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/files/me', 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}/pension/nest/files/me",
  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([
    'overwrite_soft_validation' => false
  ]),
  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}/pension/nest/files/me"

	payload := strings.NewReader("{\n  \"overwrite_soft_validation\": false\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://dev.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/files/me")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"overwrite_soft_validation\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dev.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/files/me")

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  \"overwrite_soft_validation\": false\n}"

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

{
  "file_id": "<string>",
  "file_type": "ME",
  "status": "GENERATED",
  "record_count": 123,
  "document_id": "<string>",
  "problems": [
    {
      "code": "MISSING_VALUE",
      "message": "<string>",
      "employee_id": "<string>",
      "field": "<string>"
    }
  ],
  "warnings": [
    {
      "code": "MISSING_VALUE",
      "message": "<string>",
      "employee_id": "<string>",
      "field": "<string>"
    }
  ],
  "members": [
    {
      "employee_id": "<string>",
      "enrolment_date": "2023-12-25",
      "scheme_id": "<string>",
      "identifier_type": "NINO",
      "rejected": true,
      "resolved_at": "2023-11-07T05:31:56Z"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "uploaded_at": "2023-11-07T05:31:56Z",
  "uploaded_by": "<string>"
}

NEST

Generate a NEST enrol workers (ME) file

Builds the ME for every enrolment in a NEST scheme with submission method FILE that NEST does not hold yet: not in an uploaded file, not in the baseline, and not rejected and awaiting a fix in NEST. When records have problems NEST would reject, the file is stored as FAILED with every problem listed and no CSV. Warnings return 422 NEST_FILE_WARNINGS unless overwrite_soft_validation is true; the acknowledged warnings are kept on the file. A new file replaces an earlier one that was never marked uploaded. Files are uploaded by the client on the NEST website; Intermezzo cannot see the outcome, so the client reports it with mark-uploaded.

POST

organizations

{organization_id}

pension

nest

files

Generate a NEST enrol workers (ME) file

curl --request POST \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/files/me \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "overwrite_soft_validation": false
}
'

import requests

url = "https://dev.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/files/me"

payload = { "overwrite_soft_validation": False }
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({overwrite_soft_validation: false})
};

fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/files/me', 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}/pension/nest/files/me",
  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([
    'overwrite_soft_validation' => false
  ]),
  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}/pension/nest/files/me"

	payload := strings.NewReader("{\n  \"overwrite_soft_validation\": false\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://dev.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/files/me")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"overwrite_soft_validation\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dev.intermezzo.ai/gb/organizations/{organization_id}/pension/nest/files/me")

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  \"overwrite_soft_validation\": false\n}"

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

{
  "file_id": "<string>",
  "file_type": "ME",
  "status": "GENERATED",
  "record_count": 123,
  "document_id": "<string>",
  "problems": [
    {
      "code": "MISSING_VALUE",
      "message": "<string>",
      "employee_id": "<string>",
      "field": "<string>"
    }
  ],
  "warnings": [
    {
      "code": "MISSING_VALUE",
      "message": "<string>",
      "employee_id": "<string>",
      "field": "<string>"
    }
  ],
  "members": [
    {
      "employee_id": "<string>",
      "enrolment_date": "2023-12-25",
      "scheme_id": "<string>",
      "identifier_type": "NINO",
      "rejected": true,
      "resolved_at": "2023-11-07T05:31:56Z"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "uploaded_at": "2023-11-07T05:31:56Z",
  "uploaded_by": "<string>"
}

Authorizations

Authorization

string

header

required

Get token from Auth0 and paste it here

Path Parameters

organization_id

string

required

Body

application/json

overwrite_soft_validation

boolean

default:false

Request-scoped, not stored as a setting: generate even when there are warnings. The acknowledged warnings are recorded on the file

Response

Successful Response

file_id

string

required

file_type

enum<string>

required

Which NEST file a row records.

Available options:

ME,

BASELINE

status

enum<string>

required

Lifecycle of one generated NEST file.

Uploads happen on the NEST website, so the two UPLOADED states are set by the client.

Available options:

GENERATED,

FAILED,

SUPERSEDED,

UPLOADED_ALL_ACCEPTED,

UPLOADED_WITH_ERRORS

record_count

integer

required

document_id

string | null

required

problems

NestFileFinding · object[]

required

Why the file could not be produced; only when FAILED

Show child attributes

warnings

NestFileFinding · object[]

required

Warnings acknowledged with overwrite_soft_validation

Show child attributes

members

NestFileMemberResponse · object[]

required

Show child attributes

created_at

string<date-time>

required

created_by

string | null

required

uploaded_at

string<date-time> | null

required

uploaded_by

string | null

required

Core

Great Britain

Generate a NEST enrol workers (ME) file

Authorizations

Path Parameters

Body

Response