Create a compliance item

POST

/v1/compliance

curl --request POST \
  --url https://api2.recruso.co.uk/v1/compliance \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "complianceName": "example", "displayInSelfRegistration": true }'

• Production

Creates a compliance item for your agency. A compliance item is a record your agency holds against a worker, and it may or may not carry a validity date.

The name must not already be in use by another of your agency’s records; a clash returns 400 rather than creating a duplicate.

Returns 201 with the created record.

You only ever see and change your own agency’s records; there is no owner id on the request, and an id belonging to another agency returns 404 rather than 403 so that its existence is never disclosed.

Access. Requires a client-credentials access token. Tokens issued through the interactive user login are rejected.

Authorizations

• Bearer

Request Body^required

Media typeapplication/json

object

complianceName

string

displayInSelfRegistration

Whether this compliance item appears in Recruso’s separate worker self-registration service. Your agency chooses which items a self-registering worker is asked for.

boolean

Example^generated

{
  "complianceName": "example",
  "displayInSelfRegistration": true
}

Responses

201

Created

Media typeapplication/json

object

complianceId

integer format: int16

complianceName

string

displayInSelfRegistration

Whether this compliance item appears in Recruso’s separate worker self-registration service. Your agency chooses which items a self-registering worker is asked for.

boolean

Example^generated

{
  "complianceId": 1,
  "complianceName": "example",
  "displayInSelfRegistration": true
}

400

Bad Request

Media typeapplication/problem+json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

401

Unauthorized

Media typeapplication/problem+json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

403

Forbidden

Media typeapplication/problem+json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}