status is a string, holding one of the following values to describe the status of the result:
“pass” – certificate issued;
“pass with restrictions” – certificate issued, though candidate restricted from working in certain roles/areas;
“pass with recommendations” – certificate issued with recommended risk assessment/workstation etc.;
“pass with advisory letters” – certificate issued with Hep B/TB advisory letters, etc.;
“temporary clearance” – certificate issued, though cleared for a short time only;
“fail” – candidate did not provide evidence of sufficient immunity;
“other” – submission failed; HB screening process returns with optional information.
information is a string, that holds additional information regarding the result of the submission. Typically, HB uses this to provide explanation or further details about the outcome of the screening process, like if the candidate is not contactable, or candidate requires further blood tests, etc.
documents holds details of the status of each of the documents that are required in relation to the current submission. If documents are not required for the submission this tag is not populated:
document_id is the document reference,
document_status is the status of the document with values of either accepted or rejected
document_information is additional information relating to the document in the case of status rejected indicating the reason the reason for rejection.
result is holding details of the certificate (if certificate is available, otherwise this
tag is not populated):
clearance_level is the level of clearance of candidate,
certificate_expire is the expiration date of the certificate.
If the screening process finished successfully the response is HTTP 200 OK. If the submission_ref is not valid then the API should respond 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.
