Healthier Business Group
Home
HB PortalRequest API access
Home
HB PortalRequest API access
X
Instagram
LinkedIn
  1. OH Requests
  • 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
      • Get Form Fields
        GET
      • Creating a new submission
        POST
      • Modifying the details of an existing submission (Upload Documents)
        PATCH
      • Make final form submission (after uploading documents)
        POST
      • Get submission list
        GET
      • Retrieve submission result details
        GET
      • Retrieve the submission result documents for the employer
        GET
    • 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
      GET
  • The Direct Training Academy
    • Bookings
      • Get Past Bookings
      • Get Upcoming Bookings
      • Search Bookings by Date
    • Booking Links
      • Search Booking Links
  • Schemas
    • Booking
    • TokenResponse
    • InterviewBooking
    • Pagination
    • BookingInvite
    • ReferenceRequest
    • BookingsResponse
    • Reference
    • BookingLinksResponse
    • ReferenceDetail
    • CreateReferenceRequest
    • RefereeInput
    • Template
    • WebhookEndpoint
    • CreateWebhookEndpoint
    • UpdateWebhookEndpoint
    • WebhookCall
    • WebhookPayload
    • PaginationMeta
    • PaginationLinks
    • Error
    • RateLimitError
    • ValidationError
  1. OH Requests

Retrieve the submission result documents for the employer

GET
/submission-result/{{submission_ref}}/document/employer
Maintainer:Not configured
This endpoint retrieves the result document in PDF format that should be forwarded to the employer.
If the screening process finished successfully and the document is available, the response is an HTTP 200 OK, application/pdf or application/octet-stream and it wraps a binary data stream for the file content.
If the submission_ref is not valid then the API should response with HTTP 404 Not Found error.
If the screening process has not finished yet the response should be HTTP 202 Accepted without any other data.
If the candidate screening process did not result a downloadable certification, most likely because further information is required before the process can be completed, the API should send an HTTP 204 No Content response.

Request

Authorization
Add parameter in header
API-Key
Example:
API-Key: ********************
Header 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 -g --request GET '/submission-result/{{submission_ref}}/document/employer' \
--header 'Accept: application/pdf' \
--header 'API-Version: {{api_version}}' \
--header 'API-Key: <api-key>'

Responses

🟢200Success
application/json
Body

Example
{}
Modified at 2024-08-09 12:15:37
Previous
Retrieve submission result details
Next
Get Training Certificate
Built with