" %}
Each individual check that the application comprises also has a "check score" or result. The possible checks scores depend on the type of check ordered. Here are a couple of examples.
* A Canadian Criminal Record Check may return scores like "Negative" when no criminal record was found, or "Confirmation of criminal record" when the convictions disclosed by the candidate was confirmed.
* An Employment Check may return results like "Verified" when all details of the employment was confirmed to be correct or "Partially verified" when some details were confirmed but perhaps the dates or position title did not exactly match what the candidate provided.
***
## Where can I find information about the application status and score, and the check statuses and scores?
The information about statuses and scores, whether at the application or check level, is available in the object that is returned when you [Retrieve the results](/api/start/demo-account/retrieve-results) of an application.
* For the application status, see the `report_status` field (see example below).
* For each of the check statuses, `check_executions` will contain the check status in the `status` field for the particular check (see example below).
* For the application result, see the `result` field (see example below).
* For each check result, see the `result` fields (or similar fields) inside each check's results (see[Report field mappings](/api/api-reference/resources/report-field-mappings) for the names of each check's result fields).
"check_executions": [
{
"id": "check_exec_2kHNvQYTrTDgNL6aMeJybJ",
"check_name": "uk_basic_dbs_check",
"status": "WAITING_ON_CANDIDATE"
}
],
"result": "NONE",
"result_label": "None",
"report_status": "IN_PROGRESS",
The individual scores, or results, per check type can be found
# Settings and packages
How to organize general resources in Certn's API, such as Superteams, Teams, Users, and Packages .
{% hint style="info" %}
#### Demo environment
When sending test data to the following endpoints, change the domain to `https://demo-api.certn.co`.
{% endhint %}
To view a list of all application parameters, visit [Application parameters](/api/api-reference/resources/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.
{% hint style="info" %}
Available to partners using API version >= 1.1.0.
{% endhint %}
## Retrieve a list of your superteams
`GET` `https://api.certn.co/api/v1/superteams/` [**`DEPRECATED`**](/api/deprecation)
View the list of your superteams.
{% tabs %}
{% tab title="200: OK Superteam successfully retrieved" %}
{% tabs %}
{% tab title="Response type" %}
{
"count": int,
"next": URL,
"previous": URL,
"results": [
{
"id": string <uuid>,
"name": string
}
]
}
{% endtab %}
{% tab title="Example" %}
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "23554549-b086-4f74-94fe-ccf88e1c643b",
"name": "Superteam Name"
}
]
}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="403: Forbidden Authentication failed" %}
{% endtab %}
{% endtabs %}
## Retrieve details of a specific superteam
`GET` `https://api.certn.co/api/v1/superteams/{superteam_id}/` [**`DEPRECATED`**](/api/deprecation)
View the details of a specific superteam using the team id.
#### Path Parameters
| Name | Type | Description |
| ----------------------------------------------- | ------ | ------------------- |
| superteam\_id\* | string | ID of the superteam |
{% tabs %}
{% tab title="200: OK Superteam successfully retrieved" %}
{% tabs %}
{% tab title="Response Type" %}
{% code title="application/json" %}
```json
{
"id": string ,
"name": string,
"is_secure_sms_enabled": boolean,
"is_report_id_enabled": boolean,
"street_address": string,
"city": string,
"postal_code": string,
"province_state": string,
"other_province_state": string,
"country": string
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{
"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"
}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="403: Forbidden Authentication failed" %}
{% endtab %}
{% endtabs %}
## Create a superteam
`POST` `https://api.certn.co/api/v1/superteams/` [**`DEPRECATED`**](/api/deprecation)
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](https://docs.certn.co/api/api-reference/resources/region-codes#provinces-and-states) for Superteam's primary location |
| country\* | string \ | 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 | |
{% tabs %}
{% tab title="201: Created Superteam successfully created" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
{
"id": "string ",
"name": "string",
"is_secure_sms_enabled": boolean,
"street_address": "string",
"city": "string",
"postal_code": "string",
"province_state": "string",
"country": "string"
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{
"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"
}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="400: Bad Request Missing required field(s) or invalid data" %}
This may be happening because:
**You have missed a required field in your payload.**
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="403: Forbidden Authentication failed" %}
{% endtab %}
{% endtabs %}
## Update a superteam
`PUT` `https://api.certn.co/api/v1/superteams/{superteam_id}/` [**`DEPRECATED`**](/api/deprecation)
#### Path Parameters
| Name | Type | Description |
| ----------------------------------------------- | -------------- | ------------ |
| superteam\_id\* | string \ | 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". |
{% tabs %}
{% tab title="200: OK Superteam successfully updated" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
[
{
"id": string ,
"name": string,
"business_number": integer,
"accounting_first_name": string,
"accounting_last_name": string,
"accounting_email": string,
"team_first_name": string,
"team_last_name": string,
"team_email": string,
"team_phone_number": string,
"street_address": string,
"city": string,
"province_state": string ,
"country": string ,
"postal_code": string,
"website": string,
"industry": string,
"active_user_count": integer,
"internal_name": string,
"team_type": string,
}
]
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
[
{
"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"
}
]
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="400: Bad Request Missing required field(s) or invalid data" %}
This may be happening because:
**You have missed a required field in your payload.**
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="403: Forbidden Authentication failed" %}
{% endtab %}
{% endtabs %}
## 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.
{% hint style="info" %}
Only available to partners using API version >= 1.1.0.
{% endhint %}
## Retrieve a list of your teams
`GET` `https://api.certn.co/api/v1/teams/` [**`DEPRECATED`**](/api/deprecation)
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=`
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 \ | Superteam id |
| page | int | Page number to retrieve |
{% tabs %}
{% tab title="200: OK Teams successfully retrieved" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
{
"count": int,
"next": URL,
"previous": URL,
"results": [
{
"id": string ,
"name": string,
"superteam": string ,
"pre_pay": boolean
"street_address": string,
"city": string,
"postal_code": string,
"province_state": string,
"other_province_state": string,
"country": string,
"accounting_first_name": string,
"accounting_last_name": string,
"accounting_email": string,
"accounting_email_cc": string,
},
]
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
```
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": "9624967f-993a-46b3-9dc0-4c9f71818f4e",
"name": "Team Name 2",
"superteam": "111cec04-a23c-4eda-81d8-9d32bb369c27",
"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",
"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": "Accounting",
"accounting_last_name": "Name",
"accounting_email": "accountant@certn.co",
"accounting_email_cc": null
}
]
}
```
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="403: Forbidden Authentication failed" %}
{% endtab %}
{% endtabs %}
## Retrieve team details
`GET` `https://api.certn.co/api/v1/teams/{team_id}/` [**`DEPRECATED`**](/api/deprecation)
View the details of a team.
#### Path Parameters
| Name | Type | Description |
| ------------------------------------------ | -------------- | ----------- |
| team\_id\* | string \ | Team id |
{% tabs %}
{% tab title="200: OK Team successfully retrieved" %}
{% tabs %}
{% tab title="Response Type" %}
{% code title="application/json" %}
```json
{
"id": string ,
"name": string,
"superteam": string ,
"type": string ,
"pre_pay": boolean,
"street_address": string,
"city": string,
"postal_code": string,
"province_state": string,
"other_province_state": string,
"country": string,
"accounting_first_name": string,
"accounting_last_name": string,
"accounting_email": string,
"accounting_email_cc": string
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
{
"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
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="403: Forbidden Authentication failed" %}
{% endtab %}
{% endtabs %}
## Create a team
`POST` `https://api.certn.co/api/v1/teams/` [**`DEPRECATED`**](/api/deprecation)
Create a new team.
#### Request Body
| Name | Type | Description |
| ------------------------------------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| name\* | string | Unique team name |
| type\* | string \ | Team type, "HR" or "PM" |
| country\* | string \ | [ISO country code](/api/api-reference/resources/region-codes#countries) 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 \ | Superteam |
| province\_state\* | string | [ISO province or state code](https://docs.certn.co/api/api-reference/resources/region-codes#provinces-and-states) 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 |
{% tabs %}
{% tab title="201: Created Team successfully created" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
{
"id": string ,
"name": string,
"superteam": string ,
"type": string ,
"pre_pay": boolean,
"street_address": string,
"city": string,
"postal_code": string,
"province_state": string,
"other_province_state": string,
"country": string,
"accounting_first_name": string,
"accounting_last_name": string,
"accounting_email": string,
"accounting_email_cc": string
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
{
"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": ""
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="400: Bad Request Missing required field(s) or invalid data" %}
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.
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="400: Bad Request Invalid superteam id" %}
This may be happening because:
**The incorrect superteam id was provided.**
Enter the correct superteam id in your request.
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="400: Bad Request Country or type "LM" is not a valid choice" %}
This may be happening because:
**The country or type field values are not valid.**
Ensure you are using the following values for the country and type fields:
*Country*: "US", "CA", "GB", or "AU"\
*Type*: "HR" or "PM"
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="403: Forbidden Authentication failed" %}
{% endtab %}
{% endtabs %}
## Update a team
`PUT` `https://api.certn.co/api/v1/teams/{team_id}/` [**`DEPRECATED`**](/api/deprecation)
Update the details of a team.
A PUT request is an entire resource replacement.
#### Path Parameters
| Name | Type | Description |
| ------------------------------------------ | -------------- | ----------- |
| team\_id\* | string \ | Team id |
#### Request Body
| Name | Type | Description |
| --------------------------------------------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| name\* | string | Unique team name |
| type\* | string \ | Team type, "HR" or "PM" |
| country\* | string \ | [ISO country code](/api/api-reference/resources/region-codes#countries) for Team's primary location. Must be one of "CA", "US", "GB", or "AU". |
| pre\_pay\* | boolean | Billing type. Default false. |
| superteam\* | string \ | 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](https://docs.certn.co/api/api-reference/resources/region-codes#provinces-and-states) 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 |
{% tabs %}
{% tab title="200: OK Team successfully updated" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
{
"id": string ,
"name": string,
"superteam": string ,
"type": string
"pre_pay": boolean,
"street_address": string,
"city": string,
"postal_code": string,
"province_state": string,
"other_province_state": string,
"country": string,
"accounting_first_name": string,
"accounting_last_name": string,
"accounting_email": string,
"accounting_email_cc": string
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
{
"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": ""
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="400: Bad Request Missing required field(s) or invalid data" %}
This may be happening because:
**No id, name, type, superteam name, and/or country provided in the request.**
Ensure your request includes the id, name, type, superteam name, and country.
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="400: Bad Request cannot be updated" %}
Once a team **type**, **superteam**, and **country** have been set, they cannot be changed. It is recommended you create a new team with applicable fields.
{% endtab %}
{% tab title="403: Forbidden Authentication failed" %}
{% endtab %}
{% endtabs %}
## Retrieve a team's address reference templates
`GET` `https://api.certn.co/api/v1/teams/{team_id}/address/reference_templates/` [**`DEPRECATED`**](/api/deprecation)
View the details of all address reference templates for a team.
#### Path Parameters
| Name | Type | Description |
| ------------------------------------------ | ------ | -------------- |
| team\_id\* | string | ID of the team |
{% tabs %}
{% tab title="200: OK Questionnaires successfully retrieved" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
[
{
"id": string,
"name": string,
"version": string,
"description": string,
"type": string < enum > ,
"questions": [{
"id": string,
"index": int,
"question": string,
"type": string < enum > ,
"multiple_choice_options": [
string,
string
],
"multiple_choice_correct_option": string,
"is_verifiable": boolean,
"is_required": boolean
}, {
"id": string,
"index": int,
"question": string,
"type": string < enum > ,
"multiple_choice_options": [
string,
string
],
"multiple_choice_correct_option": string,
"is_verifiable": boolean,
"is_required": boolean
}
]
}
]
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
[
{
"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
}
]
}
]
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="404: Not Found Team not found" %}
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.
*See* [Error codes](/api/api-reference/resources/error-codes#404-not-found) *for more details.*
{% endtab %}
{% endtabs %}
## Retrieve a team's employer reference templates
`GET` `https://api.certn.co/api/v1/teams/{team_id}/employer/reference_templates/` [**`DEPRECATED`**](/api/deprecation)
View the details of all employer references templates for a team.
#### Path Parameters
| Name | Type | Description |
| -------- | ------ | -------------- |
| team\_id | string | ID of the team |
{% tabs %}
{% tab title="200: OK Questionnaires successfully retrieved" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
[
{
"id": string,
"name": string,
"version": string,
"description": string,
"type": string < enum > ,
"questions": [{
"id": string,
"index": int,
"question": string,
"type": string < enum > ,
"multiple_choice_options": [
string,
string,
string
],
"multiple_choice_correct_option": string,
"is_verifiable": boolean,
"is_required": boolean
}, {
"id": string,
"index": int,
"question": string,
"type": string < enum > ,
"multiple_choice_options": [
string,
string,
string
],
"multiple_choice_correct_option": string,
"is_verifiable": boolean,
"is_required": boolean
}
]
}
]
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```
[
{
"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
}
]
}
]
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="404: Not Found Team not found" %}
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.
*See* [Error codes](/api/api-reference/resources/error-codes#404-not-found) *for more details.*
{% endtab %}
{% endtabs %}
## 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?**](https://app.certn.co/login) link.
{% hint style="info" %}
Only available to partners using API version >= 1.1.0
{% endhint %}
## Retrieve a list of users
`GET` `https://api.certn.co/api/v1/users/` [**`DEPRECATED`**](/api/deprecation)
View a list of users.
#### Query Parameters
| Name | Type | Description |
| ---------- | -------------- | ------------ |
| superteam | string \ | Superteam id |
| team | string \ | Team id |
| is\_active | boolean | |
{% tabs %}
{% tab title="200: OK Users successfully retrieved" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
{
"count": int,
"next": URL,
"previous": URL,
"results": [
{
"id": string ,
"first_name": string,
"last_name": string,
"is_active": boolean,
"superteam": string ,
"team": string
}
]
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
```json
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": "c1b0c944-551a-46b5-ab88-bdf22f6b06fd",
"first_name": "Joe",
"last_name": "Bidem",
"is_active": false,
"superteam": "aafa6f6b-e394-4514-b2b4-e5cfdabcffa1",
"team": "10626a80-00f2-4e04-9b99-16693f76a6ed"
},
{
"id": "0ec5b68e-890b-4a40-992d-a5cb080abd46",
"first_name": "User Three",
"last_name": "lastname",
"is_active": true,
"superteam": "23554549-b086-4f74-94fe-ccf88e1c643b",
"team": "6aba518e-1d98-4f97-bc77-c5cee59e44cd"
}
]
}
```
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="403: Forbidden Authentication failed" %}
{% endtab %}
{% endtabs %}
## Retrieve a user's details
`GET` `https://api.certn.co/api/v1/users/{user_id}/` [**`DEPRECATED`**](/api/deprecation)
View a user's details.
#### Path Parameters
| Name | Type | Description |
| ------------------------------------------ | -------------- | ----------- |
| user\_id\* | string \ | User id |
{% tabs %}
{% tab title="200: OK Details successfully retrieved" %}
{% tabs %}
{% tab title="Response Type" %}
{
"id": string <uuid>,
"first_name": string,
"last_name": string,
"email": string,
"language": string <Enum>,
"is_active": boolean,
"superteam": string <uuid>,
"team": string <uuid>
}
{% endtab %}
{% tab title="Example" %}
{
"id": "d04a8ade-4cf1-4bab-9ba5-c82b16c6daca",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@certn.co",
"language": "en",
"is_active": true,
"superteam": "c10f334c-0af8-4fb9-8e42-736f555bb400",
"team": "0de5550b-f93f-4075-a022-52b907592198"
}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="403: Forbidden Authentication failed" %}
{% endtab %}
{% endtabs %}
## Create a user
`POST` `https://api.certn.co/api/v1/users/` [**`DEPRECATED`**](/api/deprecation)
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 \ | User's language. Must be either "en" or "fr" |
| team\* | string \ | Team id |
| is\_active\* | boolean | Default true |
{% tabs %}
{% tab title="201: Created User successfully retrieved. " %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
{
"id": string ,
"first_name": string,
"last_name": string,
"email": string,
"language": string ,
"is_active": boolean,
"team": string
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
{
"id": "1ee80af9-e047-438d-a6d3-a14bbf179cfd",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@certn.co",
"language": "en",
"is_active": true,
"team": "0de5550b-f93f-4075-a022-52b907592198"
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="400: Bad Request Missing required field(s) or invalid data" %}
This is happening because:
You have missed one of the required parameters in the request body (see parameters above)
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="400: Bad Request Invalid team id. " %}
This may be happening because:
**The incorrect team id was provided.**
Enter the correct team id in your request.
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="400: Bad Request is not a valid choice. " %}
This may be happening because:
**Field values are not in the pre-defined list.**
Ensure you are using valid values for each field.
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="400: Bad Request Email is already in use" %}
This is happening because there is already a user registered by this email in our system. Emails must be unique.
{% endtab %}
{% tab title="403: Forbidden Authentication failed" %}
{% endtab %}
{% endtabs %}
## Update a user
`PUT` `https://api.certn.co/api/v1/users/{user_id}/` [**`DEPRECATED`**](/api/deprecation)
#### 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 \ | Language for user details. Must be either "en" or "fr" |
| team\* | string \ | Team id |
| is\_active\* | boolean | Default true |
{% tabs %}
{% tab title="200: OK User successfully updated" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
{
"id": string ,
"first_name": string,
"last_name": string,
"email": string,
"language": string ,
"is_active": boolean,
"team": string
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
{
"id": "1ee80af9-e047-438d-a6d3-a14bbf179cfd",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@certn.co",
"language": "en",
"is_active": true,
"team": "0de5550b-f93f-4075-a022-52b907592198"
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="400: Bad Request Missing required field(s) or invalid data" %}
This may be happening because:
**You are missing required fields**
Add all the required fields to the body of your request.
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="400: Bad Request Invalid team id" %}
This may be happening because:
**The incorrect team id was provided.**
Enter the correct team id in your request.
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="400: Bad Request is not a valid choice" %}
This may be happening because:
**Field values are not in the pre-defined list.**
Ensure you are using valid values for each field.
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="403: Forbidden " %}
{% endtab %}
{% endtabs %}
## 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](/api/api-reference/resources/application-parameters/request-flags) to include when users [invite](/api/api-reference/hr#invite-an-applicant) or [instantly screen](/api/api-reference/hr#screen-an-applicant-instantly) an applicant via [Human Resources](/api/api-reference/hr).
Or when users [invite](/api/api-reference/pm#invite-an-applicant) or [instantly screen](/api/api-reference/pm#screen-an-applicant-instantly) an applicant via [Property Management](/api/api-reference/pm).
{% hint style="info" %}
Available to all partners
{% endhint %}
## Retrieve your packages
`GET` `https://api.certn.co/api/v1/packages/` [**`DEPRECATED`**](/api/deprecation)
#### Query Parameters
| Name | Type | Description |
| --------- | -------------- | ------------ |
| superteam | string \ | Superteam id |
| team | string \ | Team id |
{% tabs %}
{% tab title="200: OK Packages successfully retrieved" %}
{% tabs %}
{% tab title="Response Type" %}
{% endtab %}
{% tab title="Example" %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="403: Forbidden Authentication failed" %}
{% endtab %}
{% endtabs %}
## Retrieve details for a specific package by id
`GET` `https://api.certn.co/api/v1/packages/{package_id}/` [**`DEPRECATED`**](/api/deprecation)
#### Path Parameters
| Name | Type | Description |
| ----------- | -------------- | ----------------- |
| package\_id | string \ | ID of the package |
{% tabs %}
{% tab title="200: OK Package successfully retrieved" %}
{% tabs %}
{% tab title="Response Type" %}
{% code title="application/json" %}
```json
{
"id": string ,
"name": "Package Name",
"superteam": string ,
"team": string ,
"request_flags": [
"request_enhanced_identity_verification",
"request_social_media_check",
"request_us_criminal_record_check_tier_1"
],
"settings": {
"requested_countries": [string],
"us_criminal_record_check_years": 7,
"employer_questionaire_id": string ,
"address_questionaire_id": string ,
"employer_references_max": int,
"employer_references_min": int,
"address_references_max": int,
"address_references_min": int,
"employment_verification_min": int,
"employment_verification_max": int,
"education_verification_min": int,
"education_verification_max": int,
"credential_verification_min": int,
"credential_verification_max": int,
"credential_verification_level": string ,
"education_verification_level": string ,
"employer_references_years": int,
"address_references_years": int,
"employment_verification_years": int,
"address_references_years_or_individually": string ,
"employer_references_years_or_individually": string ,
"employment_verification_years_or_individually": string ,
"purpose_of_check": string ,
"position_title": string,
"place_of_work": string,
"license_type": string,
"issuing_authority": string,
"reason_for_check": string,
"state_or_territory": string,
"location_of_work": string,
"volunteer_role": string,
"volunteer_organization": string,
"role_or_position_title": string,
"employment_sector": string
}
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
{
"id": "35e95c65-ed02-4a34-948d-2267568fe69f",
"name": "Package Name",
"superteam": "c10f334c-0af8-4fb9-8e42-736f555bb400",
"team": "0de5550b-f93f-4075-a022-52b907592198",
"request_flags": [
"request_enhanced_identity_verification",
"request_social_media_check",
"request_us_criminal_record_check_tier_1"
],
"settings": {
"requested_countries": [],
"us_criminal_record_check_years": 7,
"employer_questionaire_id": null,
"address_questionaire_id": null,
"employer_references_max": 1,
"employer_references_min": 1,
"address_references_max": 1,
"address_references_min": 1,
"employment_verification_min": 1,
"employment_verification_max": 1,
"education_verification_min": 1,
"education_verification_max": 1,
"credential_verification_min": 1,
"credential_verification_max": 1,
"credential_verification_level": "ALL",
"education_verification_level": "ALL",
"employer_references_years": 3,
"address_references_years": 3,
"employment_verification_years": 3,
"address_references_years_or_individually": "INDIVIDUALLY",
"employer_references_years_or_individually": "INDIVIDUALLY",
"employment_verification_years_or_individually": "INDIVIDUALLY",
"purpose_of_check": null,
"position_title": "",
"place_of_work": "",
"license_type": "",
"issuing_authority": "",
"reason_for_check": "",
"state_or_territory": "",
"location_of_work": "",
"volunteer_role": "",
"volunteer_organization": "",
"role_or_position_title": "",
"employment_sector": ""
}
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="404: Not Found Package not found" %}
This may be happening because:
**The pacakge\_id you used doesn't exist.**
Ensure you are using a valid id.
*See* [Error codes](/api/api-reference/resources/error-codes#404-not-found) *for more details.*
{% endtab %}
{% tab title="400: Bad Request Missing required field(s) or invalid data" %}
{% endtab %}
{% tab title="403: Forbidden Authentication failed" %}
{% endtab %}
{% endtabs %}
## Create a package
`POST` `https://api.certn.co/api/v1/packages/` [**`DEPRECATED`**](/api/deprecation)
#### Request Body
| Name | Type | Description |
| -------------------------------------- | -------------- | -------------------------------------------------------------------------------------------------- |
| team | string \ | Team id. Defaults to api user's team if not provided. |
| name\* | string | Name of package |
| request\_flags | list\[string] | List of [Request flags](/api/api-reference/resources/application-parameters/request-flags) strings |
| settings | object | [Package settings](/api/api-reference/resources/application-parameters/package-settings) |
{% tabs %}
{% tab title="201: Created Package successfully created" %}
{% tabs %}
{% tab title="Response Type" %}
{% code title="application/json" %}
```json
{
"id": string ,
"name": string,
"team": string ,
"request_flags": [
string
]
"settings": {
object (Package settings)
}
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
{
"id": "2ffb4c49-96cf-4b31-8ec3-63ba2dfd3b3b",
"name": "Package Name",
"team": "0de5550b-f93f-4075-a022-52b907592198",
"request_flags": [
"request_enhanced_identity_verification"
]
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="400: Bad Request Missing required field(s) or invalid data" %}
This may be happening because:
**You have missed a required field in your payload.**
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="403: Forbidden Authentication failed" %}
{% endtab %}
{% endtabs %}
## Update a package
`PUT` `https://api.certn.co/api/v1/packages/{package_id}/` [**`DEPRECATED`**](/api/deprecation)
#### Path Parameters
| Name | Type | Description |
| --------------------------------------------- | -------------- | ------------- |
| package\_id\* | string \ | ID of package |
#### Request Body
| Name | Type | Description |
| ------------------------------------------------ | -------------- | -------------------------------------------------------------------------------------------------- |
| name\* | string | Name of package |
| team\* | string \ | Team id |
| request\_flags\* | list\[string] | List of [Request flags](/api/api-reference/resources/application-parameters/request-flags) strings |
| settings\* | object | [Package settings](/api/api-reference/resources/application-parameters/package-settings) |
{% tabs %}
{% tab title="200: OK Package successfully updated" %}
{% tabs %}
{% tab title="Response Type" %}
```json
{
"id": string ,
"name": "Package Name",
"superteam": string ,
"team": string ,
"request_flags": [
"request_enhanced_identity_verification",
"request_social_media_check",
"request_us_criminal_record_check_tier_1"
],
"settings": {
"requested_countries": [string],
"us_criminal_record_check_years": 7,
"employer_questionaire_id": string ,
"address_questionaire_id": string ,
"employer_references_max": int,
"employer_references_min": int,
"address_references_max": int,
"address_references_min": int,
"employment_verification_min": int,
"employment_verification_max": int,
"education_verification_min": int,
"education_verification_max": int,
"credential_verification_min": int,
"credential_verification_max": int,
"credential_verification_level": string ,
"education_verification_level": string ,
"employer_references_years": int,
"address_references_years": int,
"employment_verification_years": int,
"address_references_years_or_individually": string ,
"employer_references_years_or_individually": string ,
"employment_verification_years_or_individually": string ,
"purpose_of_check": string ,
"position_title": string,
"place_of_work": string,
"license_type": string,
"issuing_authority": string,
"reason_for_check": string,
"state_or_territory": string,
"location_of_work": string,
"volunteer_role": string,
"volunteer_organization": string,
"role_or_position_title": string,
"employment_sector": string
}
}
```
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
{
"id": "35e95c65-ed02-4a34-948d-2267568fe69f",
"name": "Package Name",
"superteam": "c10f334c-0af8-4fb9-8e42-736f555bb400",
"team": "0de5550b-f93f-4075-a022-52b907592198",
"request_flags": [
"request_enhanced_identity_verification",
"request_social_media_check",
"request_us_criminal_record_check_tier_1"
],
"settings": {
"requested_countries": [],
"us_criminal_record_check_years": 7,
"employer_questionaire_id": null,
"address_questionaire_id": null,
"employer_references_max": 1,
"employer_references_min": 1,
"address_references_max": 1,
"address_references_min": 1,
"employment_verification_min": 1,
"employment_verification_max": 1,
"education_verification_min": 1,
"education_verification_max": 1,
"credential_verification_min": 1,
"credential_verification_max": 1,
"credential_verification_level": "ALL",
"education_verification_level": "ALL",
"employer_references_years": 3,
"address_references_years": 3,
"employment_verification_years": 3,
"address_references_years_or_individually": "INDIVIDUALLY",
"employer_references_years_or_individually": "INDIVIDUALLY",
"employment_verification_years_or_individually": "INDIVIDUALLY",
"purpose_of_check": null,
"position_title": "",
"place_of_work": "",
"license_type": "",
"issuing_authority": "",
"reason_for_check": "",
"state_or_territory": "",
"location_of_work": "",
"volunteer_role": "",
"volunteer_organization": "",
"role_or_position_title": "",
"employment_sector": ""
}
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="404: Not Found Package not found" %}
This may be happening because:
**The pacakge\_id you used doesn't exist.**
Ensure you are using a valid id.
*See* [Error codes](/api/api-reference/resources/error-codes#404-not-found) *for more details.*
{% endtab %}
{% tab title="400: Bad Request Missing required field(s) or invalid data" %}
This may be happening because:
**You have missed a required field in your payload.**
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="403: Forbidden Authentication failed" %}
{% endtab %}
{% endtabs %}
## Delete a package
`DELETE` `https://api.certn.co/api/v1/packages/{package_id}/` [**`DEPRECATED`**](/api/deprecation)
#### Path Parameters
| Name | Type | Description |
| --------------------------------------------- | -------------- | ------------- |
| package\_id\* | string \ | ID of package |
{% tabs %}
{% tab title="200: OK Package successfully deleted" %}
{% endtab %}
{% tab title="404: Not Found Package not found" %}
This may be happening because:
**The pacakge\_id you used doesn't exist.**
Ensure you are using a valid id.
*See* [Error codes](/api/api-reference/resources/error-codes#404-not-found) *for more details.*
{% endtab %}
{% tab title="400: Bad Request Missing required field(s) or invalid data" %}
This may be happening because:
**You have missed a required field in your payload.**
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="403: Forbidden Authentication failed" %}
{% endtab %}
{% endtabs %}
# Human Resources
How to make requests and generate reports as a human resources client in the Certn API.
{% hint style="info" %}
#### Demo Environment
When sending test data to the following endpoints, change the domain to `https://demo-api.certn.co`.
{% endhint %}
To view a list of all application parameters, visit [Application parameters](/api/api-reference/resources/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/` [**`DEPRECATED`**](/api/deprecation)
Invite an applicant to complete a screen via email.
Ensure Certn has SMS turned on for your account and provide a [Application parameters](/api/api-reference/resources/application-parameters#phonenumber) to invite the applicant via SMS as well.
Provide information in the body of the request to pre-fill the application forms.
#### Request Body
| Name | Type | Description |
| ------------------------------------------------- | -------------- | --------------------------------------------------------------------------------------------------- |
| email\* | string | Applicant's email address |
| phone\_number | object | [Application parameters](/api/api-reference/resources/application-parameters#phonenumber) |
| tag | string | Group related applications by tag |
| information | object | [Application parameters](/api/api-reference/resources/application-parameters#information) |
| {request\_flag}\* | boolean | [Request flags](/api/api-reference/resources/application-parameters/request-flags) |
| {ACIC parameters} | string | [Application parameters](/api/api-reference/resources/application-parameters#purpose-of-check-acic) |
| owner\_id\* | string \ | ID of user ordering the application |
{% tabs %}
{% tab title="201: Created HR application successfully created" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
{
"id": string ,
"created": string ,
"modified": string ,
"applicant": {
"id": string ,
"status": string ,
"first_name": string,
"last_name": string,
"email": string,
"phone_number": {
"phone_type": string ,
"number": string,
"country": string
}
}
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```
{
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-10T18:20:21Z",
"modified": "2021-11-10T18:20:21Z",
"applicant": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "Pending",
"first_name": "string",
"last_name": "string",
"email": "string",
"phone_number": {
"phone_type": "NONE",
"number": "+1 250 555 1234",
"country": "string"
}
}
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="400: Bad Request Missing field, wrong data type, account not configured" %}
This may be happening because:
**You are missing required fields**
Add all the required fields to the body of your request.
**You used the wrong format or data type for a field**
Format all your fields according to their [data type](https://www.w3schools.com/js/js_json_datatypes.asp).
**Your account isn't configured to run this check**
[Contact our support team](/api/contact#api) to have your account configured for this check.
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="500: Internal Server Error Wrong data type" %}
This may be happening because:
**You used the wrong format or data type for a field**
Format all your fields according to their [data type](https://www.w3schools.com/js/js_json_datatypes.asp). Most fields in our API take strings, while request flags take booleans.
*See* [Error codes](/api/api-reference/resources/error-codes#500-internal-server-error) *for more details.*
{% endtab %}
{% endtabs %}
## Screen an applicant instantly
`POST` `https://api.certn.co/api/v1/hr/applications/quick/` [**`DEPRECATED`**](/api/deprecation)
Screen an applicant using only the information in the body of your request.
[Get the applicant's consent](/api/guides/use-the-api/consent) *before* running the screen.
#### Request Body
| Name | Type | Description |
| ------------------------------------------------------------------ | -------------- | ------------------------------------------------------------------------------------------------------------ |
| email | string | Applicant's email address |
| tag | string | Group related applications by tag |
| information\* | object | [Application parameters](/api/api-reference/resources/application-parameters#information) |
| enhanced\_identity\_verification | object | [Application parameters](/api/api-reference/resources/application-parameters#enhanced-identity-verification) |
| {request\_flag}\* | boolean | [Request flags](/api/api-reference/resources/application-parameters/request-flags) |
| position\_or\_property\_location\* | object | [Application parameters](/api/api-reference/resources/application-parameters#position-or-property-location) |
| owner\_id\* | string \ | ID of user ordering the application |
{% tabs %}
{% tab title="201: Created HR application successfully created" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
{
"id": string ,
"created": string ,
"modified": string ,
"tag": string,
"(request_flags)": boolean
"last_updated": string ,
"submitted_time": string ,
"is_submitted": boolean,
"applicant_type": string ,
"report_status": string ,
"status": string ,
"status_label": string ,
"result": string ,
"result_label": string ,
"certn_score": number,
"certn_score_label": string ,
"applicant_account": {
"id": string,
"email": string
},
"application": {
object (Application)
},
"country": "CA",
"information": {
object (Information)
},
"employment_verification": string ,
"education_verification": string ,
"credential_verification": string ,
"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 ,
"reliability_risk": number,
"reliability_risk_label": string ,
"workplace_misconduct": number,
"workplace_misconduct_label": string
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```
{
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-10T18:20:21Z",
"modified": "2021-11-10T18:20:21Z",
"tag": "Sub-Client 123",
"request_base": false,
"request_behavioural": false,
"request_softcheck": true,
"request_us_ssn_verification": false,
"request_equifax": true,
"request_identity_verification": false,
"request_enhanced_identity_verification": false,
"request_criminal_record_check": false,
"request_enhanced_criminal_record_check": false,
"request_us_criminal_record_check_tier_1": false,
"request_us_criminal_record_check_tier_2": false,
"request_us_criminal_record_check_tier_3": false,
"request_international_criminal_record_check": false,
"request_motor_vehicle_records": false,
"request_employment_verification": false,
"request_education_verification": false,
"request_credential_verification": false,
"request_employer_references": false,
"request_address_references": false,
"request_employer_phone_references": false,
"request_address_phone_references": false,
"request_instant_verify_employment": false,
"request_instant_verify_education": false,
"request_instant_verify_credential": false,
"last_updated": "2021-11-10T18:20:21Z",
"submitted_time": "2021-11-10T18:20:21Z",
"is_submitted": true,
"applicant_type": "STANDARD",
"report_status": "IN_PROGRESS",
"status": "Pending",
"status_label": "Pending",
"result": "REVIEW",
"result_label": "Review",
"certn_score": 85,
"certn_score_label": "PASS",
"applicant_account": {
"id": "string",
"email": "string"
},
"application": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-10T18:20:21Z",
"modified": "2021-11-10T18:20:21Z",
"email": "string"
},
"country": "CA",
"information": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-10T18:20:21Z",
"modified": "2021-11-10T18:20:21Z",
"first_name": "Sebastien",
"middle_name": "Jack Pierre",
"last_name": "Normandin",
"last_name_at_birth": "string",
"former_names": "string",
"alias": "string",
"date_of_birth": "2021-11-10",
"phone_number": "250-123-1234",
"sin_ssn": 123123123,
"gender": "M",
"birth_city": "string",
"birth_province_state": "string",
"birth_other_province_state": "string",
"birth_country": "string",
"license_number": "string",
"license_valid": true,
"license_prov_state": "string",
"license_other_country": true,
"license_type": "CA",
"cover_letter": "string",
"addresses": [
{
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2",
"rent_or_own": "R",
"cost": 0,
"start_date": "2021-11-10",
"end_date": "2021-11-10",
"certn_verification": "VERIFIED",
"verification_notes": "string",
"address_reference": {
"email": {
"address": "email@certn.co"
},
"phone_number": {
"phone_type": "NONE",
"number": "+1 250 555 1234",
"country": "string"
},
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
},
"contact": {
"can_contact": true,
"can_contact_after_date": "2021-11-10"
}
}
}
],
"employers": [
{
"company_name": "string",
"position": "string",
"income": 8500,
"pay_period": "PER_HOUR",
"start_date": "2021-11-10",
"end_date": "2021-11-10",
"certn_verification": "VERIFIED",
"verification_notes": "string",
"employer_reference": {
"email": {
"address": "email@certn.co"
},
"phone_number": {
"phone_type": "NONE",
"number": "+1 250 555 1234",
"country": "string"
},
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
},
"contact": {
"can_contact": true,
"can_contact_after_date": "2021-11-10"
}
}
}
],
"educations": [
{
"institution": "string",
"degree": {
"degree": "2021-11-10",
"verified": true
},
"address": {
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2"
},
"start_date": "2021-11-10",
"end_date": "2021-11-10",
"certn_verification": "VERIFIED",
"verification_notes": "string"
}
],
"convictions": [
{
"offense": 2002,
"date_of_sentence": "2000-01-01T00:00:00.000Z",
"court_location": "Toronto, ON, Canada",
"description": "Robbery; Theft over $200"
}
]
},
"employment_verification": "VERIFIED",
"education_verification": "VERIFIED",
"credential_verification": "VERIFIED",
"reference_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"information_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"risk_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"risk_evaluations": [
{
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"overall_score": "PASS",
"risk_information_result": {},
"criminal_results": [
{
"confidence": 0,
"confidence_label": "Likely",
"overall_score": "PASS",
"criminal_identity": {
"criminal_cases": [
{
"case_type": "Criminal",
"number": "123asd",
"file_date": "2000-12-12",
"judgment_date": "2000-12-12",
"summary_description": "The case filings summary description",
"full_description": "string",
"notes": "No additional case notes available",
"court": {
"court": "Seattle Superior Court",
"court_type": "Criminal",
"docket_number": "545fjd",
"filed_date": "2000-12-12",
"served_date": "2000-12-12",
"trial_date": "2000-12-12",
"jurisdiction": "Seattle County"
},
"criminal_charges": [
{
"offense_description": "Breach of peace",
"offense_date": "2000-12-12",
"offense_type": "Felony",
"plea": "Not Guilty",
"hearing_date": "2000-12-12",
"hearing_type": "Open court hearing",
"probation": "No probation given",
"community_service": "No community service given",
"sentence_suspended": "None",
"fines": "No fines given",
"fines_paid_status": "Fines not paid",
"fines_paid_date": "2000-12-12",
"cost": "200",
"restitution": "None",
"transferred_jurisdiction": "Transferred from Seattle",
"transferred_case_number": "690330",
"active_warrant": "No active warrant",
"jail_time": "6 months jail time",
"prison_time": "6 months prison time",
"charge_in_progress": "no charge in progress",
"charge": "Vehicular manslaughter two counts",
"charge_level": "Felony",
"charge_class": "None",
"dispositions": [
{
"offense_description": "Speeding",
"offense_type": "Infraction",
"offense_date": "2000-12-12",
"description": "Description of the disposition offense",
"disposition_date": "2000-12-12",
"statue": "20-1212(B)",
"offense_class": "The offense class description",
"final_plea": "Not Guilty",
"disposition_description": "The description of the dispostion"
}
],
"arrests": [
{
"arrest_date": "2000-12-12",
"booking_number": "42069",
"citation_number": "247365",
"arresting_agency": "KERSHAW COUNTY DETENTION CENTER",
"offense_type": "Misdemeanor",
"offense_description": "A description of the arresting offense",
"counts": "Arrest has 6 counts"
}
],
"sentences": [
{
"sentence_type": "Community Service and Fines",
"duration": "6 months",
"amount": "100",
"amount_paid": "50",
"paid": "Half the fine has been paid",
"qualifier": "The sentence has no qualifier information",
"description": "The sentence description",
"effective_date": "2000-12-12",
"appearance_date": "2000-12-12",
"appearance_finding": "There are no appearance findings to detail about the sentence"
}
],
"additional_informations": [
{
"description": "More case information was found.",
"additional_description": "None",
"event_date": "2000-12-12"
}
]
}
]
}
],
"criminal_alerts": [
{
"parent_category": "FRAUD",
"category": "Burglary",
"stage": "Conviction",
"type": "Citation",
"description": "Convicted of burglary",
"date": "2000-12-12",
"parent_category_label": "Fraud"
}
],
"criminal_sources": [
{
"name": "World News",
"url": "worldnews.com",
"date": "2000-12-12",
"format": "Online Media",
"headline": "Burglary Conviction for Area Man",
"publication_source": "World News Conglomerate",
"publisher": "World News"
}
],
"criminal_addresses": [
{
"start_date": "2000-12-12",
"end_date": "2000-12-12",
"unit": "1a",
"address": "123 fort st.",
"city": "Victoria",
"province_state": "BC",
"country": "Canda",
"postal_code": "V8X2C3"
}
],
"criminal_additional_informations": [
{
"aliases": [
"willy will",
"billy bill"
],
"dates_of_birth": [
"2000-12-12"
],
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
}
}
]
}
}
]
}
]
},
"equifax_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"description": "The financial score is based on self-provided information from the applicant and an analysis of the applicant's information available to Certn. This includes a credit check, Equifax record analysis, as well as other important informational data points",
"total_debt": 100,
"upgradable": false,
"trades": [
{
"credit_grantor": "RBC",
"payment_status": "Up to date",
"date_opened": "2000-12-12",
"account_rating": "High",
"date_reported": "2000-12-12",
"account_type": "Revolving",
"high_credit": 2000,
"balance_amount": 1000,
"last_activity_or_payment": "Paid as up to date",
"r_code": "R-1",
"percent_credit_used": 50,
"account_number": "112ksjd",
"past_due_amount": 0,
"payment_term_amount": 120,
"months_reviewed": 15,
"narratives": [
"Account has been paid in full."
]
}
],
"employers": [
{
"employment": "Subject's Current Employer",
"occupation": "Software",
"employer": "Certn",
"city": "Victoria",
"province": "BC",
"verification": true,
"salary": 1000000
}
],
"addresses": [
{
"address": "123 fort st.",
"civic_number": 123,
"street_name": "fort st.",
"city": "Victoria",
"province": "BC"
}
],
"collections": [
{
"date_of_last_payment": "2000-12-12",
"creditor": "Boys Club",
"amount_owed": 10000,
"amount_paid": 50,
"ledger_number": "123aslld",
"date_paid": "2000-12-12T00:00:00.000Z",
"date_reported": "2000-12-12T00:00:00.000Z",
"assigned_date": "2012-12-12T00:00:00.000Z",
"verification_date": "2000-12-12T00:00:00.000Z",
"account_designation": "Individual",
"first_deliquency": "2000-12-12T00:00:00.000Z",
"agency_entity": "GQC123",
"reason": "Credit not paid on in full",
"description": "Parking ticket"
}
],
"deposit_alerts": [
{
"customer_entity": "RBC",
"date_reported": "2000-12-12T00:00:00.000Z",
"account_type": "Business",
"date_opened": "2000-12-12T00:00:00.000Z",
"date_closed": "2000-12-12T00:00:00.000Z",
"date_written_off": "2000-12-12T00:00:00.000Z",
"amount_written_off": 2000,
"alert_status": "High",
"alert_status_date": "2000-12-12T00:00:00.000Z"
}
],
"bankruptcies": [
{
"account_type": "Individual",
"liability_amount": 2000,
"asset_amount": 20000,
"customer": "CRED COUNSELLING SOC",
"case_number_and_trustee": "12312 CE ASSOCIATES",
"filer": "Subject",
"legal_narrative": "No legal information available",
"date_filed": "2000-12-12T00:00:00.000Z",
"intent_or_disposition": "Discharged"
}
],
"judgments": [
{
"plaintiff": "Fred Rickleson",
"defendant": "Rick Frederickson",
"amount": 1000.21,
"date_filed": "2000-12-12T00:00:00.000Z",
"date_satisfied": "2000-12-12T00:00:00.000Z",
"verification_date": "2000-12-12T00:00:00.000Z",
"court_entity": "RBC",
"garnishee": "RBC",
"description": "Fred sued Rick"
}
],
"legal_items": [
{
"case_number": "1232djdsj",
"verification_date": "2000-12-12T00:00:00.000Z",
"update_source_code": "Tape rptd",
"date_filed": "2000-12-12T00:00:00.000Z",
"court_entity": "Toronto small claims",
"status_code": "Satisfied",
"date_satisfied": "2000-12-12T00:00:00.000Z",
"amount": 10000,
"defendant": "John Smithy",
"plaintiff": "Smith Johny",
"lawyer_name_address": "Johnson LLC 123 fort st Victoria",
"legal_item_description": "It was very bad deal"
}
],
"liens": [
{
"amount": 1000,
"date_filed": "1999-12-12T00:00:00.000Z",
"lien_class": "Class A",
"date_released": "1990-12-12T00:00:00.000Z",
"date_verified": "1990-12-12T00:00:00.000Z",
"court_entity": "Superior Court.",
"case_number": "123asda",
"lien_description": "Lien on house."
}
],
"secured_loans": [
{
"date_filed": "1990-12-12T00:00:00.000Z",
"court_entity": "Superior",
"creditor_name_address": "RBC 123 Main st.",
"creditor_industry_code": "620a",
"maturity_date": "1990-12-12T00:00:00.000Z"
}
],
"fraud_warnings": [
{
"product_description": "Fraud warnings are warnings of fraud.",
"message_priority": "Very high",
"message_code": "123a",
"message_description": "High fraud alert for bank fraud"
}
],
"non_sufficient_funds": [
{
"date_reported": "1990-12-12T00:00:00.000Z",
"creditor_entity": "RBC",
"nsfamount": 1000.2,
"details": "No sufficient funds in savings account.",
"verification_date": "1990-12-12T00:00:00.000Z"
}
],
"credit_file_metadatas": [
{
"hit_strength_indicator": "HIT",
"request_number": "123asd",
"address_discrepancy": "No discrepancy found in address",
"customer_number": "123asd",
"report_id": "123asd",
"file_since_date": "1990-12-12T00:00:00.000Z",
"date_of_last_activity": "1990-12-12T00:00:00.000Z",
"date_of_request": "1990-12-12T00:00:00.000Z",
"hit": "Big Hit",
"data_warning_messages": [
"No data warning messages"
],
"card_alert_warning_messages": [
"Credit card on high alert"
],
"alert_indicators": [
"No messages"
]
}
],
"other_incomes": [
{
"date_reported": "1990-12-12T00:00:00.000Z",
"income_source": "RBC",
"amount": 1000000,
"verification_date": "1990-12-12T00:00:00.000Z"
}
],
"consumer_statements": [
{
"date_reported": "1990-12-12T00:00:00.000Z",
"statement": "No consumer statement available."
}
],
"bank_accounts": [
{
"account": "Personal checking",
"date_reported": "1990-12-12T00:00:00.000Z",
"creditor_entity": "RBC",
"account_number": "123asd",
"figure_amount": 1000.12,
"date_opened": "1990-12-12T00:00:00.000Z",
"account_type": "Checking",
"status": "active",
"number_of_nsf": 0
}
],
"local_inquiries": [
{
"inquiry_date": "1990-12-12T00:00:00.000Z",
"customer_name": "Certn"
}
],
"foreign_inquiries": [
{
"inquiry_date": "1990-12-12T00:00:00.000Z",
"city_name_or_inquiry_number": "Seattle",
"inquiry_province": "WA"
}
]
},
"identity_verified": true,
"employment_verified": true,
"identity_verification": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-10T18:20:21Z",
"modified": "2021-11-10T18:20:21Z",
"status": "A",
"result": "VERIFIED"
},
"enhanced_identity_verification": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-10T18:20:21Z",
"modified": "2021-11-10T18:20:21Z",
"status": "A",
"result": "VERIFIED"
},
"manual_id_verification": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-10T18:20:21Z",
"modified": "2021-11-10T18:20:21Z",
"status": "A",
"result": "VERIFIED"
},
"rcmp_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"us_criminal_record_check_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"criminal_cases": [
{
"case_type": "Criminal",
"number": "123asd",
"file_date": "2000-12-12",
"judgment_date": "2000-12-12",
"summary_description": "The case filings summary description",
"full_description": "string",
"notes": "No additional case notes available",
"court": {
"court": "Seattle Superior Court",
"court_type": "Criminal",
"docket_number": "545fjd",
"filed_date": "2000-12-12",
"served_date": "2000-12-12",
"trial_date": "2000-12-12",
"jurisdiction": "Seattle County"
},
"criminal_charges": [
{
"offense_description": "Breach of peace",
"offense_date": "2000-12-12",
"offense_type": "Felony",
"plea": "Not Guilty",
"hearing_date": "2000-12-12",
"hearing_type": "Open court hearing",
"probation": "No probation given",
"community_service": "No community service given",
"sentence_suspended": "None",
"fines": "No fines given",
"fines_paid_status": "Fines not paid",
"fines_paid_date": "2000-12-12",
"cost": "200",
"restitution": "None",
"transferred_jurisdiction": "Transferred from Seattle",
"transferred_case_number": "690330",
"active_warrant": "No active warrant",
"jail_time": "6 months jail time",
"prison_time": "6 months prison time",
"charge_in_progress": "no charge in progress",
"charge": "Vehicular manslaughter two counts",
"charge_level": "Felony",
"charge_class": "None",
"dispositions": [
{
"offense_description": "Speeding",
"offense_type": "Infraction",
"offense_date": "2000-12-12",
"description": "Description of the disposition offense",
"disposition_date": "2000-12-12",
"statue": "20-1212(B)",
"offense_class": "The offense class description",
"final_plea": "Not Guilty",
"disposition_description": "The description of the dispostion"
}
],
"arrests": [
{
"arrest_date": "2000-12-12",
"booking_number": "42069",
"citation_number": "247365",
"arresting_agency": "KERSHAW COUNTY DETENTION CENTER",
"offense_type": "Misdemeanor",
"offense_description": "A description of the arresting offense",
"counts": "Arrest has 6 counts"
}
],
"sentences": [
{
"sentence_type": "Community Service and Fines",
"duration": "6 months",
"amount": "100",
"amount_paid": "50",
"paid": "Half the fine has been paid",
"qualifier": "The sentence has no qualifier information",
"description": "The sentence description",
"effective_date": "2000-12-12",
"appearance_date": "2000-12-12",
"appearance_finding": "There are no appearance findings to detail about the sentence"
}
],
"additional_informations": [
{
"description": "More case information was found.",
"additional_description": "None",
"event_date": "2000-12-12"
}
]
}
]
}
],
"ssn_id_document_reports": [
{
"ssn_result": "Discrepancy",
"ssn_status": "Complete",
"names": [
{
"first_name": "string",
"middle_name": "string",
"last_name": "string"
}
],
"addresses": [
{
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2"
}
],
"id_documents": [
{
"type": "Passport",
"number": "123412kdsdsk",
"issuing_country": "US",
"issuing_province_state": "WA",
"issue_date": "2000-12-12",
"expiry_date": "2000-12-12"
}
],
"dates_of_birth": [
{
"date_of_birth": "2000-12-12"
}
]
}
],
"scan_status": {
"national_sex_offender_registry_scan": "Complete",
"security_watch_list_scan": "Complete",
"fraud_scan": "Complete",
"ofac_global_sanctions_scan": "Complete",
"ssn_verification_scan": "Complete",
"criminal_record_scan": "Complete",
"federal_record_scan": "Incomplete",
"single_state_county_record_scan": "Incomplete",
"all_state_county_record_scan": "Incomplete"
},
"record_check_requests": [
{
"status": "Complete",
"state": "OH",
"county": "Kershaw",
"district": "District 1",
"fips_code": 12312,
"search_type": "Criminal/Court Database Search"
}
]
},
"verification_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"employment_verification": "VERIFIED",
"education_verification": "VERIFIED",
"credential_verification": "VERIFIED",
"certn_verification": "VERIFIED",
"employer_verification_results": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"certn_verification": "VERIFIED",
"company_name_verified": false,
"position_name_verified": false,
"income_verified": false,
"employment_dates_verified": true,
"verification_notes": "Verification notes!",
"employer": {
"company_name": "string",
"position": "string",
"income": 8500,
"pay_period": "PER_HOUR",
"start_date": "2021-11-10",
"end_date": "2021-11-10",
"certn_verification": "VERIFIED",
"verification_notes": "string",
"employer_reference": {
"email": {
"address": "email@certn.co"
},
"phone_number": {
"phone_type": "NONE",
"number": "+1 250 555 1234",
"country": "string"
},
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
},
"contact": {
"can_contact": true,
"can_contact_after_date": "2021-11-10"
}
}
}
},
"education_verification_results": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"certn_verification": "VERIFIED",
"specializations_verified": false,
"degree_verified": false,
"institution_verified": false,
"enrolment_dates_verified": true,
"verification_notes": "Verification notes!",
"education": {
"institution": "string",
"degree": {
"degree": "2021-11-10",
"verified": true
},
"address": {
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2"
},
"start_date": "2021-11-10",
"end_date": "2021-11-10",
"certn_verification": "VERIFIED",
"verification_notes": "string"
}
},
"credential_verification_results": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"certn_verification": "VERIFIED",
"certification_date_verified": false,
"certification_verified": false,
"institution_verified": true,
"verification_notes": "Verification notes!",
"credential": {
"description": "string",
"institution": "string",
"certification": "string",
"date_of_certification": "2021-11-10",
"current": true,
"certn_verification": "VERIFIED",
"verification_notes": "string"
}
}
},
"international_criminal_record_check_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"motor_vehicle_record_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"salary": 0,
"sufficient_salary": true,
"high_risk_vulnerable_sector": true,
"job_safety_undue_risk": true,
"early_termination": 0,
"early_termination_label": "High",
"reliability_risk": 0,
"reliability_risk_label": "High",
"workplace_misconduct": 0,
"workplace_misconduct_label": "High"
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="400: Bad Request Missing field, wrong data type, account not configured" %}
This may be happening because:
**You are missing required fields**
Add all the required fields to the body of your request.
**You used the wrong format or data type for a field**
Format all your fields according to their [data type](https://www.w3schools.com/js/js_json_datatypes.asp).
**Your account isn't configured to run this check**
[Contact our support team](/api/contact#api) to have your account configured for this check.
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="500: Internal Server Error Wrong data type" %}
This may be happening because:
**You used the wrong format or data type for a field**
Format all your fields according to their [data type](https://www.w3schools.com/js/js_json_datatypes.asp). Most fields in our API take strings, while request flags take booleans.
*See* [Error codes](/api/api-reference/resources/error-codes#500-internal-server-error) *for more details.*
{% endtab %}
{% endtabs %}
## Upgrade an application
`PUT` `https://api.certn.co/api/v1/hr/applicants/{applicant_id}/packages/` [**`DEPRECATED`**](/api/deprecation)
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
| Name | Type | Description |
| ----------------------------------------------- | ------ | ------------------- |
| applicant\_id\* | string | ID of the applicant |
#### Request Body
| Name | Type | Description |
| ------------------------------------------------- | ------- | ---------------------------------------------------------------------------------- |
| tag | string | Group related applications by tag |
| {request\_flag}\* | boolean | [Request flags](/api/api-reference/resources/application-parameters/request-flags) |
{% tabs %}
{% tab title="200: OK Application successfully retrieved" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```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 >
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
{
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-10T18:20:22Z",
"modified": "2021-11-10T18:20:22Z",
"tag": "Sub-Client 123",
"request_base": false,
"request_behavioural": false,
"request_softcheck": true,
"request_us_ssn_verification": false,
"request_equifax": true,
"request_identity_verification": false,
"request_enhanced_identity_verification": false,
"request_criminal_record_check": false,
"request_enhanced_criminal_record_check": false,
"request_us_criminal_record_check_tier_1": false,
"request_us_criminal_record_check_tier_2": false,
"request_us_criminal_record_check_tier_3": false,
"request_international_criminal_record_check": false,
"request_motor_vehicle_records": false,
"request_employment_verification": false,
"request_education_verification": false,
"request_credential_verification": false,
"request_employer_references": false,
"request_address_references": false,
"request_employer_phone_references": false,
"request_address_phone_references": false,
"request_instant_verify_employment": false,
"request_instant_verify_education": false,
"request_instant_verify_credential": false,
"last_updated": "2021-11-10T18:20:22Z",
"submitted_time": "2021-11-10T18:20:22Z",
"is_submitted": true,
"applicant_type": "STANDARD",
"report_status": "IN_PROGRESS",
"status": "Pending",
"status_label": "Pending",
"result": "REVIEW",
"result_label": "Review",
"certn_score": 85,
"certn_score_label": "PASS",
"applicant_account": {
"id": "string",
"email": "string"
},
"application": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-10T18:20:22Z",
"modified": "2021-11-10T18:20:22Z",
"email": "string"
},
"country": "CA",
"information": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-10T18:20:22Z",
"modified": "2021-11-10T18:20:22Z",
"first_name": "Sebastien",
"middle_name": "Jack Pierre",
"last_name": "Normandin",
"last_name_at_birth": "string",
"former_names": "string",
"alias": "string",
"date_of_birth": "2021-11-10",
"phone_number": "250-123-1234",
"sin_ssn": 123123123,
"gender": "M",
"birth_city": "string",
"birth_province_state": "string",
"birth_other_province_state": "string",
"birth_country": "string",
"license_number": "string",
"license_valid": true,
"license_prov_state": "string",
"license_other_country": true,
"license_type": "CA",
"cover_letter": "string",
"addresses": [{
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2",
"rent_or_own": "R",
"cost": 0,
"start_date": "2021-11-10",
"end_date": "2021-11-10",
"certn_verification": "VERIFIED",
"verification_notes": "string",
"address_reference": {
"email": {
"address": "email@certn.co"
},
"phone_number": {
"phone_type": "NONE",
"number": "+1 250 555 1234",
"country": "string"
},
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
},
"contact": {
"can_contact": true,
"can_contact_after_date": "2021-11-10"
}
}
}
],
"employers": [{
"company_name": "string",
"position": "string",
"income": 8500,
"pay_period": "PER_HOUR",
"start_date": "2021-11-10",
"end_date": "2021-11-10",
"certn_verification": "VERIFIED",
"verification_notes": "string",
"employer_reference": {
"email": {
"address": "email@certn.co"
},
"phone_number": {
"phone_type": "NONE",
"number": "+1 250 555 1234",
"country": "string"
},
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
},
"contact": {
"can_contact": true,
"can_contact_after_date": "2021-11-10"
}
}
}
],
"educations": [{
"institution": "string",
"degree": {
"degree": "2021-11-10",
"verified": true
},
"address": {
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2"
},
"start_date": "2021-11-10",
"end_date": "2021-11-10",
"certn_verification": "VERIFIED",
"verification_notes": "string"
}
],
"convictions": [{
"offense": 2002,
"date_of_sentence": "2000-01-01T00:00:00.000Z",
"court_location": "Toronto, ON, Canada",
"description": "Robbery; Theft over $200"
}
]
},
"employment_verification": "VERIFIED",
"education_verification": "VERIFIED",
"credential_verification": "VERIFIED",
"reference_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"information_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"behavioural_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"risk_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"risk_evaluations": [{
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"overall_score": "PASS",
"risk_information_result": {},
"criminal_results": [{
"confidence": 0,
"confidence_label": "Likely",
"overall_score": "PASS",
"criminal_identity": {
"criminal_cases": [{
"case_type": "Criminal",
"number": "123asd",
"file_date": "2000-12-12",
"judgment_date": "2000-12-12",
"summary_description": "The case filings summary description",
"full_description": "string",
"notes": "No additional case notes available",
"court": {
"court": "Seattle Superior Court",
"court_type": "Criminal",
"docket_number": "545fjd",
"filed_date": "2000-12-12",
"served_date": "2000-12-12",
"trial_date": "2000-12-12",
"jurisdiction": "Seattle County"
},
"criminal_charges": [{
"offense_description": "Breach of peace",
"offense_date": "2000-12-12",
"offense_type": "Felony",
"plea": "Not Guilty",
"hearing_date": "2000-12-12",
"hearing_type": "Open court hearing",
"probation": "No probation given",
"community_service": "No community service given",
"sentence_suspended": "None",
"fines": "No fines given",
"fines_paid_status": "Fines not paid",
"fines_paid_date": "2000-12-12",
"cost": "200",
"restitution": "None",
"transferred_jurisdiction": "Transferred from Seattle",
"transferred_case_number": "690330",
"active_warrant": "No active warrant",
"jail_time": "6 months jail time",
"prison_time": "6 months prison time",
"charge_in_progress": "no charge in progress",
"charge": "Vehicular manslaughter two counts",
"charge_level": "Felony",
"charge_class": "None",
"dispositions": [{
"offense_description": "Speeding",
"offense_type": "Infraction",
"offense_date": "2000-12-12",
"description": "Description of the disposition offense",
"disposition_date": "2000-12-12",
"statue": "20-1212(B)",
"offense_class": "The offense class description",
"final_plea": "Not Guilty",
"disposition_description": "The description of the dispostion"
}
],
"arrests": [{
"arrest_date": "2000-12-12",
"booking_number": "42069",
"citation_number": "247365",
"arresting_agency": "KERSHAW COUNTY DETENTION CENTER",
"offense_type": "Misdemeanor",
"offense_description": "A description of the arresting offense",
"counts": "Arrest has 6 counts"
}
],
"sentences": [{
"sentence_type": "Community Service and Fines",
"duration": "6 months",
"amount": "100",
"amount_paid": "50",
"paid": "Half the fine has been paid",
"qualifier": "The sentence has no qualifier information",
"description": "The sentence description",
"effective_date": "2000-12-12",
"appearance_date": "2000-12-12",
"appearance_finding": "There are no appearance findings to detail about the sentence"
}
],
"additional_informations": [{
"description": "More case information was found.",
"additional_description": "None",
"event_date": "2000-12-12"
}
]
}
]
}
],
"criminal_alerts": [{
"parent_category": "FRAUD",
"category": "Burglary",
"stage": "Conviction",
"type": "Citation",
"description": "Convicted of burglary",
"date": "2000-12-12",
"parent_category_label": "Fraud"
}
],
"criminal_sources": [{
"name": "World News",
"url": "worldnews.com",
"date": "2000-12-12",
"format": "Online Media",
"headline": "Burglary Conviction for Area Man",
"publication_source": "World News Conglomerate",
"publisher": "World News"
}
],
"criminal_addresses": [{
"start_date": "2000-12-12",
"end_date": "2000-12-12",
"unit": "1a",
"address": "123 fort st.",
"city": "Victoria",
"province_state": "BC",
"country": "Canda",
"postal_code": "V8X2C3"
}
],
"criminal_additional_informations": [{
"aliases": [
"willy will",
"billy bill"
],
"dates_of_birth": [
"2000-12-12"
],
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
}
}
]
}
}
]
}
]
},
"equifax_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"description": "The financial score is based on self-provided information from the applicant and an analysis of the applicant's information available to Certn. This includes a credit check, Equifax record analysis, as well as other important informational data points",
"total_debt": 100,
"upgradable": false,
"trades": [{
"credit_grantor": "RBC",
"payment_status": "Up to date",
"date_opened": "2000-12-12",
"account_rating": "High",
"date_reported": "2000-12-12",
"account_type": "Revolving",
"high_credit": 2000,
"balance_amount": 1000,
"last_activity_or_payment": "Paid as up to date",
"r_code": "R-1",
"percent_credit_used": 50,
"account_number": "112ksjd",
"past_due_amount": 0,
"payment_term_amount": 120,
"months_reviewed": 15,
"narratives": [
"Account has been paid in full."
]
}
],
"employers": [{
"employment": "Subject's Current Employer",
"occupation": "Software",
"employer": "Certn",
"city": "Victoria",
"province": "BC",
"verification": true,
"salary": 1000000
}
],
"addresses": [{
"address": "123 fort st.",
"civic_number": 123,
"street_name": "fort st.",
"city": "Victoria",
"province": "BC"
}
],
"collections": [{
"date_of_last_payment": "2000-12-12",
"creditor": "Boys Club",
"amount_owed": 10000,
"amount_paid": 50,
"ledger_number": "123aslld",
"date_paid": "2000-12-12T00:00:00.000Z",
"date_reported": "2000-12-12T00:00:00.000Z",
"assigned_date": "2012-12-12T00:00:00.000Z",
"verification_date": "2000-12-12T00:00:00.000Z",
"account_designation": "Individual",
"first_deliquency": "2000-12-12T00:00:00.000Z",
"agency_entity": "GQC123",
"reason": "Credit not paid on in full",
"description": "Parking ticket"
}
],
"deposit_alerts": [{
"customer_entity": "RBC",
"date_reported": "2000-12-12T00:00:00.000Z",
"account_type": "Business",
"date_opened": "2000-12-12T00:00:00.000Z",
"date_closed": "2000-12-12T00:00:00.000Z",
"date_written_off": "2000-12-12T00:00:00.000Z",
"amount_written_off": 2000,
"alert_status": "High",
"alert_status_date": "2000-12-12T00:00:00.000Z"
}
],
"bankruptcies": [{
"account_type": "Individual",
"liability_amount": 2000,
"asset_amount": 20000,
"customer": "CRED COUNSELLING SOC",
"case_number_and_trustee": "12312 CE ASSOCIATES",
"filer": "Subject",
"legal_narrative": "No legal information available",
"date_filed": "2000-12-12T00:00:00.000Z",
"intent_or_disposition": "Discharged"
}
],
"judgments": [{
"plaintiff": "Fred Rickleson",
"defendant": "Rick Frederickson",
"amount": 1000.21,
"date_filed": "2000-12-12T00:00:00.000Z",
"date_satisfied": "2000-12-12T00:00:00.000Z",
"verification_date": "2000-12-12T00:00:00.000Z",
"court_entity": "RBC",
"garnishee": "RBC",
"description": "Fred sued Rick"
}
],
"legal_items": [{
"case_number": "1232djdsj",
"verification_date": "2000-12-12T00:00:00.000Z",
"update_source_code": "Tape rptd",
"date_filed": "2000-12-12T00:00:00.000Z",
"court_entity": "Toronto small claims",
"status_code": "Satisfied",
"date_satisfied": "2000-12-12T00:00:00.000Z",
"amount": 10000,
"defendant": "John Smithy",
"plaintiff": "Smith Johny",
"lawyer_name_address": "Johnson LLC 123 fort st Victoria",
"legal_item_description": "It was very bad deal"
}
],
"liens": [{
"amount": 1000,
"date_filed": "1999-12-12T00:00:00.000Z",
"lien_class": "Class A",
"date_released": "1990-12-12T00:00:00.000Z",
"date_verified": "1990-12-12T00:00:00.000Z",
"court_entity": "Superior Court.",
"case_number": "123asda",
"lien_description": "Lien on house."
}
],
"secured_loans": [{
"date_filed": "1990-12-12T00:00:00.000Z",
"court_entity": "Superior",
"creditor_name_address": "RBC 123 Main st.",
"creditor_industry_code": "620a",
"maturity_date": "1990-12-12T00:00:00.000Z"
}
],
"fraud_warnings": [{
"product_description": "Fraud warnings are warnings of fraud.",
"message_priority": "Very high",
"message_code": "123a",
"message_description": "High fraud alert for bank fraud"
}
],
"non_sufficient_funds": [{
"date_reported": "1990-12-12T00:00:00.000Z",
"creditor_entity": "RBC",
"nsfamount": 1000.2,
"details": "No sufficient funds in savings account.",
"verification_date": "1990-12-12T00:00:00.000Z"
}
],
"credit_file_metadatas": [{
"hit_strength_indicator": "HIT",
"request_number": "123asd",
"address_discrepancy": "No discrepancy found in address",
"customer_number": "123asd",
"report_id": "123asd",
"file_since_date": "1990-12-12T00:00:00.000Z",
"date_of_last_activity": "1990-12-12T00:00:00.000Z",
"date_of_request": "1990-12-12T00:00:00.000Z",
"hit": "Big Hit",
"data_warning_messages": [
"No data warning messages"
],
"card_alert_warning_messages": [
"Credit card on high alert"
],
"alert_indicators": [
"No messages"
]
}
],
"other_incomes": [{
"date_reported": "1990-12-12T00:00:00.000Z",
"income_source": "RBC",
"amount": 1000000,
"verification_date": "1990-12-12T00:00:00.000Z"
}
],
"consumer_statements": [{
"date_reported": "1990-12-12T00:00:00.000Z",
"statement": "No consumer statement available."
}
],
"bank_accounts": [{
"account": "Personal checking",
"date_reported": "1990-12-12T00:00:00.000Z",
"creditor_entity": "RBC",
"account_number": "123asd",
"figure_amount": 1000.12,
"date_opened": "1990-12-12T00:00:00.000Z",
"account_type": "Checking",
"status": "active",
"number_of_nsf": 0
}
],
"local_inquiries": [{
"inquiry_date": "1990-12-12T00:00:00.000Z",
"customer_name": "Certn"
}
],
"foreign_inquiries": [{
"inquiry_date": "1990-12-12T00:00:00.000Z",
"city_name_or_inquiry_number": "Seattle",
"inquiry_province": "WA"
}
]
},
"identity_verified": true,
"employment_verified": true,
"identity_verification": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-10T18:20:22Z",
"modified": "2021-11-10T18:20:22Z",
"status": "A",
"result": "VERIFIED"
},
"enhanced_identity_verification": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-10T18:20:22Z",
"modified": "2021-11-10T18:20:22Z",
"status": "A",
"result": "VERIFIED"
},
"manual_id_verification": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-10T18:20:22Z",
"modified": "2021-11-10T18:20:22Z",
"status": "A",
"result": "VERIFIED"
},
"rcmp_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"us_criminal_record_check_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"criminal_cases": [{
"case_type": "Criminal",
"number": "123asd",
"file_date": "2000-12-12",
"judgment_date": "2000-12-12",
"summary_description": "The case filings summary description",
"full_description": "string",
"notes": "No additional case notes available",
"court": {
"court": "Seattle Superior Court",
"court_type": "Criminal",
"docket_number": "545fjd",
"filed_date": "2000-12-12",
"served_date": "2000-12-12",
"trial_date": "2000-12-12",
"jurisdiction": "Seattle County"
},
"criminal_charges": [{
"offense_description": "Breach of peace",
"offense_date": "2000-12-12",
"offense_type": "Felony",
"plea": "Not Guilty",
"hearing_date": "2000-12-12",
"hearing_type": "Open court hearing",
"probation": "No probation given",
"community_service": "No community service given",
"sentence_suspended": "None",
"fines": "No fines given",
"fines_paid_status": "Fines not paid",
"fines_paid_date": "2000-12-12",
"cost": "200",
"restitution": "None",
"transferred_jurisdiction": "Transferred from Seattle",
"transferred_case_number": "690330",
"active_warrant": "No active warrant",
"jail_time": "6 months jail time",
"prison_time": "6 months prison time",
"charge_in_progress": "no charge in progress",
"charge": "Vehicular manslaughter two counts",
"charge_level": "Felony",
"charge_class": "None",
"dispositions": [{
"offense_description": "Speeding",
"offense_type": "Infraction",
"offense_date": "2000-12-12",
"description": "Description of the disposition offense",
"disposition_date": "2000-12-12",
"statue": "20-1212(B)",
"offense_class": "The offense class description",
"final_plea": "Not Guilty",
"disposition_description": "The description of the dispostion"
}
],
"arrests": [{
"arrest_date": "2000-12-12",
"booking_number": "42069",
"citation_number": "247365",
"arresting_agency": "KERSHAW COUNTY DETENTION CENTER",
"offense_type": "Misdemeanor",
"offense_description": "A description of the arresting offense",
"counts": "Arrest has 6 counts"
}
],
"sentences": [{
"sentence_type": "Community Service and Fines",
"duration": "6 months",
"amount": "100",
"amount_paid": "50",
"paid": "Half the fine has been paid",
"qualifier": "The sentence has no qualifier information",
"description": "The sentence description",
"effective_date": "2000-12-12",
"appearance_date": "2000-12-12",
"appearance_finding": "There are no appearance findings to detail about the sentence"
}
],
"additional_informations": [{
"description": "More case information was found.",
"additional_description": "None",
"event_date": "2000-12-12"
}
]
}
]
}
],
"ssn_id_document_reports": [{
"ssn_result": "Discrepancy",
"ssn_status": "Complete",
"names": [{
"first_name": "string",
"middle_name": "string",
"last_name": "string"
}
],
"addresses": [{
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2"
}
],
"id_documents": [{
"type": "Passport",
"number": "123412kdsdsk",
"issuing_country": "US",
"issuing_province_state": "WA",
"issue_date": "2000-12-12",
"expiry_date": "2000-12-12"
}
],
"dates_of_birth": [{
"date_of_birth": "2000-12-12"
}
]
}
],
"scan_status": {
"national_sex_offender_registry_scan": "Complete",
"security_watch_list_scan": "Complete",
"fraud_scan": "Complete",
"ofac_global_sanctions_scan": "Complete",
"ssn_verification_scan": "Complete",
"criminal_record_scan": "Complete",
"federal_record_scan": "Incomplete",
"single_state_county_record_scan": "Incomplete",
"all_state_county_record_scan": "Incomplete"
},
"record_check_requests": [{
"status": "Complete",
"state": "OH",
"county": "Kershaw",
"district": "District 1",
"fips_code": 12312,
"search_type": "Criminal/Court Database Search"
}
]
},
"verification_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"employment_verification": "VERIFIED",
"education_verification": "VERIFIED",
"credential_verification": "VERIFIED",
"certn_verification": "VERIFIED",
"employer_verification_results": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"certn_verification": "VERIFIED",
"company_name_verified": false,
"position_name_verified": false,
"income_verified": false,
"employment_dates_verified": true,
"verification_notes": "Verification notes!",
"employer": {
"company_name": "string",
"position": "string",
"income": 8500,
"pay_period": "PER_HOUR",
"start_date": "2021-11-10",
"end_date": "2021-11-10",
"certn_verification": "VERIFIED",
"verification_notes": "string",
"employer_reference": {
"email": {
"address": "email@certn.co"
},
"phone_number": {
"phone_type": "NONE",
"number": "+1 250 555 1234",
"country": "string"
},
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
},
"contact": {
"can_contact": true,
"can_contact_after_date": "2021-11-10"
}
}
}
},
"education_verification_results": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"certn_verification": "VERIFIED",
"specializations_verified": false,
"degree_verified": false,
"institution_verified": false,
"enrolment_dates_verified": true,
"verification_notes": "Verification notes!",
"education": {
"institution": "string",
"degree": {
"degree": "2021-11-10",
"verified": true
},
"address": {
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2"
},
"start_date": "2021-11-10",
"end_date": "2021-11-10",
"certn_verification": "VERIFIED",
"verification_notes": "string"
}
},
"credential_verification_results": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"certn_verification": "VERIFIED",
"certification_date_verified": false,
"certification_verified": false,
"institution_verified": true,
"verification_notes": "Verification notes!",
"credential": {
"description": "string",
"institution": "string",
"certification": "string",
"date_of_certification": "2021-11-10",
"current": true,
"certn_verification": "VERIFIED",
"verification_notes": "string"
}
}
},
"international_criminal_record_check_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"motor_vehicle_record_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"instant_verify_result": {
"instant_verify_employment": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"instant_verify_employment_result": [{
"verification_status": "VERIFIED",
"verifications_scale": 0.8,
"label_source_data": "Tiger Keeping",
"label_verifier_data": "Keeping of Tigers",
"org_source_data": "The Greater Wynnewood Exotic Animal Park",
"org_verifier_data": "The Greater Wynnewood Exotic Animal Park",
"dates_source_data": "Feb - Sept 2020",
"dates_verifier_data": "Feb - Sept 2020"
}
]
},
"instant_verify_education": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"instant_verify_education_result": [{
"verification_status": "VERIFIED",
"verifications_scale": 0.8,
"label_source_data": "Exploring Level 1",
"label_verifier_data": "Exploring 1",
"org_source_data": "DZ Center",
"org_verifier_data": "DZ Center",
"dates_source_data": "Feb - Sept 2020",
"dates_verifier_data": "Feb - Sept 2020"
}
]
},
"instant_verify_credential": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"instant_verification_credential_result": [{
"verification_status": "VERIFIED",
"verifications_scale": 0.8,
"label_source_data": "CPR",
"label_verifier_data": "CPR Care Giver",
"org_source_data": "Red Cross",
"org_verifier_data": "Red Cross",
"dates_source_data": "Feb - Sept 2020",
"dates_verifier_data": "Feb - Sept 2020"
}
]
}
},
"salary": 0,
"sufficient_salary": true,
"high_risk_vulnerable_sector": true,
"job_safety_undue_risk": true,
"early_termination": 0,
"early_termination_label": "High",
"reliability_risk": 0,
"reliability_risk_label": "High",
"workplace_misconduct": 0,
"workplace_misconduct_label": "High"
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="400: Bad Request Account not configured" %}
This may be happening because:
**Your account isn't configured to run this check**
[Contact our support team](/api/contact#api) to have your account configured for this check.
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% endtabs %}
## Retrieve all your applications
`GET` `https://api.certn.co/api/v1/hr/applicants/` [**`DEPRECATED`**](/api/deprecation)
View the details of all your applications.
The results are sent via paginated response, in chronological order. 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/hr/v1/applicants/?page=`
You can retrieve the final report for an application when its `report_status` field is marked as `COMPLETE`.
#### Query Parameters
| Name | Type | Description |
| ------------------------- | -------------- | --------------------------------------------------------------------------- |
| page | int | Page number to retrieve |
| application\_\_team\_\_id | string \ | Filter applicants by team associated with the application |
| owner | string \ | Filter applicants by the user id associated as the owner of the application |
{% tabs %}
{% tab title="200: OK Reports successfully retrieved" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
{
"count": int,
"next": URL,
"previous": URL,
"results": [
{
"(request_flags)": boolean,
"last_updated": string ,
"id": string ,
"short_uid": string,
"report_status": string ,
"information": {
object(Information)
},
"applicant_account": {
"id": string ,
"email": string,
"email_verified": boolean,
"phone_number": string
},
"application": {
object(Application)
},
"adjudication_status": string ,
"adjudication_status_label": string ,
"report_summary": {
"reference_result": object(BasePackageResult),
"australian_criminal_intelligence_commission_check_result": object(certificate_url),
"rcmp_result": object(RCMPResult),
"equifax_result": object(EquifaxResult),
"information_result": object(BasePackageResult),
"instant_verify_result": object(BasePackageResult),
"international_criminal_record_check_result": object(InternationalCriminalRecordCheckResult),
"motor_vehicle_record_result": object(MotorVehicleRecordResult),
"social_media_check_result": object(SocialMediaCheckResult),
"risk_result": object(RiskResult),
"soquij_result": object(SoquijResult),
"uk_basic_dbs_check_result": object(UKBasicDBSCheckResult),
"uk_basic_ds_check_result": object(UKBasicDSCheckResult),
"uk_right_to_work_check_result": object(UKRightToWorkResult),
"us_criminal_record_check_result": object(USCriminalRecordCheckResult),
"vaccination_check_result": object(BasePackageResult),
"right_to_work_result": object(RightToWorkResult),
"certn_verification": object(BasePackageResult),
"report_result": string ,
"report_result_label": string ,
"dispute": boolean,
"report_status": string ,
"report_status_label": string
},
"can_upgrade": boolean,
"is_equifax_eligible": boolean,
"can_resend_email": boolean,
"resend_email_time": string ,
"is_viewed": boolean,
"onboarding_link": URL,
"applicant_adjudication": null,
"has_active_automated_reminders": boolean,
"order_status": string ,
"check_executions": [
{
"id": "check_exec_ABcDefghIJKlmNOPQRsTUv",
"check_name": string,
"status": string
}
],
"status": string
}
]
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"request_identity_verification": false,
"request_equifax": false,
"request_base": false,
"request_instant_verify_employment": false,
"request_instant_verify_education": false,
"request_instant_verify_credential": false,
"request_international_criminal_record_check": false,
"request_enhanced_identity_verification": false,
"request_motor_vehicle_records": false,
"request_criminal_record_check": false,
"request_enhanced_criminal_record_check": false,
"request_vulnerable_sector_criminal_record_check": false,
"request_employer_references": false,
"request_address_references": false,
"request_employer_phone_references": false,
"request_address_phone_references": false,
"request_softcheck": true,
"request_social_media_check": false,
"request_soquij": false,
"request_us_criminal_record_check_tier_1": false,
"request_us_criminal_record_check_tier_2": false,
"request_us_criminal_record_check_tier_3": false,
"request_education_verification": false,
"request_credential_verification": false,
"request_employment_verification": false,
"request_vaccination_check": false,
"request_australian_criminal_intelligence_commission_check": false,
"request_volunteer_acic_check": false,
"request_right_to_work": false,
"request_uk_basic_dbs_check": false,
"request_uk_basic_ds_check": false,
"request_uk_right_to_work_check": false,
"last_updated": "2023-09-13T22:14:42.636137Z",
"id": "9779b0fa-e72b-4647-bf19-b721827636f1",
"short_uid": "abcEFgHI",
"report_status": "SENT",
"information": {
"first_name": "Andrew",
"last_name": "McLeod"
},
"applicant_account": {
"id": "abf9fcf4-45cc-40fc-b964-52add35aaab4",
"email": "test@certn.co",
"email_verified": false,
"phone_number": null
},
"application": {
"owner": {
"email": "john.doe@certn.co"
},
"posting": null,
"is_active": true,
"team": {
"internal_name": "Team Name"
}
},
"adjudication_status": "NONE",
"adjudication_status_label": "None",
"report_summary": {
"reference_result": null,
"australian_criminal_intelligence_commission_check_result": null,
"rcmp_result": null,
"equifax_result": null,
"information_result": null,
"instant_verify_result": null,
"international_criminal_record_check_result": null,
"motor_vehicle_record_result": null,
"social_media_check_result": null,
"risk_result": null,
"soquij_result": null,
"uk_basic_dbs_check_result": null,
"uk_basic_ds_check_result": null,
"uk_right_to_work_check_result": null,
"us_criminal_record_check_result": null,
"vaccination_check_result": null,
"right_to_work_result": null,
"certn_verification": null,
"report_result": "NONE",
"report_result_label": "None",
"dispute": false,
"report_status": "SENT",
"report_status_label": "Sent"
},
"can_upgrade": false,
"is_equifax_eligible": false,
"can_resend_email": false,
"resend_email_time": "2023-09-14T22:14:42.586648Z",
"is_viewed": false,
"onboarding_link": "https://demo-app.certn.co/welcome/email?session=12d0449f-6ddd-40e8-91c7-405956692c58&token=1b4894b9-a211-4b4b-b14a-4a1234398e8f&onboardingType=HR&inviteRoute=email&inviteCode=111a1",
"applicant_adjudication": null,
"has_active_automated_reminders": true,
"order_status": "WAITING_ON_CANDIDATE",
"check_executions": [
{
"id": "check_exec_ABcDefghIJKlmNOPQRsTUv",
"check_name": "softcheck",
"status": "WAITING_ON_CANDIDATE"
}
],
"status": "Pending"
}
]
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="404: Not Found Page not found" %}
This may be happening because:
**The page number you provided doesn't exist**
Make sure the page number you entered is a valid integer and within the bounds of your expected results.
*See* [Error codes](/api/api-reference/resources/error-codes#404-not-found) *for more details.*
{% endtab %}
{% endtabs %}
## Retrieve an application
`GET` `https://api.certn.co/api/v1/hr/applicants/{applicant_id}/` [**`DEPRECATED`**](/api/deprecation)
View the details of an application.
Check the `status` field to see if the application is done processing.
You can retrieve the final report when the `report_status` field is marked as `COMPLETE`.
#### Path Parameters
| Name | Type | Description |
| ----------------------------------------------- | ------ | ------------------- |
| applicant\_id\* | string | ID of the applicant |
{% tabs %}
{% tab title="200: OK Report successfully retrieved" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```
{
"id": string ,
"created": string ,
"modified": string ,
"tag": string,
"(request_flags)": boolean
"last_updated": string ,
"submitted_time": string ,
"is_submitted": boolean,
"applicant_type": string ,
"report_status": string ,
"status": string ,
"status_label": string ,
"result": string ,
"result_label": string ,
"certn_score": number,
"certn_score_label": string ,
"applicant_account": {
"id": string,
"email": string
},
"application": {
object (Application)
},
"country": "CA",
"information": {
object (Information)
},
"employment_verification": string ,
"education_verification": string ,
"credential_verification": string ,
"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 ,
"reliability_risk": number,
"reliability_risk_label": string ,
"workplace_misconduct": number,
"workplace_misconduct_label": string
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
{
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-10T18:20:22Z",
"modified": "2021-11-10T18:20:22Z",
"tag": "Sub-Client 123",
"request_base": false,
"request_behavioural": false,
"request_softcheck": true,
"request_us_ssn_verification": false,
"request_equifax": true,
"request_identity_verification": false,
"request_enhanced_identity_verification": false,
"request_criminal_record_check": false,
"request_enhanced_criminal_record_check": false,
"request_us_criminal_record_check_tier_1": false,
"request_us_criminal_record_check_tier_2": false,
"request_us_criminal_record_check_tier_3": false,
"request_international_criminal_record_check": false,
"request_motor_vehicle_records": false,
"request_employment_verification": false,
"request_education_verification": false,
"request_credential_verification": false,
"request_employer_references": false,
"request_address_references": false,
"request_employer_phone_references": false,
"request_address_phone_references": false,
"request_instant_verify_employment": false,
"request_instant_verify_education": false,
"request_instant_verify_credential": false,
"last_updated": "2021-11-10T18:20:22Z",
"submitted_time": "2021-11-10T18:20:22Z",
"is_submitted": true,
"applicant_type": "STANDARD",
"report_status": "IN_PROGRESS",
"status": "Pending",
"status_label": "Pending",
"result": "REVIEW",
"result_label": "Review",
"certn_score": 85,
"certn_score_label": "PASS",
"applicant_account": {
"id": "string",
"email": "string"
},
"application": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-10T18:20:22Z",
"modified": "2021-11-10T18:20:22Z",
"email": "string"
},
"country": "CA",
"information": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-10T18:20:22Z",
"modified": "2021-11-10T18:20:22Z",
"first_name": "Sebastien",
"middle_name": "Jack Pierre",
"last_name": "Normandin",
"last_name_at_birth": "string",
"former_names": "string",
"alias": "string",
"date_of_birth": "2021-11-10",
"phone_number": "250-123-1234",
"sin_ssn": 123123123,
"gender": "M",
"birth_city": "string",
"birth_province_state": "string",
"birth_other_province_state": "string",
"birth_country": "string",
"license_number": "string",
"license_valid": true,
"license_prov_state": "string",
"license_other_country": true,
"license_type": "CA",
"cover_letter": "string",
"addresses": [
{
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2",
"rent_or_own": "R",
"cost": 0,
"start_date": "2021-11-10",
"end_date": "2021-11-10",
"certn_verification": "VERIFIED",
"verification_notes": "string",
"address_reference": {
"email": {
"address": "email@certn.co"
},
"phone_number": {
"phone_type": "NONE",
"number": "+1 250 555 1234",
"country": "string"
},
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
},
"contact": {
"can_contact": true,
"can_contact_after_date": "2021-11-10"
}
}
}
],
"employers": [
{
"company_name": "string",
"position": "string",
"income": 8500,
"pay_period": "PER_HOUR",
"start_date": "2021-11-10",
"end_date": "2021-11-10",
"certn_verification": "VERIFIED",
"verification_notes": "string",
"employer_reference": {
"email": {
"address": "email@certn.co"
},
"phone_number": {
"phone_type": "NONE",
"number": "+1 250 555 1234",
"country": "string"
},
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
},
"contact": {
"can_contact": true,
"can_contact_after_date": "2021-11-10"
}
}
}
],
"educations": [
{
"institution": "string",
"degree": {
"degree": "2021-11-10",
"verified": true
},
"address": {
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2"
},
"start_date": "2021-11-10",
"end_date": "2021-11-10",
"certn_verification": "VERIFIED",
"verification_notes": "string"
}
],
"convictions": [
{
"offense": 2002,
"date_of_sentence": "2000-01-01T00:00:00.000Z",
"court_location": "Toronto, ON, Canada",
"description": "Robbery; Theft over $200"
}
]
},
"employment_verification": "VERIFIED",
"education_verification": "VERIFIED",
"credential_verification": "VERIFIED",
"reference_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"information_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"risk_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"risk_evaluations": [
{
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"overall_score": "PASS",
"risk_information_result": {},
"criminal_results": [
{
"confidence": 0,
"confidence_label": "Likely",
"overall_score": "PASS",
"criminal_identity": {
"criminal_cases": [
{
"case_type": "Criminal",
"number": "123asd",
"file_date": "2000-12-12",
"judgment_date": "2000-12-12",
"summary_description": "The case filings summary description",
"full_description": "string",
"notes": "No additional case notes available",
"court": {
"court": "Seattle Superior Court",
"court_type": "Criminal",
"docket_number": "545fjd",
"filed_date": "2000-12-12",
"served_date": "2000-12-12",
"trial_date": "2000-12-12",
"jurisdiction": "Seattle County"
},
"criminal_charges": [
{
"offense_description": "Breach of peace",
"offense_date": "2000-12-12",
"offense_type": "Felony",
"plea": "Not Guilty",
"hearing_date": "2000-12-12",
"hearing_type": "Open court hearing",
"probation": "No probation given",
"community_service": "No community service given",
"sentence_suspended": "None",
"fines": "No fines given",
"fines_paid_status": "Fines not paid",
"fines_paid_date": "2000-12-12",
"cost": "200",
"restitution": "None",
"transferred_jurisdiction": "Transferred from Seattle",
"transferred_case_number": "690330",
"active_warrant": "No active warrant",
"jail_time": "6 months jail time",
"prison_time": "6 months prison time",
"charge_in_progress": "no charge in progress",
"charge": "Vehicular manslaughter two counts",
"charge_level": "Felony",
"charge_class": "None",
"dispositions": [
{
"offense_description": "Speeding",
"offense_type": "Infraction",
"offense_date": "2000-12-12",
"description": "Description of the disposition offense",
"disposition_date": "2000-12-12",
"statue": "20-1212(B)",
"offense_class": "The offense class description",
"final_plea": "Not Guilty",
"disposition_description": "The description of the dispostion"
}
],
"arrests": [
{
"arrest_date": "2000-12-12",
"booking_number": "42069",
"citation_number": "247365",
"arresting_agency": "KERSHAW COUNTY DETENTION CENTER",
"offense_type": "Misdemeanor",
"offense_description": "A description of the arresting offense",
"counts": "Arrest has 6 counts"
}
],
"sentences": [
{
"sentence_type": "Community Service and Fines",
"duration": "6 months",
"amount": "100",
"amount_paid": "50",
"paid": "Half the fine has been paid",
"qualifier": "The sentence has no qualifier information",
"description": "The sentence description",
"effective_date": "2000-12-12",
"appearance_date": "2000-12-12",
"appearance_finding": "There are no appearance findings to detail about the sentence"
}
],
"additional_informations": [
{
"description": "More case information was found.",
"additional_description": "None",
"event_date": "2000-12-12"
}
]
}
]
}
],
"criminal_alerts": [
{
"parent_category": "FRAUD",
"category": "Burglary",
"stage": "Conviction",
"type": "Citation",
"description": "Convicted of burglary",
"date": "2000-12-12",
"parent_category_label": "Fraud"
}
],
"criminal_sources": [
{
"name": "World News",
"url": "worldnews.com",
"date": "2000-12-12",
"format": "Online Media",
"headline": "Burglary Conviction for Area Man",
"publication_source": "World News Conglomerate",
"publisher": "World News"
}
],
"criminal_addresses": [
{
"start_date": "2000-12-12",
"end_date": "2000-12-12",
"unit": "1a",
"address": "123 fort st.",
"city": "Victoria",
"province_state": "BC",
"country": "Canda",
"postal_code": "V8X2C3"
}
],
"criminal_additional_informations": [
{
"aliases": [
"willy will",
"billy bill"
],
"dates_of_birth": [
"2000-12-12"
],
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
}
}
]
}
}
]
}
]
},
"equifax_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"description": "The financial score is based on self-provided information from the applicant and an analysis of the applicant's information available to Certn. This includes a credit check, Equifax record analysis, as well as other important informational data points",
"total_debt": 100,
"upgradable": false,
"trades": [
{
"credit_grantor": "RBC",
"payment_status": "Up to date",
"date_opened": "2000-12-12",
"account_rating": "High",
"date_reported": "2000-12-12",
"account_type": "Revolving",
"high_credit": 2000,
"balance_amount": 1000,
"last_activity_or_payment": "Paid as up to date",
"r_code": "R-1",
"percent_credit_used": 50,
"account_number": "112ksjd",
"past_due_amount": 0,
"payment_term_amount": 120,
"months_reviewed": 15,
"narratives": [
"Account has been paid in full."
]
}
],
"employers": [
{
"employment": "Subject's Current Employer",
"occupation": "Software",
"employer": "Certn",
"city": "Victoria",
"province": "BC",
"verification": true,
"salary": 1000000
}
],
"addresses": [
{
"address": "123 fort st.",
"civic_number": 123,
"street_name": "fort st.",
"city": "Victoria",
"province": "BC"
}
],
"collections": [
{
"date_of_last_payment": "2000-12-12",
"creditor": "Boys Club",
"amount_owed": 10000,
"amount_paid": 50,
"ledger_number": "123aslld",
"date_paid": "2000-12-12T00:00:00.000Z",
"date_reported": "2000-12-12T00:00:00.000Z",
"assigned_date": "2012-12-12T00:00:00.000Z",
"verification_date": "2000-12-12T00:00:00.000Z",
"account_designation": "Individual",
"first_deliquency": "2000-12-12T00:00:00.000Z",
"agency_entity": "GQC123",
"reason": "Credit not paid on in full",
"description": "Parking ticket"
}
],
"deposit_alerts": [
{
"customer_entity": "RBC",
"date_reported": "2000-12-12T00:00:00.000Z",
"account_type": "Business",
"date_opened": "2000-12-12T00:00:00.000Z",
"date_closed": "2000-12-12T00:00:00.000Z",
"date_written_off": "2000-12-12T00:00:00.000Z",
"amount_written_off": 2000,
"alert_status": "High",
"alert_status_date": "2000-12-12T00:00:00.000Z"
}
],
"bankruptcies": [
{
"account_type": "Individual",
"liability_amount": 2000,
"asset_amount": 20000,
"customer": "CRED COUNSELLING SOC",
"case_number_and_trustee": "12312 CE ASSOCIATES",
"filer": "Subject",
"legal_narrative": "No legal information available",
"date_filed": "2000-12-12T00:00:00.000Z",
"intent_or_disposition": "Discharged"
}
],
"judgments": [
{
"plaintiff": "Fred Rickleson",
"defendant": "Rick Frederickson",
"amount": 1000.21,
"date_filed": "2000-12-12T00:00:00.000Z",
"date_satisfied": "2000-12-12T00:00:00.000Z",
"verification_date": "2000-12-12T00:00:00.000Z",
"court_entity": "RBC",
"garnishee": "RBC",
"description": "Fred sued Rick"
}
],
"legal_items": [
{
"case_number": "1232djdsj",
"verification_date": "2000-12-12T00:00:00.000Z",
"update_source_code": "Tape rptd",
"date_filed": "2000-12-12T00:00:00.000Z",
"court_entity": "Toronto small claims",
"status_code": "Satisfied",
"date_satisfied": "2000-12-12T00:00:00.000Z",
"amount": 10000,
"defendant": "John Smithy",
"plaintiff": "Smith Johny",
"lawyer_name_address": "Johnson LLC 123 fort st Victoria",
"legal_item_description": "It was very bad deal"
}
],
"liens": [
{
"amount": 1000,
"date_filed": "1999-12-12T00:00:00.000Z",
"lien_class": "Class A",
"date_released": "1990-12-12T00:00:00.000Z",
"date_verified": "1990-12-12T00:00:00.000Z",
"court_entity": "Superior Court.",
"case_number": "123asda",
"lien_description": "Lien on house."
}
],
"secured_loans": [
{
"date_filed": "1990-12-12T00:00:00.000Z",
"court_entity": "Superior",
"creditor_name_address": "RBC 123 Main st.",
"creditor_industry_code": "620a",
"maturity_date": "1990-12-12T00:00:00.000Z"
}
],
"fraud_warnings": [
{
"product_description": "Fraud warnings are warnings of fraud.",
"message_priority": "Very high",
"message_code": "123a",
"message_description": "High fraud alert for bank fraud"
}
],
"non_sufficient_funds": [
{
"date_reported": "1990-12-12T00:00:00.000Z",
"creditor_entity": "RBC",
"nsfamount": 1000.2,
"details": "No sufficient funds in savings account.",
"verification_date": "1990-12-12T00:00:00.000Z"
}
],
"credit_file_metadatas": [
{
"hit_strength_indicator": "HIT",
"request_number": "123asd",
"address_discrepancy": "No discrepancy found in address",
"customer_number": "123asd",
"report_id": "123asd",
"file_since_date": "1990-12-12T00:00:00.000Z",
"date_of_last_activity": "1990-12-12T00:00:00.000Z",
"date_of_request": "1990-12-12T00:00:00.000Z",
"hit": "Big Hit",
"data_warning_messages": [
"No data warning messages"
],
"card_alert_warning_messages": [
"Credit card on high alert"
],
"alert_indicators": [
"No messages"
]
}
],
"other_incomes": [
{
"date_reported": "1990-12-12T00:00:00.000Z",
"income_source": "RBC",
"amount": 1000000,
"verification_date": "1990-12-12T00:00:00.000Z"
}
],
"consumer_statements": [
{
"date_reported": "1990-12-12T00:00:00.000Z",
"statement": "No consumer statement available."
}
],
"bank_accounts": [
{
"account": "Personal checking",
"date_reported": "1990-12-12T00:00:00.000Z",
"creditor_entity": "RBC",
"account_number": "123asd",
"figure_amount": 1000.12,
"date_opened": "1990-12-12T00:00:00.000Z",
"account_type": "Checking",
"status": "active",
"number_of_nsf": 0
}
],
"local_inquiries": [
{
"inquiry_date": "1990-12-12T00:00:00.000Z",
"customer_name": "Certn"
}
],
"foreign_inquiries": [
{
"inquiry_date": "1990-12-12T00:00:00.000Z",
"city_name_or_inquiry_number": "Seattle",
"inquiry_province": "WA"
}
]
},
"identity_verified": true,
"employment_verified": true,
"identity_verification": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-10T18:20:22Z",
"modified": "2021-11-10T18:20:22Z",
"status": "A",
"result": "VERIFIED"
},
"enhanced_identity_verification": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-10T18:20:22Z",
"modified": "2021-11-10T18:20:22Z",
"status": "A",
"result": "VERIFIED"
},
"manual_id_verification": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-10T18:20:22Z",
"modified": "2021-11-10T18:20:22Z",
"status": "A",
"result": "VERIFIED"
},
"rcmp_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"us_criminal_record_check_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"criminal_cases": [
{
"case_type": "Criminal",
"number": "123asd",
"file_date": "2000-12-12",
"judgment_date": "2000-12-12",
"summary_description": "The case filings summary description",
"full_description": "string",
"notes": "No additional case notes available",
"court": {
"court": "Seattle Superior Court",
"court_type": "Criminal",
"docket_number": "545fjd",
"filed_date": "2000-12-12",
"served_date": "2000-12-12",
"trial_date": "2000-12-12",
"jurisdiction": "Seattle County"
},
"criminal_charges": [
{
"offense_description": "Breach of peace",
"offense_date": "2000-12-12",
"offense_type": "Felony",
"plea": "Not Guilty",
"hearing_date": "2000-12-12",
"hearing_type": "Open court hearing",
"probation": "No probation given",
"community_service": "No community service given",
"sentence_suspended": "None",
"fines": "No fines given",
"fines_paid_status": "Fines not paid",
"fines_paid_date": "2000-12-12",
"cost": "200",
"restitution": "None",
"transferred_jurisdiction": "Transferred from Seattle",
"transferred_case_number": "690330",
"active_warrant": "No active warrant",
"jail_time": "6 months jail time",
"prison_time": "6 months prison time",
"charge_in_progress": "no charge in progress",
"charge": "Vehicular manslaughter two counts",
"charge_level": "Felony",
"charge_class": "None",
"dispositions": [
{
"offense_description": "Speeding",
"offense_type": "Infraction",
"offense_date": "2000-12-12",
"description": "Description of the disposition offense",
"disposition_date": "2000-12-12",
"statue": "20-1212(B)",
"offense_class": "The offense class description",
"final_plea": "Not Guilty",
"disposition_description": "The description of the dispostion"
}
],
"arrests": [
{
"arrest_date": "2000-12-12",
"booking_number": "42069",
"citation_number": "247365",
"arresting_agency": "KERSHAW COUNTY DETENTION CENTER",
"offense_type": "Misdemeanor",
"offense_description": "A description of the arresting offense",
"counts": "Arrest has 6 counts"
}
],
"sentences": [
{
"sentence_type": "Community Service and Fines",
"duration": "6 months",
"amount": "100",
"amount_paid": "50",
"paid": "Half the fine has been paid",
"qualifier": "The sentence has no qualifier information",
"description": "The sentence description",
"effective_date": "2000-12-12",
"appearance_date": "2000-12-12",
"appearance_finding": "There are no appearance findings to detail about the sentence"
}
],
"additional_informations": [
{
"description": "More case information was found.",
"additional_description": "None",
"event_date": "2000-12-12"
}
]
}
]
}
],
"ssn_id_document_reports": [
{
"ssn_result": "Discrepancy",
"ssn_status": "Complete",
"names": [
{
"first_name": "string",
"middle_name": "string",
"last_name": "string"
}
],
"addresses": [
{
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2"
}
],
"id_documents": [
{
"type": "Passport",
"number": "123412kdsdsk",
"issuing_country": "US",
"issuing_province_state": "WA",
"issue_date": "2000-12-12",
"expiry_date": "2000-12-12"
}
],
"dates_of_birth": [
{
"date_of_birth": "2000-12-12"
}
]
}
],
"scan_status": {
"national_sex_offender_registry_scan": "Complete",
"security_watch_list_scan": "Complete",
"fraud_scan": "Complete",
"ofac_global_sanctions_scan": "Complete",
"ssn_verification_scan": "Complete",
"criminal_record_scan": "Complete",
"federal_record_scan": "Incomplete",
"single_state_county_record_scan": "Incomplete",
"all_state_county_record_scan": "Incomplete"
},
"record_check_requests": [
{
"status": "Complete",
"state": "OH",
"county": "Kershaw",
"district": "District 1",
"fips_code": 12312,
"search_type": "Criminal/Court Database Search"
}
]
},
"verification_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"employment_verification": "VERIFIED",
"education_verification": "VERIFIED",
"credential_verification": "VERIFIED",
"certn_verification": "VERIFIED",
"employer_verification_results": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"certn_verification": "VERIFIED",
"company_name_verified": false,
"position_name_verified": false,
"income_verified": false,
"employment_dates_verified": true,
"verification_notes": "Verification notes!",
"employer": {
"company_name": "string",
"position": "string",
"income": 8500,
"pay_period": "PER_HOUR",
"start_date": "2021-11-10",
"end_date": "2021-11-10",
"certn_verification": "VERIFIED",
"verification_notes": "string",
"employer_reference": {
"email": {
"address": "email@certn.co"
},
"phone_number": {
"phone_type": "NONE",
"number": "+1 250 555 1234",
"country": "string"
},
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
},
"contact": {
"can_contact": true,
"can_contact_after_date": "2021-11-10"
}
}
}
},
"education_verification_results": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"certn_verification": "VERIFIED",
"specializations_verified": false,
"degree_verified": false,
"institution_verified": false,
"enrolment_dates_verified": true,
"verification_notes": "Verification notes!",
"education": {
"institution": "string",
"degree": {
"degree": "2021-11-10",
"verified": true
},
"address": {
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2"
},
"start_date": "2021-11-10",
"end_date": "2021-11-10",
"certn_verification": "VERIFIED",
"verification_notes": "string"
}
},
"credential_verification_results": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"certn_verification": "VERIFIED",
"certification_date_verified": false,
"certification_verified": false,
"institution_verified": true,
"verification_notes": "Verification notes!",
"credential": {
"description": "string",
"institution": "string",
"certification": "string",
"date_of_certification": "2021-11-10",
"current": true,
"certn_verification": "VERIFIED",
"verification_notes": "string"
}
}
},
"international_criminal_record_check_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"motor_vehicle_record_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"salary": 0,
"sufficient_salary": true,
"high_risk_vulnerable_sector": true,
"job_safety_undue_risk": true,
"early_termination": 0,
"early_termination_label": "High",
"reliability_risk": 0,
"reliability_risk_label": "High",
"workplace_misconduct": 0,
"workplace_misconduct_label": "High"
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="404: Not Found Application not found" %}
This may be happening because:
**The ID you provided couldn't be found**
Add your [application ID](/api/start/demo-account/retrieve-results#send-the-request) to the URL and make sure it's in the proper format.
*See* [Error codes](/api/api-reference/resources/error-codes#404-not-found) *for more details.*
{% endtab %}
{% endtabs %}
## 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.
## Download a PDF report
`GET` `https://api.certn.co/api/v1/hr/reports/{applicant_id}/pdf/` [**`DEPRECATED`**](/api/deprecation)
Download an application's report as a PDF file.
To download the report, wait for the application's `status` field to show `Returned`.
#### Path Parameters
| Name | Type | Description |
| ----------------------------------------------- | ------ | ------------------- |
| applicant\_id\* | string | ID of the applicant |
{% tabs %}
{% tab title="200: OK Report as a PDF file" %}
{% tabs %}
{% tab title="Response Type" %}
{% code title="application/pdf" %}
```
string
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="400: Bad Request Incomplete application" %}
This may be happening because:
**The application is still processing**
Wait for the application's `status` field to show `Returned` before generating the final report.
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="404: Not Found Application not found" %}
This may be happening because:
**The ID you provided couldn't be found**
Add your [application ID](/api/start/demo-account/retrieve-results#send-the-request) to the URL and make sure it's in the proper format.
*See* [Error codes](/api/api-reference/resources/error-codes#404-not-found) *for more details.*
{% endtab %}
{% endtabs %}
## Create a hosted PDF report
`GET` `https://api.certn.co/api/v1/hr/reports/{applicant_id}/link/` [**`DEPRECATED`**](/api/deprecation)
Create a PDF report hosted on Certn's servers. The URL returned can be used to view the report without downloading it. *This link is valid for 1 hour only.*
To create the hosted PDF report, wait for the application's `status` field to show `Returned`.
#### Path Parameters
| Name | Type | Description |
| ----------------------------------------------- | ------ | ------------------- |
| applicant\_id\* | string | ID of the applicant |
{% tabs %}
{% tab title="200: OK URL to view the report" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
{
"report_url": string
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```
{
"report_url": "https://s3.ca-central-1.amazonaws.com/certn-reports/hr_806066d2-f9e7-4d54-844e-bcc225a8ef6d_1575603960.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAI322I2RK3VQJ4O3Q%2F20191206%2Fca-central-1%2Fs3%2Faws4_request&X-Amz-Date=20191206T034608Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=0032b9ff42a2fe1135d28079f67b70338f5abc373b4b0a72707e3109eac8815d"
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="400: Bad Request Incomplete application" %}
This may be happening because:
**The application is still processing**
Wait for the application's `status` field to show `Returned` before generating the final report.
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="404: Not Found Application not found" %}
This may be happening because:
**The ID you provided couldn't be found**
Add your [application ID](/api/start/demo-account/retrieve-results#send-the-request) to the URL and make sure it's in the proper format.
*See* [Error codes](/api/api-reference/resources/error-codes#404-not-found) *for more details.*
{% endtab %}
{% endtabs %}
## Download an HTML report
`GET` `https://api-certn.co/api/v1/hr/reports/{applicant_id}/web/` [**`DEPRECATED`**](/api/deprecation)
Download an application's report as an HTML file.
To download the report, wait for the application's `status` field to show `Returned`.
#### Path Parameters
| Name | Type | Description |
| ----------------------------------------------- | ------ | ------------------- |
| applicant\_id\* | string | ID of the applicant |
{% tabs %}
{% tab title="200: OK Report as an HTML file" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
{
"html": string
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
{
"html": "\\n\\n\\nCertn ReportHR"
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="400: Bad Request Incomplete application" %}
This may be happening because:
**The application is still processing**
Wait for the application's `status` field to show `Returned` before generating the final report.
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="404: Not Found Application not found" %}
This may be happening because:
**The ID you provided couldn't be found**
Add your [application ID](/api/start/demo-account/retrieve-results#send-the-request) to the URL and make sure it's in the proper format.
*See* [Error codes](/api/api-reference/resources/error-codes#404-not-found) *for more details.*
{% endtab %}
{% endtabs %}
# Available checks
You can run checks on candidates for employment in these regions:
## Australia
{% content-ref url="/pages/q2o9DidI5WrTaKYw7prM" %}
[Social Media Check](/api/guides/checks/social-media-check)
{% endcontent-ref %}
{% content-ref url="/pages/mG7q9lFzNqRGj7sycP2W" %}
[Australia Right To Work Check](/api/guides/checks/australia-right-to-work-check)
{% endcontent-ref %}
## Canada
{% content-ref url="/pages/-MbrlU9COwpTylPjhBNA" %}
[Softcheck](/api/guides/checks/softcheck)
{% endcontent-ref %}
{% content-ref url="/pages/q2o9DidI5WrTaKYw7prM" %}
[Social Media Check](/api/guides/checks/social-media-check)
{% endcontent-ref %}
{% content-ref url="/pages/-Mhu7i3qlJG7I92zFoQH" %}
[Credit Check](/api/guides/checks/credit-check)
{% endcontent-ref %}
{% content-ref url="/pages/-Mi88TmkehPnss5fTP3M" %}
[Enhanced Identity Verification](/api/guides/checks/enhanced-identity-verification)
{% endcontent-ref %}
{% content-ref url="/pages/-Mi8EDAjjmirZKJqut0r" %}
[Canadian Criminal Record Check](/api/guides/checks/canadian-criminal-record-check)
{% endcontent-ref %}
{% content-ref url="/pages/-MiMb5j1QlkmkQIIomYJ" %}
[US Criminal Record Check](/api/guides/checks/us-criminal-record-check)
{% endcontent-ref %}
{% content-ref url="/pages/-MiMb6nZb56Vb2GWZNHg" %}
[International Criminal Record Check](/api/guides/checks/international-criminal-record-check)
{% endcontent-ref %}
{% content-ref url="/pages/-MiMb7jcob6QTeVLjboG" %}
[Education Verification](/api/guides/checks/education-verification)
{% endcontent-ref %}
{% content-ref url="/pages/tInoFFN7iXwDFTufuFo7" %}
[Credential Verification](/api/guides/checks/credential-verification)
{% endcontent-ref %}
{% content-ref url="/pages/-MiMb8S9M3VgbvPqifPs" %}
[Employment Verification](/api/guides/checks/employment-verification)
{% endcontent-ref %}
{% content-ref url="/pages/-MiMb8S9M3VgbvPqifPs" %}
[Employment Verification](/api/guides/checks/employment-verification)
{% endcontent-ref %}
{% content-ref url="/pages/-MiMtlGLdJoGEQw3DaYx" %}
[Motor Vehicle Record Check / Driver's Abstract](/api/guides/checks/motor-vehicle-record-check)
{% endcontent-ref %}
{% content-ref url="/pages/-MiMtmBEPdviGbOP\_p5N" %}
[Employment Reference Check](/api/guides/checks/employer-reference-check)
{% endcontent-ref %}
## UK
{% content-ref url="/pages/TKfVNlP2XzXwMhjy2v5h" %}
[UK Right To Work Check](/api/guides/checks/uk-right-to-work-check)
{% endcontent-ref %}
{% content-ref url="/pages/LULDjv0brH5O7p0w1glN" %}
[Basic Disclosure Scotland Check](/api/guides/checks/basic-disclosure-scotland-check)
{% endcontent-ref %}
{% content-ref url="/pages/CMXmGcSHvJMKFZXmR2yo" %}
[Basic Disclosure And Barring Service Check](/api/guides/checks/basic-disclosure-and-barring-service-check)
{% endcontent-ref %}
## US
{% content-ref url="/pages/q2o9DidI5WrTaKYw7prM" %}
[Social Media Check](/api/guides/checks/social-media-check)
{% endcontent-ref %}
{% content-ref url="/pages/-Mhu7i3qlJG7I92zFoQH" %}
[Credit Check](/api/guides/checks/credit-check)
{% endcontent-ref %}
{% content-ref url="/pages/-Mi88TmkehPnss5fTP3M" %}
[Enhanced Identity Verification](/api/guides/checks/enhanced-identity-verification)
{% endcontent-ref %}
{% content-ref url="/pages/-Mi8EDAjjmirZKJqut0r" %}
[Canadian Criminal Record Check](/api/guides/checks/canadian-criminal-record-check)
{% endcontent-ref %}
{% content-ref url="/pages/-MiMb5j1QlkmkQIIomYJ" %}
[US Criminal Record Check](/api/guides/checks/us-criminal-record-check)
{% endcontent-ref %}
{% content-ref url="/pages/-MiMb6nZb56Vb2GWZNHg" %}
[International Criminal Record Check](/api/guides/checks/international-criminal-record-check)
{% endcontent-ref %}
{% content-ref url="/pages/-MiMb7jcob6QTeVLjboG" %}
[Education Verification](/api/guides/checks/education-verification)
{% endcontent-ref %}
{% content-ref url="/pages/tInoFFN7iXwDFTufuFo7" %}
[Credential Verification](/api/guides/checks/credential-verification)
{% endcontent-ref %}
{% content-ref url="/pages/-MiMb8S9M3VgbvPqifPs" %}
[Employment Verification](/api/guides/checks/employment-verification)
{% endcontent-ref %}
{% content-ref url="/pages/-MiMtlGLdJoGEQw3DaYx" %}
[Motor Vehicle Record Check / Driver's Abstract](/api/guides/checks/motor-vehicle-record-check)
{% endcontent-ref %}
{% content-ref url="/pages/-MiMtmBEPdviGbOP\_p5N" %}
[Employment Reference Check](/api/guides/checks/employer-reference-check)
{% endcontent-ref %}
# Property Management
How to make requests and generate reports as a property management client in the Certn API.
{% hint style="info" %}
#### Demo Environment
When sending test data to the following endpoints, change the domain to `https://demo-api.certn.co`.
{% endhint %}
To view a list of all application parameters, visit [Application parameters](/api/api-reference/resources/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/pm/applications/invite/` [**`DEPRECATED`**](/api/deprecation)
Invite an applicant to complete a screen.
Provide information in the body of the request to pre-fill the application forms.
To invite multiple applicants at once use the `grouped_applicants` parameter. Add each applicant as an object within the array, and provide an `email` (required) and a [`phone_number`](/api/api-reference/resources/application-parameters#phonenumber) (optional).
**Example**
{
"request\_softcheck": true,
"email": "",
"owner\_id" : "bd78a737-16cf-496a-9c3a-7b9e5533cfce"
}
#### Request Body
| Name | Type | Description |
| ------------------------------------------------- | -------------- | ----------------------------------------------------------------------------------------- |
| email\* | string | Applicant's email address |
| tag | string | Group related applications by tag |
| phone\_number | object | [Application parameters](/api/api-reference/resources/application-parameters#phonenumber) |
| information | object | [Application parameters](/api/api-reference/resources/application-parameters#information) |
| {request\_flag}\* | boolean | [Request flags](/api/api-reference/resources/application-parameters/request-flags) |
| owner\_id\* | string \ | ID of user ordering the application |
{% tabs %}
{% tab title="201: Created PM application successfully created" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
{
"id": string ,
"created": string ,
"modified": string ,
"applicants": [
{
"id": string ,
"status": string ,
"first_name": string,
"last_name": string,
"email": string,
"phone_number": {
"phone_type": string ,
"number": string",
"country": string
}
}
]
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
{
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-12T21:21:50Z",
"modified": "2021-11-12T21:21:50Z",
"applicants": [
{
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "Pending",
"first_name": "string",
"last_name": "string",
"email": "string",
"phone_number": {
"phone_type": "NONE",
"number": "+1 250 555 1234",
"country": "CA"
}
}
]
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="400: Bad Request Missing field, wrong data type, account not configured" %}
This may be happening because:
**You are missing required fields**
Add all the required fields to the body of your request.
**You used the wrong format or data type for a field**
Format all your fields according to their [data type](https://www.w3schools.com/js/js_json_datatypes.asp).
**Your account isn't configured to run this check**
[Contact our support team](/api/contact#api) to have your account configured for this check.
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="500: Internal Server Error Wrong data type" %}
This may be happening because:
**You used the wrong format or data type for a field**
Format all your fields according to their [data type](https://www.w3schools.com/js/js_json_datatypes.asp). Most fields in our API take strings, while request flags take booleans.
*See* [Error codes](/api/api-reference/resources/error-codes#500-internal-server-error) *for more details.*
{% endtab %}
{% endtabs %}
## Screen an applicant instantly
`POST` `https://api.certn.co/api/v1/pm/applications/quick/` [**`DEPRECATED`**](/api/deprecation)
Screen an applicant using only the information in the body of your request.
[Get the applicant's consent](/api/guides/use-the-api/consent) *before* running the screen.
#### Request Body
| Name | Type | Description |
| ------------------------------------------------------------------ | -------------- | ------------------------------------------------------------------------------------------------------------ |
| tag | string | Group related applications by tag |
| email | string | Applicant's email address |
| information\* | object | [Application parameters](/api/api-reference/resources/application-parameters#information) |
| {request\_flag}\* | boolean | [Request flags](/api/api-reference/resources/application-parameters/request-flags) |
| position\_or\_property\_location\* | object | [Application parameters](/api/api-reference/resources/application-parameters#position-or-property-location) |
| owner\_id\* | string \ | ID of user ordering the application |
| enhanced\_identity\_verification | object | [Application parameters](/api/api-reference/resources/application-parameters#enhanced-identity-verification) |
{% tabs %}
{% tab title="201: Created PM application successfully created" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
{
"id": string ,
"created": string ,
"modified": string ,
"tag": string,
"(request_flags)": boolean
"last_updated": string ,
"submitted_time": string ,
"is_submitted": boolean,
"applicant_type": string ,
"report_status": string ,
"status": string ,
"status_label": string ,
"result": string ,
"result_label": string ,
"certn_score": number,
"certn_score_label": string ,
"applicant_account": {
"id": string,
"email": string
},
"application": {
object (Application)
},
"country": "CA",
"information": {
object (Information)
},
"employment_verification": string ,
"education_verification": string ,
"credential_verification": string ,
"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 ,
"reliability_risk": number,
"reliability_risk_label": string ,
"workplace_misconduct": number,
"workplace_misconduct_label": string
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
{
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-12T21:21:50Z",
"modified": "2021-11-12T21:21:50Z",
"tag": "Sub-Client 123",
"request_base": false,
"request_behavioural": false,
"request_softcheck": true,
"request_us_ssn_verification": false,
"request_equifax": true,
"request_identity_verification": false,
"request_enhanced_identity_verification": false,
"request_criminal_record_check": false,
"request_enhanced_criminal_record_check": false,
"request_us_criminal_record_check_tier_1": false,
"request_us_criminal_record_check_tier_2": false,
"request_us_criminal_record_check_tier_3": false,
"request_international_criminal_record_check": false,
"request_motor_vehicle_records": false,
"request_employment_verification": false,
"request_education_verification": false,
"request_credential_verification": false,
"request_employer_references": false,
"request_address_references": false,
"request_employer_phone_references": false,
"request_address_phone_references": false,
"request_instant_verify_employment": false,
"request_instant_verify_education": false,
"request_instant_verify_credential": false,
"last_updated": "2021-11-12T21:21:50Z",
"submitted_time": "2021-11-12T21:21:50Z",
"is_submitted": true,
"applicant_type": "STANDARD",
"report_status": "IN_PROGRESS",
"status": "Pending",
"status_label": "Pending",
"result": "REVIEW",
"result_label": "Review",
"certn_score": 85,
"certn_score_label": "PASS",
"applicant_account": {
"id": "string",
"email": "string"
},
"application": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-12T21:21:50Z",
"modified": "2021-11-12T21:21:50Z",
"email": "string"
},
"country": "CA",
"information": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-12T21:21:50Z",
"modified": "2021-11-12T21:21:50Z",
"first_name": "Sebastien",
"middle_name": "Jack Pierre",
"last_name": "Normandin",
"last_name_at_birth": "string",
"former_names": "string",
"alias": "string",
"date_of_birth": "2021-11-12",
"phone_number": "250-123-1234",
"sin_ssn": 123123123,
"gender": "M",
"birth_city": "string",
"birth_province_state": "string",
"birth_other_province_state": "string",
"birth_country": "string",
"license_number": "string",
"license_valid": true,
"license_prov_state": "string",
"license_other_country": true,
"license_type": "CA",
"cover_letter": "string",
"addresses": [{
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2",
"rent_or_own": "R",
"cost": 0,
"start_date": "2021-11-12",
"end_date": "2021-11-12",
"certn_verification": "VERIFIED",
"verification_notes": "string",
"address_reference": {
"email": {
"address": "email@certn.co"
},
"phone_number": {
"phone_type": "NONE",
"number": "+1 250 555 1234",
"country": "string"
},
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
},
"contact": {
"can_contact": true,
"can_contact_after_date": "2021-11-12"
}
}
}
],
"employers": [{
"company_name": "string",
"position": "string",
"income": 8500,
"pay_period": "PER_HOUR",
"start_date": "2021-11-12",
"end_date": "2021-11-12",
"certn_verification": "VERIFIED",
"verification_notes": "string",
"employer_reference": {
"email": {
"address": "email@certn.co"
},
"phone_number": {
"phone_type": "NONE",
"number": "+1 250 555 1234",
"country": "string"
},
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
},
"contact": {
"can_contact": true,
"can_contact_after_date": "2021-11-12"
}
}
}
],
"educations": [{
"institution": "string",
"degree": {
"degree": "2021-11-12",
"verified": true
},
"address": {
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2"
},
"start_date": "2021-11-12",
"end_date": "2021-11-12",
"certn_verification": "VERIFIED",
"verification_notes": "string"
}
],
"convictions": [{
"offense": 2002,
"date_of_sentence": "2000-01-01T00:00:00.000Z",
"court_location": "Toronto, ON, Canada",
"description": "Robbery; Theft over $200"
}
]
},
"employment_verification": "VERIFIED",
"education_verification": "VERIFIED",
"credential_verification": "VERIFIED",
"reference_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"information_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"risk_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"risk_evaluations": [{
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"overall_score": "PASS",
"risk_information_result": {},
"criminal_results": [{
"confidence": 0,
"confidence_label": "Likely",
"overall_score": "PASS",
"criminal_identity": {
"criminal_cases": [{
"case_type": "Criminal",
"number": "123asd",
"file_date": "2000-12-12",
"judgment_date": "2000-12-12",
"summary_description": "The case filings summary description",
"full_description": "string",
"notes": "No additional case notes available",
"court": {
"court": "Seattle Superior Court",
"court_type": "Criminal",
"docket_number": "545fjd",
"filed_date": "2000-12-12",
"served_date": "2000-12-12",
"trial_date": "2000-12-12",
"jurisdiction": "Seattle County"
},
"criminal_charges": [{
"offense_description": "Breach of peace",
"offense_date": "2000-12-12",
"offense_type": "Felony",
"plea": "Not Guilty",
"hearing_date": "2000-12-12",
"hearing_type": "Open court hearing",
"probation": "No probation given",
"community_service": "No community service given",
"sentence_suspended": "None",
"fines": "No fines given",
"fines_paid_status": "Fines not paid",
"fines_paid_date": "2000-12-12",
"cost": "200",
"restitution": "None",
"transferred_jurisdiction": "Transferred from Seattle",
"transferred_case_number": "690330",
"active_warrant": "No active warrant",
"jail_time": "6 months jail time",
"prison_time": "6 months prison time",
"charge_in_progress": "no charge in progress",
"charge": "Vehicular manslaughter two counts",
"charge_level": "Felony",
"charge_class": "None",
"dispositions": [{
"offense_description": "Speeding",
"offense_type": "Infraction",
"offense_date": "2000-12-12",
"description": "Description of the disposition offense",
"disposition_date": "2000-12-12",
"statue": "20-1212(B)",
"offense_class": "The offense class description",
"final_plea": "Not Guilty",
"disposition_description": "The description of the dispostion"
}
],
"arrests": [{
"arrest_date": "2000-12-12",
"booking_number": "42069",
"citation_number": "247365",
"arresting_agency": "KERSHAW COUNTY DETENTION CENTER",
"offense_type": "Misdemeanor",
"offense_description": "A description of the arresting offense",
"counts": "Arrest has 6 counts"
}
],
"sentences": [{
"sentence_type": "Community Service and Fines",
"duration": "6 months",
"amount": "100",
"amount_paid": "50",
"paid": "Half the fine has been paid",
"qualifier": "The sentence has no qualifier information",
"description": "The sentence description",
"effective_date": "2000-12-12",
"appearance_date": "2000-12-12",
"appearance_finding": "There are no appearance findings to detail about the sentence"
}
],
"additional_informations": [{
"description": "More case information was found.",
"additional_description": "None",
"event_date": "2000-12-12"
}
]
}
]
}
],
"criminal_alerts": [{
"parent_category": "FRAUD",
"category": "Burglary",
"stage": "Conviction",
"type": "Citation",
"description": "Convicted of burglary",
"date": "2000-12-12",
"parent_category_label": "Fraud"
}
],
"criminal_sources": [{
"name": "World News",
"url": "worldnews.com",
"date": "2000-12-12",
"format": "Online Media",
"headline": "Burglary Conviction for Area Man",
"publication_source": "World News Conglomerate",
"publisher": "World News"
}
],
"criminal_addresses": [{
"start_date": "2000-12-12",
"end_date": "2000-12-12",
"unit": "1a",
"address": "123 fort st.",
"city": "Victoria",
"province_state": "BC",
"country": "Canda",
"postal_code": "V8X2C3"
}
],
"criminal_additional_informations": [{
"aliases": [
"willy will",
"billy bill"
],
"dates_of_birth": [
"2000-12-12"
],
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
}
}
]
}
}
]
}
]
},
"equifax_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"description": "The financial score is based on self-provided information from the applicant and an analysis of the applicant's information available to Certn. This includes a credit check, Equifax record analysis, as well as other important informational data points",
"total_debt": 100,
"upgradable": false,
"trades": [{
"credit_grantor": "RBC",
"payment_status": "Up to date",
"date_opened": "2000-12-12",
"account_rating": "High",
"date_reported": "2000-12-12",
"account_type": "Revolving",
"high_credit": 2000,
"balance_amount": 1000,
"last_activity_or_payment": "Paid as up to date",
"r_code": "R-1",
"percent_credit_used": 50,
"account_number": "112ksjd",
"past_due_amount": 0,
"payment_term_amount": 120,
"months_reviewed": 15,
"narratives": [
"Account has been paid in full."
]
}
],
"employers": [{
"employment": "Subject's Current Employer",
"occupation": "Software",
"employer": "Certn",
"city": "Victoria",
"province": "BC",
"verification": true,
"salary": 1000000
}
],
"addresses": [{
"address": "123 fort st.",
"civic_number": 123,
"street_name": "fort st.",
"city": "Victoria",
"province": "BC"
}
],
"collections": [{
"date_of_last_payment": "2000-12-12",
"creditor": "Boys Club",
"amount_owed": 10000,
"amount_paid": 50,
"ledger_number": "123aslld",
"date_paid": "2000-12-12T00:00:00.000Z",
"date_reported": "2000-12-12T00:00:00.000Z",
"assigned_date": "2012-12-12T00:00:00.000Z",
"verification_date": "2000-12-12T00:00:00.000Z",
"account_designation": "Individual",
"first_deliquency": "2000-12-12T00:00:00.000Z",
"agency_entity": "GQC123",
"reason": "Credit not paid on in full",
"description": "Parking ticket"
}
],
"deposit_alerts": [{
"customer_entity": "RBC",
"date_reported": "2000-12-12T00:00:00.000Z",
"account_type": "Business",
"date_opened": "2000-12-12T00:00:00.000Z",
"date_closed": "2000-12-12T00:00:00.000Z",
"date_written_off": "2000-12-12T00:00:00.000Z",
"amount_written_off": 2000,
"alert_status": "High",
"alert_status_date": "2000-12-12T00:00:00.000Z"
}
],
"bankruptcies": [{
"account_type": "Individual",
"liability_amount": 2000,
"asset_amount": 20000,
"customer": "CRED COUNSELLING SOC",
"case_number_and_trustee": "12312 CE ASSOCIATES",
"filer": "Subject",
"legal_narrative": "No legal information available",
"date_filed": "2000-12-12T00:00:00.000Z",
"intent_or_disposition": "Discharged"
}
],
"judgments": [{
"plaintiff": "Fred Rickleson",
"defendant": "Rick Frederickson",
"amount": 1000.21,
"date_filed": "2000-12-12T00:00:00.000Z",
"date_satisfied": "2000-12-12T00:00:00.000Z",
"verification_date": "2000-12-12T00:00:00.000Z",
"court_entity": "RBC",
"garnishee": "RBC",
"description": "Fred sued Rick"
}
],
"legal_items": [{
"case_number": "1232djdsj",
"verification_date": "2000-12-12T00:00:00.000Z",
"update_source_code": "Tape rptd",
"date_filed": "2000-12-12T00:00:00.000Z",
"court_entity": "Toronto small claims",
"status_code": "Satisfied",
"date_satisfied": "2000-12-12T00:00:00.000Z",
"amount": 10000,
"defendant": "John Smithy",
"plaintiff": "Smith Johny",
"lawyer_name_address": "Johnson LLC 123 fort st Victoria",
"legal_item_description": "It was very bad deal"
}
],
"liens": [{
"amount": 1000,
"date_filed": "1999-12-12T00:00:00.000Z",
"lien_class": "Class A",
"date_released": "1990-12-12T00:00:00.000Z",
"date_verified": "1990-12-12T00:00:00.000Z",
"court_entity": "Superior Court.",
"case_number": "123asda",
"lien_description": "Lien on house."
}
],
"secured_loans": [{
"date_filed": "1990-12-12T00:00:00.000Z",
"court_entity": "Superior",
"creditor_name_address": "RBC 123 Main st.",
"creditor_industry_code": "620a",
"maturity_date": "1990-12-12T00:00:00.000Z"
}
],
"fraud_warnings": [{
"product_description": "Fraud warnings are warnings of fraud.",
"message_priority": "Very high",
"message_code": "123a",
"message_description": "High fraud alert for bank fraud"
}
],
"non_sufficient_funds": [{
"date_reported": "1990-12-12T00:00:00.000Z",
"creditor_entity": "RBC",
"nsfamount": 1000.2,
"details": "No sufficient funds in savings account.",
"verification_date": "1990-12-12T00:00:00.000Z"
}
],
"credit_file_metadatas": [{
"hit_strength_indicator": "HIT",
"request_number": "123asd",
"address_discrepancy": "No discrepancy found in address",
"customer_number": "123asd",
"report_id": "123asd",
"file_since_date": "1990-12-12T00:00:00.000Z",
"date_of_last_activity": "1990-12-12T00:00:00.000Z",
"date_of_request": "1990-12-12T00:00:00.000Z",
"hit": "Big Hit",
"data_warning_messages": [
"No data warning messages"
],
"card_alert_warning_messages": [
"Credit card on high alert"
],
"alert_indicators": [
"No messages"
]
}
],
"other_incomes": [{
"date_reported": "1990-12-12T00:00:00.000Z",
"income_source": "RBC",
"amount": 1000000,
"verification_date": "1990-12-12T00:00:00.000Z"
}
],
"consumer_statements": [{
"date_reported": "1990-12-12T00:00:00.000Z",
"statement": "No consumer statement available."
}
],
"bank_accounts": [{
"account": "Personal checking",
"date_reported": "1990-12-12T00:00:00.000Z",
"creditor_entity": "RBC",
"account_number": "123asd",
"figure_amount": 1000.12,
"date_opened": "1990-12-12T00:00:00.000Z",
"account_type": "Checking",
"status": "active",
"number_of_nsf": 0
}
],
"local_inquiries": [{
"inquiry_date": "1990-12-12T00:00:00.000Z",
"customer_name": "Certn"
}
],
"foreign_inquiries": [{
"inquiry_date": "1990-12-12T00:00:00.000Z",
"city_name_or_inquiry_number": "Seattle",
"inquiry_province": "WA"
}
]
},
"identity_verified": true,
"employment_verified": true,
"identity_verification": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-12T21:21:50Z",
"modified": "2021-11-12T21:21:50Z",
"status": "A",
"result": "VERIFIED"
},
"enhanced_identity_verification": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-12T21:21:50Z",
"modified": "2021-11-12T21:21:50Z",
"status": "A",
"result": "VERIFIED"
},
"manual_id_verification": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-12T21:21:50Z",
"modified": "2021-11-12T21:21:50Z",
"status": "A",
"result": "VERIFIED"
},
"rcmp_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"us_criminal_record_check_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"criminal_cases": [{
"case_type": "Criminal",
"number": "123asd",
"file_date": "2000-12-12",
"judgment_date": "2000-12-12",
"summary_description": "The case filings summary description",
"full_description": "string",
"notes": "No additional case notes available",
"court": {
"court": "Seattle Superior Court",
"court_type": "Criminal",
"docket_number": "545fjd",
"filed_date": "2000-12-12",
"served_date": "2000-12-12",
"trial_date": "2000-12-12",
"jurisdiction": "Seattle County"
},
"criminal_charges": [{
"offense_description": "Breach of peace",
"offense_date": "2000-12-12",
"offense_type": "Felony",
"plea": "Not Guilty",
"hearing_date": "2000-12-12",
"hearing_type": "Open court hearing",
"probation": "No probation given",
"community_service": "No community service given",
"sentence_suspended": "None",
"fines": "No fines given",
"fines_paid_status": "Fines not paid",
"fines_paid_date": "2000-12-12",
"cost": "200",
"restitution": "None",
"transferred_jurisdiction": "Transferred from Seattle",
"transferred_case_number": "690330",
"active_warrant": "No active warrant",
"jail_time": "6 months jail time",
"prison_time": "6 months prison time",
"charge_in_progress": "no charge in progress",
"charge": "Vehicular manslaughter two counts",
"charge_level": "Felony",
"charge_class": "None",
"dispositions": [{
"offense_description": "Speeding",
"offense_type": "Infraction",
"offense_date": "2000-12-12",
"description": "Description of the disposition offense",
"disposition_date": "2000-12-12",
"statue": "20-1212(B)",
"offense_class": "The offense class description",
"final_plea": "Not Guilty",
"disposition_description": "The description of the dispostion"
}
],
"arrests": [{
"arrest_date": "2000-12-12",
"booking_number": "42069",
"citation_number": "247365",
"arresting_agency": "KERSHAW COUNTY DETENTION CENTER",
"offense_type": "Misdemeanor",
"offense_description": "A description of the arresting offense",
"counts": "Arrest has 6 counts"
}
],
"sentences": [{
"sentence_type": "Community Service and Fines",
"duration": "6 months",
"amount": "100",
"amount_paid": "50",
"paid": "Half the fine has been paid",
"qualifier": "The sentence has no qualifier information",
"description": "The sentence description",
"effective_date": "2000-12-12",
"appearance_date": "2000-12-12",
"appearance_finding": "There are no appearance findings to detail about the sentence"
}
],
"additional_informations": [{
"description": "More case information was found.",
"additional_description": "None",
"event_date": "2000-12-12"
}
]
}
]
}
],
"ssn_id_document_reports": [{
"ssn_result": "Discrepancy",
"ssn_status": "Complete",
"names": [{
"first_name": "string",
"middle_name": "string",
"last_name": "string"
}
],
"addresses": [{
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2"
}
],
"id_documents": [{
"type": "Passport",
"number": "123412kdsdsk",
"issuing_country": "US",
"issuing_province_state": "WA",
"issue_date": "2000-12-12",
"expiry_date": "2000-12-12"
}
],
"dates_of_birth": [{
"date_of_birth": "2000-12-12"
}
]
}
],
"scan_status": {
"national_sex_offender_registry_scan": "Complete",
"security_watch_list_scan": "Complete",
"fraud_scan": "Complete",
"ofac_global_sanctions_scan": "Complete",
"ssn_verification_scan": "Complete",
"criminal_record_scan": "Complete",
"federal_record_scan": "Incomplete",
"single_state_county_record_scan": "Incomplete",
"all_state_county_record_scan": "Incomplete"
},
"record_check_requests": [{
"status": "Complete",
"state": "OH",
"county": "Kershaw",
"district": "District 1",
"fips_code": 12312,
"search_type": "Criminal/Court Database Search"
}
]
},
"verification_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"employment_verification": "VERIFIED",
"education_verification": "VERIFIED",
"credential_verification": "VERIFIED",
"certn_verification": "VERIFIED",
"employer_verification_results": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"certn_verification": "VERIFIED",
"company_name_verified": false,
"position_name_verified": false,
"income_verified": false,
"employment_dates_verified": true,
"verification_notes": "Verification notes!",
"employer": {
"company_name": "string",
"position": "string",
"income": 8500,
"pay_period": "PER_HOUR",
"start_date": "2021-11-12",
"end_date": "2021-11-12",
"certn_verification": "VERIFIED",
"verification_notes": "string",
"employer_reference": {
"email": {
"address": "email@certn.co"
},
"phone_number": {
"phone_type": "NONE",
"number": "+1 250 555 1234",
"country": "string"
},
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
},
"contact": {
"can_contact": true,
"can_contact_after_date": "2021-11-12"
}
}
}
},
"education_verification_results": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"certn_verification": "VERIFIED",
"specializations_verified": false,
"degree_verified": false,
"institution_verified": false,
"enrolment_dates_verified": true,
"verification_notes": "Verification notes!",
"education": {
"institution": "string",
"degree": {
"degree": "2021-11-12",
"verified": true
},
"address": {
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2"
},
"start_date": "2021-11-12",
"end_date": "2021-11-12",
"certn_verification": "VERIFIED",
"verification_notes": "string"
}
},
"credential_verification_results": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"certn_verification": "VERIFIED",
"certification_date_verified": false,
"certification_verified": false,
"institution_verified": true,
"verification_notes": "Verification notes!",
"credential": {
"description": "string",
"institution": "string",
"certification": "string",
"date_of_certification": "2021-11-12",
"current": true,
"certn_verification": "VERIFIED",
"verification_notes": "string"
}
}
},
"international_criminal_record_check_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"motor_vehicle_record_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"damage_to_property": 0,
"damage_to_property_label": "High",
"eviction_potential": 0,
"eviction_potential_label": "High",
"late_rent_potential": 0,
"late_rent_potential_label": "High",
"tenancy_length": 0,
"tenancy_length_label": "High"
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="400: Bad Request Missing field, wrong data type, account not configured" %}
This may be happening because:
**You are missing required fields**
Add all the required fields to the body of your request.
**You used the wrong format or data type for a field**
Format all your fields according to their [data type](https://www.w3schools.com/js/js_json_datatypes.asp).
**Your account isn't configured to run this check**
[Contact our support team](/api/contact#api) to have your account configured for this check.
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="500: Internal Server Error Wrong data type" %}
This may be happening because:
**You used the wrong format or data type for a field**
Format all your fields according to their [data type](https://www.w3schools.com/js/js_json_datatypes.asp). Most fields in our API take strings, while request flags take booleans.
*See* [Error codes](/api/api-reference/resources/error-codes#500-internal-server-error) *for more details.*
{% endtab %}
{% endtabs %}
## Upgrade an application
`PUT` `https://api.certn.co/api/v1/pm/applicants/{applicant_id}/packages/` [**`DEPRECATED`**](/api/deprecation)
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
| Name | Type | Description |
| ----------------------------------------------- | ------ | ------------------- |
| applicant\_id\* | string | ID of the applicant |
#### Request Body
| Name | Type | Description |
| ------------------------------------------------- | ------- | ---------------------------------------------------------------------------------- |
| tag | string | Group related applications by tag |
| {request\_flag}\* | boolean | [Request flags](/api/api-reference/resources/application-parameters/request-flags) |
{% tabs %}
{% tab title="200: OK Application successfully retrieved" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
{
"id": string ,
"created": string ,
"modified": string ,
"tag": string,
"(request_flags)": boolean
"last_updated": string ,
"submitted_time": string ,
"is_submitted": boolean,
"applicant_type": string ,
"report_status": string ,
"status": string ,
"status_label": string ,
"result": string ,
"result_label": string ,
"certn_score": number,
"certn_score_label": string ,
"applicant_account": {
"id": string,
"email": string
},
"application": {
object (Application)
},
"country": "CA",
"information": {
object (Information)
},
"employment_verification": string ,
"education_verification": string ,
"credential_verification": string ,
"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 ,
"reliability_risk": number,
"reliability_risk_label": string ,
"workplace_misconduct": number,
"workplace_misconduct_label": string
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
{
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-12T21:21:50Z",
"modified": "2021-11-12T21:21:50Z",
"tag": "Sub-Client 123",
"request_base": false,
"request_behavioural": false,
"request_softcheck": true,
"request_us_ssn_verification": false,
"request_equifax": true,
"request_identity_verification": false,
"request_enhanced_identity_verification": false,
"request_criminal_record_check": false,
"request_enhanced_criminal_record_check": false,
"request_us_criminal_record_check_tier_1": false,
"request_us_criminal_record_check_tier_2": false,
"request_us_criminal_record_check_tier_3": false,
"request_international_criminal_record_check": false,
"request_motor_vehicle_records": false,
"request_employment_verification": false,
"request_education_verification": false,
"request_credential_verification": false,
"request_employer_references": false,
"request_address_references": false,
"request_employer_phone_references": false,
"request_address_phone_references": false,
"request_instant_verify_employment": false,
"request_instant_verify_education": false,
"request_instant_verify_credential": false,
"last_updated": "2021-11-12T21:21:50Z",
"submitted_time": "2021-11-12T21:21:50Z",
"is_submitted": true,
"applicant_type": "STANDARD",
"report_status": "IN_PROGRESS",
"status": "Pending",
"status_label": "Pending",
"result": "REVIEW",
"result_label": "Review",
"certn_score": 85,
"certn_score_label": "PASS",
"applicant_account": {
"id": "string",
"email": "string"
},
"application": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-12T21:21:50Z",
"modified": "2021-11-12T21:21:50Z",
"email": "string"
},
"country": "CA",
"information": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-12T21:21:50Z",
"modified": "2021-11-12T21:21:50Z",
"first_name": "Sebastien",
"middle_name": "Jack Pierre",
"last_name": "Normandin",
"last_name_at_birth": "string",
"former_names": "string",
"alias": "string",
"date_of_birth": "2021-11-12",
"phone_number": "250-123-1234",
"sin_ssn": 123123123,
"gender": "M",
"birth_city": "string",
"birth_province_state": "string",
"birth_other_province_state": "string",
"birth_country": "string",
"license_number": "string",
"license_valid": true,
"license_prov_state": "string",
"license_other_country": true,
"license_type": "CA",
"cover_letter": "string",
"addresses": [
{
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2",
"rent_or_own": "R",
"cost": 0,
"start_date": "2021-11-12",
"end_date": "2021-11-12",
"certn_verification": "VERIFIED",
"verification_notes": "string",
"address_reference": {
"email": {
"address": "email@certn.co"
},
"phone_number": {
"phone_type": "NONE",
"number": "+1 250 555 1234",
"country": "string"
},
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
},
"contact": {
"can_contact": true,
"can_contact_after_date": "2021-11-12"
}
}
}
],
"employers": [
{
"company_name": "string",
"position": "string",
"income": 8500,
"pay_period": "PER_HOUR",
"start_date": "2021-11-12",
"end_date": "2021-11-12",
"certn_verification": "VERIFIED",
"verification_notes": "string",
"employer_reference": {
"email": {
"address": "email@certn.co"
},
"phone_number": {
"phone_type": "NONE",
"number": "+1 250 555 1234",
"country": "string"
},
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
},
"contact": {
"can_contact": true,
"can_contact_after_date": "2021-11-12"
}
}
}
],
"educations": [
{
"institution": "string",
"degree": {
"degree": "2021-11-12",
"verified": true
},
"address": {
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2"
},
"start_date": "2021-11-12",
"end_date": "2021-11-12",
"certn_verification": "VERIFIED",
"verification_notes": "string"
}
],
"convictions": [
{
"offense": 2002,
"date_of_sentence": "2000-01-01T00:00:00.000Z",
"court_location": "Toronto, ON, Canada",
"description": "Robbery; Theft over $200"
}
]
},
"employment_verification": "VERIFIED",
"education_verification": "VERIFIED",
"credential_verification": "VERIFIED",
"reference_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"information_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"behavioural_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"risk_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"risk_evaluations": [
{
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"overall_score": "PASS",
"risk_information_result": {},
"criminal_results": [
{
"confidence": 0,
"confidence_label": "Likely",
"overall_score": "PASS",
"criminal_identity": {
"criminal_cases": [
{
"case_type": "Criminal",
"number": "123asd",
"file_date": "2000-12-12",
"judgment_date": "2000-12-12",
"summary_description": "The case filings summary description",
"full_description": "string",
"notes": "No additional case notes available",
"court": {
"court": "Seattle Superior Court",
"court_type": "Criminal",
"docket_number": "545fjd",
"filed_date": "2000-12-12",
"served_date": "2000-12-12",
"trial_date": "2000-12-12",
"jurisdiction": "Seattle County"
},
"criminal_charges": [
{
"offense_description": "Breach of peace",
"offense_date": "2000-12-12",
"offense_type": "Felony",
"plea": "Not Guilty",
"hearing_date": "2000-12-12",
"hearing_type": "Open court hearing",
"probation": "No probation given",
"community_service": "No community service given",
"sentence_suspended": "None",
"fines": "No fines given",
"fines_paid_status": "Fines not paid",
"fines_paid_date": "2000-12-12",
"cost": "200",
"restitution": "None",
"transferred_jurisdiction": "Transferred from Seattle",
"transferred_case_number": "690330",
"active_warrant": "No active warrant",
"jail_time": "6 months jail time",
"prison_time": "6 months prison time",
"charge_in_progress": "no charge in progress",
"charge": "Vehicular manslaughter two counts",
"charge_level": "Felony",
"charge_class": "None",
"dispositions": [
{
"offense_description": "Speeding",
"offense_type": "Infraction",
"offense_date": "2000-12-12",
"description": "Description of the disposition offense",
"disposition_date": "2000-12-12",
"statue": "20-1212(B)",
"offense_class": "The offense class description",
"final_plea": "Not Guilty",
"disposition_description": "The description of the dispostion"
}
],
"arrests": [
{
"arrest_date": "2000-12-12",
"booking_number": "42069",
"citation_number": "247365",
"arresting_agency": "KERSHAW COUNTY DETENTION CENTER",
"offense_type": "Misdemeanor",
"offense_description": "A description of the arresting offense",
"counts": "Arrest has 6 counts"
}
],
"sentences": [
{
"sentence_type": "Community Service and Fines",
"duration": "6 months",
"amount": "100",
"amount_paid": "50",
"paid": "Half the fine has been paid",
"qualifier": "The sentence has no qualifier information",
"description": "The sentence description",
"effective_date": "2000-12-12",
"appearance_date": "2000-12-12",
"appearance_finding": "There are no appearance findings to detail about the sentence"
}
],
"additional_informations": [
{
"description": "More case information was found.",
"additional_description": "None",
"event_date": "2000-12-12"
}
]
}
]
}
],
"criminal_alerts": [
{
"parent_category": "FRAUD",
"category": "Burglary",
"stage": "Conviction",
"type": "Citation",
"description": "Convicted of burglary",
"date": "2000-12-12",
"parent_category_label": "Fraud"
}
],
"criminal_sources": [
{
"name": "World News",
"url": "worldnews.com",
"date": "2000-12-12",
"format": "Online Media",
"headline": "Burglary Conviction for Area Man",
"publication_source": "World News Conglomerate",
"publisher": "World News"
}
],
"criminal_addresses": [
{
"start_date": "2000-12-12",
"end_date": "2000-12-12",
"unit": "1a",
"address": "123 fort st.",
"city": "Victoria",
"province_state": "BC",
"country": "Canda",
"postal_code": "V8X2C3"
}
],
"criminal_additional_informations": [
{
"aliases": [
"willy will",
"billy bill"
],
"dates_of_birth": [
"2000-12-12"
],
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
}
}
]
}
}
]
}
]
},
"equifax_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"description": "The financial score is based on self-provided information from the applicant and an analysis of the applicant's information available to Certn. This includes a credit check, Equifax record analysis, as well as other important informational data points",
"total_debt": 100,
"upgradable": false,
"trades": [
{
"credit_grantor": "RBC",
"payment_status": "Up to date",
"date_opened": "2000-12-12",
"account_rating": "High",
"date_reported": "2000-12-12",
"account_type": "Revolving",
"high_credit": 2000,
"balance_amount": 1000,
"last_activity_or_payment": "Paid as up to date",
"r_code": "R-1",
"percent_credit_used": 50,
"account_number": "112ksjd",
"past_due_amount": 0,
"payment_term_amount": 120,
"months_reviewed": 15,
"narratives": [
"Account has been paid in full."
]
}
],
"employers": [
{
"employment": "Subject's Current Employer",
"occupation": "Software",
"employer": "Certn",
"city": "Victoria",
"province": "BC",
"verification": true,
"salary": 1000000
}
],
"addresses": [
{
"address": "123 fort st.",
"civic_number": 123,
"street_name": "fort st.",
"city": "Victoria",
"province": "BC"
}
],
"collections": [
{
"date_of_last_payment": "2000-12-12",
"creditor": "Boys Club",
"amount_owed": 10000,
"amount_paid": 50,
"ledger_number": "123aslld",
"date_paid": "2000-12-12T00:00:00.000Z",
"date_reported": "2000-12-12T00:00:00.000Z",
"assigned_date": "2012-12-12T00:00:00.000Z",
"verification_date": "2000-12-12T00:00:00.000Z",
"account_designation": "Individual",
"first_deliquency": "2000-12-12T00:00:00.000Z",
"agency_entity": "GQC123",
"reason": "Credit not paid on in full",
"description": "Parking ticket"
}
],
"deposit_alerts": [
{
"customer_entity": "RBC",
"date_reported": "2000-12-12T00:00:00.000Z",
"account_type": "Business",
"date_opened": "2000-12-12T00:00:00.000Z",
"date_closed": "2000-12-12T00:00:00.000Z",
"date_written_off": "2000-12-12T00:00:00.000Z",
"amount_written_off": 2000,
"alert_status": "High",
"alert_status_date": "2000-12-12T00:00:00.000Z"
}
],
"bankruptcies": [
{
"account_type": "Individual",
"liability_amount": 2000,
"asset_amount": 20000,
"customer": "CRED COUNSELLING SOC",
"case_number_and_trustee": "12312 CE ASSOCIATES",
"filer": "Subject",
"legal_narrative": "No legal information available",
"date_filed": "2000-12-12T00:00:00.000Z",
"intent_or_disposition": "Discharged"
}
],
"judgments": [
{
"plaintiff": "Fred Rickleson",
"defendant": "Rick Frederickson",
"amount": 1000.21,
"date_filed": "2000-12-12T00:00:00.000Z",
"date_satisfied": "2000-12-12T00:00:00.000Z",
"verification_date": "2000-12-12T00:00:00.000Z",
"court_entity": "RBC",
"garnishee": "RBC",
"description": "Fred sued Rick"
}
],
"legal_items": [
{
"case_number": "1232djdsj",
"verification_date": "2000-12-12T00:00:00.000Z",
"update_source_code": "Tape rptd",
"date_filed": "2000-12-12T00:00:00.000Z",
"court_entity": "Toronto small claims",
"status_code": "Satisfied",
"date_satisfied": "2000-12-12T00:00:00.000Z",
"amount": 10000,
"defendant": "John Smithy",
"plaintiff": "Smith Johny",
"lawyer_name_address": "Johnson LLC 123 fort st Victoria",
"legal_item_description": "It was very bad deal"
}
],
"liens": [
{
"amount": 1000,
"date_filed": "1999-12-12T00:00:00.000Z",
"lien_class": "Class A",
"date_released": "1990-12-12T00:00:00.000Z",
"date_verified": "1990-12-12T00:00:00.000Z",
"court_entity": "Superior Court.",
"case_number": "123asda",
"lien_description": "Lien on house."
}
],
"secured_loans": [
{
"date_filed": "1990-12-12T00:00:00.000Z",
"court_entity": "Superior",
"creditor_name_address": "RBC 123 Main st.",
"creditor_industry_code": "620a",
"maturity_date": "1990-12-12T00:00:00.000Z"
}
],
"fraud_warnings": [
{
"product_description": "Fraud warnings are warnings of fraud.",
"message_priority": "Very high",
"message_code": "123a",
"message_description": "High fraud alert for bank fraud"
}
],
"non_sufficient_funds": [
{
"date_reported": "1990-12-12T00:00:00.000Z",
"creditor_entity": "RBC",
"nsfamount": 1000.2,
"details": "No sufficient funds in savings account.",
"verification_date": "1990-12-12T00:00:00.000Z"
}
],
"credit_file_metadatas": [
{
"hit_strength_indicator": "HIT",
"request_number": "123asd",
"address_discrepancy": "No discrepancy found in address",
"customer_number": "123asd",
"report_id": "123asd",
"file_since_date": "1990-12-12T00:00:00.000Z",
"date_of_last_activity": "1990-12-12T00:00:00.000Z",
"date_of_request": "1990-12-12T00:00:00.000Z",
"hit": "Big Hit",
"data_warning_messages": [
"No data warning messages"
],
"card_alert_warning_messages": [
"Credit card on high alert"
],
"alert_indicators": [
"No messages"
]
}
],
"other_incomes": [
{
"date_reported": "1990-12-12T00:00:00.000Z",
"income_source": "RBC",
"amount": 1000000,
"verification_date": "1990-12-12T00:00:00.000Z"
}
],
"consumer_statements": [
{
"date_reported": "1990-12-12T00:00:00.000Z",
"statement": "No consumer statement available."
}
],
"bank_accounts": [
{
"account": "Personal checking",
"date_reported": "1990-12-12T00:00:00.000Z",
"creditor_entity": "RBC",
"account_number": "123asd",
"figure_amount": 1000.12,
"date_opened": "1990-12-12T00:00:00.000Z",
"account_type": "Checking",
"status": "active",
"number_of_nsf": 0
}
],
"local_inquiries": [
{
"inquiry_date": "1990-12-12T00:00:00.000Z",
"customer_name": "Certn"
}
],
"foreign_inquiries": [
{
"inquiry_date": "1990-12-12T00:00:00.000Z",
"city_name_or_inquiry_number": "Seattle",
"inquiry_province": "WA"
}
]
},
"identity_verified": true,
"employment_verified": true,
"identity_verification": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-12T21:21:50Z",
"modified": "2021-11-12T21:21:50Z",
"status": "A",
"result": "VERIFIED"
},
"enhanced_identity_verification": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-12T21:21:50Z",
"modified": "2021-11-12T21:21:50Z",
"status": "A",
"result": "VERIFIED"
},
"manual_id_verification": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-12T21:21:50Z",
"modified": "2021-11-12T21:21:50Z",
"status": "A",
"result": "VERIFIED"
},
"rcmp_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"us_criminal_record_check_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"criminal_cases": [
{
"case_type": "Criminal",
"number": "123asd",
"file_date": "2000-12-12",
"judgment_date": "2000-12-12",
"summary_description": "The case filings summary description",
"full_description": "string",
"notes": "No additional case notes available",
"court": {
"court": "Seattle Superior Court",
"court_type": "Criminal",
"docket_number": "545fjd",
"filed_date": "2000-12-12",
"served_date": "2000-12-12",
"trial_date": "2000-12-12",
"jurisdiction": "Seattle County"
},
"criminal_charges": [
{
"offense_description": "Breach of peace",
"offense_date": "2000-12-12",
"offense_type": "Felony",
"plea": "Not Guilty",
"hearing_date": "2000-12-12",
"hearing_type": "Open court hearing",
"probation": "No probation given",
"community_service": "No community service given",
"sentence_suspended": "None",
"fines": "No fines given",
"fines_paid_status": "Fines not paid",
"fines_paid_date": "2000-12-12",
"cost": "200",
"restitution": "None",
"transferred_jurisdiction": "Transferred from Seattle",
"transferred_case_number": "690330",
"active_warrant": "No active warrant",
"jail_time": "6 months jail time",
"prison_time": "6 months prison time",
"charge_in_progress": "no charge in progress",
"charge": "Vehicular manslaughter two counts",
"charge_level": "Felony",
"charge_class": "None",
"dispositions": [
{
"offense_description": "Speeding",
"offense_type": "Infraction",
"offense_date": "2000-12-12",
"description": "Description of the disposition offense",
"disposition_date": "2000-12-12",
"statue": "20-1212(B)",
"offense_class": "The offense class description",
"final_plea": "Not Guilty",
"disposition_description": "The description of the dispostion"
}
],
"arrests": [
{
"arrest_date": "2000-12-12",
"booking_number": "42069",
"citation_number": "247365",
"arresting_agency": "KERSHAW COUNTY DETENTION CENTER",
"offense_type": "Misdemeanor",
"offense_description": "A description of the arresting offense",
"counts": "Arrest has 6 counts"
}
],
"sentences": [
{
"sentence_type": "Community Service and Fines",
"duration": "6 months",
"amount": "100",
"amount_paid": "50",
"paid": "Half the fine has been paid",
"qualifier": "The sentence has no qualifier information",
"description": "The sentence description",
"effective_date": "2000-12-12",
"appearance_date": "2000-12-12",
"appearance_finding": "There are no appearance findings to detail about the sentence"
}
],
"additional_informations": [
{
"description": "More case information was found.",
"additional_description": "None",
"event_date": "2000-12-12"
}
]
}
]
}
],
"ssn_id_document_reports": [
{
"ssn_result": "Discrepancy",
"ssn_status": "Complete",
"names": [
{
"first_name": "string",
"middle_name": "string",
"last_name": "string"
}
],
"addresses": [
{
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2"
}
],
"id_documents": [
{
"type": "Passport",
"number": "123412kdsdsk",
"issuing_country": "US",
"issuing_province_state": "WA",
"issue_date": "2000-12-12",
"expiry_date": "2000-12-12"
}
],
"dates_of_birth": [
{
"date_of_birth": "2000-12-12"
}
]
}
],
"scan_status": {
"national_sex_offender_registry_scan": "Complete",
"security_watch_list_scan": "Complete",
"fraud_scan": "Complete",
"ofac_global_sanctions_scan": "Complete",
"ssn_verification_scan": "Complete",
"criminal_record_scan": "Complete",
"federal_record_scan": "Incomplete",
"single_state_county_record_scan": "Incomplete",
"all_state_county_record_scan": "Incomplete"
},
"record_check_requests": [
{
"status": "Complete",
"state": "OH",
"county": "Kershaw",
"district": "District 1",
"fips_code": 12312,
"search_type": "Criminal/Court Database Search"
}
]
},
"verification_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"employment_verification": "VERIFIED",
"education_verification": "VERIFIED",
"credential_verification": "VERIFIED",
"certn_verification": "VERIFIED",
"employer_verification_results": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"certn_verification": "VERIFIED",
"company_name_verified": false,
"position_name_verified": false,
"income_verified": false,
"employment_dates_verified": true,
"verification_notes": "Verification notes!",
"employer": {
"company_name": "string",
"position": "string",
"income": 8500,
"pay_period": "PER_HOUR",
"start_date": "2021-11-12",
"end_date": "2021-11-12",
"certn_verification": "VERIFIED",
"verification_notes": "string",
"employer_reference": {
"email": {
"address": "email@certn.co"
},
"phone_number": {
"phone_type": "NONE",
"number": "+1 250 555 1234",
"country": "string"
},
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
},
"contact": {
"can_contact": true,
"can_contact_after_date": "2021-11-12"
}
}
}
},
"education_verification_results": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"certn_verification": "VERIFIED",
"specializations_verified": false,
"degree_verified": false,
"institution_verified": false,
"enrolment_dates_verified": true,
"verification_notes": "Verification notes!",
"education": {
"institution": "string",
"degree": {
"degree": "2021-11-12",
"verified": true
},
"address": {
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2"
},
"start_date": "2021-11-12",
"end_date": "2021-11-12",
"certn_verification": "VERIFIED",
"verification_notes": "string"
}
},
"credential_verification_results": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"certn_verification": "VERIFIED",
"certification_date_verified": false,
"certification_verified": false,
"institution_verified": true,
"verification_notes": "Verification notes!",
"credential": {
"description": "string",
"institution": "string",
"certification": "string",
"date_of_certification": "2021-11-12",
"current": true,
"certn_verification": "VERIFIED",
"verification_notes": "string"
}
}
},
"international_criminal_record_check_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"motor_vehicle_record_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"instant_verify_result": {
"instant_verify_employment": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"instant_verify_employment_result": [
{
"verification_status": "VERIFIED",
"verifications_scale": 0.8,
"label_source_data": "Tiger Keeping",
"label_verifier_data": "Keeping of Tigers",
"org_source_data": "The Greater Wynnewood Exotic Animal Park",
"org_verifier_data": "The Greater Wynnewood Exotic Animal Park",
"dates_source_data": "Feb - Sept 2020",
"dates_verifier_data": "Feb - Sept 2020"
}
]
},
"instant_verify_education": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"instant_verify_education_result": [
{
"verification_status": "VERIFIED",
"verifications_scale": 0.8,
"label_source_data": "Exploring Level 1",
"label_verifier_data": "Exploring 1",
"org_source_data": "DZ Center",
"org_verifier_data": "DZ Center",
"dates_source_data": "Feb - Sept 2020",
"dates_verifier_data": "Feb - Sept 2020"
}
]
},
"instant_verify_credential": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"instant_verification_credential_result": [
{
"verification_status": "VERIFIED",
"verifications_scale": 0.8,
"label_source_data": "CPR",
"label_verifier_data": "CPR Care Giver",
"org_source_data": "Red Cross",
"org_verifier_data": "Red Cross",
"dates_source_data": "Feb - Sept 2020",
"dates_verifier_data": "Feb - Sept 2020"
}
]
}
},
"damage_to_property": 0,
"damage_to_property_label": "High",
"eviction_potential": 0,
"eviction_potential_label": "High",
"late_rent_potential": 0,
"late_rent_potential_label": "High",
"tenancy_length": 0,
"tenancy_length_label": "High"
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="400: Bad Request Account not configured" %}
This may be happening because:
**Your account isn't configured to run this check**
[Contact our support team](/api/contact#api) to have your account configured for this check.
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% endtabs %}
## Retrieve applicant list
`GET` `https://api.certn.co/api/v1/pm/applicants/` [**`DEPRECATED`**](/api/deprecation)
View the details of all your applications.
The results are sent via paginated response, in chronological order. 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/pm/applicants/?page=`
You can retrieve the final report for an application when its `report_status` field is marked as `COMPLETE`.
#### Query Parameters
| Name | Type | Description |
| ------------------------- | -------------- | -------------------------- |
| page | int | Page number to retrieve |
| application\_\_team\_\_id | string \ | The application's team id. |
| owner | string \ | |
{% tabs %}
{% tab title="200: OK Applicants successfully retrieved" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
{
"count": int,
"next": URL,
"previous": URL,
"results": [
{
"request_identity_verification": boolean,
"request_equifax": boolean,
"request_base": boolean,
"request_instant_verify_employment": boolean,
"request_instant_verify_education": boolean,
"request_instant_verify_credential": boolean,
"request_international_criminal_record_check": boolean,
"request_enhanced_identity_verification": boolean,
"request_motor_vehicle_records": boolean,
"request_criminal_record_check": boolean,
"request_enhanced_criminal_record_check": boolean,
"request_vulnerable_sector_criminal_record_check": boolean,
"request_employer_references": boolean,
"request_address_references": boolean,
"request_employer_phone_references": boolean,
"request_address_phone_references": boolean,
"request_softcheck": boolean,
"request_social_media_check": boolean,
"request_soquij": boolean,
"request_us_criminal_record_check_tier_1": boolean,
"request_us_criminal_record_check_tier_2": boolean,
"request_us_criminal_record_check_tier_3": boolean,
"request_education_verification": boolean,
"request_credential_verification": boolean,
"request_employment_verification": boolean,
"request_vaccination_check": boolean,
"request_right_to_work": boolean,
"request_uk_basic_dbs_check": boolean,
"request_uk_basic_ds_check": boolean,
"request_uk_right_to_work_check": boolean,
"id": string ,
"short_uid": string,
"last_updated": string ,
"report_status": string ,
"is_cosigner": boolean,
"information": {
"first_name": string,
"last_name": string
},
"applicant_account": {
"id": string ,
"email": string,
"email_verified": boolean,
"phone_number": string
},
"application": {
"applicants": [
{
"id": string ,
"first_name": string,
"last_name": string,
"email": string,
"phone_number": string,
"share_of_rent": float,
"is_cosigner": boolean,
"application_url": URL,
"report_url": URL,
"status": string
}
],
"owner": {
"email": string
},
"is_active": boolean,
"team": {
"name": string
},
"listing": object(Listing)
},
"can_upgrade": boolean,
"is_equifax_eligible": boolean,
"can_resend_email": boolean,
"resend_email_time": string ,
"report_summary": {
"reference_result": object(BasePackageResult),
"rcmp_result": object(RCMPResult),
"equifax_result": object(EquifaxResult),
"information_result": object(BasePackageResult),
"instant_verify_result": object(BasePackageResult),
"international_criminal_record_check_result": object(InternationalCriminalRecordCheckResult),
"motor_vehicle_record_result": object(MotorVehicleRecordResult),
"social_media_check_result": object(SocialMediaCheckResult),
"risk_result": object(RiskResult),
"soquij_result": object(SoquijResult),
"uk_basic_dbs_check_result": object(UKBasicDBSCheckResult),
"uk_basic_ds_check_result": object(UKBasicDSCheckResult),
"uk_right_to_work_check_result": object(UKRightToWorkResult),
"us_criminal_record_check_result": object(USCriminalRecordCheckResult),
"vaccination_check_result": object(BasePackageResult),
"right_to_work_result": object(RightToWorkResult),
"certn_verification": object(BasePackageResult),
"report_result": string ,
"report_result_label": string ,
"dispute": boolean,
"report_status": string ,
"report_status_label": string
},
"is_viewed": boolean,
"onboarding_link": URL,
"adjudication_status": string ,
"adjudication_status_label": string ,
"status": string ,
"has_active_automated_reminders": boolean,
"order_status": string ,
"check_executions": [
{
"id": string,
"check_name": string ,
"status": string ,
},
]
}
]
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"request_identity_verification": false,
"request_equifax": false,
"request_base": true,
"request_instant_verify_employment": false,
"request_instant_verify_education": false,
"request_instant_verify_credential": false,
"request_international_criminal_record_check": false,
"request_enhanced_identity_verification": false,
"request_motor_vehicle_records": false,
"request_criminal_record_check": false,
"request_enhanced_criminal_record_check": false,
"request_vulnerable_sector_criminal_record_check": false,
"request_employer_references": false,
"request_address_references": false,
"request_employer_phone_references": false,
"request_address_phone_references": false,
"request_softcheck": true,
"request_social_media_check": false,
"request_soquij": false,
"request_us_criminal_record_check_tier_1": false,
"request_us_criminal_record_check_tier_2": false,
"request_us_criminal_record_check_tier_3": false,
"request_education_verification": false,
"request_credential_verification": false,
"request_employment_verification": false,
"request_vaccination_check": false,
"request_right_to_work": false,
"request_uk_basic_dbs_check": false,
"request_uk_basic_ds_check": false,
"request_uk_right_to_work_check": false,
"id": "aec12a3e-789b-0123-a2b3-bb567e2fe123",
"short_uid": "ABCDE1FG",
"last_updated": "2023-09-14T15:55:14.791018Z",
"report_status": "SENT",
"is_cosigner": false,
"information": {
"first_name": "Andrew",
"last_name": "McLeod"
},
"applicant_account": {
"id": "1eb234ab-a890-12c3-9876-4f9a73fe123d",
"email": "test@certn.co",
"email_verified": false,
"phone_number": null
},
"application": {
"applicants": [
{
"id": "aec12a3e-789b-0123-a2b3-bb567e2fe123",
"first_name": "Andrew",
"last_name": "McLeod",
"email": "test@certn.co",
"phone_number": null,
"share_of_rent": null,
"is_cosigner": false,
"application_url": "https://demo-app.certn.co/welcome/email?session=a98c8f8c-88ff-44b4-8ef8-04d4b4e4fb4c&token=b44b11e2-a001-444d-bafe-2c2d02d222f2&onboardingType=PM&inviteRoute=email&inviteCode=ee4e4",
"report_url": "https://demo-app.certn.co/pm/applications/aec12a3e-789b-0123-a2b3-bb567e2fe123/",
"status": "Pending"
}
],
"owner": {
"email": "jane.doe@certn.co"
},
"is_active": true,
"team": {
"name": "PM Team Name"
},
"listing": null
},
"can_upgrade": false,
"is_equifax_eligible": false,
"can_resend_email": false,
"resend_email_time": "2023-09-15T15:55:14.750410Z",
"report_summary": {
"australian_criminal_intelligence_commission_check_result": null,
"equifax_result": null,
"information_result": {
"status": "PENDING",
"status_label": "Pending",
"dispute": false,
"result": "NONE",
"result_label": "None"
},
"instant_verify_result": null,
"international_criminal_record_check_result": null,
"motor_vehicle_record_result": null,
"social_media_check_result": null,
"risk_result": {
"status": "PENDING",
"status_label": "Pending",
"dispute": false,
"result": "NONE",
"result_label": "None"
},
"soquij_result": null,
"uk_basic_dbs_check_result": null,
"uk_basic_ds_check_result": null,
"uk_right_to_work_check_result": null,
"us_criminal_record_check_result": null,
"right_to_work_result": null,
"certn_verification": {
"status": "NONE",
"status_label": "None",
"dispute": false,
"employment_verification": "NONE",
"employment_verification_label": "None"
},
"report_result": "NONE",
"report_result_label": "None",
"dispute": false,
"report_status": "SENT",
"report_status_label": "Sent"
},
"is_viewed": false,
"onboarding_link": "https://demo-app.certn.co/welcome/email?session=a98c8f8c-88ff-44b4-8ef8-04d4b4e4fb4c&token=b44b11e2-a001-444d-bafe-2c2d02d222f2&onboardingType=PM&inviteRoute=email&inviteCode=ee4e4",
"adjudication_status": "NONE",
"adjudication_status_label": "None",
"status": "Pending",
"has_active_automated_reminders": true,
"order_status": "WAITING_ON_CANDIDATE",
"check_executions": [
{
"id": "check_exec_aABbC1cdefgDhijE2FGkHl",
"check_name": "base",
"status": "WAITING_ON_CANDIDATE"
},
{
"id": "check_exec_abABCDc0EdefFgGHhiIjJk",
"check_name": "softcheck",
"status": "WAITING_ON_CANDIDATE"
}
]
}
]
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="404: Not Found Page not found" %}
This may be happening because:
**The page number you provided doesn't exist**
Make sure the page number you entered is a valid integer and within the bounds of your expected results.
*See* [Error codes](/api/api-reference/resources/error-codes#404-not-found) *for more details.*
{% endtab %}
{% endtabs %}
## Retrieve an application
`GET` `https://api.certn.co/api/v1/pm/applicants/{applicant_id}/` [**`DEPRECATED`**](/api/deprecation)
View the details of an application.
Check the `status` field to see if the application is done processing.
You can retrieve the final report when the `report_status` field is marked as `COMPLETE`.
#### Path Parameters
| Name | Type | Description |
| ----------------------------------------------- | ------ | ------------------- |
| applicant\_id\* | string | ID of the applicant |
{% tabs %}
{% tab title="200: OK Report successfully retrieved" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
{
"id": string ,
"created": string ,
"modified": string ,
"tag": string,
"(request_flags)": boolean
"last_updated": string ,
"submitted_time": string ,
"is_submitted": boolean,
"applicant_type": string ,
"report_status": string ,
"status": string ,
"status_label": string ,
"result": string ,
"result_label": string ,
"certn_score": number,
"certn_score_label": string ,
"applicant_account": {
"id": string,
"email": string
},
"application": {
object (Application)
},
"country": "CA",
"information": {
object (Information)
},
"employment_verification": string ,
"education_verification": string ,
"credential_verification": string ,
"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 ,
"reliability_risk": number,
"reliability_risk_label": string ,
"workplace_misconduct": number,
"workplace_misconduct_label": string
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
{
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-12T21:21:50Z",
"modified": "2021-11-12T21:21:50Z",
"tag": "Sub-Client 123",
"request_base": false,
"request_behavioural": false,
"request_softcheck": true,
"request_us_ssn_verification": false,
"request_equifax": true,
"request_identity_verification": false,
"request_enhanced_identity_verification": false,
"request_criminal_record_check": false,
"request_enhanced_criminal_record_check": false,
"request_us_criminal_record_check_tier_1": false,
"request_us_criminal_record_check_tier_2": false,
"request_us_criminal_record_check_tier_3": false,
"request_international_criminal_record_check": false,
"request_motor_vehicle_records": false,
"request_employment_verification": false,
"request_education_verification": false,
"request_credential_verification": false,
"request_employer_references": false,
"request_address_references": false,
"request_employer_phone_references": false,
"request_address_phone_references": false,
"request_instant_verify_employment": false,
"request_instant_verify_education": false,
"request_instant_verify_credential": false,
"last_updated": "2021-11-12T21:21:50Z",
"submitted_time": "2021-11-12T21:21:50Z",
"is_submitted": true,
"applicant_type": "STANDARD",
"report_status": "IN_PROGRESS",
"status": "Pending",
"status_label": "Pending",
"result": "REVIEW",
"result_label": "Review",
"certn_score": 85,
"certn_score_label": "PASS",
"applicant_account": {
"id": "string",
"email": "string"
},
"application": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-12T21:21:50Z",
"modified": "2021-11-12T21:21:50Z",
"email": "string"
},
"country": "CA",
"information": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-12T21:21:50Z",
"modified": "2021-11-12T21:21:50Z",
"first_name": "Sebastien",
"middle_name": "Jack Pierre",
"last_name": "Normandin",
"last_name_at_birth": "string",
"former_names": "string",
"alias": "string",
"date_of_birth": "2021-11-12",
"phone_number": "250-123-1234",
"sin_ssn": 123123123,
"gender": "M",
"birth_city": "string",
"birth_province_state": "string",
"birth_other_province_state": "string",
"birth_country": "string",
"license_number": "string",
"license_valid": true,
"license_prov_state": "string",
"license_other_country": true,
"license_type": "CA",
"cover_letter": "string",
"addresses": [
{
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2",
"rent_or_own": "R",
"cost": 0,
"start_date": "2021-11-12",
"end_date": "2021-11-12",
"certn_verification": "VERIFIED",
"verification_notes": "string",
"address_reference": {
"email": {
"address": "email@certn.co"
},
"phone_number": {
"phone_type": "NONE",
"number": "+1 250 555 1234",
"country": "string"
},
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
},
"contact": {
"can_contact": true,
"can_contact_after_date": "2021-11-12"
}
}
}
],
"employers": [
{
"company_name": "string",
"position": "string",
"income": 8500,
"pay_period": "PER_HOUR",
"start_date": "2021-11-12",
"end_date": "2021-11-12",
"certn_verification": "VERIFIED",
"verification_notes": "string",
"employer_reference": {
"email": {
"address": "email@certn.co"
},
"phone_number": {
"phone_type": "NONE",
"number": "+1 250 555 1234",
"country": "string"
},
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
},
"contact": {
"can_contact": true,
"can_contact_after_date": "2021-11-12"
}
}
}
],
"educations": [
{
"institution": "string",
"degree": {
"degree": "2021-11-12",
"verified": true
},
"address": {
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2"
},
"start_date": "2021-11-12",
"end_date": "2021-11-12",
"certn_verification": "VERIFIED",
"verification_notes": "string"
}
],
"convictions": [
{
"offense": 2002,
"date_of_sentence": "2000-01-01T00:00:00.000Z",
"court_location": "Toronto, ON, Canada",
"description": "Robbery; Theft over $200"
}
]
},
"employment_verification": "VERIFIED",
"education_verification": "VERIFIED",
"credential_verification": "VERIFIED",
"reference_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"information_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"behavioural_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"risk_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"risk_evaluations": [
{
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"overall_score": "PASS",
"risk_information_result": {},
"criminal_results": [
{
"confidence": 0,
"confidence_label": "Likely",
"overall_score": "PASS",
"criminal_identity": {
"criminal_cases": [
{
"case_type": "Criminal",
"number": "123asd",
"file_date": "2000-12-12",
"judgment_date": "2000-12-12",
"summary_description": "The case filings summary description",
"full_description": "string",
"notes": "No additional case notes available",
"court": {
"court": "Seattle Superior Court",
"court_type": "Criminal",
"docket_number": "545fjd",
"filed_date": "2000-12-12",
"served_date": "2000-12-12",
"trial_date": "2000-12-12",
"jurisdiction": "Seattle County"
},
"criminal_charges": [
{
"offense_description": "Breach of peace",
"offense_date": "2000-12-12",
"offense_type": "Felony",
"plea": "Not Guilty",
"hearing_date": "2000-12-12",
"hearing_type": "Open court hearing",
"probation": "No probation given",
"community_service": "No community service given",
"sentence_suspended": "None",
"fines": "No fines given",
"fines_paid_status": "Fines not paid",
"fines_paid_date": "2000-12-12",
"cost": "200",
"restitution": "None",
"transferred_jurisdiction": "Transferred from Seattle",
"transferred_case_number": "690330",
"active_warrant": "No active warrant",
"jail_time": "6 months jail time",
"prison_time": "6 months prison time",
"charge_in_progress": "no charge in progress",
"charge": "Vehicular manslaughter two counts",
"charge_level": "Felony",
"charge_class": "None",
"dispositions": [
{
"offense_description": "Speeding",
"offense_type": "Infraction",
"offense_date": "2000-12-12",
"description": "Description of the disposition offense",
"disposition_date": "2000-12-12",
"statue": "20-1212(B)",
"offense_class": "The offense class description",
"final_plea": "Not Guilty",
"disposition_description": "The description of the dispostion"
}
],
"arrests": [
{
"arrest_date": "2000-12-12",
"booking_number": "42069",
"citation_number": "247365",
"arresting_agency": "KERSHAW COUNTY DETENTION CENTER",
"offense_type": "Misdemeanor",
"offense_description": "A description of the arresting offense",
"counts": "Arrest has 6 counts"
}
],
"sentences": [
{
"sentence_type": "Community Service and Fines",
"duration": "6 months",
"amount": "100",
"amount_paid": "50",
"paid": "Half the fine has been paid",
"qualifier": "The sentence has no qualifier information",
"description": "The sentence description",
"effective_date": "2000-12-12",
"appearance_date": "2000-12-12",
"appearance_finding": "There are no appearance findings to detail about the sentence"
}
],
"additional_informations": [
{
"description": "More case information was found.",
"additional_description": "None",
"event_date": "2000-12-12"
}
]
}
]
}
],
"criminal_alerts": [
{
"parent_category": "FRAUD",
"category": "Burglary",
"stage": "Conviction",
"type": "Citation",
"description": "Convicted of burglary",
"date": "2000-12-12",
"parent_category_label": "Fraud"
}
],
"criminal_sources": [
{
"name": "World News",
"url": "worldnews.com",
"date": "2000-12-12",
"format": "Online Media",
"headline": "Burglary Conviction for Area Man",
"publication_source": "World News Conglomerate",
"publisher": "World News"
}
],
"criminal_addresses": [
{
"start_date": "2000-12-12",
"end_date": "2000-12-12",
"unit": "1a",
"address": "123 fort st.",
"city": "Victoria",
"province_state": "BC",
"country": "Canda",
"postal_code": "V8X2C3"
}
],
"criminal_additional_informations": [
{
"aliases": [
"willy will",
"billy bill"
],
"dates_of_birth": [
"2000-12-12"
],
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
}
}
]
}
}
]
}
]
},
"equifax_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"description": "The financial score is based on self-provided information from the applicant and an analysis of the applicant's information available to Certn. This includes a credit check, Equifax record analysis, as well as other important informational data points",
"total_debt": 100,
"upgradable": false,
"trades": [
{
"credit_grantor": "RBC",
"payment_status": "Up to date",
"date_opened": "2000-12-12",
"account_rating": "High",
"date_reported": "2000-12-12",
"account_type": "Revolving",
"high_credit": 2000,
"balance_amount": 1000,
"last_activity_or_payment": "Paid as up to date",
"r_code": "R-1",
"percent_credit_used": 50,
"account_number": "112ksjd",
"past_due_amount": 0,
"payment_term_amount": 120,
"months_reviewed": 15,
"narratives": [
"Account has been paid in full."
]
}
],
"employers": [
{
"employment": "Subject's Current Employer",
"occupation": "Software",
"employer": "Certn",
"city": "Victoria",
"province": "BC",
"verification": true,
"salary": 1000000
}
],
"addresses": [
{
"address": "123 fort st.",
"civic_number": 123,
"street_name": "fort st.",
"city": "Victoria",
"province": "BC"
}
],
"collections": [
{
"date_of_last_payment": "2000-12-12",
"creditor": "Boys Club",
"amount_owed": 10000,
"amount_paid": 50,
"ledger_number": "123aslld",
"date_paid": "2000-12-12T00:00:00.000Z",
"date_reported": "2000-12-12T00:00:00.000Z",
"assigned_date": "2012-12-12T00:00:00.000Z",
"verification_date": "2000-12-12T00:00:00.000Z",
"account_designation": "Individual",
"first_deliquency": "2000-12-12T00:00:00.000Z",
"agency_entity": "GQC123",
"reason": "Credit not paid on in full",
"description": "Parking ticket"
}
],
"deposit_alerts": [
{
"customer_entity": "RBC",
"date_reported": "2000-12-12T00:00:00.000Z",
"account_type": "Business",
"date_opened": "2000-12-12T00:00:00.000Z",
"date_closed": "2000-12-12T00:00:00.000Z",
"date_written_off": "2000-12-12T00:00:00.000Z",
"amount_written_off": 2000,
"alert_status": "High",
"alert_status_date": "2000-12-12T00:00:00.000Z"
}
],
"bankruptcies": [
{
"account_type": "Individual",
"liability_amount": 2000,
"asset_amount": 20000,
"customer": "CRED COUNSELLING SOC",
"case_number_and_trustee": "12312 CE ASSOCIATES",
"filer": "Subject",
"legal_narrative": "No legal information available",
"date_filed": "2000-12-12T00:00:00.000Z",
"intent_or_disposition": "Discharged"
}
],
"judgments": [
{
"plaintiff": "Fred Rickleson",
"defendant": "Rick Frederickson",
"amount": 1000.21,
"date_filed": "2000-12-12T00:00:00.000Z",
"date_satisfied": "2000-12-12T00:00:00.000Z",
"verification_date": "2000-12-12T00:00:00.000Z",
"court_entity": "RBC",
"garnishee": "RBC",
"description": "Fred sued Rick"
}
],
"legal_items": [
{
"case_number": "1232djdsj",
"verification_date": "2000-12-12T00:00:00.000Z",
"update_source_code": "Tape rptd",
"date_filed": "2000-12-12T00:00:00.000Z",
"court_entity": "Toronto small claims",
"status_code": "Satisfied",
"date_satisfied": "2000-12-12T00:00:00.000Z",
"amount": 10000,
"defendant": "John Smithy",
"plaintiff": "Smith Johny",
"lawyer_name_address": "Johnson LLC 123 fort st Victoria",
"legal_item_description": "It was very bad deal"
}
],
"liens": [
{
"amount": 1000,
"date_filed": "1999-12-12T00:00:00.000Z",
"lien_class": "Class A",
"date_released": "1990-12-12T00:00:00.000Z",
"date_verified": "1990-12-12T00:00:00.000Z",
"court_entity": "Superior Court.",
"case_number": "123asda",
"lien_description": "Lien on house."
}
],
"secured_loans": [
{
"date_filed": "1990-12-12T00:00:00.000Z",
"court_entity": "Superior",
"creditor_name_address": "RBC 123 Main st.",
"creditor_industry_code": "620a",
"maturity_date": "1990-12-12T00:00:00.000Z"
}
],
"fraud_warnings": [
{
"product_description": "Fraud warnings are warnings of fraud.",
"message_priority": "Very high",
"message_code": "123a",
"message_description": "High fraud alert for bank fraud"
}
],
"non_sufficient_funds": [
{
"date_reported": "1990-12-12T00:00:00.000Z",
"creditor_entity": "RBC",
"nsfamount": 1000.2,
"details": "No sufficient funds in savings account.",
"verification_date": "1990-12-12T00:00:00.000Z"
}
],
"credit_file_metadatas": [
{
"hit_strength_indicator": "HIT",
"request_number": "123asd",
"address_discrepancy": "No discrepancy found in address",
"customer_number": "123asd",
"report_id": "123asd",
"file_since_date": "1990-12-12T00:00:00.000Z",
"date_of_last_activity": "1990-12-12T00:00:00.000Z",
"date_of_request": "1990-12-12T00:00:00.000Z",
"hit": "Big Hit",
"data_warning_messages": [
"No data warning messages"
],
"card_alert_warning_messages": [
"Credit card on high alert"
],
"alert_indicators": [
"No messages"
]
}
],
"other_incomes": [
{
"date_reported": "1990-12-12T00:00:00.000Z",
"income_source": "RBC",
"amount": 1000000,
"verification_date": "1990-12-12T00:00:00.000Z"
}
],
"consumer_statements": [
{
"date_reported": "1990-12-12T00:00:00.000Z",
"statement": "No consumer statement available."
}
],
"bank_accounts": [
{
"account": "Personal checking",
"date_reported": "1990-12-12T00:00:00.000Z",
"creditor_entity": "RBC",
"account_number": "123asd",
"figure_amount": 1000.12,
"date_opened": "1990-12-12T00:00:00.000Z",
"account_type": "Checking",
"status": "active",
"number_of_nsf": 0
}
],
"local_inquiries": [
{
"inquiry_date": "1990-12-12T00:00:00.000Z",
"customer_name": "Certn"
}
],
"foreign_inquiries": [
{
"inquiry_date": "1990-12-12T00:00:00.000Z",
"city_name_or_inquiry_number": "Seattle",
"inquiry_province": "WA"
}
]
},
"identity_verified": true,
"employment_verified": true,
"identity_verification": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-12T21:21:50Z",
"modified": "2021-11-12T21:21:50Z",
"status": "A",
"result": "VERIFIED"
},
"enhanced_identity_verification": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-12T21:21:50Z",
"modified": "2021-11-12T21:21:50Z",
"status": "A",
"result": "VERIFIED"
},
"manual_id_verification": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"created": "2021-11-12T21:21:50Z",
"modified": "2021-11-12T21:21:50Z",
"status": "A",
"result": "VERIFIED"
},
"rcmp_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"us_criminal_record_check_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"criminal_cases": [
{
"case_type": "Criminal",
"number": "123asd",
"file_date": "2000-12-12",
"judgment_date": "2000-12-12",
"summary_description": "The case filings summary description",
"full_description": "string",
"notes": "No additional case notes available",
"court": {
"court": "Seattle Superior Court",
"court_type": "Criminal",
"docket_number": "545fjd",
"filed_date": "2000-12-12",
"served_date": "2000-12-12",
"trial_date": "2000-12-12",
"jurisdiction": "Seattle County"
},
"criminal_charges": [
{
"offense_description": "Breach of peace",
"offense_date": "2000-12-12",
"offense_type": "Felony",
"plea": "Not Guilty",
"hearing_date": "2000-12-12",
"hearing_type": "Open court hearing",
"probation": "No probation given",
"community_service": "No community service given",
"sentence_suspended": "None",
"fines": "No fines given",
"fines_paid_status": "Fines not paid",
"fines_paid_date": "2000-12-12",
"cost": "200",
"restitution": "None",
"transferred_jurisdiction": "Transferred from Seattle",
"transferred_case_number": "690330",
"active_warrant": "No active warrant",
"jail_time": "6 months jail time",
"prison_time": "6 months prison time",
"charge_in_progress": "no charge in progress",
"charge": "Vehicular manslaughter two counts",
"charge_level": "Felony",
"charge_class": "None",
"dispositions": [
{
"offense_description": "Speeding",
"offense_type": "Infraction",
"offense_date": "2000-12-12",
"description": "Description of the disposition offense",
"disposition_date": "2000-12-12",
"statue": "20-1212(B)",
"offense_class": "The offense class description",
"final_plea": "Not Guilty",
"disposition_description": "The description of the dispostion"
}
],
"arrests": [
{
"arrest_date": "2000-12-12",
"booking_number": "42069",
"citation_number": "247365",
"arresting_agency": "KERSHAW COUNTY DETENTION CENTER",
"offense_type": "Misdemeanor",
"offense_description": "A description of the arresting offense",
"counts": "Arrest has 6 counts"
}
],
"sentences": [
{
"sentence_type": "Community Service and Fines",
"duration": "6 months",
"amount": "100",
"amount_paid": "50",
"paid": "Half the fine has been paid",
"qualifier": "The sentence has no qualifier information",
"description": "The sentence description",
"effective_date": "2000-12-12",
"appearance_date": "2000-12-12",
"appearance_finding": "There are no appearance findings to detail about the sentence"
}
],
"additional_informations": [
{
"description": "More case information was found.",
"additional_description": "None",
"event_date": "2000-12-12"
}
]
}
]
}
],
"ssn_id_document_reports": [
{
"ssn_result": "Discrepancy",
"ssn_status": "Complete",
"names": [
{
"first_name": "string",
"middle_name": "string",
"last_name": "string"
}
],
"addresses": [
{
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2"
}
],
"id_documents": [
{
"type": "Passport",
"number": "123412kdsdsk",
"issuing_country": "US",
"issuing_province_state": "WA",
"issue_date": "2000-12-12",
"expiry_date": "2000-12-12"
}
],
"dates_of_birth": [
{
"date_of_birth": "2000-12-12"
}
]
}
],
"scan_status": {
"national_sex_offender_registry_scan": "Complete",
"security_watch_list_scan": "Complete",
"fraud_scan": "Complete",
"ofac_global_sanctions_scan": "Complete",
"ssn_verification_scan": "Complete",
"criminal_record_scan": "Complete",
"federal_record_scan": "Incomplete",
"single_state_county_record_scan": "Incomplete",
"all_state_county_record_scan": "Incomplete"
},
"record_check_requests": [
{
"status": "Complete",
"state": "OH",
"county": "Kershaw",
"district": "District 1",
"fips_code": 12312,
"search_type": "Criminal/Court Database Search"
}
]
},
"verification_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"employment_verification": "VERIFIED",
"education_verification": "VERIFIED",
"credential_verification": "VERIFIED",
"certn_verification": "VERIFIED",
"employer_verification_results": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"certn_verification": "VERIFIED",
"company_name_verified": false,
"position_name_verified": false,
"income_verified": false,
"employment_dates_verified": true,
"verification_notes": "Verification notes!",
"employer": {
"company_name": "string",
"position": "string",
"income": 8500,
"pay_period": "PER_HOUR",
"start_date": "2021-11-12",
"end_date": "2021-11-12",
"certn_verification": "VERIFIED",
"verification_notes": "string",
"employer_reference": {
"email": {
"address": "email@certn.co"
},
"phone_number": {
"phone_type": "NONE",
"number": "+1 250 555 1234",
"country": "string"
},
"name": {
"first_name": "string",
"middle_name": "string",
"last_name": "string"
},
"contact": {
"can_contact": true,
"can_contact_after_date": "2021-11-12"
}
}
}
},
"education_verification_results": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"certn_verification": "VERIFIED",
"specializations_verified": false,
"degree_verified": false,
"institution_verified": false,
"enrolment_dates_verified": true,
"verification_notes": "Verification notes!",
"education": {
"institution": "string",
"degree": {
"degree": "2021-11-12",
"verified": true
},
"address": {
"address": "4412 King Alfred Court",
"unit": 100,
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": "V8A1B2"
},
"start_date": "2021-11-12",
"end_date": "2021-11-12",
"certn_verification": "VERIFIED",
"verification_notes": "string"
}
},
"credential_verification_results": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"certn_verification": "VERIFIED",
"certification_date_verified": false,
"certification_verified": false,
"institution_verified": true,
"verification_notes": "Verification notes!",
"credential": {
"description": "string",
"institution": "string",
"certification": "string",
"date_of_certification": "2021-11-12",
"current": true,
"certn_verification": "VERIFIED",
"verification_notes": "string"
}
}
},
"international_criminal_record_check_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"motor_vehicle_record_result": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review"
},
"instant_verify_result": {
"instant_verify_employment": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"instant_verify_employment_result": [
{
"verification_status": "VERIFIED",
"verifications_scale": 0.8,
"label_source_data": "Tiger Keeping",
"label_verifier_data": "Keeping of Tigers",
"org_source_data": "The Greater Wynnewood Exotic Animal Park",
"org_verifier_data": "The Greater Wynnewood Exotic Animal Park",
"dates_source_data": "Feb - Sept 2020",
"dates_verifier_data": "Feb - Sept 2020"
}
]
},
"instant_verify_education": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"instant_verify_education_result": [
{
"verification_status": "VERIFIED",
"verifications_scale": 0.8,
"label_source_data": "Exploring Level 1",
"label_verifier_data": "Exploring 1",
"org_source_data": "DZ Center",
"org_verifier_data": "DZ Center",
"dates_source_data": "Feb - Sept 2020",
"dates_verifier_data": "Feb - Sept 2020"
}
]
},
"instant_verify_credential": {
"id": "a123b4cd-1a23-1a23-12a3-a123456b7890",
"status": "ANALYZING",
"status_label": "Analyzing",
"overall_score": "PASS",
"overall_score_label": "Pass",
"red_flags": [
"This may indicate the applicant is high risk."
],
"green_flags": [
"This may indicate the applicant is low risk."
],
"result": "REVIEW",
"result_label": "Review",
"instant_verification_credential_result": [
{
"verification_status": "VERIFIED",
"verifications_scale": 0.8,
"label_source_data": "CPR",
"label_verifier_data": "CPR Care Giver",
"org_source_data": "Red Cross",
"org_verifier_data": "Red Cross",
"dates_source_data": "Feb - Sept 2020",
"dates_verifier_data": "Feb - Sept 2020"
}
]
}
},
"damage_to_property": 0,
"damage_to_property_label": "High",
"eviction_potential": 0,
"eviction_potential_label": "High",
"late_rent_potential": 0,
"late_rent_potential_label": "High",
"tenancy_length": 0,
"tenancy_length_label": "High"
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="404: Not Found Application not found" %}
This may be happening because:
**The ID you provided couldn't be found**
Add your [application ID](/api/start/demo-account/retrieve-results#send-the-request) to the URL and make sure it's in the proper format.
*See* [Error codes](/api/api-reference/resources/error-codes#404-not-found) *for more details.*
{% endtab %}
{% endtabs %}
## 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.
## Download a PDF report
`GET` `https://api.certn.co/api/v1/pm/reports/{applicant_id}/pdf` [**`DEPRECATED`**](/api/deprecation)
Download an application's report as a PDF file.
To download the report, wait for the application's `status` field to show `Returned`.
#### Path Parameters
| Name | Type | Description |
| ----------------------------------------------- | ------ | ------------------- |
| applicant\_id\* | string | ID of the applicant |
{% tabs %}
{% tab title="200: OK Report as a PDF file" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/pdf" %}
```
string
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="400: Bad Request Incomplete application" %}
This may be happening because:
**The application is still processing**
Wait for the application's `status` field to show `Returned` before generating the final report.
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="404: Not Found Application not found" %}
This may be happening because:
**The ID you provided couldn't be found**
Add your [application ID](/api/start/demo-account/retrieve-results#send-the-request) to the URL and make sure it's in the proper format.
*See* [Error codes](/api/api-reference/resources/error-codes#404-not-found) *for more details.*
{% endtab %}
{% endtabs %}
## Create a hosted PDF report
`GET` `https://api.certn.co/api/v1/pm/reports/{applicant_id}/link` [**`DEPRECATED`**](/api/deprecation)
Create a PDF report hosted on Certn's servers. The URL returned can be used to view the report without downloading it. *This link is valid for 1 hour only.*
To create the hosted PDF report, wait for the application's `status` field to show `Returned`.
#### Path Parameters
| Name | Type | Description |
| ----------------------------------------------- | ------ | ------------------- |
| applicant\_id\* | string | ID of the applicant |
{% tabs %}
{% tab title="200: OK URL to view the report" %}
{% tabs %}
{% tab title="Response type" %}
```
{
"report_url": string
}
```
{% endtab %}
{% tab title="Example" %}
```
{
"report_url": "https://s3.ca-central-1.amazonaws.com/certn-reports/pm_806066d2-f9e7-4d54-844e-bcc225a8ef6d_1575603960.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAI322I2RK3VQJ4O3Q%2F20191206%2Fca-central-1%2Fs3%2Faws4_request&X-Amz-Date=20191206T034608Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=0032b9ff42a2fe1135d28079f67b70338f5abc373b4b0a72707e3109eac8815d"
}
```
{% endtab %}
{% endtabs %}
```javascript
{
// Response
}
```
{% endtab %}
{% tab title="400: Bad Request Incomplete application" %}
This may be happening because:
**The application is still processing**
Wait for the application's `status` field to show `Returned` before generating the final report.
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="404: Not Found Application not found" %}
This may be happening because:
**The ID you provided couldn't be found**
Add your [application ID](/api/start/demo-account/retrieve-results#send-the-request) to the URL and make sure it's in the proper format.
*See* [Error codes](/api/api-reference/resources/error-codes#404-not-found) *for more details.*
{% endtab %}
{% endtabs %}
## Download an HTML report
`GET` `https://api.certn.co/api/v1/pm/reports/{applicant_id}/web/` [**`DEPRECATED`**](/api/deprecation)
Download an application's report as an HTML file.
To download the report, wait for the application's `status` field to show `Returned`.
#### Path Parameters
| Name | Type | Description |
| ----------------------------------------------- | ------ | ------------------- |
| applicant\_id\* | string | ID of the applicant |
{% tabs %}
{% tab title="200: OK The report as an HTML file" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```
{
"html": string
}
```
{% endcode %}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
{
"html": "\\n\\n\\nCertn ReportPM"
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="400: Bad Request Incomplete application" %}
This may be happening because:
**The application is still processing**
Wait for the application's `status` field to show `Returned` before generating the final report.
*See* [Error codes](/api/api-reference/resources/error-codes#400-bad-request) *for more details.*
{% endtab %}
{% tab title="404: Not Found Application not found" %}
This may be happening because:
**The ID you provided couldn't be found**
Add your [application ID](/api/start/demo-account/retrieve-results#send-the-request) to the URL and make sure it's in the proper format.
*See* [Error codes](/api/api-reference/resources/error-codes#404-not-found) *for more details.*
{% endtab %}
{% endtabs %}
## Properties
A property is a specific location with an address that you are renting. These endpoints allow you to create and retrieve the properties associated with your team.
## Retrieve your properties
`GET` `https://api.certn.co/api/v1/pm/properties/` [**`DEPRECATED`**](/api/deprecation)
View the details of all your properties.
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/v2/properties/?page=`
#### Query Parameters
| Name | Type | Description |
| ---- | ---- | ----------------------- |
| page | int | Page number to retrieve |
{% tabs %}
{% tab title="200: OK Properties successfully retrieved" %}
{% tabs %}
{% tab title="Response type" %}
{
"count": int,
"next": URL,
"previous": URL,
"results": [
{
"id": string <uuid>,
"status": string <Enum>,
"get_status_display": string <Enum>,
"created": string <date-time>,
"modified": string <date-time>,
"last_updated": string <date-time>,
"building": string,
"building_code": string,
"address": string,
"city": string,
"province_state": string <ISO Code>,
"country": string <ISO Country Code>,
"postal_code": string,
"county": string,
"is_active": boolean,
"owner": {
"id": string <uuid>,
"email": string,
"team": object(Team)
},
"listing_count": int,
"full_address": string,
"url_code": string <uuid>
}
]
}
{% endtab %}
{% tab title="Example" %}
{% code title="application/json" %}
```json
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "ec351b3c-0375-4e29-b050-2302f0475b65",
"status": "N",
"get_status_display": "No Vacancy",
"created": "2023-09-14T17:25:44.158367Z",
"modified": "2023-09-14T17:25:44.158400Z",
"last_updated": "2023-09-14T17:25:44.158451Z",
"building": "View Towers",
"building_code": "123ABC",
"address": "1017 Fort Street",
"city": "Victoria",
"province_state": "BC",
"country": "CA",
"postal_code": null,
"county": null,
"is_active": true,
"owner": {
"id": "cb14a9c1-2fb9-47f2-b508-9c397b49f1d1",
"email": "jane.doe@certn.co",
"team": {
"id": "82b3f6d6-3a61-41f3-a5cc-da4335b9e4ff",
"name": "PM Team Name",
"country": "CA",
"industry": null,
"team_type": "PM",
"internal_name": "PM Team Name",
"app_url": "https://demo-app.certn.co/",
"compliance_region": {
"id": "fb123456-39e7-4738-b1aa-1234c204d888",
"name": "Initial",
"country": "CA",
"team_type": "PM",
"sub_region": "",
"default": true,
"score_value_field": "certn_score",
"score_label_field": "certn_score_label",
"show_legal_us": false,
"show_credit_report": true,
"show_fcra": false,
"require_address_history": true
},
"settings_config": {
"redirect_url": null,
"require_id_with_address": false,
"education_verification_level": "ALL",
"credential_verification_level": "ALL",
"volunteer_organization": "",
"request_motor_vehicle_records": false,
"resume_req": false,
"tenancy_years_amount_req": 2,
"request_criminal_record_check": false,
"employment_verification_min": 1,
"request_soquij": false,
"employment_verification_years": 3,
"get_org_name": "PM Team Name",
"org_name": null,
"tenancy_ref_phone_req": true,
"request_right_to_work": false,
"request_instant_verify_employment": false,
"request_enhanced_criminal_record_check": false,
"credential_verification_min": 1,
"request_employment_verification": false,
"request_identity_verification": false,
"hide_id_verification_photos": true,
"employer_references_max": 1,
"employer_ref_phone_req": true,
"visa_req": false,
"request_uk_basic_dbs_check": false,
"tenancy_ref_email_req": false,
"request_volunteer_acic_check": false,
"hide_detailed_financial": false,
"education_req": false,
"employer_years_amount_req": 0,
"hide_activity_log": true,
"employment_verification_max": 1,
"request_enhanced_identity_verification": false,
"reason_for_check": "",
"org_logo_link": "https://certn-api-s3-certn-images-ca-central-1-demo.s3.amazonaws.com/certn_logo_new.png",
"review_all_negative_mvr_results": false,
"enable_rcmp_reflow": false,
"emergency_contact_req": false,
"address_references_max": 1,
"education_verification_min": 1,
"credential_verification_max": 1,
"request_international_criminal_record_check": false,
"request_education_verification": false,
"org_primary_color": "#084146",
"document_required": false,
"request_vulnerable_sector_criminal_record_check": false,
"request_credential_verification": false,
"personal_ref_amount_req": 0,
"place_of_work": "",
"request_address_phone_references": false,
"request_softcheck": false,
"personal_ref_req": false,
"state_or_territory": "",
"whitelabel_emails": false,
"address_references_min": 1,
"request_base": false,
"employer_ref_email_req": false,
"compact_pdf_report": false,
"hide_date_of_birth": false,
"cover_letter_req": false,
"proof_of_income_req": false,
"us_criminal_record_check_years": 7,
"request_social_media_check": false,
"request_uk_right_to_work_check": false,
"request_australian_criminal_intelligence_commission_check": false,
"location_of_work": "",
"my_crc_region": null,
"request_address_references": false,
"employer_ref_req": false,
"issuing_authority": "",
"request_us_criminal_record_check_tier_2": false,
"volunteer_role": "",
"government_id_req": false,
"request_employer_phone_references": false,
"education_verification_max": 1,
"employer_references_min": 1,
"address_references_years": 3,
"position_title": "",
"request_employer_references": false,
"request_us_criminal_record_check_tier_1": false,
"whitelabel_report": false,
"employment_verification_years_or_individually": "INDIVIDUALLY",
"request_equifax": false,
"hide_sin_ssn": false,
"workable_fast_complete": false,
"request_uk_basic_ds_check": false,
"tenancy_ref_amount_req": 1,
"custom_tracks": [],
"hide_ssn_trace": true,
"applicant_login": false,
"purpose_of_check": null,
"limit_education_verifications": false,
"employer_references_years": 3,
"request_vaccination_check": false,
"license_type": "",
"exclude_softcheck_possible_matches": false,
"passport_req": false,
"employer_references_years_or_individually": "INDIVIDUALLY",
"hide_current_address": true,
"request_instant_verify_credential": false,
"request_us_criminal_record_check_tier_3": false,
"role_or_position_title": "",
"request_instant_verify_education": false,
"employment_sector": "",
"address_references_years_or_individually": "INDIVIDUALLY"
},
"billing_plan": {
"pm_request_softcheck_price": "0.00",
"hr_request_softcheck_price": "0.00",
"pm_request_equifax_price": "0.00",
"hr_request_equifax_price": "0.00",
"pm_request_identity_verification_price": "0.00",
"hr_request_identity_verification_price": "0.00",
"pm_request_enhanced_identity_verification_price": "0.00",
"hr_request_enhanced_identity_verification_price": "0.00",
"pm_request_criminal_record_check_price": "0.00",
"hr_request_criminal_record_check_price": "0.00",
"pm_request_vulnerable_sector_criminal_record_check_price": "0.00",
"hr_request_vulnerable_sector_criminal_record_check_price": "0.00",
"pm_request_motor_vehicle_records_price": "0.00",
"hr_request_motor_vehicle_records_price": "0.00",
"pm_request_education_verification_price": "0.00",
"hr_request_education_verification_price": "0.00",
"pm_request_credential_verification_price": "0.00",
"hr_request_credential_verification_price": "0.00",
"pm_request_employment_verification_price": "0.00",
"hr_request_employment_verification_price": "0.00",
"pm_request_us_criminal_record_check_tier_1_price": "0.00",
"hr_request_us_criminal_record_check_tier_1_price": "0.00",
"pm_request_us_criminal_record_check_tier_2_price": "0.00",
"hr_request_us_criminal_record_check_tier_2_price": "0.00",
"pm_request_us_criminal_record_check_tier_3_seven_year_price": "0.00",
"hr_request_us_criminal_record_check_tier_3_seven_year_price": "0.00",
"pm_request_us_criminal_record_check_tier_3_ten_year_price": "0.00",
"hr_request_us_criminal_record_check_tier_3_ten_year_price": "0.00",
"pm_request_employer_references_price": "0.00",
"hr_request_employer_references_price": "0.00",
"pm_request_address_references_price": "0.00",
"hr_request_address_references_price": "0.00",
"pm_request_employer_phone_references_price": "0.00",
"hr_request_employer_phone_references_price": "0.00",
"pm_request_address_phone_references_price": "0.00",
"hr_request_address_phone_references_price": "0.00",
"pm_request_enhanced_criminal_record_check_price": "0.00",
"hr_request_enhanced_criminal_record_check_price": "0.00",
"pm_request_instant_verify_employment_price": "0.00",
"pm_request_instant_verify_education_price": "0.00",
"pm_request_instant_verify_credential_price": "0.00",
"hr_request_instant_verify_employment_price": "0.00",
"hr_request_instant_verify_education_price": "0.00",
"hr_request_instant_verify_credential_price": "0.00",
"pm_request_soquij_price": "0.00",
"hr_request_soquij_price": "0.00",
"stripe_public_api_key": ""
},
"google_analytics_key": "",
"adwords_key": "",
"adwords_conversion_key": "",
"bing_key": "",
"external_domain": "",
"countries_excluded_from_international_check": []
}
},
"listing_count": 0,
"full_address": "1017 Fort Street Victoria BC CA ",
"url_code": "ec351b3c-0375-4e29-b050-2302f0475b65"
}
]
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="404: Not Found Page not found" %}
This may be happening because:
**The page number you provided doesn't exist**
Make sure the page number you entered is a valid integer and within the bounds of your expected results.
*See* [Error codes](/api/api-reference/resources/error-codes#404-not-found) *for more details.*
{% endtab %}
{% endtabs %}
## Create a property
`POST` `https://api.certn.co/api/v1/pm/properties` [**`DEPRECATED`**](/api/deprecation)
Create a new property with the information provided in the body of your request.
#### Request Body
| Name | Type | Description |
| ------------------------------------------------- | ------- | -------------------------------------------------------------------------- |
| building | string | Building's name |
| building\_code | string | |
| address\* | string | |
| city\* | string | |
| province\_state\* | string | [ISO Code](/api/api-reference/resources/region-codes#provinces-and-states) |
| country | string | [ISO Country Code](/api/api-reference/resources/region-codes#countries) |
| is\_active | boolean | |
| owner\_id\* | string | Assign this property to a specific user |
| county\* | string | US county, required for US addresses |
{% tabs %}
{% tab title="201: Created Property successfully created" %}
{% tabs %}
{% tab title="Response type" %}
{% code title="application/json" %}
```json
{
"id": string ,
"status": string,
"get_status_display": string,
"created": string ,
"modified": string ,
"last_updated": string ,
"building": string,
"building_code": string,
"address": string,
"city": string,
"county": string,
"province_state": string ,
"country": string ,
"postal_code": string,
"is_active": boolean,
"owner": {
"id": string ,
"email": string,
"team": {
"id": string .png?alt=media&token=c8003a34-034a-4225-a7a0-fc58151632f8)
5. Click **Settings**
6. Locate the team you want to use for testing
7. Click **Settings** for this team
{% hint style="success" %}
You can manage your account settings and billing info from here.
{% endhint %}
### Add a payment card
Adding a payment card to your account allows you to test a greater variety of features. Since this is a demo environment, you can use the card information provided below.
From your team's **Settings** page:
1. Click **Billing**
2. Click **Connect Payment Card**
3. Fill in the following card number: `4242 4242 4242 4242`
4. Add an expiry date in the future
5. Fill in the following CVC: `424`
6. Click **Authorize Card**
### Create an API key
1. Navigate back to the dashboard by clicking the Certn logo in the top left
2. Click on the **Partner** tab
3. Click **Refresh Keys**
4. Click **OK** to accept that a new key will be created, inactivating the previously generated key
5. Click **Copy**
6. A new **Client ID** and **Secret Key** will appear in a modal for copy/pasting
1. Once this modal is closed, the **Secret Key** will not be accessible anymore
.png?alt=media&token=6068928b-85e9-44bb-b585-acd97a3aeed1)
To log in, go to 
.png?alt=media&token=372585c2-0beb-4b93-ab1d-16887e5faf81)
.png?alt=media&token=83341d19-fca0-495b-9e52-898edeb79bd3)