# Changelogs

## Versions 1.1.0 +

### \[1.1.3] - 2026-04-13

**Deprecated**

* API responses now include Deprecation, Sunset, and Link HTTP headers to communicate deprecation status programmatically.

**Added**

* Added a new [API Deprecation Notice](/api/deprecation.md) page with full details on the deprecation timeline, migration guide, and FAQ.
* Added a deprecation warning banner to documentation homepage with deprecation and sunset dates, and links to the new Centric API portal and migration guide.
* Added `DEPRECATED` badges to all legacy API endpoint documentation pages, linking to the deprecation notice.

### \[1.1.2] - 2024-01-23

**Updated**

* In **Canadian Criminal Record Check** updated check descriptions for clarity.
* In **Canadian Criminal Record Check**, **UK Right To Work Check**, **Basic Disclosure And Barring Service Check**, and **Basic Disclosure Scotland Check** updated example requests to include the required Identity Verification required to run these checks.
* In check pages where a US address is provided as part of an example, updated these addresses to include missing `county` fields. Additionally, added information in the related address objects in **Application Parameters**.
* In **Employment Verification**, updated the example request to match the allowed order methods.
* In **Enhanced Identity Verification**, updated the text for additional clarity.

###  \[1.1.1] - 2023-10-13

**Added**

* In **Settings & Packages**, under **Teams**, added:
  * Address reference templates endpoint
  * Employer reference templates endpoint

### \[1.1.0] - 2023-09-20

**Added**

* Added **Manage your integration users**, as support for integration specific partner users was added
* In **Request a demo account**, changed instructions to connect with Certn partnerships
* In **Guides**, added **Manage your integration users**
* In **Use the API,** updated instruction to align with the new authentication method and added **Webhook Parameters and Example**
*  In **Run a check, r**emoved Identity Check, as the check has been deprecated
* In **Account Settings**, added:
  * **Superteams**
  * **Teams**
  * **Users**
  * **Packages**
* In **Application parameters**, added **Package settings**

## Versions 1.0.0 +

### \[1.0.32] - 2023-08-15

**Added**

* In **Run a check**, added a page with instructions for the **Basic Disclosure Scotland (DS) Check**.
* In **Run a check**, added a page with instructions for the **Basic Disclosure And Barring Service (DBS) Check**.
* In **Application parameters**, added the parameters pertaining to the Basic DS Check and the Basic DBS Check.
* In **Report field mappings**, added the parameters pertaining to the Basic DS Check and the Basic DBS Check.

### \[1.0.31] - 2023-08-14

**Updated**

* In **Softcheck**, updated the example address to be a Canadian address.
* In **Social Media Check**, updated the Availability table to be country specific. 

**Added**

* In **Social Media Check**, added additional examples with different addresses for the different countries that the check is available in.
* In **Credit Check**, added additional example with different addresses for the different countries that the check is available in.

### \[1.0.30] - 2023-05-30

**Added**

* Added instructions for **Australia Right to Work Check**.

### \[1.0.29] - 2023-05-02

**Added**

* In **Use Webhooks**, added a sample JSON webhook payload.
* In **Certn API**, added a new welcome message and links to our other sites.

#### Updated

* In **Application Parameters**, under `Parameter objects`, `Address`, updated the `Current` parameter to be required, added notes.
* In **API Reference**, in the Property Management page, inside the `Create a property` endpoint, updated `County` to be a required parameter, added notes.\
  On both the Human Resources and Property Management pages, in the `Screen an applicant instantly` endpoint, updated the `position_or_property_location` parameter to be required.
* In **Softcheck**, updated the check's description.

### \[1.0.28] - 2023-02-24

#### Updated

* In **Enhanced Identity Verification**, updated redirect URL's new feature.
* In **Application parameters**, under “Enhanced Identity Verification”, added `on_success_url`.

### \[1.0.27] - 2023-02-17

#### Updated

* In **Social Media Check**, updated the sample consent forms provided for quickscreens.

### \[1.0.26] - 2023-02-16

#### Added

* Added instructions for **Social Media Check**.
* In **Application parameters**, under Parameter objects, added Social Media Details.
* In **Report field mappings**, added a section for Social Media Check.
* Under **Human Resources**, in **Available checks**, added **Social Media Check** in relevant regions.
* Under **Property Management**, in **Available checks**, added **Social Media Check** in relevant regions.

