Healthier Business Group
Home
HB Portal
Request API access
Home
HB Portal
Request API access
Contact Us
Copy Page
Walk through Healthier Business Group 🔵
Heathier Business Portal APIs V2
Authentication
Get access token
Refresh access token
Get token info
Revoke current token
Reference Requests
References
Get reference detail
Download reference PDF
List reference requests
Create reference request
Get reference request
Cancel reference request
Add referee to request
Send reminders
Candidate Requests
Training Requests
OH Requests
Practical Training Requests
BLS Requests
Appraisal Requests
Certificate Requests
Training Verification Requests
Webhooks
List webhook endpoints
Create webhook endpoint
Update webhook endpoint
Delete webhook endpoint
View webhook call logs
Send test webhook
Templates
List form templates
Heathier Business Portal APIs V1 - Deprecated
Candidate Requests
Get All Candidates
Get Candidate Data
Create New Candidate
Update Candidate Details
Training Requests
Get Available Trainings
Get Candidate Course Result
Get Candidate Training Report
Get Candidate Training Report - Unassigned
OH Requests
Get Available Forms
Get Form Fields
Creating a new submission
Modifying the details of an existing submission (Upload Documents)
Make final form submission (after uploading documents)
Get submission list
Retrieve submission result details
Retrieve the submission result documents for the employer
Certificates Requests
Get Training Certificate
Get Training Certificate - including expired
Get Training Certificate - including non-assigned courses, but excluding expired
Get Training Certificate - All available courses
Get Training Certificate - Specific Course
Webhooks
Training Completion
Course Completion
HB Services
List Interview Bookings
The Direct Training Academy
Bookings
Get Past Bookings
Get Upcoming Bookings
Search Bookings by Date
Booking Links
Search Booking Links
Registration Assurance Monitoring Portal
Authentication
Obtain access token
Refresh access token
Get token info
Revoke current token
Workers
List workers
Create worker
Get worker
Update worker
Partially update worker
Delete worker
Verification
Verify single worker
Get worker verification history
Batch verify all workers
Get verification job status
Alerts
List alerts
Get alert
Acknowledge single alert
Acknowledge alerts in bulk
Monitoring
Update worker monitoring settings
Bulk update monitoring settings
Evidence
List worker evidence files
Get evidence metadata
Download evidence file
Billing
Get billing and usage summary
Imports
List worker imports
Upload worker CSV import
Get worker import status
Team
List available team roles
List team users
Create team user
Get team user
Update team user
Delete team user
Webhooks
List webhook endpoints
Create webhook endpoint
Get webhook endpoint
Update webhook endpoint
Delete webhook endpoint
Rotate webhook secret
Queue test webhook delivery
Schemas
TokenRequest
Booking
InterviewBooking
TokenResponse
Pagination
RefreshRequest
ReferenceRequest
BookingInvite
Reference
BookingsResponse
ReferenceDetail
TokenInfo
BookingLinksResponse
CreateReferenceRequest
Worker
RefereeInput
WorkerResponse
Template
WorkerPaginatedResponse
WebhookEndpoint
StoreWorkerRequest
CreateWebhookEndpoint
UpdateWorkerRequest
VerificationCheck
UpdateWebhookEndpoint
WebhookCall
VerificationCheckPaginatedResponse
WebhookPayload
VerifyQueuedResponse
PaginationMeta
VerifyBatchResponse
PaginationLinks
VerificationJobStatus
Error
Alert
RateLimitError
AlertPaginatedResponse
MessageResponse
BulkAcknowledgeAlertsRequest
ValidationError
ValidationErrorResponse
AcknowledgeCountResponse
UpdateMonitoringSettingsRequest
BulkUpdateMonitoringSettingsRequest
EvidenceFile
EvidenceFilePaginatedResponse
BillingUsageResponse
StoreWorkerImportRequest
WorkerImport
WorkerImportPaginatedResponse
TeamUser
TeamUserPaginatedResponse
StoreTeamUserRequest
UpdateTeamUserRequest
WebhookEndpointPaginatedResponse
StoreWebhookEndpointRequest
UpdateWebhookEndpointRequest
CreateWebhookEndpointResponse
RotateWebhookSecretResponse
WebhookTestRequest
WebhookTestQueuedResponse
WebhookEventStatusChanged
WebhookEventInitialVerification
Error
Copy Page
{
"error"
:
"string"
,
"message"
:
"string"
}