Healthier Business Group
Home
HB PortalRequest API access
Home
HB PortalRequest API access
X
Instagram
LinkedIn
  1. References
  • 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
          GET
        • Download reference PDF
          GET
      • List reference requests
        GET
      • Create reference request
        POST
      • Get reference request
        GET
      • Cancel reference request
        POST
      • Add referee to request
        POST
      • Send reminders
        POST
    • 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
  1. References

Download reference PDF

GET
/references/{uuid}/pdf
Maintainer:Not configured
Download the generated PDF report for a completed reference. Only available for references with status completed that have a generated PDF.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/references//pdf' \
--header 'Authorization: Bearer <token>'

Responses

🟢200
application/pdf
PDF file
🟠404
Modified at 2026-02-17 18:56:15
Previous
Get reference detail
Next
List reference requests
Built with