Deprecated. This API is retiring soon. Switch to the HB Compliance Hub API v2.Switch to API v2
HB Portal APIs V1 - Deprecated
Candidate Requests
Training Requests
OH Requests
- GETGet Available Forms
/forms-list - GETGet Form Fields
/form-fields/{{form_type}} - POSTCreating a new submission
/submission/{{candidate_ref}} - PATCHModifying the details of an existing submission (Upload Documents)
/submissions/{{submission_ref}} - POSTMake final form submission (after uploading documents)
/submit-form/{{submission_ref}} - GETGet submission list
/submissions - GETRetrieve submission result details
/submission-result/{{submission_ref}} - GETRetrieve the submission result documents for the employer
/submission-result/{{submission_ref}}/document/employer
Certificates Requests
- GETGet Training Certificate
/training-results/{{candidate_ref}}/certificate - GETGet Training Certificate - including expired
/training-results/{{candidate_ref}}/certificate/incl_expired - GETGet Training Certificate - including non-assigned courses, but excluding expired
/training-results/{{candidate_ref}}/certificate/all_excl_expired - GETGet Training Certificate - All available courses
/training-results/{{candidate_ref}}/certificate/all - GETGet Training Certificate - Specific Course
/training-results/{{candidate_ref}}/certificate/course/{{course_id}}