Settings and packages
How to organize general resources in Certn's API, such as Superteams, Teams, Users, and Packages .
To view a list of all application parameters, visit Application parameters.
Team hierarchy
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.
Superteams
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.
Retrieve a list of your superteams
GET
https://api.certn.co/api/v1/superteams/
View the list of your superteams.
Retrieve details of a specific superteam
GET
https://api.certn.co/api/v1/superteams/{superteam_id}/
View the details of a specific superteam using the team id.
Path Parameters
Name | Type | Description |
---|---|---|
superteam_id* | string | ID of the superteam |
Create a superteam
POST
https://api.certn.co/api/v1/superteams/
Create a new superteam.
Request Body
Name | Type | Description |
---|---|---|
name* | string | Superteam name |
street_address* | string | Street address of Superteam's primary location |
city* | string | City of Superteam's primary location |
province_state* | string | ISO province or state code for Superteam's primary location |
country* | string <enum> | Country Code for Superteam's primary location. Must be one of "CA", "US", "GB", or "AU". |
postal_code* | string | Postal code of Superteam's primary location |
other_province_state | string | If province_state is OT, provide the province or state of the Superteam's primary location |
is_secure_sms_enabled* | boolean | SMS enabled or disabled for the team |
is_report_id_enabled | boolean |
Update a superteam
PUT
https://api.certn.co/api/v1/superteams/{superteam_id}/
Path Parameters
Name | Type | Description |
---|---|---|
superteam_id* | string <uuid> | Superteam id |
Request Body
Name | Type | Description |
---|---|---|
name* | string | Superteam name |
is_secure_sms_enabled* | boolean | SMS enabled or disabled for the team |
is_report_id_enabled* | boolean | |
street_address* | string | Street address of Superteam's primary location |
city* | string | City of Superteam's primary location |
postal_code* | string | Postal code of Superteam's primary location |
province_state* | string | for Superteam's primary location |
other_province_state | string | If province_state is OT, provide the province or state of the Superteam's primary location |
country* | string | ISO Country Code for Superteam's primary location. Must be one of "CA", "US", "GB", or "AU". |
Teams
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.
Retrieve a list of your teams
GET
https://api.certn.co/api/v1/teams/
View a list of all your teams.
The results are sent via paginated response. To retrieve the next page, send a request to the URL under the field next
, or add one to your page counter:
https://api.certn.co/api/v1/teams/?page=<pgNum>
You can also filter the list by a superteam by providing the superteam id as a query parameter.
Query Parameters
Name | Type | Description |
---|---|---|
superteam* | string <uuid> | Superteam id |
page | int | Page number to retrieve |
Retrieve team details
GET
https://api.certn.co/api/v1/teams/{team_id}/
View the details of a team.
Path Parameters
Name | Type | Description |
---|---|---|
team_id* | string <uuid> | Team id |
Create a team
POST
https://api.certn.co/api/v1/teams/
Create a new team.
Request Body
Name | Type | Description |
---|---|---|
name* | string | Unique team name |
type* | string <enum> | Team type, "HR" or "PM" |
country* | string <enum> | ISO country code for team's primary location. Must be one of "CA", "US", "GB", or "AU". |
pre_pay | boolean | Billing to be pre-paid. Default false. |
superteam* | string <uuid> | Superteam |
province_state* | string | ISO province or state code for Team's primary location |
street_address | string | Street address of Team's primary location |
city | string | City of Team's primary location |
postal_code | string | Postal code of Team's primary location |
other_province_state | string | If province_state is OT, provide the province or state of the Team's primary location |
accounting_email_cc | string | Email addresses to CC invoice emails to |
accounting_email | string | Email address to send invoices to |
accounting_last_name | string | Last name of accountant responsible for handling team billing |
accounting_first_name | string | First name of accountant responsible for handling team billing |
Update a team
PUT
https://api.certn.co/api/v1/teams/{team_id}/
Update the details of a team.
A PUT request is an entire resource replacement.
Path Parameters
Name | Type | Description |
---|---|---|
team_id* | string <uuid> | Team id |
Request Body
Name | Type | Description |
---|---|---|
name* | string | Unique team name |
type* | string <enum> | Team type, "HR" or "PM" |
country* | string <enum> | ISO country code for Team's primary location. Must be one of "CA", "US", "GB", or "AU". |
pre_pay* | boolean | Billing type. Default false. |
superteam* | string <uuid> | Superteam id |
postal_code* | string | Postal code of Team's primary location |
city* | string | City of Team's primary location |
street_address* | string | Street address of Team's primary location |
province_state* | string | ISO province or state code for Team's primary location |
accounting_first_name* | string | First name of accountant responsible for handling team billing |
accounting_last_name* | string | Last name of accountant responsible for handling team billing |
accounting_email* | string | Email address to send invoices to |
accounting_email_cc* | string | Email addresses to CC invoice emails to |
other_province_state | string | If province_state is OT, provide the province or state of the Superteam's primary location |
Retrieve a team's address reference templates
GET
https://api.certn.co/api/v1/teams/{team_id}/address/reference_templates/
View the details of all address reference templates for a team.
Path Parameters
Name | Type | Description |
---|---|---|
team_id* | string | ID of the team |
Retrieve a team's employer reference templates
GET
https://api.certn.co/api/v1/teams/{team_id}/employer/reference_templates/
View the details of all employer references templates for a team.
Path Parameters
Name | Type | Description |
---|---|---|
team_id | string | ID of the team |
Users
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
Retrieve a list of users
GET
https://api.certn.co/api/v1/users/
View a list of users.
Query Parameters
Name | Type | Description |
---|---|---|
superteam | string <uuid> | Superteam id |
team | string <uuid> | Team id |
is_active | boolean |
Retrieve a user's details
GET
https://api.certn.co/api/v1/users/{user_id}/
View a user's details.
Path Parameters
Name | Type | Description |
---|---|---|
user_id* | string <uuid> | User id |
Create a user
POST
https://api.certn.co/api/v1/users/
Create a new user.
Request Body
Name | Type | Description |
---|---|---|
first_name* | string | User's first name |
last_name* | string | User's last name |
email* | string | User's email, unique |
language* | string <enum> | User's language. Must be either "en" or "fr" |
team* | string <uuid> | Team id |
is_active* | boolean | Default true |
Update a user
PUT
https://api.certn.co/api/v1/users/{user_id}/
Path Parameters
Name | Type | Description |
---|---|---|
first_name* | string | User's first name |
last_name* | string | User's last name |
email* | string | User's email, unique |
language* | string <enum> | Language for user details. Must be either "en" or "fr" |
team* | string <uuid> | Team id |
is_active* | boolean | Default true |
Packages
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.
Or when users invite or instantly screen an applicant via Property Management.
Available to all partners
Retrieve your packages
GET
https://api.certn.co/api/v1/packages/
Query Parameters
Name | Type | Description |
---|---|---|
superteam | string <uuid> | Superteam id |
team | string <uuid> | Team id |
Retrieve details for a specific package by id
GET
https://api.certn.co/api/v1/packages/{package_id}/
Path Parameters
Name | Type | Description |
---|---|---|
package_id | string <uuid> | ID of the package |
Create a package
POST
https://api.certn.co/api/v1/packages/
Request Body
Name | Type | Description |
---|---|---|
team | string <uuid> | Team id. Defaults to api user's team if not provided. |
name* | string | Name of package |
request_flags | list[string] | List of Request flags strings |
settings | object |
Update a package
PUT
https://api.certn.co/api/v1/packages/{package_id}/
Path Parameters
Name | Type | Description |
---|---|---|
package_id* | string <uuid> | ID of package |
Request Body
Name | Type | Description |
---|---|---|
name* | string | Name of package |
team* | string <uuid> | Team id |
request_flags* | list[string] | List of Request flags strings |
settings* | object |
Delete a package
DELETE
https://api.certn.co/api/v1/packages/{package_id}/
Path Parameters
Name | Type | Description |
---|---|---|
package_id* | string <uuid> | ID of package |
Last updated