Skip to content

Get National Insurance category details

GET
/v1/reference/ni-categories/{id}
curl --request GET \
--url https://api2.recruso.co.uk/v1/reference/ni-categories/1 \
--header 'Authorization: <Authorization>'

Returns one National Insurance category by id. The HMRC National Insurance category letter a worker is paid under.

National Insurance categories are platform-wide, so an id means the same National Insurance category for every agency.

An id that does not match a National Insurance category returns 404.

Access. Requires an authenticated token. No further policy is applied.

id
required
integer format: int32

The id path parameter

OK

Media typeapplication/json

One National Insurance category.

object
id

The National Insurance category’s identifier. Stable and platform-wide — the same id means the same thing for every agency.

integer format: int16
name

The National Insurance category name, as it appears in Recruso. Up to 10 characters. Unique across all National Insurance categories.

string
description

A longer description of the National Insurance category. May be null.

string
nullable
Example
{
"id": 1,
"name": "A",
"description": "Standard rate"
}

Unauthorized

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}