Human Resources

How to make requests and generate reports as a human resources client in the Certn API.

Demo Environment

When sending test data to the following endpoints, change the domain to https://demo-api.certn.co.

To view a list of all application parameters, visit Application parameters.

Applications

An application is a single request containing a variety of checks for one applicant. These endpoints allow you to create, upgrade, and retrieve the applications associated with your team.

Invite an applicant

POST https://api.certn.co/api/v1/hr/applications/invite/

Invite an applicant to complete a screen via email.

Provide information in the body of the request to pre-fill the application forms.

Request Body

NameTypeDescription

email*

string

Applicant's email address

phone_number

object

tag

string

Group related applications by tag

information

object

{request_flag}*

boolean

{ACIC parameters}

string

owner_id*

string <uuid>

ID of user ordering the application

application/json
{
  "id": string <uuid>,
  "created": string <date-time>,
  "modified": string <date-time>,
  "applicant": {
    "id": string <uuid>,
    "status": string <Enum>,
    "first_name": string,
    "last_name": string,
    "email": string,
    "phone_number": {
      "phone_type": string <Enum>,
      "number": string,
      "country": string <ISO Country Code>
    }
  }
}

Screen an applicant instantly

POST https://api.certn.co/api/v1/hr/applications/quick/

Screen an applicant using only the information in the body of your request.

Get the applicant's consent before running the screen.

Request Body

NameTypeDescription

email

string

Applicant's email address

tag

string

Group related applications by tag

information*

object

enhanced_identity_verification

object

{request_flag}*

boolean

position_or_property_location*

object

owner_id*

string <uuid>

ID of user ordering the application

application/json
{
  "id": string <uuid>,
  "created": string <date-time>,
  "modified": string <date-time>,
  "tag": string,
  "(request_flags)": boolean 
  "last_updated": string <date-time>,
  "submitted_time": string <date-time>,
  "is_submitted": boolean,
  "applicant_type": string <Enum>,
  "report_status": string <Enum>,
  "status": string <Enum>,
  "status_label": string <Enum>,
  "result": string <Enum>,
  "result_label": string <Enum>,
  "certn_score": number,
  "certn_score_label": string <Enum>,
  "applicant_account": {
    "id": string,
    "email": string
  },
  "application": {
    object (Application) 
  },
  "country": "CA",
  "information": {
    object (Information)
  },
  "employment_verification": string <VerificationEnum>,
  "education_verification": string <VerificationEnum>,
  "credential_verification": string <VerificationEnum>,
  "reference_result": {
    object (BasePackageResult)
  },
  "information_result": {
    object (BasePackageResult)
  },
  "risk_result": {
    object (RiskResult)
  },
  "equifax_result": {
    object (EquifaxResult)
  },
  "identity_verified": boolean,
  "employment_verified": boolean,
  "identity_verification": {
    object (Identity Verification)
  },
  "enhanced_identity_verification": {
    object (EnhancedIdentityVerification)
  },
  "manual_id_verification": {
    object (ManualIDVerification)
  },
  "rcmp_result": {
    object (BasePackageResult)
  },
  "us_criminal_record_check_result": {
    object (USCriminalRecordCheckResult)
  },
  "verification_result": {
    object (VerificationResult)
  },
  "international_criminal_record_check_result": {
    object (BasePackageResult)
  },
  "motor_vehicle_record_result": {
    object (BasePackageResult)
  },
  "salary": number,
  "sufficient_salary": boolean,
  "high_risk_vulnerable_sector": boolean,
  "job_safety_undue_risk": boolean,
  "early_termination": number,
  "early_termination_label": string <Enum>,
  "reliability_risk": number,
  "reliability_risk_label": string <Enum>,
  "workplace_misconduct": number,
  "workplace_misconduct_label": string <Enum>
}

Upgrade an application

PUT https://api.certn.co/api/v1/hr/applicants/{applicant_id}/packages/

Add a screening request to an existing application.

To add screening requests to your application, wait for the report's status field to show Returned.

Path Parameters

NameTypeDescription

applicant_id*

string

ID of the applicant

Request Body

NameTypeDescription

tag

string

Group related applications by tag

{request_flag}*

boolean

application/json
{
    "id": string < uuid > ,