Skip to main content
GET
List outstanding requirements

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Query Parameters

businessId
string

Filter by business. Required unless personId is provided.

personId
string

Filter by person. Returns only worker_data requirements where this person appears in affected_persons. Useful for building per-worker onboarding or compliance views. countryCode must be provided alongside this parameter.

countryCode
string

Filter by jurisdiction (ISO 3166-1 alpha-2). Required when personId is provided; the request fails with 400 if omitted.

status
enum<string>
Available options:
outstanding,
satisfied,
waived
category
enum<string>
Available options:
business_registration,
business_document,
business_tax_parameter,
worker_data

Response

200 - application/json

List of requirements

data
object[]