### \[1.0.25] - 2023-02-08

#### Added

* Added instructions for **Australian Criminal Intelligence Commission Check**.
* In **Application parameters**, under Main parameters, added `purpose_of_check` and Purpose of Check (ACIC).
* Under **API Reference**, in **Human Resources**, added `{ACIC parameters}` to the invite an applicant endpoint. 
* In **Report field mappings**, added a section for Australian Criminal Intelligence Commission Check.
* Under **Human Resources**, in **Available checks**, added **Australian Criminal Intelligence Commission Check**, **Credential Verifications**, and **Employment Verifications**.
* Under **Property Management**, in **Available checks**, added **Address Reference Check**.
* In the **FAQ**, added information about rate limiting.

#### Updated

* In **Application parameters**, under "Information", updated the Notes section for `gender`.
* In **Canadian Criminal Record Check**, indicated (`M`, `F`, `X`) as the available options for `gender`.

### \[1.0.24] - 2023-01-16

#### Updated

* In **Application parameters**, under “Main parameters”, added `position_or_property_location`.
* In **Application parameters**, under “Position or Property Location”, made a separate table for `Gig Location`.
* In **SOQUIJ**, replaced the example for `position_or_property_location` with `location_type: "Gig location"`.
* Fixed a formatting issue with the sample codes in **Softcheck**, **Credit Check**, **Enhanced Identity Verification**, **Canadian Criminal Record Check**, **SOQUIJ**, **US Criminal Record Check**, **Education Verification**, **Credential Verification**, **Employment Verification**, **Motor Vehicle Record Check / Driver's Abstract** and **Employment Reference Check**.

### \[1.0.23] - 2023-01-05

#### Added

* Under **API Reference**, on both the **Human Resources** and **Property Management** pages, added `position_or_property_location` to the Screen an applicant instantly endpoint. 
* Added Position and Property Location in **Application parameters**. 
* Added `current` under Address in **Application parameters**.
* Added `position_or_property_location` to all Quickscreen parameters lists and examples for our checks listed under **Run a check**.
* Added `current` to all adresses in Quickscreen examples for our checks listed under **Run a check**.
* Under **API Reference**, on the **Property Management** page, added `county` to the Create a property endpoint.

**Removed**

* Removed **Messages**.

### \[1.0.22] - 2022-11-9

#### Updated

* Updated **Get the applicant's consent** to be clearer around quickscreen consent.
* Added a note on each of the checks pages and the **FAQ** to indicate that consent must be obtained prior to running a quickscreen.
* Temporarily removed the quickscreen options from **Employment Verification** while our team works on improving the process for this check.
* Updated `address` under Education in **Application parameters** to indicate that it is required.

### \[1.0.21] - 2022-10-11

#### Added

* Added a row for Credit Check in **Request flags**.

#### Updated

* Added a note in **Credit Check** to indicate that the `sin_ssn` parameter is strongly recommended when requesting it as a quickscreen.
* Updated the Identity verification row’s in **Request flags** to `request_identity_verification`.

#### Removed

* Removed the `sin_ssn` quickscreen parameter from **Softcheck**.

### \[1.0.20] - 2022-09-12

#### Added

* Added Employer Reference in **Application parameters**.
* Added the error code related to `min`/`max` parameters in **Error codes.** 

#### Updated

* Updated the parameters in **Employment Reference Check** and the field mappings in **Report field mappings** to follow our new reference object model.

#### Removed

* Removed Contact from **Application parameters**.

### \[1.0.19] - 2022-08-31

#### Updated

* Added some descriptions to our endpoints sections in **Human Resources** and **Property Management** under **API Reference**.
* Fixed an error in the script provided in **Retrieve the results**.
* Added some links for context to our **Getting started** and **Guides** sections.

#### Added

* Added Service Collections endpoints to **Human Resources** under **API Reference**.
* Added `specialization` back to **Education Verification** and **Application parameters**.

### \[1.0.18] - 2022-07-29

#### Removed

* Removed `specialization` from **Education Verification** and **Application parameters**.

### \[1.0.17] - 2022-06-08

#### Updated

* Added new parameters and updated the example in **Employment Reference Check** to be in line with the current version of the API.
* Updated sections related to Employment References in **Application parameters** and **Request flags**.
* Renamed **Employer Reference Check** (under **Run a check**) to **Employment Reference Check**.

