Changelogs
All notable changes to the api docs are documented in this file.
- 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
addressunder Education in Application parameters to indicate that it is required.
- Added a row for Credit Check in Request flags.
- Added a note in Credit Check to indicate that the
sin_ssnparameter is strongly recommended when requesting it as a quickscreen. - Updated the Identity verification row’s in Request flags to
request_identity_verification.
- Removed the
sin_ssnquickscreen parameter from Softcheck.
- Added Employer Reference in Application parameters.
- Added the error code related to
min/maxparameters in Error codes.
- Updated the parameters in Employment Reference Check and the field mappings in Report field mappings to follow our new reference object model.
- Removed Contact from Application parameters.
- 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 Service Collections endpoints to Human Resources under API Reference.
- Added
specializationback to Education Verification and Application parameters.
- Removed
specializationfrom Education Verification and Application parameters.
- 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 Employment Reference flags to Request flags.
- 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.
- Added instructions for SOQUIJ.
- Renamed References (under API reference) to Resources.
- 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.
- 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.
- Created the Message page to communicate timely updates.
- Updated the check description for phone references in Employer Reference Check and Address Reference Check.
- Removed
request_us_ssn_verificationfrom Request flags as it is no longer used (this verification is part of our US Criminal Record Checks).
- 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.
- Updated Motor Vehicle Record Check / Driver's Abstract to include province and state limitations.
- 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.
- 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.
- Marked the
postal_codefield underaddressas required in the Application parameters page.
- Created the Credential Verification page
- Created the Request flags page
- 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
- Created the Address Reference Check page
- 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 the [IN BETA] message on the main page
- 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
- Updated the example in the Softcheck page
- Fixed minor typos
We redid our entire API documentation. It is currently in Beta, and we are improving it as we go!
- Created account section that walks through the demo setup porcess
- US Softcheck
- RCMP changed to Canadian for headers only
- Webhook signatures added
- Minimum image size requirements for enhanced identity verification (Longest side >300 pixels).
- Moved the enhanced_identity_verification object out of the information object in the enhanced Id check example.
- id_backside_image to enhanced_id_verification example json.
- Added fields for Employer income information.
- Added verification result to docs.
- Address to education model.
- Documented request data sets for services that have static server responses.
- Changed authentication section to reference the new process for Viewing, Creating and Deleting Access Tokens
- 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.
- Updated Us Criminal and Risk Result sections to include mock data
- Equifax result fields
- Change log link added to docs
- Description of us criminal softcheck added to Services section.
- Added Questions to the FAQ.
- Added Consent flags and description section.
- 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.
- Updated check marks on Services tables to web friendly font.
Last modified 26d ago