Skip to main content
PUT
Create Insurance Edition

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Headers

If-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
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
national_insurance_number
string | null

National Insurance number

Required string length: 9

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

Required string length: 9
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