#### Added

* Added Employment Reference flags to **Request flags**.

### \[1.0.16] - 2022-05-25

#### Updated

* Added distinct descriptions for our Canadian Credit Report and US Equifax Report in **Credit Check**.
* Updated the test data in **Credit Check** to be in line with Certn's recent report changes.
* Clarified the steps in **Enhanced Identity Verification** for quickscreens with redirect URLs.
* Added a note in **Canadian Criminal Record Check** mentioning invites require an **Identity Verification** or an **Enhanced Identity Verification** to complete.

### \[1.0.15] - 2022-05-11

#### Added

* Added instructions for **SOQUIJ**.

#### Updated

* Renamed **References** (under API reference) to **Resources**.

### \[1.0.14] - 2022-05-09

#### Updated

* Added an Errors section to **Canadian Criminal Record Check**.
* Updated the api support email address.
* Renamed a few instances of *quickscreen* that were missed in the last update.

### \[1.0.13] - 2022-05-05

#### Updated

* Added a note in **Canadian Criminal Record Check** mentioning quickscreens require an **Enhanced Identity Verification** to complete.
* Renamed all instances of *quick screen* to *quickscreen*.

### \[1.0.12] - 2022-04-11

#### Added

* Created the **Message** page to communicate timely updates.

### \[1.0.11] - 2022-03-18

#### Updated

* Updated the check description for phone references in **Employer Reference Check** and **Address Reference Check**.

### \[1.0.10] - 2022-03-10

#### Removed

* Removed `request_us_ssn_verification` from **Request flags** as it is no longer used (this verification is part of our **US Criminal Record Checks**).

### \[1.0.9] - 2022-01-31

#### Updated

* Added statements clarifying which parameters are required for a quick screen vs an invite in each of our checks and in **Application parameters**.
* Added an external link icon (![](/files/i1X0t7ez6Vlx9HiwQQXC)) to all outgoing links.

### \[1.0.8] - 2022-01-31

#### Updated

* Updated **Motor Vehicle Record Check / Driver's Abstract** to include province and state limitations.

### \[1.0.7] - 2022-01-26

#### Updated

* Updated the descriptions for **Softcheck**, **Identity Verification**, **Enhanced Identity Verification**, **Canadian Criminal Record Check**, **US Criminal Record Check** and **Education Verification**.
* Updated the examples and descriptions for teams API calls in **General**.
* Added errors related to team endpoints in **Error codes**.
* Updated broken links to **Error codes** in Getting Started.

### \[1.0.6] - 2022-01-21

#### Added

* Added the API call to retrieve all applications in **Human Resources** and **Property Management**.
* Added common error responses to API calls in **Human Resources** and **Property Management**.

**Updated**

* Updated PM specific endpoints in **Property Management**.
* Added errors related to pagination in **Error codes**.
* Updated all broken links to **Request flags**.

### \[1.0.5] - 2022-01-13

#### Changed

* Marked the `postal_code` field under `address` as required in the **Application parameters** page.

### \[1.0.4] - 2021-12-22

#### Added

* Created the **Credential Verification** page
* Created the **Request flags** page

#### Changed

* Removed **Credential Verification** from the Education Verification page
* Updated **Education Verification** with recent changes to the API
* Removed the request flags from the **Application parameters** page

### \[1.0.3] - 2021-11-19

#### Added

* Created the Address Reference Check page

#### Changed

* Made major updates to the Canadian Criminal Record Check, International Criminal Record Check, Education Verification, Employment Verification, Motor Vehicle Record Check and Employer Reference Check pages
* Made minor updates to the Softcheck, Credit Check, Identity Verification, and Enhanced Identity Verification pages
* Clarified the language in the consent page
* Fixed minor typos

#### Removed

* Removed the \[IN BETA] message on the main page

### \[1.0.2] - 2021-11-18

#### Changed

* Made major updates the Softcheck, Credit Check, Identity Verification, and Enhanced Identity Verification pages
* Added clearer notes to the main API Reference pages
* Moved the API section to the bottom of the Report field mappings page

### \[1.0.1] - 2021-11-18

#### **Changed**

* Updated the example in the Softcheck page
* Fixed minor typos

### \[1.0.0] - 2021-11-12

