Comment on page
Settings and packages
How to organize general resources in Certn's API, such as Superteams, Teams, Users, and Packages .
Organizations often need a structured team hierarchy for billing, user management, and package organization. Certn now supports a two-tiered hierarchy (Superteam and Team levels).
As a partner, you're required to have at least one Superteam, but you can create more Superteams and add Teams under them as needed.
This hierarchy is useful when you have end users who should only access background checks related to specific groups, rather than the entire organization's checks. If you're a reseller, using multiple Superteams can help you categorize background checks by customers and control the data visible in your end users' portal.
A superteam serves as the higher of the two levels within your account hierarchy. It functions as an overarching entity under which other teams are organized.
Available to partners using API version >= 1.1.0.
get
https://api.certn.co
/api/v1/superteams/
Retrieve a list of your superteams
get
https://api.certn.co
/api/v1/superteams/{superteam_id}/
Retrieve details of a specific superteam
post
https://api.certn.co
/api/v1/superteams/
Create a superteam
put
https://api.certn.co
/api/v1/superteams/{superteam_id}/
Update a superteam
A team serves as the lower of the two levels within your account hierarchy. It functions as an entity under a superteam. A superteam can have many teams. If
pre_pay is set to false, Certn will invoice a team each month according to the checks ordered during that billing cycle. If pre_pay is set to true, the applicant's background check process will require them to pay online.Only available to partners using API version >= 1.1.0.
get
https://api.certn.co
/api/v1/teams/
Retrieve a list of your teams
get
https://api.certn.co
/api/v1/teams/{team_id}/
Retrieve team details
post
https://api.certn.co
/api/v1/teams/
Create a team
put
https://api.certn.co
/api/v1/teams/{team_id}/
Update a team
get
https://api.certn.co
/api/v1/teams/{team_id}/address/reference_templates/
Retrieve a team's address reference templates
get
https://api.certn.co
/api/v1/teams/{team_id}/employer/reference_templates/
Retrieve a team's employer reference templates
A user is the individual that orders background checks via your platform. They can be assigned as the Owner of a background check to track activity as well. To grant your users access to the Certn platform for viewing reports or managing settings, they must have a login created using this method.
By default, users will not receive a Welcome email from Certn when they are created. However, they can receive a temporary password by following Forgot my password? link.
Only available to partners using API version >= 1.1.0
get
https://api.certn.co
/api/v1/users/
Retrieve a list of users
get
https://api.certn.co
/api/v1/users/{user_id}/
Retrieve a user's details
post
https://api.certn.co
/api/v1/users/
Create a user
put
https://api.certn.co
/api/v1/users/{user_id}/
Update a user
A collection of varied background check searches is known as a package. Retrieve these packages to enable your end users to choose from them on your platform.
Retrieving specific packages allows you to identify the correct Request Flags to include when users invite or instantly screen an applicant via Human Resources.
Available to all partners
get
https://api.certn.co
/api/v1/packages/
Retrieve your packages
get
https://api.certn.co
/api/v1/packages/{package_id}/
Retrieve details for a specific package by id
post
https://api.certn.co
/api/v1/packages/
Create a package
put
https://api.certn.co
/api/v1/packages/{package_id}/
Update a package
delete
https://api.certn.co
/api/v1/packages/{package_id}/
Delete a package
Last modified 11d ago