Human Resources

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.
post
https://api.certn.co
/hr/v1/applications/invite/
Invite an applicant
post
https://api.certn.co
/hr/v1/applications/quick/
Screen an applicant instantly
put
https://api.certn.co
/hr/v1/applicants/{applicant_id}/packages/
Upgrade an application
get
https://api.certn.co
/hr/v1/applicants/
Retrieve all your applications
get
https://api.certn.co
/hr/v1/applicants/{applicant_id}/
Retrieve an application

Reports

A report shows the final results of the requested checks. These endpoints allow you to retrieve your reports in the format of your choice.
get
https://api.certn.co
/hr/v1/reports/{applicant_id}/pdf/
Download a PDF report
get
https://api.certn.co
/hr/v1/reports/{applicant_id}/link/
Create a hosted PDF report
get
https://api-certn.co
/hr/v1/reports/{applicant_id}/web/
Download an HTML report

Service collections

If you are working through an Applicant Tracking System (ATS), we may have set service collections for you. These endpoints allow you to retrieve information about them.
get
https://api.certn.co
/hr/v1/servicecollections/
Retrieve your service collections
get
https://api.certn.co
/hr/v1/servicecollections/{servicecollection_id}/
Request details of service collection
Export as PDF
Copy link
On this page
Applications
post
Invite an applicant
post
Screen an applicant instantly
put
Upgrade an application
get
Retrieve all your applications
get
Retrieve an application
Reports
get
Download a PDF report
get
Create a hosted PDF report
get
Download an HTML report
Service collections
get
Retrieve your service collections
get
Request details of service collection