{"openapi":"3.1.0","info":{"title":"UK Auto-Enrolment Helper API","version":"0.1.0","description":"UK Auto-Enrolment Helper applies the 2026-27 workplace pension thresholds published by The Pensions Regulator and GOV.UK to a pay figure. earnings_trigger_check compares pay in a period with the GBP 10,000 a year trigger (GBP 833 a month, GBP 192 a week and the other periods) and, with the worker's age and State Pension age status, says whether automatic enrolment applies or the worker can ask to...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://uk-auto-enrolment.connectorbay.com/mcp.\n\nDisclaimer: General information only, not legal, tax, accounting or payment advice. UK Auto-Enrolment Helper is an independent tool: it is not affiliated with, endorsed by or operated by any government body, central bank, standards body or scheme operator. Rates, thresholds and rules change; check the cited official source and confirm with a qualified professional before you rely on a result.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/uk-auto-enrolment/docs"},"termsOfService":"https://connectorbay.com/uk-auto-enrolment/terms"},"servers":[{"url":"https://uk-auto-enrolment.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/uk-auto-enrolment/docs"},"security":[{},{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/earnings_trigger_check":{"post":{"operationId":"earnings_trigger_check","summary":"Compare pay in a period with the automatic enrolment earnings trigger and say which category applies given age and State","description":"Compare pay in a period with the automatic enrolment earnings trigger and say which category applies given age and State Pension age. Use for \"An employee aged 30 earns GBP 900 this month: does auto-enrolment apply?\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"pay":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"}],"description":"Gross pay in the pay reference period in GBP as a plain decimal such as 3000.00 (salary, wages, bonuses, commission, overtime and statutory pay all count)","title":"Pay"},"period":{"description":"Pay period: weekly, fortnightly, four_weekly, monthly, quarterly, bi_annual or annual","title":"Period","type":"string"},"age":{"description":"Worker's age in whole years","maximum":120,"minimum":16,"title":"Age","type":"integer"},"at_or_over_state_pension_age":{"default":false,"description":"True if the worker has reached State Pension age (confirm this separately; it is not worked out here)","title":"At Or Over State Pension Age","type":"boolean"},"on_date":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Date the thresholds apply on, YYYY-MM-DD (default today); must fall inside 2026-04-06 to 2027-04-05","title":"On Date"}},"required":["pay","period","age"],"title":"earnings_trigger_checkArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/qualifying_earnings":{"post":{"operationId":"qualifying_earnings","summary":"Pay inside the qualifying earnings band (GBP 6,240 to GBP 50,270 a year, scaled to the pay period). Use for \"How much of","description":"Pay inside the qualifying earnings band (GBP 6,240 to GBP 50,270 a year, scaled to the pay period). Use for \"How much of GBP 3,000 monthly pay counts as qualifying earnings?\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"pay":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"}],"description":"Gross pay in the pay reference period in GBP as a plain decimal such as 3000.00 (salary, wages, bonuses, commission, overtime and statutory pay all count)","title":"Pay"},"period":{"description":"Pay period: weekly, fortnightly, four_weekly, monthly, quarterly, bi_annual or annual","title":"Period","type":"string"},"on_date":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Date the thresholds apply on, YYYY-MM-DD (default today); must fall inside 2026-04-06 to 2027-04-05","title":"On Date"}},"required":["pay","period"],"title":"qualifying_earningsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/minimum_contributions":{"post":{"operationId":"minimum_contributions","summary":"Minimum workplace pension contributions on qualifying earnings: 3% employer and 5% employee, 8% in total. Use for \"What ","description":"Minimum workplace pension contributions on qualifying earnings: 3% employer and 5% employee, 8% in total. Use for \"What are the minimum employer and employee pension contributions on GBP 3,000 a month?\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"pay":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"}],"description":"Gross pay in the pay reference period in GBP as a plain decimal such as 3000.00 (salary, wages, bonuses, commission, overtime and statutory pay all count)","title":"Pay"},"period":{"description":"Pay period: weekly, fortnightly, four_weekly, monthly, quarterly, bi_annual or annual","title":"Period","type":"string"},"employer_percent":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"}],"default":"3","description":"Employer percentage of qualifying earnings (default 3, the minimum)","title":"Employer Percent"},"employee_percent":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"}],"default":"5","description":"Employee percentage of qualifying earnings, including tax relief (default 5, the minimum)","title":"Employee Percent"},"on_date":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Date the thresholds apply on, YYYY-MM-DD (default today); must fall inside 2026-04-06 to 2027-04-05","title":"On Date"}},"required":["pay","period"],"title":"minimum_contributionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/thresholds_for_period":{"post":{"operationId":"thresholds_for_period","summary":"Earnings trigger and qualifying earnings band for weekly, fortnightly, four-weekly, monthly, quarterly, bi-annual and an","description":"Earnings trigger and qualifying earnings band for weekly, fortnightly, four-weekly, monthly, quarterly, bi-annual and annual pay periods. Use for \"What are the auto-enrolment thresholds for a four-weekly pay period?\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"period":{"default":"all","description":"weekly, fortnightly, four_weekly, monthly, quarterly, bi_annual, annual or all (default all)","title":"Period","type":"string"},"on_date":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Date the thresholds apply on, YYYY-MM-DD (default today); must fall inside 2026-04-06 to 2027-04-05","title":"On Date"}},"title":"thresholds_for_periodArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/contribution_summary":{"post":{"operationId":"contribution_summary","summary":"Payslip view: worker category, qualifying earnings and the employer and employee minimum contributions in one answer. Us","description":"Payslip view: worker category, qualifying earnings and the employer and employee minimum contributions in one answer. Use for \"For a 35 year old paid GBP 2,400 a month, show the auto-enrolment assessment and minimum contributions.\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"pay":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"}],"description":"Gross pay in the pay reference period in GBP as a plain decimal such as 3000.00 (salary, wages, bonuses, commission, overtime and statutory pay all count)","title":"Pay"},"period":{"description":"Pay period: weekly, fortnightly, four_weekly, monthly, quarterly, bi_annual or annual","title":"Period","type":"string"},"age":{"description":"Worker's age in whole years","maximum":120,"minimum":16,"title":"Age","type":"integer"},"at_or_over_state_pension_age":{"default":false,"description":"True if the worker has reached State Pension age (confirm this separately; it is not worked out here)","title":"At Or Over State Pension Age","type":"boolean"},"on_date":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Date the thresholds apply on, YYYY-MM-DD (default today); must fall inside 2026-04-06 to 2027-04-05","title":"On Date"}},"required":["pay","period","age"],"title":"contribution_summaryArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}