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.
{"id":"aafa6f6b-e394-4514-b2b4-e5cfdabcffa1","name":"Partner Superteam","is_secure_sms_enabled":false,"is_report_id_enabled":true,"street_address":"123 4 Main Street","city":"Victoria","postal_code":"V8A1B2","province_state":"BC","other_province_state":null,"country":"CA"}
{"id":"aafa6f6b-e394-4514-b2b4-e5cfdabcffa1","name":"Partner Superteam","is_secure_sms_enabled":false,"street_address":"123 4 Main Street","city":"Victoria","postal_code":"V8A1B2","province_state":"BC","country":"CA"}
[ {"id":"17f225cf-f547-437a-8bd9-36599416f7e9","name":"Example Team","business_number":1234,"accounting_first_name":"Magnus","accounting_last_name":"Certn","accounting_email":"example@certn.co","team_first_name":"M","team_last_name":"C","team_email":"example_teammail@certn.co","team_phone_number":null,"street_address":"4412 King Alfred Court","city":"Victoria","province_state":"BC","country":"CA","postal_code":null,"website":"https://www.certn.co","industry":"Background Checks","active_user_count":7,"internal_name":"Example Team","team_type":"OT" }]
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
GEThttps://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.
{"id":"9624967f-993a-46b3-9dc0-4c9f71818f4e","name":"Team Name 2","superteam":"111cec04-a23c-4eda-81d8-9d32bb369c27","type":"HR","pre_pay":false,"street_address":"123 4 Main Street","city":"Victoria","postal_code":"V2K9L0","province_state":"SK","other_province_state":null,"country":"CA","accounting_first_name":"Accounting","accounting_last_name":"Name","accounting_email":"accountant@certn.co","accounting_email_cc":null}
{"id":"4c149bff-79b3-48d2-87fc-6212871a9ea4","name":"Team Name","superteam":"111cec04-a23c-4eda-81d8-9d32bb369c27","type":"HR","pre_pay":true,"street_address":"18 Main Street","city":"Saskatoon","postal_code":"M2K 0G4","province_state":"SK","other_province_state":null,"country":"CA","accounting_first_name":"Accountant","accounting_last_name":"Name","accounting_email":"accountant@certn.co","accounting_email_cc":""}
This may be happening because:
No name, superteam, type, province_state, and/or country provided in the request.
Ensure your request includes the name, superteam, type, province_state, and country.
[ {"id":"ae3087ac-bccc-4cf1-b149-30b2a854d210","name":"Default","version":"0.0.0","description":"Default Address Reference Questionnaire","type":"ADDRESS","questions": [{"id":"80f2d05c-8ee0-4c8e-a8fe-030403bd3378","index":0, "question": "Did {{ first_name }} {{ last_name }} rent from {{ start_date }}{% if end_date %} to {{ end_date }}{% endif %}?",
"type":"TRUE_FALSE","multiple_choice_options":null,"multiple_choice_correct_option":null,"is_verifiable":true,"is_required":true }, {"id":"ae95f70b-24b8-4cc5-97ae-19aeefe732bd","index":1,"question":"What was the address {{ first_name }} {{ last_name }} lived at?","type":"MULTIPLE_CHOICE","multiple_choice_options": ["11012 Main St. Vancouver BC V6T 1X1","2023 Alma Ave. Toronto ON M6H 3P2","4334 Connolly St. Halifax NS B3L 3M4","{{ address }}" ],"multiple_choice_correct_option":"{{ address }}","is_verifiable":true,"is_required":false }, {"id":"be755532-f4a2-4372-bb80-8dca8e9fe4f4","index":2, "question": "Was {{ first_name }} {{ last_name }} generally a clean and/or organized tenant (1 not clean, 10 very clean)?",
"type":"NUMERIC_RANGE","multiple_choice_options":null,"multiple_choice_correct_option":null,"is_verifiable":false,"is_required":false }, {"id":"b5b7383e-a165-4722-b09c-082643bb3cfc","index":3, "question": "How well did {{ first_name }} {{ last_name }} generally get along with property managers and/or fellow residents (1 not well at all, 10 very well)?",
"type":"NUMERIC_RANGE","multiple_choice_options":null,"multiple_choice_correct_option":null,"is_verifiable":false,"is_required":false }, {"id":"a85394ae-2e49-47a7-a94a-a8b6f6200103","index":4, "question": "How likely would you be to rent to {{ first_name }} {{ last_name }} again? Are you comfortable recommending {{ first_name }} {{ last_name }} as a tenant (1 not likely, 10 very likely)?",
"type":"NUMERIC_RANGE","multiple_choice_options":null,"multiple_choice_correct_option":null,"is_verifiable":false,"is_required":false }, {"id":"21c8810b-bb58-4f5b-8445-17526757da73","index":5, "question": "Did you receive complaints from neighbours with regards to {{ first_name }} {{ last_name }}'s behaviour (1 frequently, 10 never)?",
"type":"NUMERIC_RANGE","multiple_choice_options":null,"multiple_choice_correct_option":null,"is_verifiable":false,"is_required":false }, {"id":"05b96f0f-fbf0-4378-907f-177c6682a034","index":6, "question": "Do you have any additional comments you'd like to provide regarding {{ first_name }} {{ last_name }}?",
"type":"LONG_ANSWER","multiple_choice_options":null,"multiple_choice_correct_option":null,"is_verifiable":false,"is_required":false } ] }]
This may be happening because:
The ID you provided couldn't be found
Add your team ID to the URL and make sure it's in the proper format.
[
{
"id": "9550b49d-4069-4b41-8672-b9dc02661db2",
"name": "Default",
"version": "0.0.0",
"description": "Default Employer Reference Questionnaire",
"type": "EMPLOYER",
"questions": [{
"id": "c598a517-b89d-4372-873b-b0f27c8afd27",
"index": 0,
"question": "What was {{ first_name }} {{ last_name }}'s most recent position at {{ company_name }}?",
"type": "MULTIPLE_CHOICE",
"multiple_choice_options": [
"Financial Analyst",
"Receptionist",
"Contractor",
"{{ position }}"
],
"multiple_choice_correct_option": "{{ position }}",
"is_verifiable": true,
"is_required": false
}, {
"id": "0f1aebd6-2286-435f-bd81-f9d8e9a0645d",
"index": 1,
"question": "Did {{ first_name }} {{ last_name }} work at {{ company_name }} from {{ start_date }}{% if end_date %} to {{ end_date }}{% endif %}?",
"type": "TRUE_FALSE",
"multiple_choice_options": null,
"multiple_choice_correct_option": null,
"is_verifiable": true,
"is_required": false
}, {
"id": "4c1d943d-b595-4b7f-9983-be13a72e0003",
"index": 2,
"question": "If given the opportunity, would you hire {{ first_name }} {{ last_name }} again?",
"type": "TRUE_FALSE",
"multiple_choice_options": null,
"multiple_choice_correct_option": null,
"is_verifiable": false,
"is_required": false
}, {
"id": "1fedf7c4-0f7f-4546-841f-c6eb226da2b8",
"index": 3,
"question": "In general, how well did {{ first_name }} {{ last_name }} get along with customers, peers and/or managers (1 not at all, 10 very much so)?",
"type": "NUMERIC_RANGE",
"multiple_choice_options": null,
"multiple_choice_correct_option": null,
"is_verifiable": false,
"is_required": false
}, {
"id": "f408d503-da54-42a4-b29e-d235bf9c890c",
"index": 4,
"question": "In general, did {{ first_name }} {{ last_name }} arrive on time to work (1 not at all, 10 very much so)?",
"type": "NUMERIC_RANGE",
"multiple_choice_options": null,
"multiple_choice_correct_option": null,
"is_verifiable": false,
"is_required": false
}, {
"id": "e6c11a10-b4b8-4f47-a304-edf498e1e50f",
"index": 5,
"question": "How well did {{ first_name }} {{ last_name }} satisfy the requirements of the position (1 not satisfactory, 10 very satisfactory)?",
"type": "NUMERIC_RANGE",
"multiple_choice_options": null,
"multiple_choice_correct_option": null,
"is_verifiable": false,
"is_required": false
}, {
"id": "aea311f1-a98d-42a5-b23b-a092affd275c",
"index": 6,
"question": "Did {{ first_name }} {{ last_name }} go above and beyond what was required without being asked (1 not at all, 10 very much so)?",
"type": "NUMERIC_RANGE",
"multiple_choice_options": null,
"multiple_choice_correct_option": null,
"is_verifiable": false,
"is_required": false
}, {
"id": "cd1d12c0-002b-4090-a758-6904ad7c2bf1",
"index": 7,
"question": "How would you rate {{ first_name }} {{ last_name }}'s ability to handle high pressure or stressful situations (1 not good at all, 10 very good)?",
"type": "NUMERIC_RANGE",
"multiple_choice_options": null,
"multiple_choice_correct_option": null,
"is_verifiable": false,
"is_required": false
}, {
"id": "3dc846b6-773e-4cfe-852d-5eec405c5f5c",
"index": 8,
"question": "Do you have any additional comments you'd like to provide regarding {{ first_name }} {{ last_name }}?",
"type": "LONG_ANSWER",
"multiple_choice_options": null,
"multiple_choice_correct_option": null,
"is_verifiable": false,
"is_required": false
}
]
}
][
{
"id": "9550b49d-4069-4b41-8672-b9dc02661db2",
"name": "Default",
"version": "0.0.0",
"description": "Default Employer Reference Questionnaire",
"type": "EMPLOYER",
"questions": [{
"id": "c598a517-b89d-4372-873b-b0f27c8afd27",
"index": 0,
"question": "What was {{ first_name }} {{ last_name }}'s most recent position at {{ company_name }}?",
"type": "MULTIPLE_CHOICE",
"multiple_choice_options": [
"Financial Analyst",
"Receptionist",
"Contractor",
"{{ position }}"
],
"multiple_choice_correct_option": "{{ position }}",
"is_verifiable": true,
"is_required": false
}, {
"id": "0f1aebd6-2286-435f-bd81-f9d8e9a0645d",
"index": 1,
"question": "Did {{ first_name }} {{ last_name }} work at {{ company_name }} from {{ start_date }}{% if end_date %} to {{ end_date }}{% endif %}?",
"type": "TRUE_FALSE",
"multiple_choice_options": null,
"multiple_choice_correct_option": null,
"is_verifiable": true,
"is_required": false
}, {
"id": "4c1d943d-b595-4b7f-9983-be13a72e0003",
"index": 2,
"question": "If given the opportunity, would you hire {{ first_name }} {{ last_name }} again?",
"type": "TRUE_FALSE",
"multiple_choice_options": null,
"multiple_choice_correct_option": null,
"is_verifiable": false,
"is_required": false
}, {
"id": "1fedf7c4-0f7f-4546-841f-c6eb226da2b8",
"index": 3,
"question": "In general, how well did {{ first_name }} {{ last_name }} get along with customers, peers and/or managers (1 not at all, 10 very much so)?",
"type": "NUMERIC_RANGE",
"multiple_choice_options": null,
"multiple_choice_correct_option": null,
"is_verifiable": false,
"is_required": false
}, {
"id": "f408d503-da54-42a4-b29e-d235bf9c890c",
"index": 4,
"question": "In general, did {{ first_name }} {{ last_name }} arrive on time to work (1 not at all, 10 very much so)?",
"type": "NUMERIC_RANGE",
"multiple_choice_options": null,
"multiple_choice_correct_option": null,
"is_verifiable": false,
"is_required": false
}, {
"id": "e6c11a10-b4b8-4f47-a304-edf498e1e50f",
"index": 5,
"question": "How well did {{ first_name }} {{ last_name }} satisfy the requirements of the position (1 not satisfactory, 10 very satisfactory)?",
"type": "NUMERIC_RANGE",
"multiple_choice_options": null,
"multiple_choice_correct_option": null,
"is_verifiable": false,
"is_required": false
}, {
"id": "aea311f1-a98d-42a5-b23b-a092affd275c",
"index": 6,
"question": "Did {{ first_name }} {{ last_name }} go above and beyond what was required without being asked (1 not at all, 10 very much so)?",
"type": "NUMERIC_RANGE",
"multiple_choice_options": null,
"multiple_choice_correct_option": null,
"is_verifiable": false,
"is_required": false
}, {
"id": "cd1d12c0-002b-4090-a758-6904ad7c2bf1",
"index": 7,
"question": "How would you rate {{ first_name }} {{ last_name }}'s ability to handle high pressure or stressful situations (1 not good at all, 10 very good)?",
"type": "NUMERIC_RANGE",
"multiple_choice_options": null,
"multiple_choice_correct_option": null,
"is_verifiable": false,
"is_required": false
}, {
"id": "3dc846b6-773e-4cfe-852d-5eec405c5f5c",
"index": 8,
"question": "Do you have any additional comments you'd like to provide regarding {{ first_name }} {{ last_name }}?",
"type": "LONG_ANSWER",
"multiple_choice_options": null,
"multiple_choice_correct_option": null,
"is_verifiable": false,
"is_required": false
}
]
}
]
This may be happening because:
The ID you provided couldn't be found
Add your team ID to the URL and make sure it's in the proper format.
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
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.