Links

Changelogs

All notable changes to the api docs are documented in this file.

Versions 1.0.0 +

[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 (
    ) 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

  • Created account section that walks through the demo setup porcess

[0.0.12] - 2021-05-17

Removed

  • US Softcheck

Changed

  • RCMP changed to Canadian for headers only

[0.0.11] - 2021-03-16

Added

  • Webhook signatures added

[0.0.10] - 2021-02-11

Added

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

[0.0.9] - 2020-12-11

Fixed

  • Moved the enhanced_identity_verification object out of the information object in the enhanced Id check example.

Added

  • id_backside_image to enhanced_id_verification example json.

[0.0.8] - 2020-09-22

Added

  • Added fields for Employer income information.

[0.0.7] - 2020-04-27

Added

  • Added verification result to docs.

[0.0.6] - 2020-04-23

Added

  • Address to education model.

[0.0.5] - 2020-04-14

Added

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

[0.0.5] - 2020-04-09

Changed

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

[0.0.4]- 2020-02-24

Changed

  • 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

Added

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

[0.0.3] - 2020-02-05

Added

  • Equifax result fields

[0.0.2] - 2020-01-27

Added

  • Change log link added to docs

[0.0.1] - 2020-01-21

Added

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

Changed

  • 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

  • Updated check marks on Services tables to web friendly font.
Last modified 26d ago