The Healthier Business Legacy APIs are retiring soon. Move to the HB Compliance Hub API v2: build and test your integration against a sandbox account now, and when the Compliance Hub is released, switch to the live API by changing the base URL and key.Switch to API v2Create a sandbox
Healthier Business DEVELOPERS
SupportStatusConsole
Developer Portal GuideSchemasSDKs & MCP
Sign in
Overview
  • Healthier Business Group
  • Integrations

HB Services APIs
  • HB Services
  • List Interview BookingsGET

More sections
Authentication
  • Overview
  • Exchange an API key for a token pairPOST
  • Get a new token pair with a refresh tokenPOST
  • Revoke the access tokenPOST
  • Show the key behind the tokenGET
Hub (core)
  • Overview
  • List candidatesGET
  • Create a candidatePOST
  • Get a candidateGET
  • Update a candidatePATCH
Account
  • Overview
  • List webhook endpointsGET
  • Create a webhook endpointPOST
  • List the events an endpoint can receiveGET
  • Get one webhook endpointGET
  • Update a webhook endpointPUT
  • Delete a webhook endpointDEL
  • List the deliveries of an endpointGET
  • Redeliver an eventPOST
  • Rotate the signing secretPOST
  • Send a test eventPOST
Online Training
  • Overview
  • A combined training certificate was supplied for a candidate
  • Courses were assigned to a candidate
  • A candidate passed a course
  • A candidate completed all their assigned training
  • A candidate was sent a reminder that their training has expired
  • A candidate was sent a reminder that their training is due for renewal
  • List candidates with trainingGET
  • Get a candidate's trainingGET
  • Download a certificateGET
  • Set the courses of a candidatePUT
  • Send a reminder email to a candidatePOST
  • List the modules of a candidate's coursesGET
Occupational Health
  • Overview
  • A Fit to Work certificate or fail letter was added to a request
  • A candidate was sent a renewal reminder
  • A request is waiting for the candidate to complete the questionnaire
  • A request ended in a fail (not fit)
  • Full clearance was issued
  • The candidate completed the online questionnaire
  • A request was rejected
  • A request was submitted to Healthier Business
  • Temporary clearance was issued
  • List alertsGET
  • Dismiss all alertsPOST
  • Dismiss one alertPOST
References
  • Overview
  • Candidate Submitted Referee Details
  • All References Completed
  • Reference Declined
  • Reference Expired
  • Reminder Sent to Referee
  • Reference Request Created
  • Reference Submitted
  • Get a referee's referenceGET
  • Download a reference as a PDFGET
  • Remind one refereePOST
  • List reference requestsGET
  • Create a reference requestPOST
Practical Training
  • Overview
  • The booking balance ran out
  • The booking balance is low
  • Attendance was recorded on the last day
  • A booking was cancelled or refunded
  • A certificate is available
  • A booking was confirmed (paid)
  • A booking was created
  • A candidate did not attend
  • A booking was rescheduled
  • A booking invitation was opened
  • A booking invitation was sent
  • A booking invitation was used to book
Virtual BLS Training
  • Overview
  • Attendance was recorded
  • A booking was cancelled or refunded
  • A certificate is available
  • A booking was confirmed (paid)
  • A booking was created
  • The training kit is overdue for return
  • A booking was rescheduled
  • Get the booking linkGET
  • List bookingsGET
  • Create a bookingPOST
  • Get a bookingGET
  • Cancel a bookingPOST
Clinical Interviews
  • Overview
  • Attendance was recorded
  • A booking was cancelled
  • A booking was confirmed (paid)
  • A booking was created
  • An interview was completed, missed or ended incomplete
  • The interviewer submitted the interview report
  • A booking was rescheduled
  • List bookingsGET
  • Book a held slotPOST
  • Get a bookingGET
  • Cancel a bookingPOST
  • Download the interview reportGET
Registration Monitoring
  • Overview
  • A worker registration was verified for the first time
  • A worker registration status changed
  • List alertsGET
  • Acknowledge several alertsPOST
  • Show an alertGET
  • Acknowledge an alertPOST
  • List billsGET
  • Download a bill's invoiceGET
  • Show billing and usageGET
  • Show an evidence fileGET
  • Download an evidence fileGET
  • Show the raw data of a registration checkGET
DBS & Right To Work
  • Overview
  • A DBS or right to work alert was raised
  • A worker DBS Update Service status changed
  • A worker right to work status changed
  • List alertsGET
  • Acknowledge several alertsPOST
  • Show an alertGET
  • Acknowledge an alertPOST
  • List billsGET
  • Download a bill's invoiceGET
  • Show billing and usageGET
  • Show the raw data of a DBS checkGET
  • Download a DBS certificate PDFGET
Clinical Appraisals
  • Overview
  • A booking was confirmed (paid)
  • A booking was created
  • List appraisal typesGET
  • List bookingsGET
  • Book an appraisalPOST
  • Get a bookingGET
  • Download the evaluation reportGET
  • Get credits and balanceGET
  • List credit transactionsGET
  • Get the account profileGET
Training Verification
  • Overview
  • Training Verification API: overview
  • Who pays for what
  • Submitting a certificate
  • Statuses and results
  • Webhooks
  • Errors
  • Sandbox behaviour
  • A verification failed
  • A certificate could not be matched to a record
  • A verification started processing
  • The charge of a verification was refunded
  • A verification was rejected or cancelled
Virtual BLS APIs
  • Overview
  • Healthier Business - Virtual BLS
Practical Training APIs
  • Overview
  • Healthier Business - TDTA - Practical Training
Clinical Interview APIs
  • Overview
  • Clinical Interview APIs
Registration Assurance Monitoring APIs
  • Overview
HB Portal APIs V1 - Deprecated
  • Overview
Practical Training Legacy APIs - Deprecated
  • Overview
Developer Portal Guide
  • Overview
  • Overview
  • Create your account
  • Verify your email
  • Sign in and security
  • The console tour
  • Sandboxes
  • API keys and token exchange
  • Calling the API from curl and Postman
  • Webhooks
  • Data page and JSON viewer
  • Simulate
  • API Playground
Schemas
  • Overview
  • InterviewBooking
  • TokenRequest
  • CourseItem
  • InterviewTypeItem
  • RequiredDocument
  • Pagination
  • TokenResponse
  • ReferenceRequest
  • RefreshRequest
  • RequiredDocumentsResponse
  • BookingsResponse
  • Reference
Deprecated. This API is retiring soon. Switch to the HB Compliance Hub API v2.Switch to API v2
Home/HB Services APIs

HB Services

llms.txt

Last updated 28 Oct 20261 min readNeed help? Contact support
Was this page helpful?
PreviousCourse CompletionNextList Interview Bookings
Healthier Business Group · Abbey Mill Business Centre, 12 Seedhill Road, PA1 1JS · 0141 889 5522hbcompliance.co.ukContact usPrivacy policyAccreditationComplaintsllms.txt

Responses are generated using AI and may contain mistakes. Fair use: 30 questions a day.

Ask questions about Healthier Business and get help with your integration.

Tip: you can highlight any text to ask questions about it with ⌘ + I

Healthier Business Documentation