We redid our entire API documentation. It is currently in Beta, and we are improving it as we go!

## Versions 0.0.1 to 0.0.13

### \[0.0.13] - 2021-05-25

#### Added <a href="#added" id="added"></a>

* Created account section that walks through the demo setup porcess

### \[0.0.12] - 2021-05-17 <a href="#id-0012---2021-05-17" id="id-0012---2021-05-17"></a>

#### Removed <a href="#removed" id="removed"></a>

* US Softcheck

#### Changed <a href="#changed" id="changed"></a>

* RCMP changed to Canadian for headers only

### \[0.0.11] - 2021-03-16 <a href="#id-0011---2021-03-16" id="id-0011---2021-03-16"></a>

#### Added <a href="#added-1" id="added-1"></a>

* Webhook signatures added

### \[0.0.10] - 2021-02-11 <a href="#id-0010---2021-02-11" id="id-0010---2021-02-11"></a>

#### Added <a href="#added-2" id="added-2"></a>

* Minimum image size requirements for enhanced identity verification (Longest side >300 pixels).

### \[0.0.9] - 2020-12-11 <a href="#id-009---2020-12-11" id="id-009---2020-12-11"></a>

#### Fixed <a href="#fixed" id="fixed"></a>

* Moved the enhanced\_identity\_verification object out of the information object in the enhanced Id check example.

#### Added <a href="#added-3" id="added-3"></a>

* id\_backside\_image to enhanced\_id\_verification example json.

### \[0.0.8] - 2020-09-22 <a href="#id-008---2020-09-22" id="id-008---2020-09-22"></a>

#### Added <a href="#added-4" id="added-4"></a>

* Added fields for Employer income information.

### \[0.0.7] - 2020-04-27 <a href="#id-007---2020-04-27" id="id-007---2020-04-27"></a>

#### Added <a href="#added-5" id="added-5"></a>

* Added verification result to docs.

### \[0.0.6] - 2020-04-23 <a href="#id-006---2020-04-23" id="id-006---2020-04-23"></a>

#### Added <a href="#added-6" id="added-6"></a>

* Address to education model.

### \[0.0.5] - 2020-04-14 <a href="#id-005---2020-04-14" id="id-005---2020-04-14"></a>

#### Added <a href="#added-7" id="added-7"></a>

* Documented request data sets for services that have static server responses.

### \[0.0.5] - 2020-04-09 <a href="#id-005---2020-04-09" id="id-005---2020-04-09"></a>

#### Changed <a href="#changed-1" id="changed-1"></a>

* Changed authentication section to reference the new process for Viewing, Creating and Deleting Access Tokens

### \[0.0.4]- 2020-02-24 <a href="#id-004--2020-02-24" id="id-004--2020-02-24"></a>

#### Changed <a href="#changed-2" id="changed-2"></a>

* Change cdn address for redoc to specify specific version(2.0.0-rc23) to fix a bug that made the docs not display correctly in Chrome v80.

### \[0.0.3] - 2020-01-29 <a href="#id-003---2020-01-29" id="id-003---2020-01-29"></a>

#### Added <a href="#added-8" id="added-8"></a>

* Updated Us Criminal and Risk Result sections to include mock data

### \[0.0.3] - 2020-02-05 <a href="#id-003---2020-02-05" id="id-003---2020-02-05"></a>

#### Added <a href="#added-9" id="added-9"></a>

* Equifax result fields

### \[0.0.2] - 2020-01-27 <a href="#id-002---2020-01-27" id="id-002---2020-01-27"></a>

#### Added <a href="#added-10" id="added-10"></a>

* Change log link added to docs

### \[0.0.1] - 2020-01-21 <a href="#id-001---2020-01-21" id="id-001---2020-01-21"></a>

#### Added <a href="#added-11" id="added-11"></a>

* Description of us criminal softcheck added to Services section.
* Added Questions to the FAQ.
* Added Consent flags and description section.

#### Changed <a href="#changed-3" id="changed-3"></a>

* Updated International Criminal Record Check to have link to country codes.
* Added explanation for manual review to enhanced ID.
* Added Emphasis to report\_status field.

#### Fixed <a href="#fixed-1" id="fixed-1"></a>

* Updated check marks on Services tables to web friendly font.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.certn.co/api/changelogs.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.