List bank account types

GET

/v1/reference/bank-account-types

curl --request GET \
  --url https://api2.recruso.co.uk/v1/reference/bank-account-types \
  --header 'Authorization: <Authorization>'

• Production

Returns every bank account type the platform publishes. Distinguishes a bank account from a building society account. You need one when you record a worker’s bank details.

These values are platform-wide: every agency sees the same list and the same ids, and your agency cannot add to them or change them. No endpoint published on this API takes a bank account type id yet; the vocabulary is published so that its values are enumerable.

The list is not paged, and no order is guaranteed — sort client-side if you need one. The values change very rarely, so cache them rather than fetching them before every call.

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

Authorizations

• Bearer

Responses

200

OK

Media typeapplication/json

Every bank account type the platform publishes.

object

bankAccountTypes

required

The bank account types. Never null.

Array<object>

One bank account type in a list.

object

id

The bank account type’s identifier. Stable and platform-wide — the same id means the same thing for every agency.

integer format: int16

name

The bank account type name, as it appears in Recruso. Up to 50 characters. Unique across all bank account types.

string

Example

{
  "bankAccountTypes": [
    {
      "id": 1,
      "name": "Bank Account"
    }
  ]
}

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"
}