List outstanding requirements
Returns requirements — data inputs, documents, or registrations needed before filings can proceed.
Filter by businessId for a business-wide view (all categories), or
by personId to see what a specific worker is missing. At least one
of businessId or personId must be provided, and countryCode is
required whenever personId is used.
Requirements are generated automatically based on the business’s jurisdictions and workforce composition. They update dynamically as workers are added or laws change.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Required when using a Platform API token. The tenant key identifying which business to operate on.
Query Parameters
Filter by business. Required unless personId is provided.
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.
Filter by jurisdiction (ISO 3166-1 alpha-2). Required when personId is provided; the request fails with 400 if omitted.
outstanding, satisfied, waived business_registration, business_document, business_tax_parameter, worker_data Response
List of requirements