# Healthier Business Group ## Docs - [Walk through Healthier Business Group 🔵](https://dev.hbcompliance.co.uk/doc-625018.md): ## API Docs - Heathier Business Portal APIs V2 > Authorization [Request API Token](https://dev.hbcompliance.co.uk/api-9239662.md): - Heathier Business Portal APIs V2 > Authorization [Refresh API Token](https://dev.hbcompliance.co.uk/api-9250958.md): - Heathier Business Portal APIs V1 - Deprecated > Candidate Requests [Get All Candidates](https://dev.hbcompliance.co.uk/api-9235757.md): This endpoint retrieves a list of all non-archived candidates. - Heathier Business Portal APIs V1 - Deprecated > Candidate Requests [Get Candidate Data](https://dev.hbcompliance.co.uk/api-9235758.md): This endpoint retrieves candidate data. The URI format is: [https://hb-host.tld/api/candidates/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX](https://hb-host.tld/api/candidates/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) - Heathier Business Portal APIs V1 - Deprecated > Candidate Requests [Create New Candidate](https://dev.hbcompliance.co.uk/api-9235759.md): The request is HTTP POST (RFC 2616), application/x-www-form-urlencoded or multipart/form-data (RFC7578) and holds all the required details of the candidate. - Heathier Business Portal APIs V1 - Deprecated > Candidate Requests [Update Candidate Details](https://dev.hbcompliance.co.uk/api-9235760.md): The request is HTTP PATCH (RFC 5789), application/x-www-form-urlencoded or multipart/form-data (RFC7578) and holds the updated details of the candidate. This is a partial update call, which does not update every detail every time, only the modified ones. The available data fields are listed in Appendix 4.2. - Heathier Business Portal APIs V1 - Deprecated > Training Requests [Get Available Trainings](https://dev.hbcompliance.co.uk/api-9235761.md): The endpoint provides a method to retrieve the list of trainings provided by the authenticated client. The requests are HTTP GET (RFC2616) and uses api key as a resource identifier identifying the client uniquely at HB. - Heathier Business Portal APIs V1 - Deprecated > Training Requests [Get Candidate Course Result](https://dev.hbcompliance.co.uk/api-9235762.md): The endpoint provides a method to retrieve the status of an individual course whether currently assigned or not. The requests are HTTP GET (RFC2616) and uses candidate_ref as a resource identifier identifying the candidate uniquely at HB and the course_id to identify the course for which the status is requested. - Heathier Business Portal APIs V1 - Deprecated > Training Requests [Get Candidate Training Report](https://dev.hbcompliance.co.uk/api-9235763.md): The endpoint provides a method to retrieve status results for each course currently assigned to the candidate. - Heathier Business Portal APIs V1 - Deprecated > Training Requests [Get Candidate Training Report - Unassigned](https://dev.hbcompliance.co.uk/api-9235764.md): This endpoint is available to retrieve historical results for courses that are no longer assigned to the candidate. - Heathier Business Portal APIs V1 - Deprecated > OH Requests [Get Available Forms](https://dev.hbcompliance.co.uk/api-9235765.md): The endpoint provides a method to retrieve the list of forms provided by the authenticated client. The requests are HTTP GET (RFC2616) and uses api key as a resource identifier identifying the - Heathier Business Portal APIs V1 - Deprecated > OH Requests [Get Form Fields](https://dev.hbcompliance.co.uk/api-9235766.md): The endpoint provides a method to retrieve the list of forms fields for the perticular form_type provided by the authenticated client. The requests are HTTP GET (RFC2616) and uses api key as a resource identifier identifying the client uniquely at HB. - Heathier Business Portal APIs V1 - Deprecated > OH Requests [Creating a new submission](https://dev.hbcompliance.co.uk/api-9235767.md): This endpoint creates a new submission for a candidate at HB and initiates the screening process. The URI format is: [https://hb-host.tld/api/submissions/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXX]() - Heathier Business Portal APIs V1 - Deprecated > OH Requests [Modifying the details of an existing submission (Upload Documents)](https://dev.hbcompliance.co.uk/api-9235768.md): This end point allows additional information to be added to a previously submitted submission. This is a partial update call, which does not update every detail every - Heathier Business Portal APIs V1 - Deprecated > OH Requests [Make final form submission (after uploading documents)](https://dev.hbcompliance.co.uk/api-9235769.md): This end point allows to submit the form after uploading required documents. - Heathier Business Portal APIs V1 - Deprecated > OH Requests [Get submission list](https://dev.hbcompliance.co.uk/api-9235770.md): The endpoint provides a method to retrieve a list of candidate form submissions in the last 90 days. - Heathier Business Portal APIs V1 - Deprecated > OH Requests [Retrieve submission result details](https://dev.hbcompliance.co.uk/api-9235771.md): This endpoint retrieves the details of the finished screening operation. - Heathier Business Portal APIs V1 - Deprecated > OH Requests [Retrieve the submission result documents for the employer](https://dev.hbcompliance.co.uk/api-9235772.md): This endpoint retrieves the result document in PDF format that should be forwarded to the employer. - Heathier Business Portal APIs V1 - Deprecated > Certificates Requests [Get Training Certificate](https://dev.hbcompliance.co.uk/api-9235773.md): Assigned courses that have not expired \[default\] - Heathier Business Portal APIs V1 - Deprecated > Certificates Requests [Get Training Certificate - including expired](https://dev.hbcompliance.co.uk/api-9235774.md): Assigned courses including expired. - Heathier Business Portal APIs V1 - Deprecated > Certificates Requests [Get Training Certificate - including non-assigned courses, but excluding expired](https://dev.hbcompliance.co.uk/api-9235775.md): All courses including non-assigned courses, but excluding expired results. - Heathier Business Portal APIs V1 - Deprecated > Certificates Requests [Get Training Certificate - All available courses](https://dev.hbcompliance.co.uk/api-9235776.md): All available results regardless of whether they’re assigned or expired. - Heathier Business Portal APIs V1 - Deprecated > Certificates Requests [Get Training Certificate - Specific Course](https://dev.hbcompliance.co.uk/api-9235777.md): The endpoint provides a method to retrieve a PDF training certificate for a candidate for an individual course. - Heathier Business Portal APIs V1 - Deprecated > Webhooks [Training Completion](https://dev.hbcompliance.co.uk/api-9235778.md): Training Completion Webhook call will be sent each time when any of your candidates completes any assigned module from their assigned trainings. ## Schemas - Sample Schemas [Pet](https://dev.hbcompliance.co.uk/schema-2910960.md): - Sample Schemas [Category](https://dev.hbcompliance.co.uk/schema-2910961.md): - Sample Schemas [Tag](https://dev.hbcompliance.co.uk/schema-2910962.md):